Skip to content

Conversation

Szer
Copy link
Contributor

@Szer Szer commented Oct 19, 2021

Fixes #114

BREAKING CHANGE

Current name is used as a "reference" name to refer to that particular scheme in OpenAPI spec (in yaml or json it is key value of the map containing security schemas)

But spec refers to name as a field in that object with very specific semantic
The name of the header, query or cookie parameter to be used.

After this change name will become what it is supposed to be - name of query/header/cookie, and for "reference" name there is a new required field.

This change will break those, who uses name as "reference" name, but it will bring library closer to OpenAPI spec.

@Wicpar
Copy link
Collaborator

Wicpar commented Oct 19, 2021

looks good, i'll merge it at the same times as the other once the question is resolved. Since it's beta i'll just change the minor version.

@Wicpar Wicpar merged commit 60f21e7 into papsign:master Nov 2, 2021
@Szer Szer deleted the security-scheme-name branch November 2, 2021 16:49
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.

Can't set name of token parameter or cookie name in SecurityScheme

2 participants