Skip to content

Conversation

@Simran-B
Copy link
Contributor

@Simran-B Simran-B commented Jan 15, 2024

Description

This removes dumping the Go data structure for type: array (indirectly checked by looking for items:) at the top-level of a response schema description.

If no item type is defined for an array, still render the property (with an indicated type of array).

For arrays with a defined item type (excluding items: type: ''), display array<type> instead of [type].

Empty item type, array:

No debug-dumping of top-level arrays, array<object> instead of [object]:

Array with no items defined:

  • We don't seem to have an example for this but I tested it locally
  • Now displays a clickable array item instead of nothing
      responses:
        '200':
          description: |
            The list of collections
          content:
            application/json:
              schema:
                description: |
                  The data type is an array but without specification of its elements.
                type: array
image

Upstream PRs

  • 3.10:
  • 3.11:
  • 3.12:

@cla-bot cla-bot bot added the cla-signed label Jan 15, 2024
@arangodb-docs-automation
Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-427--docs-hugo.netlify.app

@Simran-B Simran-B self-assigned this Jan 15, 2024
@Simran-B Simran-B requested a review from nerpaula January 15, 2024 11:25
@Simran-B Simran-B changed the title Do not debug-dump for top-level arrays in OpenAPI responses Do not debug-dump for top-level arrays & improve array rendering in OpenAPI responses Jan 15, 2024
@nerpaula nerpaula merged commit 50d778c into main Jan 16, 2024
@nerpaula nerpaula deleted the remove-array-debug branch January 16, 2024 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants