Add option to specify the URL path for auto-generated API pages #1808
Closed
rhianvanesch-sc
started this conversation in
Feature Requests
Replies: 2 comments
-
|
This is a great suggestion! There might be even additional field in |
Beta Was this translation helpful? Give feedback.
0 replies
-
|
Resolved: this can be done using the |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
It's possible to auto-generate pages from an OpenAPI specification: https://www.mintlify.com/docs/api-playground/openapi-setup#auto-populate-api-pages, e.g. in
docs.json:{ "group": "Pets", "openapi": "/path/to/openapi.yaml", "pages": ["POST /pets"] },For us, the generated page for
POST /petsends up with a URL path of/api-reference/${tags[0}/${summary}, where it seems to take the first entry in thetagsfield, and slugifies thesummaryfield from the OpenAPI spec.We would like more control over this generated URL, e.g. to change the prefix from
/api-referenceto something else, or add an additional prefix, e.g./api-reference/v1and/api-reference/v2.The current workaround we have is to generate
.mdxpages for every endpoint (docs) and place them into subfolders with the desired naming, but in some cases we would prefer to use the auto-generated pages.Beta Was this translation helpful? Give feedback.
All reactions