Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 185 for documented (0.04 sec)

  1. docs/en/docs/advanced/custom-response.md

    ///
    
    /// info
    
    Of course, the actual `Content-Type` header, status code, etc, will come from the `Response` object you returned.
    
    ///
    
    ### Document in OpenAPI and override `Response` { #document-in-openapi-and-override-response }
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 12.2K bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/body-nested-models.md

    The string will be checked to be a valid URL, and documented in JSON Schema / OpenAPI as such.
    
    ## Attributes with lists of submodels { #attributes-with-lists-of-submodels }
    
    You can also use Pydantic models as subtypes of `list`, `set`, etc.:
    
    {* ../../docs_src/body_nested_models/tutorial006_py310.py hl[18] *}
    
    This will expect (convert, validate, document, etc.) a JSON body like:
    
    ```JSON hl_lines="11"
    {
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 7.3K bytes
    - Viewed (0)
  3. .github/ISSUE_TEMPLATE/10-proposal.yml

    name: Proposals
    description: New external API or other notable changes
    title: "proposal: import/path: proposal title"
    labels: ["Proposal"]
    body:
      - type: markdown
        attributes:
          value: "Our proposal process is documented here: https://go.dev/s/proposal-process"
      - type: textarea
        id: proposal-details
        attributes:
          label: "Proposal Details"
          description: "Please provide the details of your proposal here."
        validations:
    Registered: Tue Sep 09 11:13:09 UTC 2025
    - Last Modified: Wed Nov 22 20:49:24 UTC 2023
    - 471 bytes
    - Viewed (0)
  4. docs/en/docs/advanced/response-directly.md

    {* ../../docs_src/response_directly/tutorial002.py hl[1,18] *}
    
    ## Notes { #notes }
    
    When you return a `Response` directly its data is not validated, converted (serialized), or documented automatically.
    
    But you can still document it as described in [Additional Responses in OpenAPI](additional-responses.md){.internal-link target=_blank}.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 3.1K bytes
    - Viewed (0)
  5. docs/en/docs/advanced/using-request-directly.md

    It would also mean that if you get data from the `Request` object directly (for example, read the body) it won't be validated, converted or documented (with OpenAPI, for the automatic API user interface) by FastAPI.
    
    Although any other parameter declared normally (for example, the body with a Pydantic model) would still be validated, converted, annotated, etc.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 2.4K bytes
    - Viewed (0)
  6. doc/README.md

    Use the following forms in your markdown:
    
    	[http.Request]                     # symbol documentation; auto-linked as in Go doc strings
    	[Request]                          # short form, for symbols in the package being documented
    	[net/http]                         # package link
    	[#12345](/issue/12345)             # GitHub issues
    	[CL 6789](/cl/6789)                # Gerrit changelists
    
    Registered: Tue Sep 09 11:13:09 UTC 2025
    - Last Modified: Mon Jul 22 17:55:04 UTC 2024
    - 3.1K bytes
    - Viewed (0)
  7. docs/en/docs/advanced/response-headers.md

    that you want a client in a browser to be able to see, you need to add them to your CORS configurations (read more in [CORS (Cross-Origin Resource Sharing)](../tutorial/cors.md){.internal-link target=_blank}), using the parameter `expose_headers` documented in <a href="https://www.starlette.io/middleware/#corsmiddleware" class="external-link" target="_blank">Starlette's CORS docs</a>....
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 2.3K bytes
    - Viewed (0)
  8. docs/en/docs/tutorial/middleware.md

    ///
    
    /// note | Technical Details
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 4.1K bytes
    - Viewed (0)
  9. docs/batch-jobs/README.md

    - Monitoring job progress in real-time
    - Send notifications upon completion or failure to user configured target
    
    Following YAML describes the structure of a replication job, each value is documented and self-describing.
    
    ```yaml
    replicate:
      apiVersion: v1
      # source of the objects to be replicated
      source:
    	type: TYPE # valid values are "minio"
    	bucket: BUCKET
    	prefix: PREFIX
    Registered: Sun Sep 07 19:28:11 UTC 2025
    - Last Modified: Thu Oct 06 06:00:43 UTC 2022
    - 4.8K bytes
    - Viewed (0)
  10. ci/official/utilities/setup.sh

    # Therefore, "tfrun" commands cannot include pipes -- which is
    # probably for the better. If a pipe is necessary for something, it is probably
    # complex. Write a well-documented script under utilities/ to encapsulate the
    # functionality instead.
    tfrun() { "$@"; }
    
    if [[ $(uname -s) = MSYS_NT* ]]; then
      source ./ci/official/utilities/windows.sh
    Registered: Tue Sep 09 12:39:10 UTC 2025
    - Last Modified: Thu Jan 09 18:37:25 UTC 2025
    - 6.2K bytes
    - Viewed (0)
Back to top