Skip to content

[MA-1665] Add Slo Corrections to open api spec #226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.4.1.dev2",
"regenerated": "2021-01-13 15:26:23.348231",
"spec_repo_commit": "426d7a0"
"regenerated": "2021-01-13 20:15:32.702549",
"spec_repo_commit": "fe2e0b5"
},
"v2": {
"apigentools_version": "1.4.1.dev2",
"regenerated": "2021-01-13 15:26:33.836090",
"spec_repo_commit": "426d7a0"
"regenerated": "2021-01-13 20:15:45.233550",
"spec_repo_commit": "fe2e0b5"
}
}
}
17 changes: 17 additions & 0 deletions docs/v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,11 @@ Class | Method | HTTP request | Description
*PagerDutyIntegrationApi* | [**delete_pager_duty_integration_service**](PagerDutyIntegrationApi.md#delete_pager_duty_integration_service) | **DELETE** /api/v1/integration/pagerduty/configuration/services/{service_name} | Delete a single service object
*PagerDutyIntegrationApi* | [**get_pager_duty_integration_service**](PagerDutyIntegrationApi.md#get_pager_duty_integration_service) | **GET** /api/v1/integration/pagerduty/configuration/services/{service_name} | Get a single service object
*PagerDutyIntegrationApi* | [**update_pager_duty_integration_service**](PagerDutyIntegrationApi.md#update_pager_duty_integration_service) | **PUT** /api/v1/integration/pagerduty/configuration/services/{service_name} | Update a single service object
*ServiceLevelObjectiveCorrectionsApi* | [**create_slo_correction**](ServiceLevelObjectiveCorrectionsApi.md#create_slo_correction) | **POST** /api/v1/slo/correction | Create an SLO correction
*ServiceLevelObjectiveCorrectionsApi* | [**delete_slo_correction**](ServiceLevelObjectiveCorrectionsApi.md#delete_slo_correction) | **DELETE** /api/v1/slo/correction/{slo_correction_id} | Delete an SLO Correction
*ServiceLevelObjectiveCorrectionsApi* | [**get_slo_correction**](ServiceLevelObjectiveCorrectionsApi.md#get_slo_correction) | **GET** /api/v1/slo/correction/{slo_correction_id} | Get an SLO correction for an SLO
*ServiceLevelObjectiveCorrectionsApi* | [**list_slo_correction**](ServiceLevelObjectiveCorrectionsApi.md#list_slo_correction) | **GET** /api/v1/slo/correction | Get all SLO corrections
*ServiceLevelObjectiveCorrectionsApi* | [**update_slo_correction**](ServiceLevelObjectiveCorrectionsApi.md#update_slo_correction) | **PATCH** /api/v1/slo/correction/{slo_correction_id} | Update an SLO Correction
*ServiceLevelObjectivesApi* | [**check_can_delete_slo**](ServiceLevelObjectivesApi.md#check_can_delete_slo) | **GET** /api/v1/slo/can_delete | Check if SLOs can be safely deleted
*ServiceLevelObjectivesApi* | [**create_slo**](ServiceLevelObjectivesApi.md#create_slo) | **POST** /api/v1/slo | Create a SLO object
*ServiceLevelObjectivesApi* | [**delete_slo**](ServiceLevelObjectivesApi.md#delete_slo) | **DELETE** /api/v1/slo/{slo_id} | Delete a SLO
Expand Down Expand Up @@ -492,6 +497,18 @@ Class | Method | HTTP request | Description
- [SLOBulkDeleteResponse](SLOBulkDeleteResponse.md)
- [SLOBulkDeleteResponseData](SLOBulkDeleteResponseData.md)
- [SLOBulkDeleteResponseErrors](SLOBulkDeleteResponseErrors.md)
- [SLOCorrectionCategory](SLOCorrectionCategory.md)
- [SLOCorrectionCreateRequest](SLOCorrectionCreateRequest.md)
- [SLOCorrectionCreateRequestAttributes](SLOCorrectionCreateRequestAttributes.md)
- [SLOCorrectionCreateRequestData](SLOCorrectionCreateRequestData.md)
- [SLOCorrectionListResponse](SLOCorrectionListResponse.md)
- [SLOCorrectionListResponseData](SLOCorrectionListResponseData.md)
- [SLOCorrectionResponse](SLOCorrectionResponse.md)
- [SLOCorrectionResponseAttributes](SLOCorrectionResponseAttributes.md)
- [SLOCorrectionResponseData](SLOCorrectionResponseData.md)
- [SLOCorrectionUpdateRequest](SLOCorrectionUpdateRequest.md)
- [SLOCorrectionUpdateRequestAttributes](SLOCorrectionUpdateRequestAttributes.md)
- [SLOCorrectionUpdateRequestData](SLOCorrectionUpdateRequestData.md)
- [SLODeleteResponse](SLODeleteResponse.md)
- [SLOErrorTimeframe](SLOErrorTimeframe.md)
- [SLOHistoryMetrics](SLOHistoryMetrics.md)
Expand Down
11 changes: 11 additions & 0 deletions docs/v1/SLOCorrectionCategory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SLOCorrectionCategory

Category the SLO correction belongs to
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **str** | Category the SLO correction belongs to | must be one of ["Scheduled Maintenance", "Outside Business Hours", "Deployment", "Other", ]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


11 changes: 11 additions & 0 deletions docs/v1/SLOCorrectionCreateRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SLOCorrectionCreateRequest

An object that defines a correction to be applied to an SLO
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SLOCorrectionCreateRequestData**](SLOCorrectionCreateRequestData.md) | | [optional]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


16 changes: 16 additions & 0 deletions docs/v1/SLOCorrectionCreateRequestAttributes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# SLOCorrectionCreateRequestAttributes

The attribute object associated with the SLO correction to be created
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | [**SLOCorrectionCategory**](SLOCorrectionCategory.md) | |
**end** | **int** | Ending time of the correction in epoch seconds |
**slo_id** | **str** | ID of the SLO that this correction will be applied to |
**start** | **int** | Starting time of the correction in epoch seconds |
**timezone** | **str** | Timezone of the timestamps provided |
**description** | **str** | Description of the correction being made. | [optional]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


12 changes: 12 additions & 0 deletions docs/v1/SLOCorrectionCreateRequestData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# SLOCorrectionCreateRequestData

The data object associated with the SLO correction to be created
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**SLOCorrectionCreateRequestAttributes**](SLOCorrectionCreateRequestAttributes.md) | | [optional]
**type** | **str** | Should always be set to \"correction\" | [optional] if omitted the server will use the default value of "correction"

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


11 changes: 11 additions & 0 deletions docs/v1/SLOCorrectionListResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SLOCorrectionListResponse

A list of SLO correction objects
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**[SLOCorrectionListResponseData]**](SLOCorrectionListResponseData.md) | The list of of SLO corrections objects | [optional]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


13 changes: 13 additions & 0 deletions docs/v1/SLOCorrectionListResponseData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# SLOCorrectionListResponseData

The response object of a list of SLO corrections
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**SLOCorrectionResponseAttributes**](SLOCorrectionResponseAttributes.md) | | [optional]
**id** | **str** | The ID of the SLO correction | [optional]
**type** | **str** | Should always be set to \"correction\" | [optional] if omitted the server will use the default value of "correction"

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


11 changes: 11 additions & 0 deletions docs/v1/SLOCorrectionResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SLOCorrectionResponse

The response object of an SLO correction
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SLOCorrectionResponseData**](SLOCorrectionResponseData.md) | | [optional]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


17 changes: 17 additions & 0 deletions docs/v1/SLOCorrectionResponseAttributes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# SLOCorrectionResponseAttributes

The attribute object associated with the SLO correction
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | [**SLOCorrectionCategory**](SLOCorrectionCategory.md) | | [optional]
**creator** | [**Creator**](Creator.md) | | [optional]
**description** | **str** | Description of the correction being made. | [optional]
**end** | **int** | Ending time of the correction in epoch seconds | [optional]
**slo_id** | **str** | ID of the SLO that this correction will be applied to | [optional]
**start** | **int** | Starting time of the correction in epoch seconds | [optional]
**timezone** | **str** | Timezone of the timestamps provided | [optional]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


13 changes: 13 additions & 0 deletions docs/v1/SLOCorrectionResponseData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# SLOCorrectionResponseData

The data object associated with the SLO correction
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**SLOCorrectionResponseAttributes**](SLOCorrectionResponseAttributes.md) | | [optional]
**id** | **str** | The ID of the SLO correction | [optional]
**type** | **str** | Should always return \"correction\" | [optional]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


11 changes: 11 additions & 0 deletions docs/v1/SLOCorrectionUpdateRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SLOCorrectionUpdateRequest

An object that defines a correction to be applied to an SLO
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**SLOCorrectionUpdateRequestData**](SLOCorrectionUpdateRequestData.md) | | [optional]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


15 changes: 15 additions & 0 deletions docs/v1/SLOCorrectionUpdateRequestAttributes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# SLOCorrectionUpdateRequestAttributes

The attribute object associated with the SLO correction to be updated
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | [**SLOCorrectionCategory**](SLOCorrectionCategory.md) | |
**end** | **int** | Ending time of the correction in epoch seconds |
**start** | **int** | Starting time of the correction in epoch seconds |
**timezone** | **str** | Timezone of the timestamps provided |
**description** | **str** | Description of the correction being made. | [optional]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


12 changes: 12 additions & 0 deletions docs/v1/SLOCorrectionUpdateRequestData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# SLOCorrectionUpdateRequestData

The data object associated with the SLO correction to be updated
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**SLOCorrectionUpdateRequestAttributes**](SLOCorrectionUpdateRequestAttributes.md) | | [optional]
**type** | **str** | Should always be set to \"correction\" | [optional] if omitted the server will use the default value of "correction"

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


Loading