Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 1 - 10 of 19 for samples (0.09 seconds)

  1. fastapi/openapi/models.py

        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
        required: Optional[bool] = None
        deprecated: Optional[bool] = None
        # Serialization rules for simple scenarios
        style: Optional[str] = None
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 15.1K bytes
    - Click Count (0)
  2. fastapi/params.py

                allow_inf_nan=allow_inf_nan,
                max_digits=max_digits,
                decimal_places=decimal_places,
                **extra,
            )
            if examples is not None:
                kwargs["examples"] = examples
            if regex is not None:
                warnings.warn(
                    "`regex` has been deprecated, please use `pattern` instead",
                    category=FastAPIDeprecationWarning,
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 26.3K bytes
    - Click Count (0)
  3. fastapi/param_functions.py

                "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
                "although still supported. Use examples instead."
            ),
        ] = _Unset,
        openapi_examples: Annotated[
            Optional[dict[str, Example]],
            Doc(
                """
                OpenAPI-specific examples.
    
                It will be added to the generated OpenAPI (e.g. visible at `/docs`).
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 63K bytes
    - Click Count (0)
  4. tests/test_tutorial/test_static_files/test_tutorial001.py

        sample_file = static_dir / "sample.txt"
        sample_file.write_text("This is a sample static file.")
        from docs_src.static_files.tutorial001_py39 import app
    
        with TestClient(app) as client:
            yield client
        sample_file.unlink()
        static_dir.rmdir()
    
    
    def test_static_files(client: TestClient):
        response = client.get("/static/sample.txt")
        assert response.status_code == 200, response.text
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Fri Dec 26 10:43:02 GMT 2025
    - 1.1K bytes
    - Click Count (0)
  5. tests/test_schema_extra_examples.py

            def example(item: Item = Body(example={"data": "Data in Body example"})):
                return item
    
        @app.post("/examples/")
        def examples(
            item: Item = Body(
                examples=[
                    {"data": "Data in Body examples, example1"},
                    {"data": "Data in Body examples, example2"},
                ],
            ),
        ):
            return item
    
        with pytest.warns(FastAPIDeprecationWarning):
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 18:19:10 GMT 2025
    - 32.2K bytes
    - Click Count (0)
  6. tests/test_openapi_examples.py

        data: str
    
    
    @app.post("/examples/")
    def examples(
        item: Item = Body(
            examples=[
                {"data": "Data in Body examples, example1"},
            ],
            openapi_examples={
                "Example One": {
                    "summary": "Example One Summary",
                    "description": "Example One Description",
                    "value": {"data": "Data in Body examples, example1"},
                },
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 18:19:10 GMT 2025
    - 15.1K bytes
    - Click Count (0)
  7. scripts/translate.py

    
    ### Content of code blocks
    
    Do not translate the content of code blocks, except for comments in the language which the code block uses.
    
    Examples:
    
        Source (English) – The code block is a bash code example with one comment:
    
            «««
            ```bash
            # Print greeting
            echo "Hello, World!"
            ```
            »»»
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 19:05:53 GMT 2025
    - 34.1K bytes
    - Click Count (0)
  8. tests/test_tutorial/test_schema_extra_example/test_tutorial002.py

                                "title": "Name",
                                "examples": ["Foo"],
                            },
                            "description": {
                                "anyOf": [{"type": "string"}, {"type": "null"}],
                                "title": "Description",
                                "examples": ["A very nice Item"],
                            },
                            "price": {
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Fri Dec 26 10:43:02 GMT 2025
    - 4.9K bytes
    - Click Count (0)
  9. docs/de/llm-prompt.md

    Examples:
    
        Source (English):
    
            «««
            "Hello world"
            “Hello Universe”
            "He said: 'Hello'"
            “my name is ‘Nils’”
            `"__main__"`
            `"items"`
            »»»
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Fri Dec 26 09:39:53 GMT 2025
    - 11.9K bytes
    - Click Count (0)
  10. tests/test_tutorial/test_schema_extra_example/test_tutorial003.py

                                "application/json": {
                                    "schema": {
                                        "$ref": "#/components/schemas/Item",
                                        "examples": [
                                            {
                                                "description": "A very nice Item",
                                                "name": "Foo",
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Fri Dec 26 10:43:02 GMT 2025
    - 5.1K bytes
    - Click Count (0)
Back to Top