Feature/lab 1915 cm update open api to support multi template - #152
Merged
Elliot Huffman (elliot-huffman) merged 22 commits intoApr 27, 2026
Conversation
…-add-open-api-specification-for-the-get-template-list-endpoint LAB-1920 Add POST Cloud Matrix Assessment template endpoint specification.
- Update OpenAPI spec to support retrieving Cloud Matrix templates by name:
- Add a required path parameter `templateName`, change the GET path to `/Api/CloudMatrix/Template/{templateName}` (with updated operationId, descriptions and examples), and adjust response summaries.
- Preserve the POST endpoint for creating/updating templates.
- Also bump the TypeScript SDK package version from 3.2.0 to 3.2.1.
…e/LAB-1922A_Update-Get-Template-EndPoint LAB-1922A: Added templateName GET route and bump SDK version
…plate' into LAB-1921_add_new_endpoint_for_get_template_list
Copilot started reviewing on behalf of
Jagdish Khunti (JagdishKhunti)
April 15, 2026 15:43
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Data Gateway OpenAPI spec to support multiple Cloud Matrix templates (named retrieval + upload), and bumps the TypeScript SDK package version.
Changes:
- Bump
@shi-corp/sdk-data-gatewayversion from3.2.0to3.2.1 - Add
templateNamepath parameter and new schemas for template naming/upload requests - Replace the CloudMatrix template GET route with a templated route and add a POST endpoint for uploading/overwriting templates
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
src/dataGateway/TypeScript/package.json |
Bumps SDK version to publish updated generated client/spec changes. |
specs/Data-Gateway.json |
Adds multi-template support in CloudMatrix API (named GET, upload POST, new parameter/schemas). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Jagdish Khunti (JagdishKhunti)
marked this pull request as draft
April 15, 2026 15:47
…21_add_new_endpoint_for_get_template_list LAB-1921_get_list _available_templates
Document that templateName is sent as a path segment and must be URL-encoded (update parameter description and example to use "Microsoft%20Enterprise"). Also tighten the documented required permission for template-related endpoints to only `CloudMatrix.Read` for /Api/CloudMatrix/Template/{templateName} and /Api/CloudMatrix/TemplateMetadata/List.
Jagdish Khunti (JagdishKhunti)
requested review from
Copilot
and removed request for
Copilot
April 16, 2026 09:30
Copilot started reviewing on behalf of
Jagdish Khunti (JagdishKhunti)
April 16, 2026 09:30
View session
Pasha Zayko (pasha-zayko)
requested changes
Apr 16, 2026
Pasha Zayko (pasha-zayko)
left a comment
Pasha Zayko (pasha-zayko)
left a comment
Contributor
There was a problem hiding this comment.
A couple of additional observations:
- in Data-Gateway.json file there is also reference to version (that should ideally match whats in the package,json) - around line 4793 - that should also be changed to the same incremented value
- after changing package.json run "npm install" so the same version change is reflected in package-lock.json file and commit it (when this is the only change there, it is intended change to push in lock file)
- in Data-Gateway.json file, confirm the actual endpoint to get the list of templates, as I believe it is being changed
…21B_correct_TemplateMetadata_endpoint_name fix TemplateMetadata endpoint name
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
specs/Data-Gateway.json:9341
- The GET
/Api/CloudMatrix/Template/{templateName}operation still only documents200and500responses. Since this endpoint takes a required path parameter, it should also include the standard400response (and any other standard errors you expect) for invalidtemplateNameinputs, consistent with other Cloud Matrix GET endpoints (e.g./Api/CloudMatrix/Account/{accountId}/Dashboard).
"responses": {
"200": {
"description": "The requested assessment template object.",
"content": {
"application/json": {
"examples": {
"Named Template Output": {
"description": "Returns the requested template stored in blob storage. This has been trimmed to contain one element for brevity.",
"summary": "Named Template Output",
"value": {
"title": "CloudMatrix Value Assessment",
"description": "MICROSOFT CLOUD ADOPTION MATRIX v5.0",
"version": "5.0.14",
"valueAssessment": {
"actionPlan": {
"accountName": "AstraZeneca",
"discoveryDate": "2026-01-01T00:00:00Z",
"accountManager": "John Smith",
"consultant": "MSAG Consultant",
"licensingExecutive": "Jane Doe",
"customerSuccessManager": "John Doe",
"notesAndObjectives": "Sample notes and objectives for the account.",
"accountId": "fd9a6a53-594d-41aa-950a-b21ff41d4688",
"createdDate": "2026-01-01T00:00:00Z",
"modifiedDate": "2026-01-01T00:00:00Z",
"primaryPublisher": "Microsoft"
},
"userProfiles": [
{
"id": "00000000-0000-0000-0000-000000000001",
"name": "Profile Details",
"details": [
{
"name": "Profile Details",
"values": [
{
"name": "Profile Name",
"value": "Knowledge Worker"
}
]
}
]
}
],
"assessments": [
{
"metadata": {
"name": "M365 Apps for Enterprise - Mobile/Online",
"breakoutId": null,
"category": "USER EXPERIENCE",
"subCategory": "Productivity",
"help": "Brief: Common applications available through a browser used for business purposes typically bundled together by software vendors like Microsoft and Google. i.e., spreadsheets, slide presentations, word processor, etc.",
"licensingProduct": "M365 Mobile Apps",
"licensingProductHelp": "Mobile Apps The Microsoft 365 mobile app combines Word, Excel, and PowerPoint into a single app for iOS and Android devices. It offers features like creating, editing, and sharing documents on the go, scanning and signing PDFs, and using voice commands for quick tasks. You can also connect your email accounts and calendars in one convenient spot1.\n\nWeb Apps Microsoft 365 for the web includes online versions of Word, Excel, PowerPoint, OneNote, and Outlook. These web apps allow you to create, edit, and share documents directly from your browser without needing to install any software. You can access your documents from anywhere with an internet connection, making it easy to collaborate with others in real-time2.",
"isAddon": false,
"isStrategicAddon": false,
"isTenantBased": false,
"availability": null,
"notes": "",
"startYearConfig": {
"value": null,
"userProfileIds": null,
"isDeepDive": false,
"altProduct": null,
"publisher": null,
"useCase": null
},
"yearPlusOneConfig": {
"value": null,
"userProfileIds": null,
"isDeepDive": false,
"altProduct": null,
"publisher": null,
"useCase": null
},
"yearPlusTwoConfig": {
"value": null,
"userProfileIds": null,
"isDeepDive": false,
"altProduct": null,
"publisher": null,
"useCase": null
},
"yearPlusThreeConfig": {
"value": null,
"userProfileIds": null,
"isDeepDive": false,
"altProduct": null,
"publisher": null,
"useCase": null
},
"sourceValue": 0.0
},
"profiles": [
{
"name": "Microsoft E5",
"abbreviation": "ME5P",
"value": 5.0
}
],
"features": [
{
"licensing": "M365 SMB",
"products": [
{
"product": "PS",
"value": "na",
"comment": ""
}
]
}
]
}
],
"displacements": [
{
"name": "Example displacement opportunity",
"currentProvider": {
"name": "Microsoft",
"terms": "5 Years",
"contractNumber": "C12345678",
"expiryDate": "2026-01-01T00:00:00Z",
"costs": {
"monthlyCost": 5001,
"annualCost": 5002,
"contractValue": 5003
}
},
"displacement": {
"name": "Google",
"terms": "3 Years",
"contractNumber": "C87654321",
"expiryDate": "2026-01-01T00:00:00Z",
"costs": [
{
"monthlyCost": 5001,
"annualCost": 5002,
"contractValue": 5003
}
],
"replacementDate": "2026-12-31T00:00:00Z"
},
"notes": "Example notes"
}
]
},
"breakouts": [
{
"title": "PORTAL APPS",
"breakoutId": "f1ebe6ab-1164-4ab8-8970-2d561ee7634f",
"breakoutName": "BREAKOUT -Portal Apps",
"features": [
{
"roadmapElementPath": "User Experience /Productivity Apps/Extended Productivity App Ecosystem",
"elementSubdimension": "Productivity Apps",
"roadmapProduct": "Platform Only",
"feature": "Viva Insights - Personal",
"description": "Microsoft Lists is a Microsoft 365 app that helps you track information and organize work with customizable lists for tasks, projects, and more.",
"publisherLink": "",
"subscriptionFeatures": [
{
"licensing": "M365 FLW",
"products": [
{
"product": "F1",
"value": "na",
"comment": ""
},
{
"product": "F3",
"value": "na",
"comment": ""
}
]
}
]
}
]
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/CloudMatrix.BulkCloudMatrix"
}
}
}
},
"500": {
"$ref": "#/components/responses/500"
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
Files not reviewed (1)
- src/dataGateway/TypeScript/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 3 changed files in this pull request and generated no new comments.
Files not reviewed (1)
- src/dataGateway/TypeScript/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
JD-ghforme
requested review from
Pasha Zayko (pasha-zayko)
and removed request for
JD-ghforme
April 17, 2026 14:00
Jagdish Khunti (JagdishKhunti)
marked this pull request as ready for review
April 20, 2026 15:15
Jagdish Khunti (JagdishKhunti)
requested review from
Copilot
and removed request for
Copilot
April 20, 2026 15:15
Copilot started reviewing on behalf of
Jagdish Khunti (JagdishKhunti)
April 20, 2026 15:16
View session
Pasha Zayko (pasha-zayko)
approved these changes
Apr 20, 2026
Elliot Huffman (elliot-huffman)
approved these changes
Apr 27, 2026
Elliot Huffman (elliot-huffman)
left a comment
Elliot Huffman (elliot-huffman)
left a comment
Contributor
There was a problem hiding this comment.
looks good
Elliot Huffman (elliot-huffman)
deleted the
feature/LAB-1915_CM-Update-OpenAPI-To-Support-Multi-Template
branch
April 27, 2026 18:22
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.
@shi-corp/sdk-data-gatewaypackage, incrementing its version from 3.2.0 to 3.2.1.