例えば、上記のモデルは次のようなJSON「`object`」（またはPythonの `dict`）を宣言します:

```JSON
{
    "name": "Foo",
    "description": "An optional description",
    "price": 45.2,
    "tax": 3.5
}
```

...`description` と `tax` はオプション（デフォルト値が `None`）なので、このJSON「`object`」も有効です:

```JSON
{
    "name": "Foo",
    "price": 45.2
}
```

2. **Disclose significant AI involvement.** If AI tools played a major role in producing your contribution, say so in the description. We are not interested in incidental use, such as asking a chatbot for advice or accepting an autocomplete suggestion—but rather in cases where a tool generated substantial portions of the work. Disclosure will not reduce the likelihood of your...

 * under the License.
 */

/**
 * Provides annotations for Maven plugin development, including mojo configuration,
 * parameter definitions, and lifecycle bindings. These annotations are used to
 * generate plugin descriptors and configure plugin behavior.
 *
 * @since 4.0.0
 */

    init {
        project.gradle.sharedServices.registerIfAbsent(NullawayStatusService.SERVICE_NAME, NullawayStatusService::class)
        group = LifecycleBasePlugin.BUILD_GROUP
        description = "Checks status of NullAway support in this project. Call unqualified to get summary for all projects."
    }

    @TaskAction
    fun action() {

    private final SrvCopychunk[] chunks;

    /**
     * Constructs a server copy chunk operation request
     * @param sourceKey the resume key identifying the source file
     * @param chunks the array of copy chunk descriptors
     */
    public SrvCopychunkCopy(final byte[] sourceKey, final SrvCopychunk... chunks) {
        this.sourceKey = sourceKey;
        this.chunks = chunks;
    }

    /**
     * {@inheritDoc}
     *

                    "reverse.dep.*.performance.baselines",
                    type.defaultBaselines,
                    display = ParameterDisplay.PROMPT,
                    allowEmpty = true,
                    description = "The baselines you want to run performance tests against. Empty means default baseline.",
                )
                param("env.PERFORMANCE_DB_PASSWORD_TCAGENT", "%performance.db.password.tcagent%")

若要從產生的 OpenAPI 結構（也就是自動文件系統）中排除某個*路徑操作*，使用參數 `include_in_schema` 並將其設為 `False`：

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

## 從 docstring 提供進階描述 { #advanced-description-from-docstring }

你可以限制 OpenAPI 從*路徑操作函式*的 docstring 中使用的內容行數。

加上一個 `\f`（跳頁字元，form feed）會讓 FastAPI 在此處截斷用於 OpenAPI 的輸出。

這個字元不會出現在文件中，但其他工具（例如 Sphinx）仍可使用其後的內容。

        @DisplayName("should reject invalid version formats")
        void shouldRejectInvalidVersionFormats(String version, String description) {
            assertFalse(
                    ModelVersionUtils.isValidModelVersion(version), "Should reject " + description + ": " + version);
        }

        private static Stream<Arguments> provideInvalidVersions() {
            return Stream.of(

* `version`: A versão da sua API, por exemplo, `2.5.0`.
* `openapi_version`: A versão da especificação OpenAPI utilizada. Por padrão, a mais recente: `3.1.0`.
* `summary`: Um resumo curto da API.
* `description`: A descrição da sua API, que pode incluir markdown e será exibida na documentação.
* `routes`: Uma lista de rotas, que são cada uma das *operações de rota* registradas. Elas são obtidas de `app.routes`.

/// info | Informação

        Set<MojoDescriptor> descriptors = new HashSet<>(mojoExecutions.size());

        for (MojoExecution execution : mojoExecutions) {
            MojoDescriptor mojoDescriptor = fillMojoDescriptor(session, project, execution);
            descriptors.add(mojoDescriptor);
        }

        return descriptors;
    }