Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: ivan-abc <36765187+ivan-abc@users.noreply.github.com>
Co-authored-by: Alexandr <alexandrhub@vk.com>
  • Loading branch information
3 people committed Jun 20, 2023
1 parent 02497fd commit 13d2845
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/ru/docs/tutorial/path-operation-configuration.md
Expand Up @@ -31,12 +31,12 @@
{!> ../../../docs_src/path_operation_configuration/tutorial001.py!}
```

Этот код состояния будет использован в ответе, и будет добавлен в схему OpenAPI.
Этот код состояния будет использован в ответе и будет добавлен в схему OpenAPI.

!!! note "Технические детали"
Вы также можете использовать `from starlette import status`.

**FastAPI** предоставляет тот же `starlette.status`, что и `fastapi.status` для удобства разработчкиа. Но идет он непросредственно от Starlette.
**FastAPI** предоставляет тот же `starlette.status` под псевдонимом `fastapi.status` для удобства разработчика. Но его источник - это непосредственно Starlette.

## Теги

Expand Down Expand Up @@ -66,19 +66,19 @@

### Теги с перечислениями

Если у вас большое приложение, под конец вы можете набрать **несколько тегов**, и вы можете хотеть убедиться в том, что всегда используете **один и тот же тег** для связанных *операций пути*.
Если у вас большое приложение, вы можете прийти к необходимости добавить **несколько тегов**, и возможно, вы захотите убедиться в том, что всегда используете **один и тот же тег** для связанных *операций пути*.

В этих случаях, имеет смысл хранить теги в `Enum`.
В этих случаях, имеет смысл хранить теги в классе `Enum`.

**FastAPI** поддерживает это также, как и с обычными строками:
**FastAPI** поддерживает это так же, как и в случае с обычными строками:

```Python hl_lines="1 8-10 13 18"
{!../../../docs_src/path_operation_configuration/tutorial002b.py!}
```

## Краткое и развёрнутое содержание

Вы можете добавить `summary` и `description`:
Вы можете добавить параметры `summary` и `description`:

=== "Python 3.10+"

Expand All @@ -100,9 +100,9 @@

## Описание из строк документации

Так как описания обычно длинные и содержат много строк, вы можете объявить описание *операции пути* в функции <abbr title="многострочный текст в качестве первого выражения внутри функции (не присвоенная какой-либо переменной), используемый для документации">строки документации</abbr> и **FastAPI** прочитает её отсюда.
Так как описания обычно длинные и содержат много строк, вы можете объявить описание *операции пути* в функции <abbr title="многострочный текст, первое выражение внутри функции (не присвоенный какой-либо переменной), используемый для документации">строки документации</abbr> и **FastAPI** прочитает её отсюда.

Вы можете использовать <a href="https://en.wikipedia.org/wiki/Markdown" class="external-link" target="_blank">Markdown</a> в строке документации, и оно будет интерпретировано и отображено корректно (с учетом отступа в строке документации).
Вы можете использовать <a href="https://en.wikipedia.org/wiki/Markdown" class="external-link" target="_blank">Markdown</a> в строке документации, и он будет интерпретирован и отображён корректно (с учетом отступа в строке документации).

=== "Python 3.10+"

Expand Down Expand Up @@ -149,18 +149,18 @@
```

!!! info "Дополнительная информация"
Помните, что `response_description` относится конкретно к ответу, а `description` в основном относится к *операциям пути*.
Помните, что `response_description` относится конкретно к ответу, а `description` относится к *операции пути* в целом.

!!! check "Технические детали"
OpenAPI указывает, что каждой *операции пути* необходимо описание ответа.

Если вдруг вы не укажите одно из них, то **FastAPI** автоматически сгенерирует один из "Удачных ответов".
Если вдруг вы не укажете его, то **FastAPI** автоматически сгенерирует это описание с текстом "Successful response".

<img src="/img/tutorial/path-operation-configuration/image03.png">

## Обозначение *операции пути* как устаревшей

Если вам необходимо пометить *операцию пути* как <abbr title="устаревшее, не рекомендовано к использованию">устаревшую</abbr>, но без её удаления, передайте параметр `deprecated`:
Если вам необходимо пометить *операцию пути* как <abbr title="устаревшее, не рекомендовано к использованию">устаревшую</abbr>, при этом не удаляя её, передайте параметр `deprecated`:

```Python hl_lines="16"
{!../../../docs_src/path_operation_configuration/tutorial006.py!}
Expand All @@ -170,7 +170,7 @@

<img src="/img/tutorial/path-operation-configuration/image04.png">

Проверьте, как устаревшие и не-устаревшие *операции пути* будут выглядеть:
Проверьте, как будут выглядеть устаревшие и не устаревшие *операции пути*:

<img src="/img/tutorial/path-operation-configuration/image05.png">

Expand Down

0 comments on commit 13d2845

Please sign in to comment.