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

Fix schema, clarify spec (v1.1.0) #31

Merged
merged 2 commits into from
Apr 28, 2024
Merged

Fix schema, clarify spec (v1.1.0) #31

merged 2 commits into from
Apr 28, 2024

Conversation

m-mohr
Copy link
Contributor

@m-mohr m-mohr commented Apr 27, 2024

I started with a faulty schema (no Catalog support) and then came across more inconsistencies and ambiguities, so I decided to give this a rework.
I hope the changes reflect the actual intended behavior, some things were hard to understand.

Changed

  • Split Authentication Flows Object into OAuth2 Flow Object and Signed URL Object
  • The JSON Schema is much stricter compared to before, actually enforcing many restrictions documented in the written spec
  • The Parameter Schemas must comply to JSON Schema draft-07 instead of OpenAPI Schema, fixes How to define the parameter schema  #21

Fixed

  • JSON Schema supports Catalogs
  • Fixed various issues in the JSON Schema
  • Clarified which fields apply to which schema type
  • Clarified required fields
  • Fixed examples

Additionally, I'd love to also clean up #30 but that might be too much of an ask for now.

PS: The schema is pretty complex and I hope everything works as expected, but no guarantee ;-)

@m-mohr m-mohr changed the title Fix schema, clarify spec Fix schema, clarify spec (v1.1.0) Apr 27, 2024
@jamesfisher-geo
Copy link
Collaborator

Looks good. Thanks.

I added a PR #32 to remove the provider specific types in this branch.

@m-mohr m-mohr merged commit 9fa7094 into main Apr 28, 2024
2 checks passed
@m-mohr m-mohr deleted the v1.1.0 branch April 28, 2024 21:29
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.

How to define the parameter schema
2 participants