Problem/Motivation

The OpenAPI generators expose the endpoints but do not describe response schemas, query parameters or error responses in full. Consumers cannot generate a reliable client from the specification.

Proposed resolution

  • Declare request and response schemas per resource plugin, including error shapes.
  • Document query parameters (pagination, language, filters) with types and defaults.
  • Add at least one example response per endpoint.
  • Validate the generated specification against the OpenAPI 3 schema in CI.

Remaining tasks

Extend the generator base class and annotate the resource plugins.

User interface changes

Richer Swagger UI output.

API changes

None.

Issue fork myrest-3616432

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

sergeydruua created an issue. See original summary.

sergeydruua opened merge request !54

  • sergeydruua committed 8fa41a43 on 1.0.x 
    Issue #3616432: Document the shared error responses, list parameters and...
sergeydruua’s picture

sergeydruua commented
Status: Active » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

sergeydruua’s picture

sergeydruua commented
Status: Fixed » Closed (fixed)