Python: OpenAPI updates to support multiple operation servers & security config #9670
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
markwallace-microsoft
added
the
python
TaoChenOSU
approved these changes
Nov 12, 2024
| INFO_KEY = "info" | ||
| SECURITY_KEY = "security" | ||
| SERVER_URLS_KEY = "server-urls" | ||
| METADATA_KEY = "operation-extensions" |
There was a problem hiding this comment.
Just making sure: the value of METADATA_KEY is not metadata. And I am not seeing it being used.
|
|
||
|
|
||
| @experimental_class | ||
| class RestApiOAuthFlow: |
|
|
||
|
|
||
| @experimental_class | ||
| class RestApiOAuthFlows: |
| class RestApiSecurityRequirement(dict[RestApiSecurityScheme, list[str]]): | ||
| """Represents the security requirements used by the REST API.""" | ||
|
|
||
| def __init__(self, dictionary: dict[RestApiSecurityScheme, list[str]]): |
There was a problem hiding this comment.
can the parameter name be more descriptive?
| @@ -29,6 +31,18 @@ | |||
| logger: logging.Logger = logging.getLogger(__name__) | |||
|
|
|||
|
|
|||
| @experimental_class | |||
| class OperationExtensions(Enum): | |||
There was a problem hiding this comment.
should we move this into a seperate file, maybe const.py?
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.
Motivation and Context
We currently handle OpenAPI plugins via the kernel, but in a pretty simple way. The changes in this PR are allowing one to define multiple server paths for an operation as well as configure security on the operations either at the operation level or at the "global" spec level (these are included as metadata in the kernel function parameter
additional_parametersdict).Description
Adds support for OpenAPI plugin:
excluded_operationson the execution settings were never checked during REST API operation buildingOpenAI plugincode as it was deprecated by OpenAI and we never handled it in SK Python.Contribution Checklist