arangodb / docs-hugo

Source code of the ArangoDB online documentation
https://docs.arangodb.com
Apache License 2.0
5 stars 5 forks source link

Do not debug-dump for top-level arrays & improve array rendering in OpenAPI responses #427

Closed Simran-B closed 10 months ago

Simran-B commented 10 months ago

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:

      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

arangodb-docs-automation[bot] commented 10 months ago

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