Skip to content

API reference samples wrongly generated by Mintlify #3464

@curquiza

Description

@curquiza

When #3446 will be merged, API references will be generated from an openAPI file by Mintlify.

To generate code samples in different languages, we use the x-codeSamples field that is handled by Mintlify

However, it seems that there is a bug on Mintlify side.
In docs.json we disabled the autogeneration, and we enforce the order of languages with:

"examples": {
  "languages": ["curl", "javascript", "php", "python", "java", "ruby", "go", "csharp", "rust", "dart", "swift"],
  "autogenerate": false
}

Although we defined this, for some routes like Webhook where some languages are missing in x-codeSamples (cf file: meilisearch-openapi-mintlify.json), but

  • are still generated (badly) by Mintlyfy
  • are not in the right order

Cf the PHP example that is not in the openAPI file, but still present

Image Image

I reported the bug to Mintlify, but I got no answer so far.
If not fixed on their side, a solution is to generate an example for any single language with Feature not available in this language if there is no code samples to provide from SDKs

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions