docs/v2/IncidentTeamsAPI.md in datadog_api_client-1.4.0 vs docs/v2/IncidentTeamsAPI.md in datadog_api_client-1.5.0
- old
+ new
@@ -1,18 +1,17 @@
# DatadogAPIClient::V2::IncidentTeamsAPI
All URIs are relative to *https://api.datadoghq.com*
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**create_incident_team**](IncidentTeamsAPI.md#create_incident_team) | **POST** /api/v2/teams | Create a new incident team |
+| Method | HTTP request | Description |
+| -------------------------------------------------------------------- | ---------------------------------- | -------------------------------- |
+| [**create_incident_team**](IncidentTeamsAPI.md#create_incident_team) | **POST** /api/v2/teams | Create a new incident team |
| [**delete_incident_team**](IncidentTeamsAPI.md#delete_incident_team) | **DELETE** /api/v2/teams/{team_id} | Delete an existing incident team |
-| [**get_incident_team**](IncidentTeamsAPI.md#get_incident_team) | **GET** /api/v2/teams/{team_id} | Get details of an incident team |
-| [**list_incident_teams**](IncidentTeamsAPI.md#list_incident_teams) | **GET** /api/v2/teams | Get a list of all incident teams |
-| [**update_incident_team**](IncidentTeamsAPI.md#update_incident_team) | **PATCH** /api/v2/teams/{team_id} | Update an existing incident team |
+| [**get_incident_team**](IncidentTeamsAPI.md#get_incident_team) | **GET** /api/v2/teams/{team_id} | Get details of an incident team |
+| [**list_incident_teams**](IncidentTeamsAPI.md#list_incident_teams) | **GET** /api/v2/teams | Get a list of all incident teams |
+| [**update_incident_team**](IncidentTeamsAPI.md#update_incident_team) | **PATCH** /api/v2/teams/{team_id} | Update an existing incident team |
-
## create_incident_team
> <IncidentTeamResponse> create_incident_team(body)
Creates a new incident team.
@@ -56,13 +55,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**IncidentTeamCreateRequest**](IncidentTeamCreateRequest.md) | Incident Team Payload. | |
+| Name | Type | Description | Notes |
+| -------- | ------------------------------------------------------------- | ---------------------- | ----- |
+| **body** | [**IncidentTeamCreateRequest**](IncidentTeamCreateRequest.md) | Incident Team Payload. | |
### Return type
[**IncidentTeamResponse**](IncidentTeamResponse.md)
@@ -73,11 +72,10 @@
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
-
## delete_incident_team
> delete_incident_team(team_id)
Deletes an existing incident team.
@@ -120,13 +118,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **team_id** | **String** | The ID of the incident team. | |
+| Name | Type | Description | Notes |
+| ----------- | ---------- | ---------------------------- | ----- |
+| **team_id** | **String** | The ID of the incident team. | |
### Return type
nil (empty response body)
@@ -137,11 +135,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## get_incident_team
> <IncidentTeamResponse> get_incident_team(team_id, opts)
Get details of an incident team. If the `include[users]` query parameter is provided,
@@ -189,13 +186,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **team_id** | **String** | The ID of the incident team. | |
+| Name | Type | Description | Notes |
+| ----------- | ------------------------- | ---------------------------------------------------------------------------- | ---------- |
+| **team_id** | **String** | The ID of the incident team. | |
| **include** | **IncidentRelatedObject** | Specifies which types of related objects should be included in the response. | [optional] |
### Return type
[**IncidentTeamResponse**](IncidentTeamResponse.md)
@@ -207,11 +204,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## list_incident_teams
> <IncidentTeamsResponse> list_incident_teams(opts)
Get all incident teams for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident teams.
@@ -260,16 +256,16 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **include** | **IncidentRelatedObject** | Specifies which types of related objects should be included in the response. | [optional] |
-| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] |
-| **page_offset** | **Integer** | Specific offset to use as the beginning of the returned page. | [optional][default to 0] |
-| **filter** | **String** | A search query that filters teams by name. | [optional] |
+| Name | Type | Description | Notes |
+| --------------- | ------------------------- | ---------------------------------------------------------------------------- | ------------------------- |
+| **include** | **IncidentRelatedObject** | Specifies which types of related objects should be included in the response. | [optional] |
+| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] |
+| **page_offset** | **Integer** | Specific offset to use as the beginning of the returned page. | [optional][default to 0] |
+| **filter** | **String** | A search query that filters teams by name. | [optional] |
### Return type
[**IncidentTeamsResponse**](IncidentTeamsResponse.md)
@@ -280,11 +276,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## update_incident_team
> <IncidentTeamResponse> update_incident_team(team_id, body)
Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update.
@@ -329,14 +324,14 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **team_id** | **String** | The ID of the incident team. | |
-| **body** | [**IncidentTeamUpdateRequest**](IncidentTeamUpdateRequest.md) | Incident Team Payload. | |
+| Name | Type | Description | Notes |
+| ----------- | ------------------------------------------------------------- | ---------------------------- | ----- |
+| **team_id** | **String** | The ID of the incident team. | |
+| **body** | [**IncidentTeamUpdateRequest**](IncidentTeamUpdateRequest.md) | Incident Team Payload. | |
### Return type
[**IncidentTeamResponse**](IncidentTeamResponse.md)
@@ -346,6 +341,5 @@
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
-