{
            "openapi": "3.1.0",
            "info": {"title": "FastAPI", "version": "0.1.0"},
            "paths": {
                "/default": {
                    "get": {
                        "summary": "Default",
                        "operationId": "default_default_get",
                        "parameters": [
                            {
                                "required": False,

## 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).

    }

    /**
     * Creates a summary intent result for a specific document.
     *
     * @param documentUrl the document URL to summarize
     * @param reasoning the detection reasoning
     * @return the summary intent result
     */
    public static IntentDetectionResult summary(final String documentUrl, final String reasoning) {
        return new IntentDetectionResult(ChatIntent.SUMMARY, null, documentUrl, reasoning);
    }

| `title` | `str` | API 的標題。 |
| `summary` | `str` | API 的簡短摘要。<small>自 OpenAPI 3.1.0、FastAPI 0.99.0 起可用。</small> |
| `description` | `str` | API 的簡短說明。可使用 Markdown。 |
| `version` | `string` | API 的版本號。這是你自己的應用程式版本，不是 OpenAPI 的版本，例如 `2.5.0`。 |
| `terms_of_service` | `str` | 指向 API 服務條款的 URL。若提供，必須是 URL。 |

            },
            "converted": {
                "summary": "An example with converted data",
                "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
                "value": {
                    "name": "Bar",
                    "price": "35.4",
                },
            },
            "invalid": {
                "summary": "Invalid data is rejected with an error",

| `title` | `str` | API 的标题。 |
| `summary` | `str` | API 的简短摘要。 <small>自 OpenAPI 3.1.0、FastAPI 0.99.0 起可用。</small> |
| `description` | `str` | API 的简短描述。可以使用 Markdown。 |
| `version` | `string` | API 的版本。这是您自己的应用程序的版本，而不是 OpenAPI 的版本。例如 `2.5.0`。 |
| `terms_of_service` | `str` | API 服务条款的 URL。如果提供，则必须是 URL。 |

* `summary`: A short summary of the API.
* `description`: The description of your API, this can include markdown and will be shown in the docs.
* `routes`: A list of routes, these are each of the registered *path operations*. They are taken from `app.routes`.

/// info

The parameter `summary` is available in OpenAPI 3.1.0 and above, supported by FastAPI 0.99.0 and above.

        {
            "openapi": "3.1.0",
            "info": {"title": "FastAPI", "version": "0.1.0"},
            "paths": {
                "/with-duplicates": {
                    "post": {
                        "summary": "With Duplicates",
                        "operationId": "with_duplicates_with_duplicates_post",
                        "requestBody": {
                            "content": {

```yaml
groups:
- name: example
  rules:
  - alert: MinIOClusterTolerance
    expr: minio_cluster_health_erasure_set_status < 1
    for: 5m
    labels:
      severity: critical
    annotations:
      summary: "Instance {{ $labels.server }} has lost quorum on pool {{ $labels.pool }} on set {{ $labels.set }}"

        final IntentDetectionResult result = IntentDetectionResult.summary(documentUrl, "summary request");

        assertEquals(ChatIntent.SUMMARY, result.getIntent());
        assertEquals(documentUrl, result.getDocumentUrl());
        assertNull(result.getQuery());
        assertEquals("summary request", result.getReasoning());
    }

    @Test
    public void test_summary_withNullDocumentUrl() {