<img src="/img/tutorial/response-model/image01.png">

Und beide Modelle werden auch in der interaktiven API-Dokumentation verwendet:

<img src="/img/tutorial/response-model/image02.png">

## Andere Rückgabetyp-Annotationen { #other-return-type-annotations }

But if we use the same model for another *path operation*, we could be sending our user's passwords to every client.

/// danger

Never store the plain password of a user or send it in a response like this, unless you know all the caveats and you know what you are doing.

///

## Add an output model { #add-an-output-model }

В автоматической документации вы увидите, что у входной и выходной моделей есть свои JSON Schema:

<img src="/img/tutorial/response-model/image01.png">

И обе модели используются в интерактивной документации API:

<img src="/img/tutorial/response-model/image02.png">

## Другие аннотации возвращаемых типов { #other-return-type-annotations }

Quando você vê a documentação automática, pode verificar se o modelo de entrada e o modelo de saída terão seus próprios esquemas JSON:

<img src="/img/tutorial/response-model/image01.png">

E ambos os modelos serão usados ​​para a documentação interativa da API:

<img src="/img/tutorial/response-model/image02.png">

## Outras anotações de tipo de retorno { #other-return-type-annotations }

<img src="/img/tutorial/response-model/image01.png">

Y ambos modelos se utilizarán para la documentación interactiva de la API:

<img src="/img/tutorial/response-model/image02.png">

## Otras Anotaciones de Tipos de Retorno { #other-return-type-annotations }

    /**
     * Gets the file model.
     *
     * @return the file model, never {@code null}.
     */
    @Nonnull
    Model getFileModel();

    /**
     * Gets the file model + build pom transformation, without inheritance nor interpolation.
     *
     * @return The raw model, never {@code null}.
     */
    @Nonnull
    Model getRawModel();

    /**
     * Gets the effective model of the parent POM.
     *

    model: CIBuildModel,
    stage: Stage,
    os: Os? = null,
) = stageTriggerUuid(model, stage.stageName, os)

fun stageTriggerId(
    model: CIBuildModel,
    stageName: StageName,
    os: Os? = null,
) = "${model.projectId}_Stage_${stageName.id}_${osSuffix(os)}Trigger"

fun stageTriggerUuid(
    model: CIBuildModel,
    stageName: StageName,
    os: Os? = null,

import org.apache.maven.api.model.Build;
import org.apache.maven.api.model.Dependency;
import org.apache.maven.api.model.DependencyManagement;
import org.apache.maven.api.model.DeploymentRepository;
import org.apache.maven.api.model.Extension;
import org.apache.maven.api.model.Model;
import org.apache.maven.api.model.Plugin;
import org.apache.maven.api.model.Profile;
import org.apache.maven.api.model.ReportPlugin;

    return {"p": p}


class HeaderModelOptionalStr(BaseModel):
    p: Optional[str] = None


@app.get("/model-optional-str")
async def read_model_optional_str(p: Annotated[HeaderModelOptionalStr, Header()]):
    return {"p": p.p}


@pytest.mark.parametrize(
    "path",
    ["/optional-str", "/model-optional-str"],
)
def test_optional_str_schema(path: str):
    assert app.openapi()["paths"][path]["get"]["parameters"] == [

    return {"p": p}


class HeaderModelRequiredStr(BaseModel):
    p: str


@app.get("/model-required-str")
async def read_model_required_str(p: Annotated[HeaderModelRequiredStr, Header()]):
    return {"p": p.p}


@pytest.mark.parametrize(
    "path",
    ["/required-str", "/model-required-str"],
)
def test_required_str_schema(path: str):
    assert app.openapi()["paths"][path]["get"]["parameters"] == [