Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 55 for schema (0.09 sec)

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

    ///
    
    {* ../../docs_src/separate_openapi_schemas/tutorial002_py310.py hl[10] *}
    
    ### 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 Nov 03 07:19:11 UTC 2024
    - Last Modified: Sat Oct 26 16:43:54 UTC 2024
    - 4.2K bytes
    - Viewed (0)
  2. docs/pl/docs/tutorial/first-steps.md

    Definicja schematu zawiera ścieżki API, możliwe parametry, które są przyjmowane przez endpointy, itp.
    
    #### "Schemat" danych
    
    Termin "schemat" może również odnosić się do wyglądu niektórych danych, takich jak zawartość JSON.
    
    W takim przypadku będzie to oznaczać atrybuty JSON, ich typy danych itp.
    
    #### OpenAPI i JSON Schema
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 27 16:51:30 UTC 2024
    - 9.6K bytes
    - Viewed (0)
  3. fastapi/param_functions.py

                OpenAPI-specific examples than the JSON Schema `examples`, that's the main
                use case for this.
    
                Read more about it in the
                [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/#using-the-openapi_examples-parameter).
                """
            ),
        ] = None,
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Wed Oct 23 18:30:18 UTC 2024
    - 62.5K bytes
    - Viewed (0)
  4. docs/en/docs/how-to/extending-openapi.md

    ### Generate the OpenAPI schema
    
    Then, use the same utility function to generate the OpenAPI schema, inside a `custom_openapi()` function:
    
    {* ../../docs_src/extending_openapi/tutorial001.py hl[2,15:21] *}
    
    ### Modify the OpenAPI schema
    
    Now you can add the ReDoc extension, adding a custom `x-logo` to the `info` "object" in the OpenAPI schema:
    
    {* ../../docs_src/extending_openapi/tutorial001.py hl[22:24] *}
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 27 22:39:38 UTC 2024
    - 3.1K bytes
    - Viewed (0)
  5. 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 Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 27 16:07:07 UTC 2024
    - 8.7K bytes
    - Viewed (0)
  6. docs/en/docs/tutorial/first-steps.md

    This schema definition includes your API paths, the possible parameters they take, etc.
    
    #### 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
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sat Oct 26 11:48:16 UTC 2024
    - 11.8K bytes
    - Viewed (0)
  7. docs/pt/docs/advanced/behind-a-proxy.md

    Então, o frontend (que roda no navegador) tentaria acessar `/openapi.json` e não conseguiria obter o OpenAPI schema.
    
    Como temos um proxy com um prefixo de caminho de `/api/v1` para nossa aplicação, o frontend precisa buscar o OpenAPI schema em `/api/v1/openapi.json`.
    
    ```mermaid
    graph LR
    
    browser("Browser")
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 27 15:28:18 UTC 2024
    - 12.2K bytes
    - Viewed (0)
  8. 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
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 27 16:58:19 UTC 2024
    - 6.6K bytes
    - Viewed (0)
  9. docs/fr/docs/tutorial/body.md

    * Générer des définitions <a href="https://json-schema.org" class="external-link" target="_blank">JSON Schema</a> pour votre modèle, qui peuvent être utilisées où vous en avez besoin dans votre projet ensuite.
    * Ces schémas participeront à la constitution du schéma généré OpenAPI, et seront donc utilisés par les documentations automatiquement générées.
    
    ## Documentation automatique
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 27 17:34:41 UTC 2024
    - 7.6K bytes
    - Viewed (0)
  10. docs/en/docs/tutorial/body-fields.md

    You can declare extra information in `Field`, `Query`, `Body`, etc. And it will be included in the generated JSON Schema.
    
    You will learn more about adding extra information later in the docs, when learning to declare examples.
    
    /// warning
    
    Extra keys passed to `Field` will also be present in the resulting OpenAPI schema for your application.
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 27 17:01:18 UTC 2024
    - 2.2K bytes
    - Viewed (0)
Back to top