Skip to content

fix: resolve OpenAPI linting issues and switch to Redocly CLI#13

Open
johnf wants to merge 1 commit intofix/openapi-spec-updatesfrom
fix/openapi-linting-redocly
Open

fix: resolve OpenAPI linting issues and switch to Redocly CLI#13
johnf wants to merge 1 commit intofix/openapi-spec-updatesfrom
fix/openapi-linting-redocly

Conversation

@johnf
Copy link
Copy Markdown
Collaborator

@johnf johnf commented Mar 27, 2026

Summary

  • Resolve OpenAPI linting issues and switch from previous linting tool to Redocly CLI
  • Add example responses and update example URLs

Test plan

  • Verify the OpenAPI spec validates with Redocly CLI
  • Confirm linting passes cleanly

Replace swagger-cli with @redocly/cli for more thorough OpenAPI
validation. Fix all errors and warnings:

- Remove invalid `name: keyword` from highlight additionalProperties
- Remove `readOnly` from Id schema (conflicted with path parameters)
- Replace allOf-based error schemas with standalone schemas to fix
  unevaluatedProperties issues in JSON Schema 2020-12
- Fix examples to use EntityReference objects instead of plain strings
  for memberOf and rootCollection
- Wire unused error examples into response definitions
- Update example data to use realistic NT1 collection identifiers
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants