Skip to content

OpenAPI spec inaccuracies and missing or incorrect definitions #62

@ollipa

Description

@ollipa

I maintain meraki-client-python, a type-safe Python SDK generated from the Dashboard API OpenAPI spec. I've had to accumulate a number of spec overrides to work around inaccuracies in the spec. The full list of affected endpoints is documented in spec_overrides.toml.

The issues I've encountered include:

  • Endpoints returning arrays where the spec declares an object
  • Endpoints missing pagination parameters despite returning paginated responses
  • Paginated response wrapper schemas modeled incorrectly
  • Nullable responses not declared as such
  • Incorrect field types in response schemas
  • Fields consistently present in responses not marked as required
  • Fields returned by the API missing from the spec entirely
  • Endpoints with a bare {type: object} response schema and no properties defined

What is the best way to get fixes like these upstreamed into the spec? Are pull requests accepted, or is there another process?

Happy to help if PRs are welcome. Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions