Skip to content

Add description of scopes, upgrade OpenAPI spec version [SA-23072] - #226

Open
armatronic wants to merge 16 commits into
alaress:developfrom
armatronic:task-develop/SA-23072
Open

armatronic wants to merge 16 commits into
alaress:developfrom
armatronic:task-develop/SA-23072

Conversation

@armatronic

Copy link
Copy Markdown
Collaborator

This PR adds scopes to the create token endpoint, as per https://github.com/alaress/schoolbox/pull/35999.

It also upgrades the OpenAPI spec version, as OpenAPI 3.1+ relaxes what is allowed in the security property of an endpoint:

  • 3.0 does not allow scopes to be defined for schemes with a type other than oauth2 or openidconnect (bearer tokens are http)
  • 3.1+ allows them to be defined for the http type, but they are not back-referenced to anything in the scheme itself

The required changes have been made so that the schema still compiles:

  • nullable is gone from properties, and is converted to type: ['type', 'null']
  • example is expanded to multiple examples

I have not yet addressed additional warnings raised in the newer spec version.

redocly/cli is also updated, so anyone testing locally will need to run npm install once this is merged.

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.

1 participant