Skip to content

Conversation

@PedroDiez
Copy link
Contributor

What type of PR is this?

  • documentation

What this PR does / why we need it:

This PR manages the cases when a response or specific field is an array so as their description is well renderized.

It applies for #547:

Which issue(s) this PR fixes:

Fixes #547

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

Changelog input

 guideline for array descriptions

Additional documentation

This section can be blank.

docs

@PedroDiez PedroDiez self-assigned this Nov 14, 2025
@PedroDiez PedroDiez added documentation Improvements or additions to documentation Spring26 Scope of Spring26 (H1-2026) meta-release labels Nov 14, 2025
@rartych
Copy link
Contributor

rartych commented Nov 20, 2025

Case B shows the property items referencing a schema that itself is an array. That results in an array-of-arrays, maybe this would be sufficient:

```yaml
components:
  schemas:
    <schema-name>:
      type: object
      properties:
        <property-name>:
            $ref: "#/components/schemas/<schema-item-name>"
...
    <schema-item-name>:
      type: array
      items:
        type: string
        description: <description>

Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>
@PedroDiez
Copy link
Contributor Author

PedroDiez commented Nov 21, 2025

Case B shows the property items referencing a schema that itself is an array. That results in an array-of-arrays, maybe this would be sufficient:

```yaml
components:
  schemas:
    <schema-name>:
      type: object
      properties:
        <property-name>:
            $ref: "#/components/schemas/<schema-item-name>"
...
    <schema-item-name>:
      type: array
      items:
        type: string
        description: <description>

Yes, i agree. Thanks for the catch-up. Will also name to <schema-array-name>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Spring26 Scope of Spring26 (H1-2026) meta-release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Review API Design Guideline about location of description info in Array items and Request Bodies for suitable displaying

2 participants