fix: various fixes for openapi support #208
Merged
Conversation
This file contains hidden or 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
g-linville
commented
Apr 1, 2024
Comment on lines
+328
to
+329
| var fragment struct { | ||
| Paths map[string]any `json:"paths,omitempty"` |
There was a problem hiding this comment.
We want to check for the existence of the paths map, rather than the version string, since the version string is sometimes missing.
g-linville
commented
Apr 1, 2024
Comment on lines
+19
to
+31
| func getOpenAPITools(t *openapi3.T, defaultHost string) ([]types.Tool, error) { | ||
| // Determine the default server. | ||
| if len(t.Servers) == 0 { | ||
| return nil, fmt.Errorf("no servers found in OpenAPI spec") | ||
| if defaultHost != "" { | ||
| u, err := url.Parse(defaultHost) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("invalid default host URL: %w", err) | ||
| } | ||
| u.Path = "/" | ||
| t.Servers = []*openapi3.Server{{URL: u.String()}} | ||
| } else { | ||
| return nil, fmt.Errorf("no servers found in OpenAPI spec") | ||
| } |
There was a problem hiding this comment.
This adds support for a "default host" if no server is specified at the global level in the OpenAPI document.
g-linville
commented
Apr 1, 2024
| for _, param := range operation.Parameters { | ||
| // Handle query, path, and header parameters, based on the parameters for this operation | ||
| // and the parameters for this path. | ||
| for _, param := range append(operation.Parameters, pathObj.Parameters...) { |
There was a problem hiding this comment.
Parameters can also be defined at the path level (pathObj.Parameters), so we are now handling those as well.
g-linville
commented
Apr 1, 2024
g-linville
commented
Apr 1, 2024
Comment on lines
152
to
+177
| if bodyMIME == "" { | ||
| return nil, fmt.Errorf("no supported MIME types found for request body in operation %s", operation.OperationID) | ||
| // No supported MIME types found, so just skip this operation and move on. | ||
| continue operations |
There was a problem hiding this comment.
We now skip tools with no supported MIME types in the body instead of just returning an error for the whole document.
g-linville
requested review from
thedadams,
njhale,
StrongMonkey,
iwilltry42,
keyallis and
tylerslaton
ibuildthecloud
approved these changes
Apr 2, 2024
Signed-off-by: Grant Linville <[email protected]>
Signed-off-by: Grant Linville <[email protected]>
thedadams
approved these changes
Apr 2, 2024
g-linville
force-pushed
the
openapi-fixes
branch
from
aa0c094 to
1a15239
Compare
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.
These are fixes to various problems that Darren found with OpenAPI support. I annotated this PR to explain a bit about each substantial change.