feat: P4ADEV-1851 add P4PA-SEND openAPI #31
Conversation
antocalo
requested review from
antonioT90,
LarissaASLeite and
a team
as code owners
design/send/openApi.yaml
Outdated
| paths: | ||
| /notification: | ||
| post: | ||
| security: [] |
There was a problem hiding this comment.
why without security?
All APIs should expect to be under security (copy it from the openApi you can find on the repo)
There was a problem hiding this comment.
it's an error, i'll fix it
| description: Notification not found | ||
| '500': | ||
| description: Internal server error | ||
| post: |
There was a problem hiding this comment.
a POST on the entity path could be ambiguous, what do you think about to explicit configure the start operation?
/notification/{sendIdNotification}/start
design/send/openApi.yaml
Outdated
| requestBody: | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/CreateNotificationRequest' | ||
| responses: | ||
| '200': | ||
| description: OK | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/CreateNotificationResponse' |
There was a problem hiding this comment.
Why a request body?
The request response could be just the workflowId instead
design/send/openApi.yaml
Outdated
| description: Wrong notification status | ||
| '500': | ||
| description: Internal server error | ||
| /send/preload/{sendIdNotification}: |
There was a problem hiding this comment.
it's more meaningfull to configure the path to locate the entity as first and the configure the operation made on the entity (also for the other entities)
/send/{sendIdNotification}/preload
List of Changes
Motivation and Context
Screenshots (example: rendering of a Mermaid diagram):
Types of changes
Impacted Internal Process: