* `title`: The OpenAPI title, shown in the docs.
* `version`: The version of your API, e.g. `2.5.0`.
* `openapi_version`: The version of the OpenAPI specification used. By default, the latest: `3.1.0`.
* `summary`: A short summary of the API.
* `description`: The description of your API, this can include markdown and will be shown in the docs.

{* ../../docs_src/metadata/tutorial004.py hl[3:16,18] *}

Notice that you can use Markdown inside of the descriptions, for example "login" will be shown in bold (**login**) and "fancy" will be shown in italics (_fancy_).

/// tip

You don't have to add metadata for all the tags that you use.

///

### Use your tags { #use-your-tags }

    /**
     * Notification message displayed on the login page.
     * This message is shown to users on the authentication page.
     */
    @Size(max = 3000)
    public String notificationLogin;

    /**
     * Notification message displayed on the search top page.
     * This message is shown to users on the main search page.
     */
    @Size(max = 3000)
    public String notificationSearchTop;

    }

    /**
     * The CRUD operation mode (create, update, etc.).
     */
    @ValidateTypeFailure
    public Integer crudMode;

    /**
     * The search term for which related queries are shown.
     */
    @Required
    @Size(max = 10000)
    public String term;

    /**
     * The related queries to be suggested (one per line).
     */
    @Required
    @Size(max = 10000)

 * for use in test code.
 *
 * <p><b>Do not use this interface</b> for public or protected declarations: it is a fig leaf for
 * bad design, and it does not prevent anyone from using the declaration---and experience has shown
 * that they will. If the method breaks the encapsulation of its class, then its internal
 * representation will be hard to change. Instead, use <a

There are multiple tools that you can use to create those dependables, and they get integrated into OpenAPI so they are shown in the automatic docs UI, they can be used by automatically generated clients and SDKs, etc.

You can import them from `fastapi.security`:

```python
from fastapi.security import (
    APIKeyCookie,
    APIKeyHeader,

    }

    /**
     * The CRUD operation mode (create, update, etc.).
     */
    @ValidateTypeFailure
    public Integer crudMode;

    /**
     * The search term for which related content is shown.
     */
    @Required
    @Size(max = 10000)
    public String term;

    /**
     * The related content to be displayed.
     */
    @Required
    @Size(max = 10000)
    public String content;

 *       }
 *     };
 * iteratorTester.test();
 * iteratorTester.testForEachRemaining();
 * }
 *
 * <p><b>Note</b>: It is necessary to use {@code IteratorTester.KnownOrder} as shown above, rather
 * than {@code KnownOrder} directly, because otherwise the code cannot be compiled.
 *
 * @author Kevin Bourrillion
 * @author Chris Povirk
 */
@GwtCompatible
@NullMarked

## Documentation Response description - OpenAPI { #documentation-response-description-openapi }

To define the description of the response, shown in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Response description](../tutorial/path-operation-configuration.md#response-description){.internal-link target=_blank}.

 *       }
 *     };
 * iteratorTester.test();
 * iteratorTester.testForEachRemaining();
 * }
 *
 * <p><b>Note</b>: It is necessary to use {@code IteratorTester.KnownOrder} as shown above, rather
 * than {@code KnownOrder} directly, because otherwise the code cannot be compiled.
 *
 * @author Kevin Bourrillion
 * @author Chris Povirk
 */
@GwtCompatible
@NullMarked