## Теги в документации — OpenAPI { #documentation-tags-openapi }

Чтобы добавить теги к вашим *операциям пути* и группировать их в интерфейсе документации, прочитайте документацию: [Руководство — Конфигурации операций пути — Теги](../tutorial/path-operation-configuration.md#tags).

## Краткое описание и описание в документации — OpenAPI { #documentation-summary-and-description-openapi }

## Dokümantasyon Etiketleri - OpenAPI { #documentation-tags-openapi }

*path operation*'larınıza etiketler eklemek ve dokümantasyon arayüzünde gruplamak için, [Tutorial - Path Operation Configurations - Tags](../tutorial/path-operation-configuration.md#tags) dokümantasyonunu okuyun.

## Dokümantasyon Özeti ve Açıklaması - OpenAPI { #documentation-summary-and-description-openapi }

Même si elles se trouvent dans des modules différents (fichiers Python).

///

## Exclusion d’OpenAPI { #exclude-from-openapi }

Pour exclure un chemin d’accès du schéma OpenAPI généré (et donc des systèmes de documentation automatiques), utilisez le paramètre `include_in_schema` et définissez-le à `False` :

{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py310.py hl[6] *}

And those Python files are included/injected in the documentation when generating the site.

### Docs for tests

Most of the tests actually run against the example source files in the documentation.

This helps to make sure that:

* The documentation is up-to-date.
* The documentation examples can be run as is.
* Most of the features are covered by the documentation, ensured by test coverage.

## 文档的标签 - OpenAPI { #documentation-tags-openapi }

在文档界面中添加**路径操作**的标签和进行分组，请阅读 [教程 - 路径操作配置 - Tags](../tutorial/path-operation-configuration.md#tags) 文档。

## 文档的概要和描述 - OpenAPI { #documentation-summary-and-description-openapi }

C'est incroyablement utile lors du développement et du débogage du code qui interagit avec votre API.

///

## Documentation { #documentation }

Et lorsque vous ouvrez votre navigateur sur [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs), vous verrez une documentation d'API automatique et interactive comme :

<img src="/img/tutorial/path-params/image01.png">

/// check | Vérifications

Distributions are output to `distributions/archives`.

To run the test suite, see xref:TESTING.asciidoc[TESTING].

[[docs]]
== Documentation

For the complete Elasticsearch documentation visit
https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html[elastic.co].

For information about our documentation processes, see the
xref:docs/README.asciidoc[docs README].

[[contribute]]
== Contribute

## About security, APIs, and docs { #about-security-apis-and-docs }

Hiding your documentation user interfaces in production *shouldn't* be the way to protect your API.

That doesn't add any extra security to your API, the *path operations* will still be available where they are.

If there's a security flaw in your code, it will still exist.

* `externalDocs` : un `dict` décrivant une documentation externe avec :
    * `description` : un `str` avec une courte description pour la documentation externe.
    * `url` (**requis**) : un `str` avec l’URL de la documentation externe.

### Créer des métadonnées pour les tags { #create-metadata-for-tags }

                getLogger().info("Verifying documentation for file: {}", jsonFile.getName());
                allErrors.addAll(findMissingAdocFiles(jsonFile, directoryPath));
                allErrors.addAll(findMissingAnchors(jsonFile, allExistingAnchors));
            }

            if (!allErrors.isEmpty()) {
                System.out.println("Found documentation files or anchors that do not exist:");