LAB-603 - Update OpenAPI specification for Architecture Report APIs #41
Conversation
- TenantMetadata - SecurityPosture - ArchitectureReport - PrincipalAssignment
…I route. - also replaced nullable: true with type: "null" in PrincipalAssignment schema.
There was a problem hiding this comment.
Pull Request Overview
Updates the OpenAPI specifications in SHIELD.json and Data-Gateway.json to include comprehensive API definitions for Architecture Report endpoints, adding support for storing, retrieving, and managing architectural analysis reports with correlation tracking and tenant-specific access.
- Adds new parameter definitions (tenantId, dateStart, dateEnd) and complete schema definitions for architecture report data structures
- Implements 6 new API endpoints covering POST, GET, and DELETE operations for architecture reports with both tenant-scoped and admin access patterns
- Provides detailed request/response examples and proper schema references for all architecture report components
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| specs/SHIELD.json | Adds tenantId parameter, date range parameters, architecture report schemas, and 6 API endpoints for managing architecture reports |
| specs/Data-Gateway.json | Mirrors the SHIELD.json changes with identical architecture report schemas and API endpoints but with "Architecture Report" tag formatting |
Comments suppressed due to low confidence (1)
specs/SHIELD.json:1
- Invalid reference paths - these parameters are defined in the 'query' section, so references should be '#/components/parameters/query/dateStart' and '#/components/parameters/query/dateEnd'.
{
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
- also remove the dateStart and dateEnd query parameters definition.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
According to @pr0uxx and @elliot-huffman this PR and branch will be restored and rebase from main branch. |
2 participants
for ticket: https://shilab-shicorp.atlassian.net/browse/LAB-603