Public Doc -> GA Release of New Secops rest apis #665
Conversation
TamirYaariSpot
requested review from
TamirYaariSpot
and removed request for
TamirYaariSpot
| schema: | ||
| anyOf: | ||
| - type: string | ||
| - type: 'null' |
There was a problem hiding this comment.
since it is not a required parameters, there is no need to specify that null is an accepted value
| anyOf: | ||
| - type: string | ||
| - type: 'null' | ||
| title: Paginationkey |
There was a problem hiding this comment.
no need for the title
There was a problem hiding this comment.
this is also generated by FastAPI library not in our control
| in: query | ||
| name: paginationKey | ||
| required: false | ||
| schema: |
There was a problem hiding this comment.
missing - example & description
| allOf: | ||
| - $ref: ./PaginatedResponse_ComplianceModel_.yaml | ||
| responseTime: | ||
| title: Responsetime |
There was a problem hiding this comment.
no need for title - please fix for all fields (creates unneeded duplication since field name already appears there)
| error: | ||
| anyOf: | ||
| - $ref: ./ErrorModel.yaml | ||
| - type: 'null' |
There was a problem hiding this comment.
no need to state null
| title: Responsetime | ||
| type: number | ||
| required: | ||
| - request |
There was a problem hiding this comment.
for responses we do not usually mention if elements are required - this is mostly for input from user (query/path params / body etc.) - please fix for all responses
| response: | ||
| allOf: | ||
| - $ref: ./PaginatedResponse_AssetSimFilterModel_.yaml | ||
| responseTime: |
There was a problem hiding this comment.
is this API-approved? I am not familiar with returning this field in any other of our API routes
Jira Ticket
Include a link to your Jira Ticket
https://spotinst.atlassian.net/browse/SPOTSEC-4343
Demo
Screen.Recording.2024-10-24.at.2.28.50.PM.mov
Checklist: