Swagger open api macro | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
openapi: 3.0.0 info: title: Your API Title version: 1.0.0 description: Description of your API paths: /hierarchy: post: summary: Apply hierarchy operation description: Initiates a hierarchy apply process. requestBody: required: true content: requestBodyapplication/json: requiredschema: true contenttype: object application/json properties: schema entity: type: objectstring propertieshierId: entitytype: string hierarchyVars: type: stringarray decodeditems: type: object properties: name: type: string value: responses: type: string responses: '200': description: Hierarchy operation 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/status: get: summary: Get hierarchy status description: Retrieves the current status of a hierarchy operation. parameters: - in: query name: task schema: type: string required: true responses: '200': description: Current hierarchy status. content: application/json: schema: type: object properties: status: type: string '404': description: Task not found. /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: [] |
Page Comparison
General
Content
Integrations