Skip to content

Commit

Permalink
notification attachment endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
farrell-m committed Jul 19, 2024
1 parent d85ff49 commit 8ade4b0
Show file tree
Hide file tree
Showing 20 changed files with 1,707 additions and 10 deletions.
224 changes: 224 additions & 0 deletions caab-api/open-api-specification.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1178,6 +1178,189 @@ paths:
description: 'Not found'
'500':
description: 'Internal server error'
/notification-attachments:
get:
tags:
- notification attachments
summary: 'Get Notification Attachments'
operationId: 'getNotificationAttachments'
x-spring-paginated: true
parameters:
- name: 'notification-reference'
in: 'query'
schema:
type: 'string'
example: '1234567890'
- name: 'provider-id'
in: 'query'
schema:
type: 'string'
example: '1234567890'
- name: 'document-type'
in: 'query'
schema:
type: 'string'
example: 'type'
- name: 'send-by'
in: 'query'
schema:
type: 'string'
example: 'type'
responses:
'200':
description: 'Successful operation'
content:
application/json:
schema:
$ref: "#/components/schemas/notificationAttachmentDetails"
'400':
description: 'Bad request'
'401':
description: 'Unauthorized'
'403':
description: 'Forbidden'
'404':
description: 'Not found'
'500':
description: 'Internal server error'
post:
tags:
- notification attachments
summary: 'Create Notification Attachment'
operationId: 'createNotificationAttachment'
requestBody:
description: Create Notification Attachment
content:
application/json:
schema:
$ref: '#/components/schemas/notificationAttachmentDetail'
parameters:
- name: 'Caab-User-Login-Id'
in: header
required: true
schema:
type: 'string'
example: '[email protected]'
responses:
'200':
description: 'Successful operation'
'400':
description: 'Bad request'
'401':
description: 'Unauthorized'
'403':
description: 'Forbidden'
'404':
description: 'Not found'
'500':
description: 'Internal server error'
delete:
tags:
- notification attachments
summary: 'Remove Notification Attachments'
operationId: 'removeNotificationAttachments'
parameters:
- name: 'notification-reference'
in: 'query'
schema:
type: 'string'
example: '1234567890'
- name: 'provider-id'
in: 'query'
schema:
type: 'string'
example: '1234567890'
- name: 'document-type'
in: 'query'
schema:
type: 'string'
example: 'type'
- name: 'send-by'
in: 'query'
schema:
type: 'string'
example: 'type'
- name: 'Caab-User-Login-Id'
in: header
required: true
schema:
type: 'string'
example: '[email protected]'
responses:
'204':
description: 'No Content'
'400':
description: 'Bad request'
'401':
description: 'Unauthorized'
'403':
description: 'Forbidden'
'404':
description: 'Not found'
'500':
description: 'Internal server error'
/notification-attachments/{notification-attachment-id}:
get:
tags:
- notification attachments
summary: 'Get Notification Attachment'
operationId: 'getNotificationAttachment'
parameters:
- name: 'notification-attachment-id'
in: 'path'
required: true
schema:
type: 'integer'
format: 'int64'
example: '1234567890'
responses:
'200':
description: 'Successful operation'
content:
application/json:
schema:
$ref: "#/components/schemas/notificationAttachmentDetail"
'400':
description: 'Bad request'
'401':
description: 'Unauthorized'
'403':
description: 'Forbidden'
'404':
description: 'Not found'
'500':
description: 'Internal server error'
delete:
tags:
- notification attachments
summary: 'Remove a Notification Attachment'
operationId: 'removeNotificationAttachment'
parameters:
- name: 'notification-attachment-id'
in: 'path'
required: true
schema:
type: 'integer'
format: 'int64'
- name: 'Caab-User-Login-Id'
in: header
required: true
schema:
type: 'string'
example: '[email protected]'
responses:
'204':
description: 'No Content'
'400':
description: 'Bad request'
'401':
description: 'Unauthorized'
'403':
description: 'Forbidden'
'404':
description: 'Not found'
'500':
description: 'Internal server error'
/evidence:
get:
tags:
Expand Down Expand Up @@ -2511,6 +2694,47 @@ components:
$ref: "#/components/schemas/stringDisplayValue"
provider_case_reference:
type: 'string'
notificationAttachmentDetails:
allOf:
- $ref: "#/components/schemas/page"
type: 'object'
properties:
content:
type: 'array'
default: [ ]
items:
$ref: '#/components/schemas/baseNotificationAttachmentDetail'
baseNotificationAttachmentDetail:
type: 'object'
properties:
id:
type: 'integer'
provider_id:
type: 'string'
document_type:
$ref: '#/components/schemas/stringDisplayValue'
description:
type: 'string'
file_name:
type: 'string'
send_by:
type: 'string'
status:
type: 'string'
number:
type: 'integer'
format: 'int64'
notification_reference:
type: 'string'
audit_trail:
$ref: '#/components/schemas/auditDetail'
notificationAttachmentDetail:
type: 'object'
allOf:
- $ref: "#/components/schemas/baseNotificationAttachmentDetail"
properties:
file_data:
type: 'string'
evidenceDocumentDetails:
allOf:
- $ref: "#/components/schemas/page"
Expand Down
Loading

0 comments on commit 8ade4b0

Please sign in to comment.