Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 20 for include_in_schema (0.07 sec)

  1. fastapi/params.py

                    category=FastAPIDeprecationWarning,
                    stacklevel=4,
                )
            self.example = example
            self.include_in_schema = include_in_schema
            self.openapi_examples = openapi_examples
            kwargs = dict(
                default=default,
                default_factory=default_factory,
                alias=alias,
                title=title,
                description=description,
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Sat Dec 27 12:54:56 UTC 2025
    - 26.3K bytes
    - Viewed (0)
  2. docs_src/custom_docs_ui/tutorial001_py39.py

            swagger_css_url="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css",
        )
    
    
    @app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False)
    async def swagger_ui_redirect():
        return get_swagger_ui_oauth2_redirect_html()
    
    
    @app.get("/redoc", include_in_schema=False)
    async def redoc_html():
        return get_redoc_html(
            openapi_url=app.openapi_url,
            title=app.title + " - ReDoc",
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 1.1K bytes
    - Viewed (0)
  3. fastapi/param_functions.py

            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,
        )
    
    
    def Query(  # noqa: N802
        default: Annotated[
            Any,
            Doc(
                """
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Sat Dec 27 12:54:56 UTC 2025
    - 63K bytes
    - Viewed (0)
  4. fastapi/routing.py

                        response_model_exclude_none=route.response_model_exclude_none,
                        include_in_schema=route.include_in_schema
                        and self.include_in_schema
                        and include_in_schema,
                        response_class=use_response_class,
                        name=route.name,
                        route_class_override=type(route),
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Sat Dec 27 12:54:56 UTC 2025
    - 174.6K bytes
    - Viewed (0)
  5. docs_src/custom_docs_ui/tutorial002_py39.py

            swagger_css_url="/static/swagger-ui.css",
        )
    
    
    @app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False)
    async def swagger_ui_redirect():
        return get_swagger_ui_oauth2_redirect_html()
    
    
    @app.get("/redoc", include_in_schema=False)
    async def redoc_html():
        return get_redoc_html(
            openapi_url=app.openapi_url,
            title=app.title + " - ReDoc",
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 1.1K bytes
    - Viewed (0)
  6. docs_src/path_operation_advanced_configuration/tutorial003_py39.py

    from fastapi import FastAPI
    
    app = FastAPI()
    
    
    @app.get("/items/", include_in_schema=False)
    async def read_items():
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 148 bytes
    - Viewed (0)
  7. docs_src/query_params_str_validations/tutorial014_py39.py

    from typing import Union
    
    from fastapi import FastAPI, Query
    
    app = FastAPI()
    
    
    @app.get("/items/")
    async def read_items(
        hidden_query: Union[str, None] = Query(default=None, include_in_schema=False),
    ):
        if hidden_query:
            return {"hidden_query": hidden_query}
        else:
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 330 bytes
    - Viewed (0)
  8. fastapi/applications.py

                default_response_class=default_response_class,
                dependencies=dependencies,
                callbacks=callbacks,
                deprecated=deprecated,
                include_in_schema=include_in_schema,
                responses=responses,
                generate_unique_id_function=generate_unique_id_function,
            )
            self.exception_handlers: dict[
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 21:25:59 UTC 2025
    - 176.3K bytes
    - Viewed (0)
  9. docs/en/docs/advanced/path-operation-advanced-configuration.md

    ///
    
    ## Exclude from OpenAPI { #exclude-from-openapi }
    
    To exclude a *path operation* from the generated OpenAPI schema (and thus, from the automatic documentation systems), use the parameter `include_in_schema` and set it to `False`:
    
    {* ../../docs_src/path_operation_advanced_configuration/tutorial003_py39.py hl[6] *}
    
    ## Advanced description from docstring { #advanced-description-from-docstring }
    
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Sat Dec 20 15:55:38 UTC 2025
    - 7.2K bytes
    - Viewed (0)
  10. fastapi/openapi/utils.py

        for param_type, param_group in parameter_groups:
            for param in param_group:
                field_info = param.field_info
                # field_info = cast(Param, field_info)
                if not getattr(field_info, "include_in_schema", True):
                    continue
                param_schema = get_schema_from_model_field(
                    field=param,
                    model_name_map=model_name_map,
                    field_mapping=field_mapping,
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Sat Dec 27 12:54:56 UTC 2025
    - 23.2K bytes
    - Viewed (0)
Back to top