[APPS-2853] Swagger Documentation for Retention Schedule V1 APIs

This commit is contained in:
Sathish Kumar
2024-05-30 19:41:32 +05:30
committed by suneet-gupta
parent b1d9ed8bec
commit fd04b94f82

View File

@@ -2637,19 +2637,19 @@ paths:
schema: schema:
$ref: '#/definitions/Error' $ref: '#/definitions/Error'
##retention-schedule ##retention-schedule
'/categories/{categoryId}/retention-schedules': '/record-categories/{categoryId}/retention-schedules':
post: post:
tags: tags:
- retention-schedule - retention-schedule
summary: Create a retention schedule summary: Create a retention schedule
description: | description: |
Create a retention schedule. Create a retention schedule.
For example, the following JSON body to create a retention schedule: For example, using the following JSON body will create a retention schedule:
```JSON ```JSON
{ {
"authority" : "Retention Authority", "authority" : "Retention Authority",
"instructions" : "Retention Instructions", "instructions" : "Retention Instructions",
"isRecordLevelDisposition" : false "isRecordLevel" : false
} }
``` ```
operationId: createRetentionSchedule operationId: createRetentionSchedule
@@ -4469,7 +4469,7 @@ definitions:
type: string type: string
instructions: instructions:
type: string type: string
isRecordLevelDisposition: isRecordLevel:
type: boolean type: boolean
RetentionScheduleResponse: RetentionScheduleResponse:
type: object type: object
@@ -4482,7 +4482,7 @@ definitions:
type: string type: string
instructions: instructions:
type: string type: string
isRecordLevelDisposition: isRecordLevel:
type: boolean type: boolean
unpublishedUpdates: unpublishedUpdates:
type: boolean type: boolean
@@ -4504,7 +4504,7 @@ definitions:
type: string type: string
instructions: instructions:
type: string type: string
isRecordLevelDisposition: isRecordLevel:
type: boolean type: boolean
unpublishedUpdates: unpublishedUpdates:
type: boolean type: boolean