Allow generating OpenAPI spec pages using operationId #6993
jfconde-payrails
started this conversation in
Feature Requests
Replies: 0 comments
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.
Request: make it possible, via
docs.jsonconfiguration, to customize how the slugs for OpenAPI endpoints are auto-generated, allowing users to select theoperationIdfield instead ofsummary.Context
Our organization is migrating our docs to Mintlify. We currently have a large OpenAPI spec documenting our public API, with almost a hundred endpoints.
Mintlify generates the URL paths or "slugs" of openAPI specs based on the
summaryattribute of the endpoints in the OpenAPI specs. An endpoint described as:Generates the following urls inside our navigation:
<base url>/reference/entities/search-&-list-entitiesRationale
After consulting the docs and AI assistant, the suggested solution is using the
x-mint(as described here) field. Our OpenAPI spec is auto-generated from source at its original repository, and we do not want to pollute that source with extraneous fields, such asx-mint. While we can/will automate the generation or duplication of this field using theoperationIdfield, this adds an additional conversion step for our present API and every future OpenAPI spec we want to publish in Mintlify.While solvable, exposing an alternative configuration field in docs.json, at api or navigation item level, would be a very valuable feature - in my opinion - also for any other OpenAPI Mintlify users.
All reactions