fix: define empty openAPI security to signal protocol has no preference #12
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zevisert
added a commit
that referenced
this pull request
Dec 3, 2023
…-required-security revert: #12 - use linter silencing instead
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previous CI jobs had been failing because of a default linting rule from redocly that required the openAPI document to declare a security model. Being a protocol reference, open-inference-protocol has no stance on how a given model server implements their security. I thought this was going to be more tricky to declare through the spec while still making the linter rule happy. Just adding an empty security scheme declaration seems to be the way to go. If downstream implementations want to extend this spec, they can do so with JSON Schema extensions: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#document-structure
Closes #7