LAB-1922: Update OpenAPI specification for the GET template endpoint #149
Open
alyssarcano wants to merge 3 commits intofeature/LAB-1915_CM-Update-OpenAPI-To-Support-Multi-Templatefrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Data Gateway OpenAPI spec to support retrieving a specific Cloud Matrix assessment template by name.
Changes:
- Added a reusable
templateNamepath parameter undercomponents.parameters. - Updated the Cloud Matrix template GET endpoint to use
/Api/CloudMatrix/Template/{templateName}and reference the new parameter. - Adjusted response documentation (new 400 response and updated example/summary text).
Comments suppressed due to low confidence (1)
specs/Data-Gateway.json:9142
- This path item is
/Api/CloudMatrix/Template/{templateName}, but thepostoperation does not declare the requiredtemplateNamepath parameter (path params must be defined at the path-item level or on every operation). As written, the OpenAPI document is invalid for many validators/generators. Either add thetemplateNameparameter to the path-item (so it applies to both GET and POST), add it to the POST operation, or move the POST back to a non-parameterized path if it isn’t meant to use{templateName}.
"post": {
"description": "Add or update a value assessment template. When the specified template name exists, it will overwrite the existing template JSON file in blob storage.\n\nThis endpoint is only accessible from the `SHI` and `SHI Lab` tenants and requires the `CloudMatrix.ReadWrite.All` scope (permission).",
"operationId": "/Api/CloudMatrix/Template/Post",
"requestBody": {
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Enhances the OpenAPI specification for the GET template endpoint by adding support for a request parameter used to retrieve a specific template.