org.junit.runner.Description, java.util.List); private void skippedQuietly(org.junit.internal.AssumptionViolatedEx, org.junit.runner.Description, java.util.List); private void startingQuietly(org.junit.runner.Description, java.util.List); private void finishedQuietly(org.junit.runner.Description, java.util.List); protected void succeeded(org.junit.runner.Description); protected void failed(Throwable, org.junit.runner.Description); protected void skipped(org.junit.AssumptionViolatedEx, org.junit.runner.Description);...

## 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){.internal-link target=_blank}.

## Documentation Response description - OpenAPI

private final String fixedDescription; public CustomTypeSafeMatche(String description) { if (description == null) { throw new IllegalArgumentExcep("Description must be non null!"); } this.fixedDescription = description; } @Override public final void describeTo(Description description) { description.appendText(fixedDescription); } } org/hamcrest/Description.java org/hamcrest/Description.java package org.hamcrest; /** * A description of a Matcher. A Matcher will describe itself to a description * which...

        == response2.json()
        == [
            {
                "name": "Portal Gun",
                "description": "Device to travel through the multi-rick-verse",
                "sub": {"subname": "subname", "sub_description": None, "tags": []},
            },
            {"name": "Plumbus", "description": None, "sub": None},
        ]
    )


@needs_pydanticv2
def test_openapi_schema():

@needs_pydanticv1
def test_create_item(client):
    item = {"title": "Foo", "description": "Something that fights"}
    response = client.post("/users/1/items/", json=item)
    assert response.status_code == 200, response.text
    item_data = response.json()
    assert item["title"] == item_data["title"]
    assert item["description"] == item_data["description"]
    assert "id" in item_data
    assert "owner_id" in item_data

            {"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"},
            },
            "Example Two": {
                "value": {"data": "Data in Body examples, example2"},
            },

* `description`: a `str` with a short description for the tag. It can have Markdown and will be shown in the docs UI.
* `externalDocs`: a `dict` describing external documentation with:
    * `description`: a `str` with a short description for the external docs.
    * `url` (**required**): a `str` with the URL for the external documentation.

    assert response.status_code == 200, response.text
    assert response.json() == {"name": "Bar", "description": "The Bar fighters"}


def test_read_item_public_data():
    response = client.get("/items/bar/public")
    assert response.status_code == 200, response.text
    assert response.json() == {
        "name": "Bar",
        "description": "The Bar fighters",
        "price": 62,
    }


def test_openapi_schema():

name: Chore
description: Minor issue without significant impact
labels: [ "a:chore", "to-triage" ]
assignees: [ ]
body:
  - type: dropdown
    id: issue-type
    attributes:
      label: Issue type
      options:
        - Polishing
        - Deprecation
        - Refactoring
        - Other
    validations:
      required: true
  - type: textarea
    id: description
    attributes:
      label: Problem description

        "name": "Baz",
        "description": None,
        "price": 50.2,
        "tax": 10.5,
        "tags": [],
    }


@needs_py39
def test_put(client: TestClient):
    response = client.put(
        "/items/bar", json={"name": "Barz", "price": 3, "description": None}
    )
    assert response.json() == {
        "name": "Barz",
        "description": None,
        "price": 3,
        "tax": 10.5,