Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Add a JSON-schema for namespace files. #492

Open
dblock opened this issue Aug 12, 2024 · 0 comments
Open

[FEATURE] Add a JSON-schema for namespace files. #492

dblock opened this issue Aug 12, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@dblock
Copy link
Member

dblock commented Aug 12, 2024

Is your feature request related to a problem?

Coming from #483 (comment) we want to validate namespace files for certain limitations that are not present in any OpenAPI schema.

  • a fixed set of x- options, e.g. x-operation-group is supported but a typo like x-opperation-group should not be
  • only a fixed set of enums for x-distribution-included, -excluded
  • someone uses a new and valid OpenAPI keyword that the clients should handle accordingly but it got through the PR review without updating the Client Gen doc
  • #paths is not allowed in category yaml files
  • #components/schemas is not allowed in namespace yaml files
  • descriptions being full sentences starting with a capital letter and ending with a period.

What solution would you like?

A validated JSON schema for namespace files.

What alternatives have you considered?

Roll out tests in the linter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants