/// info

The parameter `summary` is available in OpenAPI 3.1.0 and above, supported by FastAPI 0.99.0 and above.

///

## Overriding the defaults { #overriding-the-defaults }

Using the information above, you can use the same utility function to generate the OpenAPI schema and override each part that you need.

But if for some reason your clients depend on the old behavior, you can revert to it by overriding the method `make_not_authenticated_error` in your security classes.

For example, you can create a subclass of `HTTPBearer` that returns a `403 Forbidden` error instead of the default `401 Unauthorized` error:

/**
 * Implementation of {@link ImmutableMap} backed by a non-empty {@link java.util.EnumMap}.
 *
 * @author Louis Wasserman
 */
@GwtCompatible
@SuppressWarnings("serial") // we're overriding default serialization
final class ImmutableEnumMap<K extends Enum<K>, V> extends IteratorBasedImmutableMap<K, V> {
  static <K extends Enum<K>, V> ImmutableMap<K, V> asImmutable(EnumMap<K, V> map) {
    switch (map.size()) {

/**
 * {@link FluentFuture} that forwards all calls to a delegate.
 *
 * <p><b>Warning:</b> The methods of {@code ForwardingFluentFuture} forward <b>indiscriminately</b>
 * to the methods of the delegate. For example, overriding {@link #get(long, TimeUnit)} alone
 * <b>will not</b> change the behavior of {@link #get()}, which can lead to unexpected behavior. In
 * this case, you should override {@code get()} as well.
 *

 * href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>.
 *
 * <p><b>Warning:</b> The methods of {@code ForwardingFuture} forward <b>indiscriminately</b> to the
 * methods of the delegate. For example, overriding {@link #get(long, TimeUnit)} alone <b>will
 * not</b> change the behavior of {@link #get()}, which can lead to unexpected behavior. In this
 * case, you should override {@code get()} as well.
 *

* `summary`：API 的簡短摘要。
* `description`：API 的描述，可包含 Markdown，會顯示在文件中。
* `routes`：路由列表，也就是所有已註冊的路徑操作。來源為 `app.routes`。

/// info

`summary` 參數在 OpenAPI 3.1.0 以上可用，且需 FastAPI 0.99.0 以上版本支援。

///

## 覆寫預設行為 { #overriding-the-defaults }

基於上述資訊，你可以用相同的工具函式來產生 OpenAPI 結構，並覆寫你需要客製的部分。

例如，我們要加入 [ReDoc 的 OpenAPI 擴充，插入自訂 logo](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo)。

 *
 * <p><b>Warning:</b> The methods of {@code ForwardingListenableFuture} forward
 * <b>indiscriminately</b> to the methods of the delegate. For example, overriding {@link #get(long,
 * TimeUnit)} alone <b>will not</b> change the behavior of {@link #get()}, which can lead to
 * unexpected behavior. In this case, you should override {@code get()} as well.
 *

- `routes`: ルートのリスト。登録済みの各 path operation です。`app.routes` から取得されます。

/// info | 情報

パラメータ `summary` は OpenAPI 3.1.0 以降で利用可能で、FastAPI 0.99.0 以降が対応しています。

///

## デフォルトの上書き { #overriding-the-defaults }

上記の情報を使って、同じユーティリティ関数で OpenAPI スキーマを生成し、必要な部分を上書きできます。

たとえば、[カスタムロゴを含めるための ReDoc の OpenAPI 拡張](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo)を追加してみましょう。

```

### Troubleshooting

1. Valid cacheable responses are not being cached

Make sure you are reading responses fully as unless they are read fully, cancelled or stalled Responses will not be cached.

### Overriding normal cache behaviour

* Put that data in a Pydantic model.
* Generate a `dict` without default values from the input model (using `exclude_unset`).
    * This way you can update only the values actually set by the user, instead of overriding values already stored with default values in your model.
* Create a copy of the stored model, updating its attributes with the received partial updates (using the `update` parameter).