{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *}

## JSON Schema에서의 `examples` - OpenAPI { #examples-in-json-schema-openapi }

다음 중 하나를 사용할 때:

* `Path()`
* `Query()`
* `Header()`
* `Cookie()`
* `Body()`
* `Form()`
* `File()`

**OpenAPI** 안의 **JSON 스키마**에 추가될 부가적인 정보를 포함한 `examples` 모음을 선언할 수도 있습니다.

### `examples`를 포함한 `Body` { #body-with-examples }

## İlk bağımlılık "dependable" { #first-dependency-dependable }

Şöyle bir ilk bağımlılık ("dependable") oluşturabilirsiniz:

{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[8:9] *}

Burada `q` adında opsiyonel bir query parametresi `str` olarak tanımlanır ve sonra doğrudan geri döndürülür.

Bu oldukça basit (pek faydalı değil), ama alt bağımlılıkların nasıl çalıştığına odaklanmamıza yardımcı olacak.

{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *}

## `examples` in JSON Schema - OpenAPI { #examples-in-json-schema-openapi }

When using any of:

* `Path()`
* `Query()`
* `Header()`
* `Cookie()`
* `Body()`
* `Form()`
* `File()`

you can also declare a group of `examples` with additional information that will be added to their **JSON Schemas** inside of **OpenAPI**.

        relatedContentHelper.setQueryPlaceHolder("{{QUERY}}");
        assertEquals("{{QUERY}}", relatedContentHelper.queryPlaceHolder);

        // Test with the new placeholder
        List<RelatedContent> testData = new ArrayList<>();
        testData.add(createRelatedContent("regex:test.*", "Content for {{QUERY}}", ""));
        mockBhv.setTestData(testData);

        relatedContentHelper.load();

Tendrá una *path operation* que recibirá un cuerpo `Invoice`, y un parámetro de query `callback_url` que contendrá la URL para el callback.

Esta parte es bastante normal, probablemente ya estés familiarizado con la mayor parte del código:

{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[7:11,34:51] *}

/// tip | Consejo

Und sie kann alles zurückgeben, was Sie möchten.

In diesem Fall erwartet diese Abhängigkeit:

* Einen optionalen Query-Parameter `q`, der ein `str` ist.
* Einen optionalen Query-Parameter `skip`, der ein `int` ist und standardmäßig `0` ist.
* Einen optionalen Query-Parameter `limit`, der ein `int` ist und standardmäßig `100` ist.

{"index":{"_index":"fess_config.scheduled_job","_id":"index_exporter"}}
{"name":"Index Exporter","target":"all","cronExpression":"","scriptType":"groovy","scriptData":"return new org.codelibs.fess.job.IndexExportJob().query(org.opensearch.index.query.QueryBuilders.matchAllQuery()).execute()","jobLogging":true,"crawler":false,"available":false,"sortOrder":12,"createdBy":"system","createdTime":0,"updatedBy":"system","updatedTime":0}

        return this;
    }

    /**
     * Deletes documents matching the specified query using scroll and bulk delete.
     *
     * @param index The index to delete from.
     * @param type The document type (deprecated, no longer used).
     * @param queryBuilder The query to match documents for deletion.
     * @return The number of deleted documents.

## 定义 `Form` 参数 { #define-form-parameters }

创建表单参数的方式与 `Body` 或 `Query` 相同：

{* ../../docs_src/request_forms/tutorial001_an_py310.py hl[9] *}

例如，在 OAuth2 规范的一种使用方式（称为“密码流”）中，要求将 `username` 和 `password` 作为表单字段发送。

<dfn title="规范">规范</dfn>要求这些字段必须精确命名为 `username` 和 `password`，并且作为表单字段发送，而不是 JSON。

使用 `Form` 可以像使用 `Body`（以及 `Query`、`Path`、`Cookie`）一样声明相同的配置，包括校验、示例、别名（例如将 `username` 写成 `user-name`）等。

/// info

import org.codelibs.fess.util.ComponentUtil;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInfo;
import org.opensearch.index.query.QueryBuilder;
import org.opensearch.index.query.functionscore.FunctionScoreQueryBuilder.FilterFunctionBuilder;
import org.opensearch.index.query.functionscore.ScoreFunctionBuilder;

public class KeyMatchHelperTest extends UnitFessTestCase {

    private KeyMatchHelper keyMatchHelper;