diff --git a/api/services/ocean/aws/paths/clusters-roll.yaml b/api/services/ocean/aws/paths/clusters-roll.yaml index 215f338f6..a3be7bcc5 100644 --- a/api/services/ocean/aws/paths/clusters-roll.yaml +++ b/api/services/ocean/aws/paths/clusters-roll.yaml @@ -26,6 +26,7 @@ post: - $ref: "../schemas/roll/roll-comment.yaml" - $ref: "../schemas/roll/roll-respectPdb.yaml" - $ref: "../schemas/roll/roll-batchMinHealthyPercentage.yaml" + - $ref: "../schemas/roll/roll-reportPartialCompletion.yaml" - type: object title: 'Roll with instance ids' properties: @@ -36,6 +37,7 @@ post: - $ref: "../schemas/roll/roll-respectPdb.yaml" - $ref: "../schemas/roll/roll-batchMinHealthyPercentage.yaml" - $ref: "../schemas/roll/roll-instanceIds.yaml" + - $ref: "../schemas/roll/roll-reportPartialCompletion.yaml" - type: object title: 'Roll with Virtual Node Group ids' properties: @@ -47,6 +49,7 @@ post: - $ref: "../schemas/roll/roll-batchMinHealthyPercentage.yaml" - $ref: "../schemas/roll/roll-launchSpecIds.yaml" - $ref: "../schemas/roll/roll-disableLaunchSpecAutoScaling.yaml" + - $ref: "../schemas/roll/roll-reportPartialCompletion.yaml" responses: 200: $ref: "../responses/initiate-clusterRoll.yaml" diff --git a/api/services/ocean/aws/responses/clusterRollGetAllResponse.yaml b/api/services/ocean/aws/responses/clusterRollGetAllResponse.yaml index 76a6ea251..8ced5e337 100644 --- a/api/services/ocean/aws/responses/clusterRollGetAllResponse.yaml +++ b/api/services/ocean/aws/responses/clusterRollGetAllResponse.yaml @@ -30,7 +30,7 @@ content: example: Cluster status: type: string - enum: [IN_PROGRESS, COMPLETED, FAILED, STOPPED] + enum: [IN_PROGRESS, COMPLETED, PARTIALLY_COMPLETED, FAILED, STOPPED] example: IN_PROGRESS currentBatch: type: integer @@ -94,6 +94,9 @@ content: batchMinHealthyPercentage: type: integer example: 100 + reportPartialCompletion: + type: boolean + example: true createdAt: type: string example: 2019-03-24T15:46:09.000Z diff --git a/api/services/ocean/aws/responses/initiate-clusterRoll.yaml b/api/services/ocean/aws/responses/initiate-clusterRoll.yaml index 274ae3cd7..ba50af747 100644 --- a/api/services/ocean/aws/responses/initiate-clusterRoll.yaml +++ b/api/services/ocean/aws/responses/initiate-clusterRoll.yaml @@ -13,7 +13,7 @@ content: example: Cluster status: type: string - enum: [IN_PROGRESS, COMPLETED, FAILED, STOPPED] + enum: [IN_PROGRESS, COMPLETED, PARTIALLY_COMPLETED, FAILED, STOPPED] example: IN_PROGRESS currentBatch: type: integer @@ -77,6 +77,9 @@ content: batchMinHealthyPercentage: type: integer example: 100 + reportPartialCompletion: + type: boolean + example: true createdAt: type: string example: 2019-03-24T15:46:09.000Z diff --git a/api/services/ocean/aws/schemas/roll/roll-reportPartialCompletion.yaml b/api/services/ocean/aws/schemas/roll/roll-reportPartialCompletion.yaml new file mode 100644 index 000000000..bff500e77 --- /dev/null +++ b/api/services/ocean/aws/schemas/roll/roll-reportPartialCompletion.yaml @@ -0,0 +1,8 @@ +type: object +properties: + reportPartialCompletion: + type: boolean + description: > + When set to true, a roll that ends with a mixed result of successfully and unsuccessfully replaced instances is reported as PARTIALLY_COMPLETED. When set to false, a mixed result is reported as FAILED. + example: true + default: false