Search Options

Results per page
Sort
Preferred Languages
Advance

Results 111 - 120 of 540 for summary (0.08 sec)

  2. github.com/tiangolo/fastapi

    tests/test_modules_same_name_body/test_main.py 

                                        }
                                }
                            },
                        },
                    },
                    "summary": "Compute",
                    "operationId": "compute_a_compute_post",
                    "requestBody": {
                        "content": {
                            "application/json": {
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Fri Jun 30 18:25:16 UTC 2023
    - 5.6K bytes
    - Viewed (0)
  3. github.com/tiangolo/fastapi

    tests/test_tutorial/test_dataclasses/test_tutorial003.py 

            "openapi": "3.1.0",
        "info": {"title": "FastAPI", "version": "0.1.0"},
        "paths": {
            "/authors/{author_id}/items/": {
                "post": {
                    "summary": "Create Author Items",
                    "operationId": "create_author_items_authors__author_id__items__post",
                    "parameters": [
                        {
                            "required": True,
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Wed Jul 31 14:09:15 UTC 2024
    - 12.1K bytes
    - Viewed (0)
  4. github.com/tiangolo/fastapi

    tests/test_tutorial/test_path_operation_configurations/test_tutorial002b.py 

            "openapi": "3.1.0",
        "info": {"title": "FastAPI", "version": "0.1.0"},
        "paths": {
            "/items/": {
                "get": {
                    "tags": ["items"],
                    "summary": "Get Items",
                    "operationId": "get_items_items__get",
                    "responses": {
                        "200": {
                            "description": "Successful Response",
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Fri Jun 30 18:25:16 UTC 2023
    - 1.7K bytes
    - Viewed (0)
  5. github.com/tiangolo/fastapi

    tests/test_tutorial/test_dependencies/test_tutorial001.py 

                                        }
                                }
                            },
                        },
                    },
                    "summary": "Read Items",
                    "operationId": "read_items_items__get",
                    "parameters": [
                        {
                            "required": False,
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Fri Jul 07 17:12:13 UTC 2023
    - 7K bytes
    - Viewed (0)
  6. github.com/tiangolo/fastapi

    tests/test_tutorial/test_response_model/test_tutorial005_py310.py 

                                        }
                                }
                            },
                        },
                    },
                    "summary": "Read Item Name",
                    "operationId": "read_item_name_items__item_id__name_get",
                    "parameters": [
                        {
                            "required": True,
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Fri Aug 04 20:47:07 UTC 2023
    - 6.2K bytes
    - Viewed (0)
  7. github.com/tiangolo/fastapi

    tests/test_tutorial/test_testing/test_main.py 

                                "description": "Successful Response",
                            "content": {"application/json": {"schema": {}}},
                        }
                    },
                    "summary": "Read Main",
                    "operationId": "read_main__get",
                }
            }
        },
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Fri Jun 30 18:25:16 UTC 2023
    - 819 bytes
    - Viewed (0)
  8. github.com/tiangolo/fastapi

    tests/test_tutorial/test_dependencies/test_tutorial001_an_py39.py 

                                        }
                                }
                            },
                        },
                    },
                    "summary": "Read Items",
                    "operationId": "read_items_items__get",
                    "parameters": [
                        {
                            "required": False,
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Fri Jul 07 17:12:13 UTC 2023
    - 7.2K bytes
    - Viewed (0)
  9. github.com/codelibs/fess

    src/main/config/openapi/openapi-user.yaml 

      - name: suggest
    description: Suggest operations
  - name: favorite
    description: Favorite operations
paths:
  /documents:
    get:
      tags:
        - search
      summary: Finds documents by query
      description: Finds documents by search conditions
      operationId: searchDocuments
      parameters:
        - name: q
          in: query
          description: Search words
    Registered: Thu Oct 31 13:40:30 UTC 2024
    - Last Modified: Thu May 09 06:31:27 UTC 2024
    - 21.6K bytes
    - Viewed (0)
  10. github.com/tiangolo/fastapi

    docs/pt/docs/tutorial/metadata.md 

    | `terms_of_service` | `str` | Uma URL para os Termos de Serviço da API. Se fornecido, deve ser uma URL. |
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Tue Oct 29 10:36:14 UTC 2024
    - 6.1K bytes
    - Viewed (0)
  11. github.com/tiangolo/fastapi

    docs/en/docs/tutorial/path-operation-configuration.md 

    **FastAPI** supports that the same way as with plain strings:

```Python hl_lines="1  8-10  13  18"
{!../../docs_src/path_operation_configuration/tutorial002b.py!}
```

## Summary and description

You can add a `summary` and `description`:

//// tab | Python 3.10+

```Python hl_lines="18-19"
{!> ../../docs_src/path_operation_configuration/tutorial003_py310.py!}
```

////
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 5.4K bytes
    - Viewed (0)
Back to top