Discussions

Ask a Question
Back to All

How to document query params that have enumerated values?

Hi, what is the best practices to document a query param that has a list of enumerated values? It looks like there isn't native support for this in API Reference > API Endpoint > Query Params.

For example, if I have a param named "sort" and it has many sort keys, such as "sort=relevance,name,availablity", how would you document that in the manual editor? I need to define the meaning of each sort key so I can't just list the keys in one sentence.

I have been building HTML tables in another tool, with a Key Name and Description, pasting the HTML into the small text field, but that is kind of hacky and tedious.