Skip to content

#223 feat(config): ship JSON Schema for the configuration file#224

Open
arseniy-gl wants to merge 1 commit into
thim81:mainfrom
arseniy-gl:f/issue-223-json-schema
Open

#223 feat(config): ship JSON Schema for the configuration file#224
arseniy-gl wants to merge 1 commit into
thim81:mainfrom
arseniy-gl:f/issue-223-json-schema

Conversation

@arseniy-gl

Copy link
Copy Markdown

Add a JSON Schema for the openapi-format config file.

The config file has no schema today. Editors cannot help the user. A typo in a key name passes the CLI without error.

Changes:

  • Add schemas/openapi-format.schema.json (JSON Schema 2020-12, 32 properties, 5 nested sets)
  • Ship the schema with the npm package
  • Add a README section with a $schema example
  • Add a CHANGELOG entry under unreleased

How to use:

{
  "$schema": "https://openapi-format.com/schema/v1.json",
  "sort": true
}

Fixes #223.

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.

Feature: ship a JSON Schema for the config file

1 participant