Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 165 for schemas (0.03 sec)

  1. docs/en/docs/how-to/separate-openapi-schemas.md

    ### Same Schema for Input and Output Models in Docs { #same-schema-for-input-and-output-models-in-docs }
    
    And now there will be one single schema for input and output for the model, only `Item`, and it will have `description` as **not required**:
    
    <div class="screenshot">
    <img src="/img/tutorial/separate-openapi-schemas/image05.png">
    </div>
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 4.6K bytes
    - Viewed (0)
  2. docs/es/docs/how-to/separate-openapi-schemas.md

    <div class="screenshot">
    <img src="/img/tutorial/separate-openapi-schemas/image03.png">
    </div>
    
    ### Modelo para Entrada y Salida en la Documentación
    
    Y si revisas todos los esquemas disponibles (JSON Schemas) en OpenAPI, verás que hay dos, uno `Item-Input` y uno `Item-Output`.
    
    Para `Item-Input`, `description` **no es requerido**, no tiene un asterisco rojo.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Mon Dec 30 18:26:57 UTC 2024
    - 4.4K bytes
    - Viewed (0)
  3. docs/en/docs/advanced/additional-responses.md

                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/HTTPValidationError"
                        }
                    }
                }
            }
        }
    }
    ```
    
    The schemas are referenced to another place inside the OpenAPI schema:
    
    ```JSON hl_lines="4-16"
    {
        "components": {
            "schemas": {
                "Message": {
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 8.9K bytes
    - Viewed (0)
  4. docs/es/docs/advanced/additional-responses.md

                        "schema": {
                            "$ref": "#/components/schemas/Message"
                        }
                    }
                }
            },
            "200": {
                "description": "Successful Response",
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/Item"
                        }
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Mon Dec 30 18:26:57 UTC 2024
    - 9.1K bytes
    - Viewed (0)
  5. docs/en/docs/tutorial/schema-extra-example.md

    ///
    
    ### JSON Schema's `examples` field { #json-schemas-examples-field }
    
    But then JSON Schema added an <a href="https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.5" class="external-link" target="_blank">`examples`</a> field to a new version of the specification.
    
    And then the new OpenAPI 3.1.0 was based on the latest version (JSON Schema 2020-12) that included this new field `examples`.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 9.6K bytes
    - Viewed (0)
  6. docs/en/docs/tutorial/body.md

    * Generate <a href="https://json-schema.org" class="external-link" target="_blank">JSON Schema</a> definitions for your model, you can also use them anywhere else you like if it makes sense for your project.
    * Those schemas will be part of the generated OpenAPI schema, and used by the automatic documentation <abbr title="User Interfaces">UIs</abbr>.
    
    ## Automatic docs { #automatic-docs }
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 10:58:56 UTC 2025
    - 7.1K bytes
    - Viewed (0)
  7. docs/pt/docs/tutorial/first-steps.md

    Esta definição de *schema* inclui as rotas da sua API, os parâmetros possíveis que elas usam, etc.
    
    #### "*Schema*" de dados
    
    O termo "*schema*" também pode se referir à forma de alguns dados, como um conteúdo JSON.
    
    Nesse caso, significaria os atributos JSON e os tipos de dados que eles possuem, etc.
    
    #### OpenAPI e JSON *Schema*
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Thu Jan 09 20:41:07 UTC 2025
    - 10.8K bytes
    - Viewed (0)
  8. docs/en/docs/advanced/generate-clients.md

    ### API Docs { #api-docs }
    
    If you go to `/docs`, you will see that it has the **schemas** for the data to be sent in requests and received in responses:
    
    <img src="/img/tutorial/generate-clients/image01.png">
    
    You can see those schemas because they were declared with the models in the app.
    
    That information is available in the app's **OpenAPI schema**, and then shown in the API docs.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 10.1K bytes
    - Viewed (1)
  9. docs/en/docs/alternatives.md

    But it was created before there existed Python type hints. So, to define every <abbr title="the definition of how data should be formed">schema</abbr> you need to use specific utils and classes provided by Marshmallow.
    
    /// check | Inspired **FastAPI** to
    
    Use code to define "schemas" that provide data types and validation, automatically.
    
    ///
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 23.6K bytes
    - Viewed (0)
  10. docs/en/docs/tutorial/first-steps.md

    This schema definition includes your API paths, the possible parameters they take, etc.
    
    #### Data "schema" { #data-schema }
    
    The term "schema" might also refer to the shape of some data, like a JSON content.
    
    In that case, it would mean the JSON attributes, and data types they have, etc.
    
    #### OpenAPI and JSON Schema { #openapi-and-json-schema }
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 11K bytes
    - Viewed (0)
Back to top