Commit aed63b14 authored by Brendan Hassett's avatar Brendan Hassett
Browse files

Edit TS28572_PlanManagement.yaml

parent 6e3e0097

OpenAPI/TS28572_PlanManagement.yaml

+26 −7
Original line number Diff line number Diff line
@@ -761,23 +761,27 @@ paths: 
    patch:

      tags:

        - Activation Management

      summary: Cancel the activation job 

      description: Cancel the activation job

      operationId: cancelActivationJobById      

      summary: Cancel or retry the activation job 

      description: Cancelor retry the activation job

      operationId: cancelRetryActivationJobById      

      requestBody:

        required: true

        content:

          application/json:

            schema:

              $ref: '#/components/schemas/CancelRequest'  

              oneOf:

                - $ref: '#/components/schemas/CancelRequest'  

                - $ref: '#/components/schemas/RetryRequest'  

          application/merge-patch+json:

            schema:

              $ref: '#/components/schemas/CancelRequest'

              oneOf:

                - $ref: '#/components/schemas/CancelRequest'

                - $ref: '#/components/schemas/RetryRequest'

      responses:

        '202': 

          description: Job cancel request was accepted and cancellation is ongoing 

          description: Job cancel or retry request was accepted and cancellation or retry is ongoing 

        '204':

          description: Job cancel request was successfully completed 

          description: Job cancel or retry request was successfully completed 

        '404':

          description: Job not found.

          content:
@@ -1705,6 +1709,10 @@ components: 
              type: boolean

              description: This boolean attribute allows to request to cancel the activation process by setting its value to "True". Setting the value to "False" has no observable result. Once the value is set to "True" it is immutable

              default: false

            retryRequest:   

              type: boolean

              description: This boolean attribute allows to request to retry the activation process by setting its value to "True". Setting the value to "False" has no observable result.

              default: false

            createdFallbackConfigDescrId:   

              type: string

              description: Id of the created Fallback Plan Configuration Descriptor
@@ -2359,6 +2367,17 @@ components: 
      # This ensures no other fields (like status or priority) can be sent in this specific PATCH

      additionalProperties: false



    RetryRequest:

      type: object

      properties:

        retryRequest:

          type: boolean

          description: Must be set to true to initiate retry.

      required:

        - retryRequest

      # This ensures no other fields (like status or priority) can be sent in this specific PATCH

      additionalProperties: false



    ErrorDetail:

      type: object

      properties: