search

zuplo / zudoku

Framework for building high quality, interactive API documentation.
https://zudoku.dev
MIT License
97 stars 7 forks source link

array type descriptor is not descriptive enough #99

Open AdrianMachado opened 2 months ago

AdrianMachado commented 2 months ago

API Url: https://api.apis.guru/v2/specs/asana.com/1.0/openapi.json Docs url: https://zudoku.dev/demo?api-url=https%3A%2F%2Fapi.apis.guru%2Fv2%2Fspecs%2Fasana.com%2F1.0%2Fopenapi.json#custom-fields-get-a-custom-field-getcustomfield/query-parameters

See opt_fields

"name": "opt_fields",
        "required": false,
        "schema": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },

If an array contains primitives, we should state it is an array of <primitive rather than just array

image
linear[bot] commented 2 months ago
ZUP-3542 array type descriptor is not descriptive enough

API Url: [https://api.apis.guru/v2/specs/asana.com/1.0/openapi.json](https://api.apis.guru/v2/specs/asana.com/1.0/openapi.json) Docs url: [https://zudoku.dev/demo?api-url=https%3A%2F%2Fapi.apis.guru%2Fv2%2Fspecs%2Fasana.com%2F1.0%2Fopenapi.json#custom-fields-get-a-custom-field-getcustomfield/query-parameters](https://zudoku.dev/demo?api-url=https%3A%2F%2Fapi.apis.guru%2Fv2%2Fspecs%2Fasana.com%2F1.0%2Fopenapi.json#custom-fields-get-a-custom-field-getcustomfield/query-parameters) See `opt_fields` ``` "name": "opt_fields", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, ``` If an array contains primitives, we should state it is an \`array of [image](https://uploads.linear.app/908a64f3-d923-4c87-a20a-09fbd46aa318/99f3e51f-4341-464d-87e6-d7bb09c4d8fc/8e8adecb-6353-4c31-b1a8-cf934a38cda1)