Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Swagger open api macro
displayOperationIdfalse
methodsnone,get,put,post,delete,options,head,patch,trace
validator
defaultModelsExpandDepth1
url
token
defaultModelRenderingexample
filter
password
expandlist
showCommonExtensionsfalse
filename
operations
maxDisplayedTags
attachfalse
displayRequestDurationfalse
showExtensionsfalse
username
order
openapi: 3.0.0
info:
  title: Your SITC API Title
  version: 1.0.0
  description: Description of your APIApply Hierarchy, Get Apply Hierarchy Status, Create Scheduler, Update Scheduler

paths:
 /hierarchy:
  post:
    summary: Apply hierarchy operationby hierarchy ID
    description: Initiates a hierarchy apply process.
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              entity:
                type: string
                enum:
                  - hierarchy
              hierId:
                type: string
              hierarchyVars:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    value:
                      type: string
    responses:
      '200':
        description: Hierarchy operation Apply process has been initiated successfully.
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                message:
                  type: string
                taskId:
                  type: string
                details:
                  type: string
      '401':
        description: Unauthorized access.
      '503':
        description: Service unavailable.

  /hierarchy/scheduler:
    post:
      summary: Manage hierarchy scheduler
      description: Create, update, or delete hierarchy scheduler.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entity:
                  type: string
                type:
                  type: string
                scName:
                  type: string
                CRON:
                  type: string
      responses:
        '200':
          description: Scheduler managed successfully.
        '404':
          description: Scheduler or hierarchy not found.
        '501':
          description: Internal server error.

components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

security:
  - BearerAuth: []

...