That extra info will be added as-is to the output **JSON Schema** for that model, and it will be used in the API docs.

You can use the attribute `model_config` that takes a `dict` as described in <a href="https://docs.pydantic.dev/latest/api/config/" class="external-link" target="_blank">Pydantic's docs: Configuration</a>.

 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package gradlebuild.docs.dsl.source;

import gradlebuild.docs.dsl.source.model.ClassMetaData;
import gradlebuild.docs.dsl.source.model.TypeMetaData;
import gradlebuild.docs.model.ClassMetaDataRepository;
import org.apache.commons.lang3.StringUtils;
import org.gradle.api.Action;
import org.gradle.internal.UncheckedException;

* `lang-all`: Translations
    * Use this for translations. You can normally quickly detect it by going to the "Files changed" tab in the PR and checking if the updated file(s) starts with `docs/{some lang}/docs` but not `docs/en/docs`. For example, `docs/es/docs`.
* `internal`: Internal

bucket). ## mcImage: repository: quay.io/minio/mc tag: RELEASE.2021-09-02T09-21-27Z pullPolicy: IfNotPresent ## minio mode, i.e. standalone or distributed or gateway (nas) ## Distributed MinIO ref: https://docs.minio.io/docs/distributed-minio-quickstart-guide ## NAS Gateway MinIO ref: https://docs.min.io/docs/minio-gateway-for-nas.html mode: distributed ## NOTE: currently only "nas" gateway is supported. ## Additional labels to include with deployment or statefulset additionalLabels: [] ## Additional annotations...

bucket). ## mcImage: repository: quay.io/minio/mc tag: RELEASE.2021-09-02T09-21-27Z pullPolicy: IfNotPresent ## minio mode, i.e. standalone or distributed or gateway (nas) ## Distributed MinIO ref: https://docs.minio.io/docs/distributed-minio-quickstart-guide ## NAS Gateway MinIO ref: https://docs.min.io/docs/minio-gateway-for-nas.html mode: distributed ## NOTE: currently only "nas" gateway is supported. ## Additional labels to include with deployment or statefulset additionalLabels: [] ## Additional annotations...

bucket). ## mcImage: repository: quay.io/minio/mc tag: RELEASE.2021-09-02T09-21-27Z pullPolicy: IfNotPresent ## minio mode, i.e. standalone or distributed or gateway (nas) ## Distributed MinIO ref: https://docs.minio.io/docs/distributed-minio-quickstart-guide ## NAS Gateway MinIO ref: https://docs.min.io/docs/minio-gateway-for-nas.html mode: distributed ## NOTE: currently only "nas" gateway is supported. ## Additional labels to include with deployment or statefulset additionalLabels: [] ## Additional annotations...

///

## OpenAPI and API docs { #openapi-and-api-docs }

If you return additional status codes and responses directly, they won't be included in the OpenAPI schema (the API docs), because FastAPI doesn't have a way to know beforehand what you are going to return.

bucket). ## mcImage: repository: quay.io/minio/mc tag: RELEASE.2021-11-16T20-37-36Z pullPolicy: IfNotPresent ## minio mode, i.e. standalone or distributed or gateway (nas) ## Distributed MinIO ref: https://docs.minio.io/docs/distributed-minio-quickstart-guide ## NAS Gateway MinIO ref: https://docs.min.io/docs/minio-gateway-for-nas.html mode: distributed ## NOTE: currently only "nas" gateway is supported. ## Additional labels to include with deployment or statefulset additionalLabels: [] ## Additional annotations...

    context = browser.new_context(viewport={"width": 960, "height": 1080})
    page = context.new_page()
    page.goto("http://localhost:8000/docs")
    page.get_by_label("post /heroes/").click()
    # Manually add the screenshot
    page.screenshot(path="docs/en/docs/img/tutorial/sql-databases/image01.png")

    # ---------------------
    context.close()
    browser.close()


process = subprocess.Popen(

### Выходная модель в документации { #model-for-output-in-docs }

В документации это тоже видно, что **оба**: `name` и `description`, помечены **красной звёздочкой** как **обязательные**:

<div class="screenshot">
<img src="/img/tutorial/separate-openapi-schemas/image03.png">
</div>

### Модели для входа и выхода в документации { #model-for-input-and-output-in-docs }