Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 1 - 10 of 274 for description (0.08 seconds)

The search processing time has exceeded the limit. The displayed results may be partial.

  1. fastapi/security/http.py

        model: HTTPBaseModel
    
        def __init__(
            self,
            *,
            scheme: str,
            scheme_name: str | None = None,
            description: str | None = None,
            auto_error: bool = True,
        ):
            self.model = HTTPBaseModel(scheme=scheme, description=description)
            self.scheme_name = scheme_name or self.__class__.__name__
            self.auto_error = auto_error
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Mon Mar 16 10:16:48 GMT 2026
    - 13.1K bytes
    - Click Count (0)
  2. docs_src/stream_json_lines/tutorial001_py310.py

    from pydantic import BaseModel
    
    app = FastAPI()
    
    
    class Item(BaseModel):
        name: str
        description: str | None
    
    
    items = [
        Item(name="Plumbus", description="A multi-purpose household device."),
        Item(name="Portal Gun", description="A portal opening device."),
        Item(name="Meeseeks Box", description="A box that summons a Meeseeks."),
    ]
    
    
    @app.get("/items/stream")
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Feb 27 18:56:47 GMT 2026
    - 936 bytes
    - Click Count (0)
  3. docs/en/docs/tutorial/path-operation-configuration.md

    ## Summary and description { #summary-and-description }
    
    You can add a `summary` and `description`:
    
    {* ../../docs_src/path_operation_configuration/tutorial003_py310.py hl[17:18] *}
    
    ## Description from docstring { #description-from-docstring }
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 05 18:13:19 GMT 2026
    - 4K bytes
    - Click Count (0)
  4. fastapi/params.py

            self.openapi_examples = openapi_examples
            kwargs = dict(
                default=default,
                default_factory=default_factory,
                alias=alias,
                title=title,
                description=description,
                gt=gt,
                ge=ge,
                lt=lt,
                le=le,
                min_length=min_length,
                max_length=max_length,
                discriminator=discriminator,
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 15 11:44:39 GMT 2026
    - 25.7K bytes
    - Click Count (0)
  5. docs/en/docs/how-to/general.md

    ## Documentation Summary and Description - OpenAPI { #documentation-summary-and-description-openapi }
    
    To add a summary and description to your *path operations*, and show them in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Summary and Description](../tutorial/path-operation-configuration.md#summary-and-description).
    
    ## Documentation Response description - OpenAPI { #documentation-response-description-openapi }
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 05 18:13:19 GMT 2026
    - 2.8K bytes
    - Click Count (0)
  6. fastapi/security/api_key.py

            self,
            location: APIKeyIn,
            name: str,
            description: str | None,
            scheme_name: str | None,
            auto_error: bool,
        ):
            self.auto_error = auto_error
    
            self.model: APIKey = APIKey(
                **{"in": location},  # ty: ignore[invalid-argument-type]
                name=name,
                description=description,
            )
            self.scheme_name = scheme_name or self.__class__.__name__
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 15 11:44:39 GMT 2026
    - 9.6K bytes
    - Click Count (1)
  7. .teamcity/src/main/kotlin/util/AdHocPerformanceScenario.kt

                    allowEmpty = true,
                    description = "The baselines you want to run performance tests against. Empty means default baseline.",
                )
                text(
                    "testProject",
                    "",
                    display = ParameterDisplay.PROMPT,
                    allowEmpty = false,
                    description = "The test project to use. E.g. largeJavaMultiProject",
                )
    Created: Wed Apr 01 11:36:16 GMT 2026
    - Last Modified: Mon Mar 30 14:08:32 GMT 2026
    - 6K bytes
    - Click Count (0)
  8. .github/workflows/translate.yml

          language:
            description: Language to translate to as a letter code (e.g. "es" for Spanish)
            type: string
            required: false
            default: ""
          en_path:
            description: File path in English to translate (e.g. docs/en/docs/index.md)
            type: string
            required: false
            default: ""
          commit_in_place:
            description: Commit changes directly instead of making a PR
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Wed Mar 18 15:36:56 GMT 2026
    - 4K bytes
    - Click Count (0)
  9. docs_src/server_sent_events/tutorial001_py310.py

    from pydantic import BaseModel
    
    app = FastAPI()
    
    
    class Item(BaseModel):
        name: str
        description: str | None
    
    
    items = [
        Item(name="Plumbus", description="A multi-purpose household device."),
        Item(name="Portal Gun", description="A portal opening device."),
        Item(name="Meeseeks Box", description="A box that summons a Meeseeks."),
    ]
    
    
    @app.get("/items/stream", response_class=EventSourceResponse)
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 01 09:21:52 GMT 2026
    - 1.1K bytes
    - Click Count (0)
  10. fastapi/security/open_id_connect_url.py

                    It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                    """
                ),
            ] = None,
            description: Annotated[
                str | None,
                Doc(
                    """
                    Security scheme description.
    
                    It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                    """
                ),
            ] = None,
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Mon Mar 16 10:16:48 GMT 2026
    - 3.1K bytes
    - Click Count (0)
Back to Top