In searching how to provide better documentation for enum, I found the CSV feature and then (by exporting the schema) a proprietary extension x-apidog-enum.
This extension is not listed in the documentation * Apidog OpenAPI Specificaiton Extensions
Also, the documentation page for “APIDog flavored markdown” is missing/
Thank you for your feedback. We will promptly add documentation for the x-apidog-enum extension. In the meantime, here’s how you can use it:
In OpenAPI/JSON Schema, add x-apidog-enum next to a field containing enum to provide display names and descriptions for each enum value. Example:
{
“type”: “string”,
“enum”: [“pending”, “shipped”, “completed”],
“x-apidog-enum”: [
{ “value”: “pending”, “name”: “Pending”, “description”: “Order has not been processed” },
{ “value”: “shipped”, “name”: “Shipped”, “description”: “Order has been dispatched” },
{ “value”: “completed”, “name”: “Completed”, “description”: “Order has been fulfilled” }
]
}
The “value” must match one of the enum items, while “name” and “description” are optional.
Regarding Apidog flavored markdown, please check: https://markdown.apidog.io/