documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Add section "API tips" to API reference overview

Open dichotommy opened this issue 2 years ago • 0 comments

As noted in a comment on #1616 , we have an urgent need to de-bloat some of our API descriptions and centralize information on interacting with the API, such as wildcard values and dot-notation.

I have suggested that the existing API reference overview page would be a good place for this.

The primary goal of this section would be to reduce the number of paragraphs in the descriptions of API parameters and bodies.

This means that a PR handling this would have to remove redundant sentences from various API reference pages, as well as find a solution to efficiently identify for users the meaning of ["*"] for a given parameter.

Name of section is arbitrary and can be changed.

dichotommy avatar May 03 '22 11:05 dichotommy