Problem/Motivation

Validate the file using redocly lint, observe several errors.

Many of them are because of an empty description.

Expected type `string` but got `null`.

20712 | "patch": {
20713 | "summary": "Relationship: field_media_image (File)",
20714 | "description": null,
20715 | "parameters": [
20716 | {

For my current project, this fixes 1100 out of 1700+ errors.

See #3197082: Generated Swagger.json Does Not Validate with Swagger Editor

Steps to reproduce

What I did was:

  1. Download the openapi spec from my local ddev even (wget http://url//openapi/jsonapi?_format=json)
  2. Use jq to properly format this file, cat jsonapi?_format=json | jq > out.json
  3. redocly lint out.json

Proposed resolution

Fix all errors, but not all in this issue, to make reviewing easier.

Remaining tasks

-

User interface changes

-

API changes

protected getRouteMethodDescription is now strictly typed

Data model changes

-

Issue fork openapi_jsonapi-3577895

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

borisson_ created an issue. See original summary.

borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented
Issue summary: View changes
borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented
Status: Active » Needs review

I have fixed this, but the commit does not seem to show up in gitlab, I will have some patience.

borisson_ opened merge request !22

pcambra made their first commit to this issue’s fork.

pcambra’s picture

pcambra
he/him
Primary language Spanish
commented
Status: Needs review » Fixed

Many thanks for all your work here @borisson_!

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.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.