To add a summary and description to your *path operations*, and show them in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Summary and Description](../tutorial/path-operation-configuration.md#summary-and-description).

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

    //                                                                      ==============
    /**
     * Show the index page.
     * @return The HTML response.
     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })
    public HtmlResponse index() {
        return asListHtml();
    }

    /**
     * Show the list page.
     * @param pageNumber The page number.
     * @param form The search form.

    //                                                                      ==============
    /**
     * Show the index page.
     * @return The HTML response.
     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })
    public HtmlResponse index() {
        return asListHtml();
    }

    /**
     * Show the list page.
     * @param pageNumber The page number.
     * @param form The search form.

///

FastAPI will now:

* **Validate** the data making sure that the max length is 50 characters
* Show a **clear error** for the client when the data is not valid
* **Document** the parameter in the OpenAPI schema *path operation* (so it will show up in the **automatic docs UI**)

## Alternative (old): `Query` as the default value { #alternative-old-query-as-the-default-value }

You can set `"json_schema_extra"` with a `dict` containing any additional data you would like to show up in the generated JSON Schema, including `examples`.

/// tip

You could use the same technique to extend the JSON Schema and add your own custom extra info.

    }

    /**
     * Hide empty state
     */
    function hideEmptyState() {
        elements.emptyState.hide();
    }

    /**
     * Show empty state
     */
    function showEmptyState() {
        elements.emptyState.show();
    }

    /**
     * Format timestamp
     */
    function formatTimestamp(date) {
        var hours = date.getHours();

* validate: валидировать (or `выполнить валидацию`)
* requirements (meaning dependencies): зависимости
* auto-reload: авто-перезагрузка (or `перезагрузить автоматически` if used as a verb)
* show (meaning show on the screen): отобразить
* parsing (noun): парсинг
* origin (in web development): origin (add `источник` if clarification is needed)
* include: включать (add `в себя` if it's appropriate, or use `содержать` as an alternative)

            - .github/workflows/deploy-docs.yml
            - scripts/mkdocs_hooks.py
  langs:
    needs:
      - changes
    runs-on: ubuntu-latest
    outputs:
      langs: ${{ steps.show-langs.outputs.langs }}
    steps:
      - uses: actions/checkout@v6
      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version-file: ".python-version"

      withEnv(["JAVA_HOME=${tool "$jdk"}",
               "PATH+MAVEN=${tool "$jdk"}/bin:${tool "maven_3_latest"}/bin",
               "MAVEN_OPTS=-Xms4G -Xmx4G -Djava.awt.headless=true"]) {
        sh "mvn --errors --batch-mode --show-version org.apache.maven.plugins:maven-wrapper-plugin:3.3.4:wrapper -Dmaven=3.9.12"
        sh "echo run Its"
        sh "./mvnw -e -B -V install $extraArgs"
      }
    }
    finally {

    }

    private static List<String> parentCommitsOf(String commit) throws IOException, InterruptedException, ExecutionException {
        String stdout = getStdout(new String[] {"git", "show", "--format=%P", "--no-patch", "--no-show-signature", commit});
        String trimmed = stdout.trim();
        if (trimmed.isEmpty()) {
            return Collections.emptyList();
        }
        return Arrays.stream(trimmed.split("\\s+"))