Skip to content

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
LAB-1922-Update-OpenAPI-template-params
Open

LAB-1922: Update OpenAPI specification for the GET template endpoint #149
alyssarcano wants to merge 3 commits intofeature/LAB-1915_CM-Update-OpenAPI-To-Support-Multi-Templatefrom
LAB-1922-Update-OpenAPI-template-params

Conversation

@alyssarcano
Copy link
Copy Markdown

Enhances the OpenAPI specification for the GET template endpoint by adding support for a request parameter used to retrieve a specific template.

Copilot AI review requested due to automatic review settings April 13, 2026 18:30
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Data Gateway OpenAPI spec to support retrieving a specific Cloud Matrix assessment template by name.

Changes:

  • Added a reusable templateName path parameter under components.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 the post operation does not declare the required templateName path 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 the templateName parameter 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.

Comment thread specs/Data-Gateway.json Outdated
Comment thread specs/Data-Gateway.json
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread specs/Data-Gateway.json
Comment thread specs/Data-Gateway.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants