Імпортуйте `Form` з `fastapi`:

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

## Оголошення параметрів `Form` { #define-form-parameters }

Створюйте параметри форми так само як ви б створювали `Body` або `Query`:

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

Наприклад, один зі способів використання специфікації OAuth2 (так званий «password flow») вимагає надсилати `username` та `password` як поля форми.

    void testWriteHeaderWireFormat() {
        byte[] dst = new byte[NameServicePacket.HEADER_LENGTH];
        packet.nameTrnId = 0x1234;
        packet.isResponse = true;
        packet.opCode = NameServicePacket.QUERY;
        packet.isAuthAnswer = true;
        packet.isTruncated = true;
        packet.isRecurDesired = true;
        packet.isRecurAvailable = true;
        packet.isBroadcast = true;

import org.opensearch.index.query.RangeQueryBuilder;
import org.opensearch.index.query.RegexpQueryBuilder;
import org.opensearch.index.query.SpanTermQueryBuilder;
import org.opensearch.index.query.TermQueryBuilder;
import org.opensearch.index.query.TermsQueryBuilder;
import org.opensearch.index.query.WildcardQueryBuilder;
import org.opensearch.index.query.functionscore.FunctionScoreQueryBuilder;

import jakarta.annotation.PostConstruct;

/**
 * Configuration class for query field mappings in the Fess search engine.
 * This class manages field configurations for various query operations including
 * response fields, search fields, facet fields, sort fields, and highlighting.
 * It initializes field mappings from the FessConfig and provides methods to
 * query field properties and capabilities.
 */
public class QueryFieldConfig {

        }
    }

    public void addDocument(final Map<String, Object> doc) {
        documentList.add(doc);
    }

    public void setSearchQuery(final String query) {
        addSearchFieldLogValue(Constants.SEARCH_FIELD_LOG_SEARCH_QUERY, query);
    }

    public OptionalEntity<UserInfo> getUserInfo() {
        if (getUserInfoId() == null) {
            return OptionalEntity.empty();
        }

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

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

При использовании любой из функций:

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

вы также можете объявить набор `examples` с дополнительной информацией, которая будет добавлена в их **JSON Schema** внутри **OpenAPI**.

    @Test
    public void test_deleteByInvalidQueryString() throws Exception {
        try {
            suggester.indexer().deleteByQuery("invalid:[query");
            // Some invalid queries may still be accepted by OpenSearch
        } catch (Exception e) {
            // Expected - invalid query syntax
            assertTrue(e instanceof SuggestIndexException || e.getCause() != null);
        }
    }

    @Test

    @Override
    public String toString() {
        String opCodeString, resultCodeString, questionTypeString, recordTypeString;

        opCodeString = switch (this.opCode) {
        case QUERY -> "QUERY";
        case WACK -> "WACK";
        default -> Integer.toString(this.opCode);
        };
        resultCodeString = switch (this.resultCode) {
        case FMT_ERR -> "FMT_ERR";

        final String questionClassString;
        String recordTypeString;
        final String recordClassString;

        opCodeString = switch (opCode) {
        case QUERY -> "QUERY";
        case WACK -> "WACK";
        default -> Integer.toString(opCode);
        };
        resultCodeString = switch (resultCode) {
        case FMT_ERR -> "FMT_ERR";
        case SRV_ERR -> "SRV_ERR";

        assertEquals(Integer.valueOf(0), JsonPath.from(response).get("response.status"));
    }

    @Test
    void testDeleteQueryWords_ok() {
        // Test deleting query-based suggest words
        String response = checkDeleteMethod("query").asString();
        assertEquals(Integer.valueOf(0), JsonPath.from(response).get("response.status"));
    }