For 'Create a session token', under response 201, schema property data.attributes.expiry does not show up, as demonstrated below.

This property should be displayed as below.

e.g.

Currently all responses are expanded, and there is no way to collapse them.

Responses should be collapsed by default.

e.g. product properties

Improve project docs to make it easier for others to consume and to contribute

• CONTRIBUTING with lint/test/building
• README with information about philosophy

Allow the app to preload a list of Open API files when it renders, e.g. like the following wireframe.

Also have a look at Redoc Demo

See descriminator

Currently, if a method description is written in markdown, it is rendered as is, e.g.

Ideally it should be rendered as html, e.g.

This also applies to schema element description.

Currently the examples are rendered as static text, e.g.

They should be rendered as json, e.g.

Currently the app does not render schema elements that have mixed data type, e.g.

"customAttributes": {
  "default": [],
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "key",
      "value"
    ],
    "properties": {
      "key": {
        "type": "string",
        "pattern": "^[a-zA-Z0-9_-]+$"
      },
      "value": {
        "type": [
          "number",
          "integer",
          "string",
          "boolean"
        ]
      }
    },
    "additionalProperties": false
  }
}

The app should be able to render the element, as below

Implement an interactive mode that works similar to the attached design.

Also see API console feature on ReDoc

See #32

JSON Schema defines several formats that it can support. Open API also defines some data types.

When crafting requests in the console, we should use "intellisense" to provide validation prior to sending the request.

JSON Schema:

• date-time
• email
• hostname
• ipv4
• ipv6
• uri
• uri-reference
• uri-template
• json-pointer

Open API

• int32
• int64
• float
• double
• byte
• binary
• date
• password

See Linking to certain attributes

The current setup only caters for the development environment.

We need to cater for at least production environment as well. This requires thinking about how the project will be deployed on a production environment, and update webpack config and scripts to support that workflow.

• Remove description under Request, e.g.

• Navigation methods: separate method type from method description e.g.
  

• Move response description to the same line as response code, e.g.
  

• Remove highlighting of property description when property is object, e.g.
  

There is quite a bit of horizontal gap between a property name and its description, e.g.

Ideally, this gap should start small, and grow bigger as properties are expanded, e.g.

Implement a design like the following wireframe

Schema property name does not seem to align well with property description, e.g.

On a smaller size screen (1078px width), some attributes are pushed to a new line, causing misalignment. For example:

Implement a design that allows other developers to take the project and provide a custom theme, which will override the default theme used in the project.

The Open API v3 specification supports a number of JSON Schema properties. We should aim to support as many as possible:

• title
• multipleOf
• maximum
• exclusiveMaximum
• minimum
• exclusiveMinimum
• maxLength
• minLength
• pattern
• maxItems
• minItems
• uniqueItems
• maxProperties
• minProperties
• format
• required
• enum

Here's a link to the JSON Schema specification.

Also see JsonSchema constraints on ReDoc.

This document about schema support is useful, and should be expanded/part of a wider selection of docs that help developers understand what this project support of the Open API v3 specification.

Currently properties that are of boolean type are not displayed, e.g. some of the Product attributes.

These properties need to be displayed, e.g.

See x-enumNames

Under Create a location object in the account - Request - Schema

data.attributes.address.line is displayed as below

Note that line is an array of string, but that doesn't show up on the display.

It should display as follows

This applies for all literal types, e.g. string, number, boolean

Make it easier to know identify success responses (200ish), e.g.

This is related to #33 and #53

This is the backend work to support #24 . Need to work out what data are required by BodySchema.js and update the parser to return data accordingly.

The current style looks a bit sad.

Perhaps it needs a bit of makeup, like this one

If I scroll the contents (on the right hand side), it will take 2-3 seconds for the corresponding navigation on the left to be highlighted. This is not a great user experience.

The synchronisation should be immediate.

This issue is related to #18

Currently the schema visualiser does not handle schema elements that are arrays.

For example, a Shipment object contains packages, which is an array of package object. This element is currently not shown on the visualiser.

Ideally, it should show up like the following:

This is related to #4. See description of issue on #53

Something like the following would be nice

We currently seem to have a bit of an ad-hoc eslint configuration going on. This makes contribution from others difficult as they are essentially aligning to some weird hybrid set of rules.

I don't feel strongly about a particular configuration, but I'd suggest we migrate to Standard JS which provides eslint configs for standard and react and move on with life 👍

Currently all tags and methods are expanded, and there is now way to collapse them.

Tags should be collapsible and expandable, and only one navigation tag should be expanded at a time, e.g.

Currently path parameters are not displayed, e.g. for 'Get all the users of a given account', the app currently displays the following:

It should display the path parameters, e.g.

Visualise security scheme, based on securityDefinitions on open API spec.

For example, given

"securityDefinitions": {
    "Session": {
      "type": "apiKey",
      "name": "Session",
      "description": "Requests made to the Temando Platform API must be authenticated with a Session header whose value is a valid session token. Session tokens expire and must be recreated for further requests to be made of the Temando Platform API.",
      "in": "header"
    }
  },

The app could visualise the above information as below

Currently query parameters are not displayed, e.g. for 'Get list of registered accounts', the app currently displays the following:

It should display the query parameters, e.g.

Currently the app does not display the possible enum values of a schema element

e.g. for enum type, it displays

It should display something like the following

Allow users to open a url (with some hash tag), that will open up the app and scroll to a tag or method matching the hash tag

Currently the app displays the following

It should display the response, e.g.

e.g. response 20 for 'Get all the users of a given account' (type = 'user')

This is related to #39