docs(openapi): update openapi schema with missing information#411
Open
runleveldev wants to merge 3 commits into
Open
docs(openapi): update openapi schema with missing information#411runleveldev wants to merge 3 commits into
runleveldev wants to merge 3 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the create-a-container OpenAPI v1 document to capture missing API behavior and schema details, improving accuracy for client generation and consumer understanding.
Changes:
- Expanded top-level API documentation (common error codes) and bumped API version to
1.1.0. - Added/extended schemas and response components (e.g.,
NotFound/Forbidden/BadRequest, richerContainer,NodeInput,User,ResourceRequest). - Documented additional endpoints and enriched many existing operations with request/response bodies (including OpenAPI self-serve endpoints and resource request flows).
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
The MCP server (manager-control-program, built on awslabs openapi-mcp-server / fastmcp) names each generated tool after the operation's operationId. Without one it falls back to munging the summary or METHOD+path and truncating at 56 chars, producing names like GET_sitessiteIdcontainersid and Usernamepassword_login_disabled_when_OIDC_SSO_is_enabled. Give all 70 operations a unique snake_case verb_noun operationId (list_sites, create_container, agent_check_in, ...).
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
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.
Used AI to make the OpenAPI schema actually match what the API server uses.