Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 7 of 7 for example (0.16 sec)

  1. fastapi/params.py

            **extra: Any,
        ):
            if example is not _Unset:
                warnings.warn(
                    "`example` has been deprecated, please use `examples` instead",
                    category=DeprecationWarning,
                    stacklevel=4,
                )
            self.example = example
            self.include_in_schema = include_in_schema
            self.openapi_examples = openapi_examples
            kwargs = dict(
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 27.5K bytes
    - Viewed (1)
  2. fastapi/param_functions.py

            strict=strict,
            multiple_of=multiple_of,
            allow_inf_nan=allow_inf_nan,
            max_digits=max_digits,
            decimal_places=decimal_places,
            example=example,
            examples=examples,
            openapi_examples=openapi_examples,
            deprecated=deprecated,
            include_in_schema=include_in_schema,
            json_schema_extra=json_schema_extra,
            **extra,
        )
    
    
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 62.5K bytes
    - Viewed (0)
  3. fastapi/security/http.py

        `HTTPDigest` in a dependency.
    
        The HTTP authorization header value is split by the first space.
    
        The first part is the `scheme`, the second part is the `credentials`.
    
        For example, in an HTTP Bearer token scheme, the client will send a header
        like:
    
        ```
        Authorization: Bearer deadbeef12346
        ```
    
        In this case:
    
        * `scheme` will have the value `"Bearer"`
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Apr 19 15:29:38 GMT 2024
    - 13.2K bytes
    - Viewed (0)
  4. fastapi/security/api_key.py

        ## Usage
    
        Create an instance object and use that object as the dependency in `Depends()`.
    
        The dependency result will be a string containing the key value.
    
        ## Example
    
        ```python
        from fastapi import Depends, FastAPI
        from fastapi.security import APIKeyQuery
    
        app = FastAPI()
    
        query_scheme = APIKeyQuery(name="api_key")
    
    
        @app.get("/items/")
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 23 22:29:18 GMT 2024
    - 9.1K bytes
    - Viewed (0)
  5. fastapi/openapi/utils.py

            if field_info.description:
                parameter["description"] = field_info.description
            if field_info.openapi_examples:
                parameter["examples"] = jsonable_encoder(field_info.openapi_examples)
            elif field_info.example != Undefined:
                parameter["example"] = jsonable_encoder(field_info.example)
            if field_info.deprecated:
                parameter["deprecated"] = True
            parameters.append(parameter)
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 21.8K bytes
    - Viewed (0)
  6. fastapi/openapi/models.py

        allowReserved: Optional[bool] = None
    
    
    class MediaType(BaseModelWithConfig):
        schema_: Optional[Union[Schema, Reference]] = Field(default=None, alias="schema")
        example: Optional[Any] = None
        examples: Optional[Dict[str, Union[Example, Reference]]] = None
        encoding: Optional[Dict[str, Encoding]] = None
    
    
    class ParameterBase(BaseModelWithConfig):
        description: Optional[str] = None
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 22:49:33 GMT 2024
    - 15K bytes
    - Viewed (1)
  7. fastapi/encoders.py

        where a integer (but not int typed) is used. Encoding this as a float
        results in failed round-tripping between encode and parse.
        Our Id type is a prime example of this.
    
        >>> decimal_encoder(Decimal("1.0"))
        1.0
    
        >>> decimal_encoder(Decimal("1"))
        1
        """
        if dec_value.as_tuple().exponent >= 0:  # type: ignore[operator]
            return int(dec_value)
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 21:56:59 GMT 2024
    - 10.8K bytes
    - Viewed (0)
Back to top