From 6f0372cfb35d7f751eb3e8f2ea230d0f230e2b8f Mon Sep 17 00:00:00 2001 From: James Brooks Date: Tue, 21 Jan 2025 08:41:36 +0000 Subject: [PATCH] Delete api-reference/openapi.yaml --- api-reference/openapi.yaml | 4812 ------------------------------------ 1 file changed, 4812 deletions(-) delete mode 100644 api-reference/openapi.yaml diff --git a/api-reference/openapi.yaml b/api-reference/openapi.yaml deleted file mode 100644 index 2c17512..0000000 --- a/api-reference/openapi.yaml +++ /dev/null @@ -1,4812 +0,0 @@ -openapi: 3.0.3 -info: - title: Cachet - description: 'API documentation for Cachet, the open source status page system.' - version: 3.0.0 -servers: - - - url: 'http://cachet.test' -paths: - /api/ping: - get: - summary: 'Test the API' - operationId: testTheAPI - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: Pong! - properties: - data: - type: string - example: Pong! - tags: - - Cachet - security: [] - /api/version: - get: - summary: 'Get Version' - operationId: getVersion - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - version: 3.x-dev - properties: - data: - type: object - properties: - version: - type: string - example: 3.x-dev - tags: - - Cachet - security: [] - /api/status: - get: - summary: 'Get System Status' - operationId: getSystemStatus - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - status: operational - message: 'All Systems Operational' - properties: - data: - type: object - properties: - status: - type: string - example: operational - message: - type: string - example: 'All Systems Operational' - tags: - - Cachet - security: [] - /api/components: - get: - summary: 'List Components' - operationId: listComponents - description: '' - parameters: - - - in: query - name: per_page - description: 'How many items to show per page.' - example: 20 - required: false - schema: - type: integer - description: 'How many items to show per page.' - example: 20 - nullable: false - - - in: query - name: page - description: 'Which page to show.' - example: 2 - required: false - schema: - type: integer - description: 'Which page to show.' - example: 2 - nullable: false - - - in: query - name: sort - description: 'Field to sort by.' - example: name - required: false - schema: - type: string - description: 'Field to sort by.' - example: name - nullable: false - enum: - - name - - status - - enabled - - - in: query - name: include - description: 'Include related resources.' - example: 'group,incidents' - required: false - schema: - type: string - description: 'Include related resources.' - example: 'group,incidents' - nullable: false - enum: - - group - - incidents - - - in: query - name: 'filters[name]' - description: 'Filter by name.' - example: 'My Component' - required: false - schema: - type: string - description: 'Filter by name.' - example: 'My Component' - nullable: false - - - in: query - name: 'filters[status]' - description: 'Filter by status.' - example: '1' - required: false - schema: - type: string - description: 'Filter by status.' - example: '1' - nullable: false - enum: - - '1' - - '2' - - '3' - - - in: query - name: 'filters[enabled]' - description: 'Filter by enabled status.' - example: '1' - required: false - schema: - type: string - description: 'Filter by enabled status.' - example: '1' - nullable: false - enum: - - '0' - - '1' - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - - - id: '1' - type: components - attributes: - id: 1 - name: natus - description: 'Quos quo et aut aut. Omnis mollitia dolor aut minus non rerum. Doloremque dolor aliquam omnis sunt reprehenderit. In et accusamus quis dolore atque qui necessitatibus.' - link: null - order: 0 - status: 2 - enabled: true - meta: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: components - attributes: - id: 2 - name: in - description: 'Sit optio voluptatem est debitis quaerat. In aut cumque voluptatum quod provident. Quia quaerat autem rerum qui.' - link: null - order: 0 - status: 2 - enabled: true - meta: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: array - example: - - - id: '1' - type: components - attributes: - id: 1 - name: natus - description: 'Quos quo et aut aut. Omnis mollitia dolor aut minus non rerum. Doloremque dolor aliquam omnis sunt reprehenderit. In et accusamus quis dolore atque qui necessitatibus.' - link: null - order: 0 - status: 2 - enabled: true - meta: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: components - attributes: - id: 2 - name: in - description: 'Sit optio voluptatem est debitis quaerat. In aut cumque voluptatum quod provident. Quia quaerat autem rerum qui.' - link: null - order: 0 - status: 2 - enabled: true - meta: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - items: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: components - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: natus - description: - type: string - example: 'Quos quo et aut aut. Omnis mollitia dolor aut minus non rerum. Doloremque dolor aliquam omnis sunt reprehenderit. In et accusamus quis dolore atque qui necessitatibus.' - link: - type: string - example: null - order: - type: integer - example: 0 - status: - type: integer - example: 2 - enabled: - type: boolean - example: true - meta: - type: string - example: null - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Components - security: [] - post: - summary: 'Create Component' - operationId: createComponent - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: components - attributes: - id: 1 - name: ipsam - description: 'Dolorem quibusdam labore at dolores labore distinctio atque dolorem. In voluptatibus architecto dolorum omnis.' - link: null - order: 0 - status: 2 - enabled: true - meta: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: components - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: ipsam - description: - type: string - example: 'Dolorem quibusdam labore at dolores labore distinctio atque dolorem. In voluptatibus architecto dolorum omnis.' - link: - type: string - example: null - order: - type: integer - example: 0 - status: - type: integer - example: 2 - enabled: - type: boolean - example: true - meta: - type: string - example: null - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Components - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: 'Must not be greater than 255 characters.' - example: leyyymoxrcsu - nullable: false - required: - - name - '/api/components/{id}': - get: - summary: 'Get Component' - operationId: getComponent - description: '' - parameters: - - - in: query - name: include - description: 'Include related resources.' - example: 'group,incidents' - required: false - schema: - type: string - description: 'Include related resources.' - example: 'group,incidents' - nullable: false - enum: - - group - - incidents - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: components - attributes: - id: 1 - name: dolor - description: 'Molestiae dolores sunt eveniet cum aut porro temporibus ipsam. A dolorem quibusdam labore. Dolores labore distinctio atque dolorem velit in voluptatibus. Dolorum omnis repudiandae culpa. Velit quos aut blanditiis fugit nobis.' - link: null - order: 0 - status: 2 - enabled: true - meta: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: components - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: dolor - description: - type: string - example: 'Molestiae dolores sunt eveniet cum aut porro temporibus ipsam. A dolorem quibusdam labore. Dolores labore distinctio atque dolorem velit in voluptatibus. Dolorum omnis repudiandae culpa. Velit quos aut blanditiis fugit nobis.' - link: - type: string - example: null - order: - type: integer - example: 0 - status: - type: integer - example: 2 - enabled: - type: boolean - example: true - meta: - type: string - example: null - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Components - security: [] - put: - summary: 'Update Component' - operationId: updateComponent - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: components - attributes: - id: 1 - name: atque - description: 'In voluptatibus architecto dolorum omnis. Culpa laboriosam velit quos aut blanditiis fugit nobis maiores. Consequatur a at facilis ut error qui provident qui.' - link: null - order: 0 - status: 2 - enabled: true - meta: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: components - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: atque - description: - type: string - example: 'In voluptatibus architecto dolorum omnis. Culpa laboriosam velit quos aut blanditiis fugit nobis maiores. Consequatur a at facilis ut error qui provident qui.' - link: - type: string - example: null - order: - type: integer - example: 0 - status: - type: integer - example: 2 - enabled: - type: boolean - example: true - meta: - type: string - example: null - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Components - delete: - summary: 'Delete Component' - operationId: deleteComponent - description: '' - parameters: [] - responses: - 204: - description: '' - tags: - - Components - parameters: - - - in: path - name: id - description: 'The ID of the component.' - example: 10 - required: true - schema: - type: integer - /api/component-groups: - get: - summary: 'List Component Groups' - operationId: listComponentGroups - description: '' - parameters: - - - in: query - name: per_page - description: 'How many items to show per page.' - example: 20 - required: false - schema: - type: integer - description: 'How many items to show per page.' - example: 20 - nullable: false - - - in: query - name: page - description: 'Which page to show.' - example: 2 - required: false - schema: - type: integer - description: 'Which page to show.' - example: 2 - nullable: false - - - in: query - name: sort - description: 'Field to sort by.' - example: name - required: false - schema: - type: string - description: 'Field to sort by.' - example: name - nullable: false - enum: - - name - - id - - - in: query - name: include - description: 'Include related resources.' - example: components - required: false - schema: - type: string - description: 'Include related resources.' - example: components - nullable: false - enum: - - components - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: componentGroups - attributes: - id: 1 - name: atque - order: 0 - visible: 0 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: componentGroups - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: atque - order: - type: integer - example: 0 - visible: - type: integer - example: 0 - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Component Groups' - security: [] - post: - summary: 'Create Component Group' - operationId: createComponentGroup - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: componentGroups - attributes: - id: 1 - name: consequatur - order: 0 - visible: 0 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: componentGroups - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: consequatur - order: - type: integer - example: 0 - visible: - type: integer - example: 0 - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Component Groups' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: 'Must not be greater than 255 characters.' - example: leyyymoxrcsu - nullable: false - components: - type: array - description: 'The id of an existing record in the components table. Must be at least 0.' - example: - - 28 - items: - type: integer - required: - - name - '/api/component-groups/{id}': - get: - summary: 'Get Component Group' - operationId: getComponentGroup - description: '' - parameters: - - - in: query - name: include - description: 'Include related resources.' - example: components - required: false - schema: - type: string - description: 'Include related resources.' - example: components - nullable: false - enum: - - components - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: componentGroups - attributes: - id: 1 - name: dolor - order: 0 - visible: 0 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: componentGroups - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: dolor - order: - type: integer - example: 0 - visible: - type: integer - example: 0 - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Component Groups' - security: [] - put: - summary: 'Update Component Group' - operationId: updateComponentGroup - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: componentGroups - attributes: - id: 1 - name: dolor - order: 0 - visible: 0 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: componentGroups - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: dolor - order: - type: integer - example: 0 - visible: - type: integer - example: 0 - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Component Groups' - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - components: - type: array - description: 'The id of an existing record in the components table. Must be at least 0.' - example: - - 41 - items: - type: integer - delete: - summary: 'Delete Component Group' - operationId: deleteComponentGroup - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: componentGroups - attributes: - id: 1 - name: atque - order: 0 - visible: 0 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: componentGroups - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: atque - order: - type: integer - example: 0 - visible: - type: integer - example: 0 - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Component Groups' - parameters: - - - in: path - name: id - description: 'The ID of the component group.' - example: 10 - required: true - schema: - type: integer - /api/incidents: - get: - summary: 'List Incidents' - operationId: listIncidents - description: '' - parameters: - - - in: query - name: per_page - description: 'How many items to show per page.' - example: 20 - required: false - schema: - type: integer - description: 'How many items to show per page.' - example: 20 - nullable: false - - - in: query - name: page - description: 'Which page to show.' - example: 2 - required: false - schema: - type: integer - description: 'Which page to show.' - example: 2 - nullable: false - - - in: query - name: sort - description: 'Field to sort by.' - example: status - required: false - schema: - type: string - description: 'Field to sort by.' - example: status - nullable: false - enum: - - name - - id - - status - - - in: query - name: include - description: 'Include related resources.' - example: updates - required: false - schema: - type: string - description: 'Include related resources.' - example: updates - nullable: false - enum: - - components - - updates - - user - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - - - id: '1' - type: incidents - attributes: - id: 1 - guid: 0e81af01-a3e4-4674-ae54-f79a3f5fe034 - name: 'Voluptatibus architecto dolorum omnis repudiandae culpa.' - message: 'Quos aut blanditiis fugit nobis. Sint consequatur a at facilis ut error qui provident. Quia nam dignissimos vel est ut.' - component_id: null - visible: 1 - stickied: false - notifications: 0 - status: - human: Identified - value: 2 - occurred: - human: null - string: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: incidents - attributes: - id: 2 - guid: a8e26d76-d83e-4c2f-8242-a23defc3d088 - name: 'Magni commodi esse accusamus reprehenderit consequuntur sequi.' - message: 'Quo totam aliquid et porro magnam. Vero voluptatem neque quod sit doloribus sed qui. Suscipit corrupti autem necessitatibus consectetur repellat explicabo ut. Ut mollitia et magni sed.' - component_id: null - visible: 1 - stickied: false - notifications: 0 - status: - human: Identified - value: 2 - occurred: - human: null - string: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: array - example: - - - id: '1' - type: incidents - attributes: - id: 1 - guid: 0e81af01-a3e4-4674-ae54-f79a3f5fe034 - name: 'Voluptatibus architecto dolorum omnis repudiandae culpa.' - message: 'Quos aut blanditiis fugit nobis. Sint consequatur a at facilis ut error qui provident. Quia nam dignissimos vel est ut.' - component_id: null - visible: 1 - stickied: false - notifications: 0 - status: - human: Identified - value: 2 - occurred: - human: null - string: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: incidents - attributes: - id: 2 - guid: a8e26d76-d83e-4c2f-8242-a23defc3d088 - name: 'Magni commodi esse accusamus reprehenderit consequuntur sequi.' - message: 'Quo totam aliquid et porro magnam. Vero voluptatem neque quod sit doloribus sed qui. Suscipit corrupti autem necessitatibus consectetur repellat explicabo ut. Ut mollitia et magni sed.' - component_id: null - visible: 1 - stickied: false - notifications: 0 - status: - human: Identified - value: 2 - occurred: - human: null - string: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - items: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: incidents - attributes: - type: object - properties: - id: - type: integer - example: 1 - guid: - type: string - example: 0e81af01-a3e4-4674-ae54-f79a3f5fe034 - name: - type: string - example: 'Voluptatibus architecto dolorum omnis repudiandae culpa.' - message: - type: string - example: 'Quos aut blanditiis fugit nobis. Sint consequatur a at facilis ut error qui provident. Quia nam dignissimos vel est ut.' - component_id: - type: string - example: null - visible: - type: integer - example: 1 - stickied: - type: boolean - example: false - notifications: - type: integer - example: 0 - status: - type: object - properties: - human: - type: string - example: Identified - value: - type: integer - example: 2 - occurred: - type: object - properties: - human: - type: string - example: null - string: - type: string - example: null - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Incidents - security: [] - post: - summary: 'Create Incident' - operationId: createIncident - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: incidents - attributes: - id: 1 - guid: e9335317-c6c6-4adb-98d5-1212bb8c1370 - name: 'Dolorem quibusdam labore at dolores labore distinctio atque dolorem.' - message: 'Voluptatibus architecto dolorum omnis repudiandae culpa. Velit quos aut blanditiis fugit nobis. Sint consequatur a at facilis ut error qui provident.' - component_id: null - visible: 1 - stickied: false - notifications: 0 - status: - human: Identified - value: 2 - occurred: - human: null - string: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: incidents - attributes: - type: object - properties: - id: - type: integer - example: 1 - guid: - type: string - example: e9335317-c6c6-4adb-98d5-1212bb8c1370 - name: - type: string - example: 'Dolorem quibusdam labore at dolores labore distinctio atque dolorem.' - message: - type: string - example: 'Voluptatibus architecto dolorum omnis repudiandae culpa. Velit quos aut blanditiis fugit nobis. Sint consequatur a at facilis ut error qui provident.' - component_id: - type: string - example: null - visible: - type: integer - example: 1 - stickied: - type: boolean - example: false - notifications: - type: integer - example: 0 - status: - type: object - properties: - human: - type: string - example: Identified - value: - type: integer - example: 2 - occurred: - type: object - properties: - human: - type: string - example: null - string: - type: string - example: null - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Incidents - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: 'Must not be greater than 255 characters.' - example: leyyymoxrcsu - nullable: false - required: - - name - '/api/incidents/{id}': - get: - summary: 'Get Incident' - operationId: getIncident - description: '' - parameters: - - - in: query - name: include - description: 'Include related resources.' - example: updates - required: false - schema: - type: string - description: 'Include related resources.' - example: updates - nullable: false - enum: - - components - - updates - - user - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: incidents - attributes: - id: 1 - guid: b6e850ea-d4b6-4f5f-88bb-225e7b5f67cb - name: 'Molestiae dolores sunt eveniet cum aut porro temporibus ipsam.' - message: 'Dolorem quibusdam labore at dolores labore distinctio atque dolorem. In voluptatibus architecto dolorum omnis.' - component_id: null - visible: 1 - stickied: false - notifications: 0 - status: - human: Identified - value: 2 - occurred: - human: null - string: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: incidents - attributes: - type: object - properties: - id: - type: integer - example: 1 - guid: - type: string - example: b6e850ea-d4b6-4f5f-88bb-225e7b5f67cb - name: - type: string - example: 'Molestiae dolores sunt eveniet cum aut porro temporibus ipsam.' - message: - type: string - example: 'Dolorem quibusdam labore at dolores labore distinctio atque dolorem. In voluptatibus architecto dolorum omnis.' - component_id: - type: string - example: null - visible: - type: integer - example: 1 - stickied: - type: boolean - example: false - notifications: - type: integer - example: 0 - status: - type: object - properties: - human: - type: string - example: Identified - value: - type: integer - example: 2 - occurred: - type: object - properties: - human: - type: string - example: null - string: - type: string - example: null - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Incidents - security: [] - put: - summary: 'Update Incident' - operationId: updateIncident - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: incidents - attributes: - id: 1 - guid: 0462b224-0c3a-4ba8-af31-9d3d3eb3b222 - name: 'Dolorem quibusdam labore at dolores labore distinctio atque dolorem.' - message: 'Voluptatibus architecto dolorum omnis repudiandae culpa. Velit quos aut blanditiis fugit nobis. Sint consequatur a at facilis ut error qui provident.' - component_id: null - visible: 1 - stickied: false - notifications: 0 - status: - human: Identified - value: 2 - occurred: - human: null - string: null - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: incidents - attributes: - type: object - properties: - id: - type: integer - example: 1 - guid: - type: string - example: 0462b224-0c3a-4ba8-af31-9d3d3eb3b222 - name: - type: string - example: 'Dolorem quibusdam labore at dolores labore distinctio atque dolorem.' - message: - type: string - example: 'Voluptatibus architecto dolorum omnis repudiandae culpa. Velit quos aut blanditiis fugit nobis. Sint consequatur a at facilis ut error qui provident.' - component_id: - type: string - example: null - visible: - type: integer - example: 1 - stickied: - type: boolean - example: false - notifications: - type: integer - example: 0 - status: - type: object - properties: - human: - type: string - example: Identified - value: - type: integer - example: 2 - occurred: - type: object - properties: - human: - type: string - example: null - string: - type: string - example: null - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Incidents - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: 'Must not be greater than 255 characters.' - example: leyyymoxrcsu - nullable: false - delete: - summary: 'Delete Incident' - operationId: deleteIncident - description: '' - parameters: [] - responses: - 204: - description: '' - tags: - - Incidents - parameters: - - - in: path - name: id - description: 'The ID of the incident.' - example: 10 - required: true - schema: - type: integer - '/api/incidents/{incident_id}/updates': - get: - summary: 'List Incident Updates' - operationId: listIncidentUpdates - description: '' - parameters: - - - in: query - name: per_page - description: 'How many items to show per page.' - example: 20 - required: false - schema: - type: integer - description: 'How many items to show per page.' - example: 20 - nullable: false - - - in: query - name: page - description: 'Which page to show.' - example: 2 - required: false - schema: - type: integer - description: 'Which page to show.' - example: 2 - nullable: false - - - in: query - name: sort - description: 'Field to sort by.' - example: name - required: false - schema: - type: string - description: 'Field to sort by.' - example: name - nullable: false - enum: - - name - - created_at - - - in: query - name: include - description: 'Include related resources.' - example: incident - required: false - schema: - type: string - description: 'Include related resources.' - example: incident - nullable: false - enum: - - incident - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - - - id: '1' - type: updates - attributes: - id: 1 - updateable_id: 1 - updateable_type: incident - message: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: updates - attributes: - id: 2 - updateable_id: 2 - updateable_type: incident - message: 'Distinctio magni commodi esse accusamus reprehenderit consequuntur sequi. Ea quo totam aliquid et porro magnam. Vero voluptatem neque quod sit doloribus sed qui.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: array - example: - - - id: '1' - type: updates - attributes: - id: 1 - updateable_id: 1 - updateable_type: incident - message: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: updates - attributes: - id: 2 - updateable_id: 2 - updateable_type: incident - message: 'Distinctio magni commodi esse accusamus reprehenderit consequuntur sequi. Ea quo totam aliquid et porro magnam. Vero voluptatem neque quod sit doloribus sed qui.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - items: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: updates - attributes: - type: object - properties: - id: - type: integer - example: 1 - updateable_id: - type: integer - example: 1 - updateable_type: - type: string - example: incident - message: - type: string - example: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Incident Updates' - security: [] - post: - summary: 'Create Incident Update' - operationId: createIncidentUpdate - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: updates - attributes: - id: 1 - updateable_id: 1 - updateable_type: incident - message: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: updates - attributes: - type: object - properties: - id: - type: integer - example: 1 - updateable_id: - type: integer - example: 1 - updateable_type: - type: string - example: incident - message: - type: string - example: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Incident Updates' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - status: - type: integer - description: '' - example: 4 - nullable: false - enum: - - 0 - - 1 - - 2 - - 3 - - 4 - message: - type: string - description: '' - example: qui - nullable: false - required: - - status - - message - parameters: - - - in: path - name: incident_id - description: 'The ID of the incident.' - example: 10 - required: true - schema: - type: integer - '/api/incidents/{incident_id}/updates/{id}': - get: - summary: 'Get Incident Update' - operationId: getIncidentUpdate - description: '' - parameters: - - - in: query - name: include - description: 'Include related resources.' - example: incident - required: false - schema: - type: string - description: 'Include related resources.' - example: incident - nullable: false - enum: - - incident - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: updates - attributes: - id: 1 - updateable_id: 1 - updateable_type: incident - message: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: updates - attributes: - type: object - properties: - id: - type: integer - example: 1 - updateable_id: - type: integer - example: 1 - updateable_type: - type: string - example: incident - message: - type: string - example: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Incident Updates' - security: [] - put: - summary: 'Update Incident Update' - operationId: updateIncidentUpdate - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: updates - attributes: - id: 1 - updateable_id: 1 - updateable_type: incident - message: 'Velit in voluptatibus architecto dolorum. Repudiandae culpa laboriosam velit quos aut blanditiis fugit. Maiores sint consequatur a at facilis ut.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: updates - attributes: - type: object - properties: - id: - type: integer - example: 1 - updateable_id: - type: integer - example: 1 - updateable_type: - type: string - example: incident - message: - type: string - example: 'Velit in voluptatibus architecto dolorum. Repudiandae culpa laboriosam velit quos aut blanditiis fugit. Maiores sint consequatur a at facilis ut.' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Incident Updates' - delete: - summary: 'Delete Incident Update' - operationId: deleteIncidentUpdate - description: '' - parameters: [] - responses: - 204: - description: '' - tags: - - 'Incident Updates' - parameters: - - - in: path - name: incident_id - description: 'The ID of the incident.' - example: 10 - required: true - schema: - type: integer - - - in: path - name: id - description: 'The ID of the update.' - example: 10 - required: true - schema: - type: integer - /api/incident-templates: - get: - summary: 'List Incident Templates' - operationId: listIncidentTemplates - description: '' - parameters: - - - in: query - name: per_page - description: 'How many items to show per page.' - example: 20 - required: false - schema: - type: integer - description: 'How many items to show per page.' - example: 20 - nullable: false - - - in: query - name: page - description: 'Which page to show.' - example: 2 - required: false - schema: - type: integer - description: 'Which page to show.' - example: 2 - nullable: false - - - in: query - name: sort - description: 'Field to sort by.' - example: name - required: false - schema: - type: string - description: 'Field to sort by.' - example: name - nullable: false - enum: - - name - - slug - - id - - - in: query - name: 'filters[name]' - description: 'Filter by name.' - example: 'My Template' - required: false - schema: - type: string - description: 'Filter by name.' - example: 'My Template' - nullable: false - - - in: query - name: 'filters[slug]' - description: 'Filter by slug.' - example: my-template - required: false - schema: - type: string - description: 'Filter by slug.' - example: my-template - nullable: false - - - in: query - name: 'filters[id]' - description: 'Filter by id.' - example: 1 - required: false - schema: - type: integer - description: 'Filter by id.' - example: 1 - nullable: false - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - - - id: '1' - type: incidentTemplates - attributes: - id: 1 - name: 'atque dolorem' - slug: atque-dolorem - template: 'This is an incident template.' - engine: twig - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: incidentTemplates - attributes: - id: 2 - name: 'velit in' - slug: velit-in - template: 'This is an incident template.' - engine: twig - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: array - example: - - - id: '1' - type: incidentTemplates - attributes: - id: 1 - name: 'atque dolorem' - slug: atque-dolorem - template: 'This is an incident template.' - engine: twig - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: incidentTemplates - attributes: - id: 2 - name: 'velit in' - slug: velit-in - template: 'This is an incident template.' - engine: twig - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - items: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: incidentTemplates - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'atque dolorem' - slug: - type: string - example: atque-dolorem - template: - type: string - example: 'This is an incident template.' - engine: - type: string - example: twig - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Incident Templates' - security: [] - post: - summary: 'Create Incident Template' - operationId: createIncidentTemplate - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: incidentTemplates - attributes: - id: 1 - name: 'dolor tenetur' - slug: dolor-tenetur - template: 'This is an incident template.' - engine: twig - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: incidentTemplates - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'dolor tenetur' - slug: - type: string - example: dolor-tenetur - template: - type: string - example: 'This is an incident template.' - engine: - type: string - example: twig - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Incident Templates' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: 'Must not be greater than 255 characters.' - example: leyyymoxrcsu - nullable: false - template: - type: string - description: '' - example: qui - nullable: false - required: - - name - - template - '/api/incident-templates/{id}': - get: - summary: 'Get Incident Template' - operationId: getIncidentTemplate - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: incidentTemplates - attributes: - id: 1 - name: 'dolor tenetur' - slug: dolor-tenetur - template: 'This is an incident template.' - engine: twig - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: incidentTemplates - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'dolor tenetur' - slug: - type: string - example: dolor-tenetur - template: - type: string - example: 'This is an incident template.' - engine: - type: string - example: twig - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Incident Templates' - security: [] - put: - summary: 'Update Incident Template' - operationId: updateIncidentTemplate - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: incidentTemplates - attributes: - id: 1 - name: 'atque dolorem' - slug: atque-dolorem - template: 'This is an incident template.' - engine: twig - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: incidentTemplates - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'atque dolorem' - slug: - type: string - example: atque-dolorem - template: - type: string - example: 'This is an incident template.' - engine: - type: string - example: twig - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Incident Templates' - delete: - summary: 'Delete Incident Template' - operationId: deleteIncidentTemplate - description: '' - parameters: [] - responses: - 204: - description: '' - tags: - - 'Incident Templates' - parameters: - - - in: path - name: id - description: 'The ID of the incident template.' - example: 10 - required: true - schema: - type: integer - /api/metrics: - get: - summary: 'List Metrics' - operationId: listMetrics - description: '' - parameters: - - - in: query - name: per_page - description: 'How many items to show per page.' - example: 20 - required: false - schema: - type: integer - description: 'How many items to show per page.' - example: 20 - nullable: false - - - in: query - name: page - description: 'Which page to show.' - example: 2 - required: false - schema: - type: integer - description: 'Which page to show.' - example: 2 - nullable: false - - - in: query - name: sort - description: 'Field to sort by.' - example: name - required: false - schema: - type: string - description: 'Field to sort by.' - example: name - nullable: false - enum: - - name - - order - - id - - - in: query - name: include - description: 'Include related resources.' - example: points - required: false - schema: - type: string - description: 'Include related resources.' - example: points - nullable: false - enum: - - points - - - in: query - name: 'filters[name]' - description: 'Filter by name.' - example: 'metric name' - required: false - schema: - type: string - description: 'Filter by name.' - example: 'metric name' - nullable: false - - - in: query - name: 'filters[calc_type]' - description: '' - example: 'sum,avg' - required: false - schema: - type: string - description: '' - example: 'sum,avg' - nullable: false - enum: - - 'Cachet\Enums\MetricTypeEnum Filter by calculation type' - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - - - id: '1' - type: metrics - attributes: - id: 1 - name: 'Cups of coffee' - suffix: cups - description: 'How many cups of coffee consumed by the team.' - default_value: 1 - calc_type: 0 - display_chart: true - places: 2 - default_view: 1 - threshold: 5 - order: 0 - visible: 1 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: metrics - attributes: - id: 2 - name: 'Cups of coffee' - suffix: cups - description: 'How many cups of coffee consumed by the team.' - default_value: 1 - calc_type: 0 - display_chart: true - places: 2 - default_view: 1 - threshold: 5 - order: 0 - visible: 1 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: array - example: - - - id: '1' - type: metrics - attributes: - id: 1 - name: 'Cups of coffee' - suffix: cups - description: 'How many cups of coffee consumed by the team.' - default_value: 1 - calc_type: 0 - display_chart: true - places: 2 - default_view: 1 - threshold: 5 - order: 0 - visible: 1 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: metrics - attributes: - id: 2 - name: 'Cups of coffee' - suffix: cups - description: 'How many cups of coffee consumed by the team.' - default_value: 1 - calc_type: 0 - display_chart: true - places: 2 - default_view: 1 - threshold: 5 - order: 0 - visible: 1 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - items: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: metrics - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'Cups of coffee' - suffix: - type: string - example: cups - description: - type: string - example: 'How many cups of coffee consumed by the team.' - default_value: - type: integer - example: 1 - calc_type: - type: integer - example: 0 - display_chart: - type: boolean - example: true - places: - type: integer - example: 2 - default_view: - type: integer - example: 1 - threshold: - type: integer - example: 5 - order: - type: integer - example: 0 - visible: - type: integer - example: 1 - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Metrics - security: [] - post: - summary: 'Create Metric' - operationId: createMetric - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: metrics - attributes: - id: 1 - name: 'Cups of coffee' - suffix: cups - description: 'How many cups of coffee consumed by the team.' - default_value: 1 - calc_type: 0 - display_chart: true - places: 2 - default_view: 1 - threshold: 5 - order: 0 - visible: 1 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: metrics - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'Cups of coffee' - suffix: - type: string - example: cups - description: - type: string - example: 'How many cups of coffee consumed by the team.' - default_value: - type: integer - example: 1 - calc_type: - type: integer - example: 0 - display_chart: - type: boolean - example: true - places: - type: integer - example: 2 - default_view: - type: integer - example: 1 - threshold: - type: integer - example: 5 - order: - type: integer - example: 0 - visible: - type: integer - example: 1 - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Metrics - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: 'Must not be greater than 255 characters.' - example: leyyymoxrcsu - nullable: false - suffix: - type: string - description: 'Must not be greater than 255 characters.' - example: iayvugwdgrme - nullable: false - required: - - name - - suffix - '/api/metrics/{id}': - get: - summary: 'Get Metric' - operationId: getMetric - description: '' - parameters: - - - in: query - name: include - description: 'Include related resources.' - example: points - required: false - schema: - type: string - description: 'Include related resources.' - example: points - nullable: false - enum: - - points - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: metrics - attributes: - id: 1 - name: 'Cups of coffee' - suffix: cups - description: 'How many cups of coffee consumed by the team.' - default_value: 1 - calc_type: 0 - display_chart: true - places: 2 - default_view: 1 - threshold: 5 - order: 0 - visible: 1 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: metrics - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'Cups of coffee' - suffix: - type: string - example: cups - description: - type: string - example: 'How many cups of coffee consumed by the team.' - default_value: - type: integer - example: 1 - calc_type: - type: integer - example: 0 - display_chart: - type: boolean - example: true - places: - type: integer - example: 2 - default_view: - type: integer - example: 1 - threshold: - type: integer - example: 5 - order: - type: integer - example: 0 - visible: - type: integer - example: 1 - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Metrics - security: [] - put: - summary: 'Update Metric' - operationId: updateMetric - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: metrics - attributes: - id: 1 - name: 'Cups of coffee' - suffix: cups - description: 'How many cups of coffee consumed by the team.' - default_value: 1 - calc_type: 0 - display_chart: true - places: 2 - default_view: 1 - threshold: 5 - order: 0 - visible: 1 - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: metrics - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'Cups of coffee' - suffix: - type: string - example: cups - description: - type: string - example: 'How many cups of coffee consumed by the team.' - default_value: - type: integer - example: 1 - calc_type: - type: integer - example: 0 - display_chart: - type: boolean - example: true - places: - type: integer - example: 2 - default_view: - type: integer - example: 1 - threshold: - type: integer - example: 5 - order: - type: integer - example: 0 - visible: - type: integer - example: 1 - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Metrics - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: 'Must not be greater than 255 characters.' - example: leyyymoxrcsu - nullable: false - required: - - name - delete: - summary: 'Delete Metric' - operationId: deleteMetric - description: '' - parameters: [] - responses: - 204: - description: '' - tags: - - Metrics - parameters: - - - in: path - name: id - description: 'The ID of the metric.' - example: 10 - required: true - schema: - type: integer - '/api/metrics/{metric_id}/points': - get: - summary: 'List Metric Points' - operationId: listMetricPoints - description: '' - parameters: - - - in: query - name: per_page - description: 'How many items to show per page.' - example: 20 - required: false - schema: - type: integer - description: 'How many items to show per page.' - example: 20 - nullable: false - - - in: query - name: page - description: 'Which page to show.' - example: 2 - required: false - schema: - type: integer - description: 'Which page to show.' - example: 2 - nullable: false - - - in: query - name: sort - description: 'Field to sort by.' - example: name - required: false - schema: - type: string - description: 'Field to sort by.' - example: name - nullable: false - enum: - - name - - order - - id - - - in: query - name: include - description: 'Include related resources.' - example: metric - required: false - schema: - type: string - description: 'Include related resources.' - example: metric - nullable: false - enum: - - metric - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - - - id: '1' - type: metricPoints - attributes: - id: 1 - metric_id: 1 - calculated_value: 1 - value: 1 - counter: 1 - created: - human: '6 seconds from now' - string: '2025-01-05 20:06:30' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: metricPoints - attributes: - id: 2 - metric_id: 2 - calculated_value: 1 - value: 1 - counter: 1 - created: - human: '6 seconds from now' - string: '2025-01-05 20:06:30' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: array - example: - - - id: '1' - type: metricPoints - attributes: - id: 1 - metric_id: 1 - calculated_value: 1 - value: 1 - counter: 1 - created: - human: '6 seconds from now' - string: '2025-01-05 20:06:30' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: metricPoints - attributes: - id: 2 - metric_id: 2 - calculated_value: 1 - value: 1 - counter: 1 - created: - human: '6 seconds from now' - string: '2025-01-05 20:06:30' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - items: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: metricPoints - attributes: - type: object - properties: - id: - type: integer - example: 1 - metric_id: - type: integer - example: 1 - calculated_value: - type: integer - example: 1 - value: - type: integer - example: 1 - counter: - type: integer - example: 1 - created: - type: object - properties: - human: - type: string - example: '6 seconds from now' - string: - type: string - example: '2025-01-05 20:06:30' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Metric Points' - security: [] - post: - summary: 'Create Metric Point' - operationId: createMetricPoint - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: metricPoints - attributes: - id: 1 - metric_id: 1 - calculated_value: 1 - value: 1 - counter: 1 - created: - human: '6 seconds from now' - string: '2025-01-05 20:06:30' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: metricPoints - attributes: - type: object - properties: - id: - type: integer - example: 1 - metric_id: - type: integer - example: 1 - calculated_value: - type: integer - example: 1 - value: - type: integer - example: 1 - counter: - type: integer - example: 1 - created: - type: object - properties: - human: - type: string - example: '6 seconds from now' - string: - type: string - example: '2025-01-05 20:06:30' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Metric Points' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - value: - type: number - description: '' - example: 89.686 - nullable: false - required: - - value - parameters: - - - in: path - name: metric_id - description: 'The ID of the metric.' - example: 10 - required: true - schema: - type: integer - '/api/metrics/{metric_id}/points/{metricPoint_id}': - get: - summary: 'Get Metric Point' - operationId: getMetricPoint - description: '' - parameters: - - - in: query - name: include - description: 'Include related resources.' - example: metric - required: false - schema: - type: string - description: 'Include related resources.' - example: metric - nullable: false - enum: - - metric - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: metricPoints - attributes: - id: 1 - metric_id: 1 - calculated_value: 1 - value: 1 - counter: 1 - created: - human: '6 seconds from now' - string: '2025-01-05 20:06:30' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: metricPoints - attributes: - type: object - properties: - id: - type: integer - example: 1 - metric_id: - type: integer - example: 1 - calculated_value: - type: integer - example: 1 - value: - type: integer - example: 1 - counter: - type: integer - example: 1 - created: - type: object - properties: - human: - type: string - example: '6 seconds from now' - string: - type: string - example: '2025-01-05 20:06:30' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Metric Points' - security: [] - delete: - summary: 'Delete Metric Point' - operationId: deleteMetricPoint - description: '' - parameters: [] - responses: - 204: - description: '' - tags: - - 'Metric Points' - parameters: - - - in: path - name: metric_id - description: 'The ID of the metric.' - example: 10 - required: true - schema: - type: integer - - - in: path - name: metricPoint_id - description: 'The ID of the metricPoint.' - example: 10 - required: true - schema: - type: integer - /api/schedules: - get: - summary: 'List Schedules' - operationId: listSchedules - description: '' - parameters: - - - in: query - name: per_page - description: 'How many items to show per page.' - example: 20 - required: false - schema: - type: integer - description: 'How many items to show per page.' - example: 20 - nullable: false - - - in: query - name: page - description: 'Which page to show.' - example: 2 - required: false - schema: - type: integer - description: 'Which page to show.' - example: 2 - nullable: false - - - in: query - name: sort - description: 'Field to sort by.' - example: name - required: false - schema: - type: string - description: 'Field to sort by.' - example: name - nullable: false - enum: - - name - - id - - scheduled_at - - completed_at - - enabled - - - in: query - name: include - description: 'Include related resources.' - example: components - required: false - schema: - type: string - description: 'Include related resources.' - example: components - nullable: false - enum: - - components - - updates - - user - - - in: query - name: 'filters[name]' - description: 'Filter the resources.' - example: name=api - required: false - schema: - type: string - description: 'Filter the resources.' - example: name=api - nullable: false - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - - - id: '1' - type: schedules - attributes: - id: 1 - name: 'Incident Schedule' - message: null - status: - human: Upcoming - value: 0 - scheduled: - human: '6 days from now' - string: '2025-01-12 20:06:23' - completed: - human: '1 week from now' - string: '2025-01-19 20:06:23' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: schedules - attributes: - id: 2 - name: 'Incident Schedule' - message: null - status: - human: Upcoming - value: 0 - scheduled: - human: '6 days from now' - string: '2025-01-12 20:06:23' - completed: - human: '1 week from now' - string: '2025-01-19 20:06:23' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: array - example: - - - id: '1' - type: schedules - attributes: - id: 1 - name: 'Incident Schedule' - message: null - status: - human: Upcoming - value: 0 - scheduled: - human: '6 days from now' - string: '2025-01-12 20:06:23' - completed: - human: '1 week from now' - string: '2025-01-19 20:06:23' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: schedules - attributes: - id: 2 - name: 'Incident Schedule' - message: null - status: - human: Upcoming - value: 0 - scheduled: - human: '6 days from now' - string: '2025-01-12 20:06:23' - completed: - human: '1 week from now' - string: '2025-01-19 20:06:23' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - items: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: schedules - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'Incident Schedule' - message: - type: string - example: null - status: - type: object - properties: - human: - type: string - example: Upcoming - value: - type: integer - example: 0 - scheduled: - type: object - properties: - human: - type: string - example: '6 days from now' - string: - type: string - example: '2025-01-12 20:06:23' - completed: - type: object - properties: - human: - type: string - example: '1 week from now' - string: - type: string - example: '2025-01-19 20:06:23' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Schedules - security: [] - post: - summary: 'Create Schedule' - operationId: createSchedule - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: schedules - attributes: - id: 1 - name: 'Incident Schedule' - message: null - status: - human: Upcoming - value: 0 - scheduled: - human: '6 days from now' - string: '2025-01-12 20:06:23' - completed: - human: '1 week from now' - string: '2025-01-19 20:06:23' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: schedules - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'Incident Schedule' - message: - type: string - example: null - status: - type: object - properties: - human: - type: string - example: Upcoming - value: - type: integer - example: 0 - scheduled: - type: object - properties: - human: - type: string - example: '6 days from now' - string: - type: string - example: '2025-01-12 20:06:23' - completed: - type: object - properties: - human: - type: string - example: '1 week from now' - string: - type: string - example: '2025-01-19 20:06:23' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Schedules - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: 'Must not be greater than 255 characters.' - example: leyyymoxrcsu - nullable: false - message: - type: string - description: '' - example: qui - nullable: false - scheduledAt: - type: string - description: 'Must be a valid date.' - example: '2025-01-05T20:06:23' - nullable: false - completedAt: - type: string - description: 'Must be a valid date.' - example: '2025-01-05T20:06:23' - nullable: false - required: - - name - - message - - scheduledAt - - completedAt - '/api/schedules/{id}': - get: - summary: 'Get Schedule' - operationId: getSchedule - description: '' - parameters: - - - in: query - name: include - description: 'Include related resources.' - example: components - required: false - schema: - type: string - description: 'Include related resources.' - example: components - nullable: false - enum: - - components - - updates - - user - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: schedules - attributes: - id: 1 - name: 'Incident Schedule' - message: null - status: - human: Upcoming - value: 0 - scheduled: - human: '6 days from now' - string: '2025-01-12 20:06:23' - completed: - human: '1 week from now' - string: '2025-01-19 20:06:23' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: schedules - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'Incident Schedule' - message: - type: string - example: null - status: - type: object - properties: - human: - type: string - example: Upcoming - value: - type: integer - example: 0 - scheduled: - type: object - properties: - human: - type: string - example: '6 days from now' - string: - type: string - example: '2025-01-12 20:06:23' - completed: - type: object - properties: - human: - type: string - example: '1 week from now' - string: - type: string - example: '2025-01-19 20:06:23' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Schedules - security: [] - put: - summary: 'Update Schedule' - operationId: updateSchedule - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: schedules - attributes: - id: 1 - name: 'Incident Schedule' - message: null - status: - human: Upcoming - value: 0 - scheduled: - human: '6 days from now' - string: '2025-01-12 20:06:23' - completed: - human: '1 week from now' - string: '2025-01-19 20:06:23' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: schedules - attributes: - type: object - properties: - id: - type: integer - example: 1 - name: - type: string - example: 'Incident Schedule' - message: - type: string - example: null - status: - type: object - properties: - human: - type: string - example: Upcoming - value: - type: integer - example: 0 - scheduled: - type: object - properties: - human: - type: string - example: '6 days from now' - string: - type: string - example: '2025-01-12 20:06:23' - completed: - type: object - properties: - human: - type: string - example: '1 week from now' - string: - type: string - example: '2025-01-19 20:06:23' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - Schedules - delete: - summary: 'Delete Schedule' - operationId: deleteSchedule - description: '' - parameters: [] - responses: - 204: - description: '' - tags: - - Schedules - parameters: - - - in: path - name: id - description: 'The ID of the schedule.' - example: 10 - required: true - schema: - type: integer - '/api/schedules/{schedule_id}/updates': - get: - summary: 'List Schedule Updates' - operationId: listScheduleUpdates - description: '' - parameters: - - - in: query - name: per_page - description: 'How many items to show per page.' - example: 20 - required: false - schema: - type: integer - description: 'How many items to show per page.' - example: 20 - nullable: false - - - in: query - name: page - description: 'Which page to show.' - example: 2 - required: false - schema: - type: integer - description: 'Which page to show.' - example: 2 - nullable: false - - - in: query - name: sort - description: 'Field to sort by.' - example: name - required: false - schema: - type: string - description: 'Field to sort by.' - example: name - nullable: false - enum: - - name - - created_at - - - in: query - name: include - description: 'Include related resources.' - example: schedule - required: false - schema: - type: string - description: 'Include related resources.' - example: schedule - nullable: false - enum: - - schedule - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - - - id: '1' - type: updates - attributes: - id: 1 - updateable_id: 1 - updateable_type: incident - message: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: updates - attributes: - id: 2 - updateable_id: 2 - updateable_type: incident - message: 'Distinctio magni commodi esse accusamus reprehenderit consequuntur sequi. Ea quo totam aliquid et porro magnam. Vero voluptatem neque quod sit doloribus sed qui.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: array - example: - - - id: '1' - type: updates - attributes: - id: 1 - updateable_id: 1 - updateable_type: incident - message: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - - - id: '2' - type: updates - attributes: - id: 2 - updateable_id: 2 - updateable_type: incident - message: 'Distinctio magni commodi esse accusamus reprehenderit consequuntur sequi. Ea quo totam aliquid et porro magnam. Vero voluptatem neque quod sit doloribus sed qui.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - items: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: updates - attributes: - type: object - properties: - id: - type: integer - example: 1 - updateable_id: - type: integer - example: 1 - updateable_type: - type: string - example: incident - message: - type: string - example: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Schedule Updates' - security: [] - post: - summary: 'Create Schedule Update' - operationId: createScheduleUpdate - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: updates - attributes: - id: 1 - updateable_id: 1 - updateable_type: incident - message: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: updates - attributes: - type: object - properties: - id: - type: integer - example: 1 - updateable_id: - type: integer - example: 1 - updateable_type: - type: string - example: incident - message: - type: string - example: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Schedule Updates' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: '' - example: qui - nullable: false - required: - - message - parameters: - - - in: path - name: schedule_id - description: 'The ID of the schedule.' - example: 10 - required: true - schema: - type: integer - '/api/schedules/{schedule_id}/updates/{id}': - get: - summary: 'Get Schedule Update' - operationId: getScheduleUpdate - description: '' - parameters: - - - in: query - name: include - description: 'Include related resources.' - example: schedule - required: false - schema: - type: string - description: 'Include related resources.' - example: schedule - nullable: false - enum: - - schedule - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: updates - attributes: - id: 1 - updateable_id: 1 - updateable_type: incident - message: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: updates - attributes: - type: object - properties: - id: - type: integer - example: 1 - updateable_id: - type: integer - example: 1 - updateable_type: - type: string - example: incident - message: - type: string - example: 'Rerum molestiae dolores sunt eveniet cum aut porro temporibus. Consequatur a dolorem quibusdam labore at. Labore distinctio atque dolorem velit.' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Schedule Updates' - security: [] - put: - summary: 'Update Schedule Update' - operationId: updateScheduleUpdate - description: '' - parameters: [] - responses: - 200: - description: '' - content: - application/json: - schema: - type: object - example: - data: - id: '1' - type: updates - attributes: - id: 1 - updateable_id: 1 - updateable_type: incident - message: 'Velit in voluptatibus architecto dolorum. Repudiandae culpa laboriosam velit quos aut blanditiis fugit. Maiores sint consequatur a at facilis ut.' - created: - human: '1 second ago' - string: '2025-01-05 20:06:23' - updated: - human: '1 second ago' - string: '2025-01-05 20:06:23' - properties: - data: - type: object - properties: - id: - type: string - example: '1' - type: - type: string - example: updates - attributes: - type: object - properties: - id: - type: integer - example: 1 - updateable_id: - type: integer - example: 1 - updateable_type: - type: string - example: incident - message: - type: string - example: 'Velit in voluptatibus architecto dolorum. Repudiandae culpa laboriosam velit quos aut blanditiis fugit. Maiores sint consequatur a at facilis ut.' - created: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - updated: - type: object - properties: - human: - type: string - example: '1 second ago' - string: - type: string - example: '2025-01-05 20:06:23' - tags: - - 'Schedule Updates' - delete: - summary: 'Delete Schedule Update' - operationId: deleteScheduleUpdate - description: '' - parameters: [] - responses: - 204: - description: '' - tags: - - 'Schedule Updates' - parameters: - - - in: path - name: schedule_id - description: 'The ID of the schedule.' - example: 10 - required: true - schema: - type: integer - - - in: path - name: id - description: 'The ID of the update.' - example: 10 - required: true - schema: - type: integer -tags: - - - name: Cachet - description: '' - - - name: Components - description: '' - - - name: 'Component Groups' - description: '' - - - name: Incidents - description: '' - - - name: 'Incident Updates' - description: '' - - - name: 'Incident Templates' - description: '' - - - name: Metrics - description: '' - - - name: 'Metric Points' - description: '' - - - name: Schedules - description: '' - - - name: 'Schedule Updates' - description: '' -components: - securitySchemes: - default: - type: http - scheme: bearer - description: '' -security: - - - default: []