Skip to content
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

Add synthetics private location endpoints #584

Merged
merged 12 commits into from
Nov 23, 2020
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.3.0",
"regenerated": "2020-11-20 17:20:02.494299",
"spec_repo_commit": "92b08fe"
"regenerated": "2020-11-23 18:02:51.669769",
"spec_repo_commit": "96fd18a"
},
"v2": {
"apigentools_version": "1.3.0",
"regenerated": "2020-11-20 17:20:08.772898",
"spec_repo_commit": "92b08fe"
"regenerated": "2020-11-23 18:02:57.288397",
"spec_repo_commit": "96fd18a"
}
}
}
12 changes: 12 additions & 0 deletions api/v1/datadog/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,12 @@ docs/SyntheticsListTestsResponse.md
docs/SyntheticsLocation.md
docs/SyntheticsLocations.md
docs/SyntheticsPlayingTab.md
docs/SyntheticsPrivateLocation.md
docs/SyntheticsPrivateLocationCreationResponse.md
docs/SyntheticsPrivateLocationCreationResponseResultEncryption.md
docs/SyntheticsPrivateLocationSecrets.md
docs/SyntheticsPrivateLocationSecretsAuthentication.md
docs/SyntheticsPrivateLocationSecretsConfigDecryption.md
docs/SyntheticsResource.md
docs/SyntheticsResourceType.md
docs/SyntheticsSSLCertificate.md
Expand Down Expand Up @@ -764,6 +770,12 @@ model_synthetics_list_tests_response.go
model_synthetics_location.go
model_synthetics_locations.go
model_synthetics_playing_tab.go
model_synthetics_private_location.go
model_synthetics_private_location_creation_response.go
model_synthetics_private_location_creation_response_result_encryption.go
model_synthetics_private_location_secrets.go
model_synthetics_private_location_secrets_authentication.go
model_synthetics_private_location_secrets_config_decryption.go
model_synthetics_resource.go
model_synthetics_resource_type.go
model_synthetics_ssl_certificate.go
Expand Down
10 changes: 10 additions & 0 deletions api/v1/datadog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,10 @@ Class | Method | HTTP request | Description
*ServiceLevelObjectivesApi* | [**UpdateSLO**](docs/ServiceLevelObjectivesApi.md#updateslo) | **Put** /api/v1/slo/{slo_id} | Update a SLO
*SnapshotsApi* | [**GetGraphSnapshot**](docs/SnapshotsApi.md#getgraphsnapshot) | **Get** /api/v1/graph/snapshot | Take graph snapshots
*SyntheticsApi* | [**CreateGlobalVariable**](docs/SyntheticsApi.md#createglobalvariable) | **Post** /api/v1/synthetics/variables | Create a global variable
*SyntheticsApi* | [**CreatePrivateLocation**](docs/SyntheticsApi.md#createprivatelocation) | **Post** /api/v1/synthetics/private-locations | Create a private location
*SyntheticsApi* | [**CreateTest**](docs/SyntheticsApi.md#createtest) | **Post** /api/v1/synthetics/tests | Create a test
*SyntheticsApi* | [**DeleteGlobalVariable**](docs/SyntheticsApi.md#deleteglobalvariable) | **Delete** /api/v1/synthetics/variables/{variable_id} | Delete a global variable
*SyntheticsApi* | [**DeletePrivateLocation**](docs/SyntheticsApi.md#deleteprivatelocation) | **Delete** /api/v1/synthetics/private-locations/{location_id} | Delete a private location
*SyntheticsApi* | [**DeleteTests**](docs/SyntheticsApi.md#deletetests) | **Post** /api/v1/synthetics/tests/delete | Delete tests
*SyntheticsApi* | [**EditGlobalVariable**](docs/SyntheticsApi.md#editglobalvariable) | **Put** /api/v1/synthetics/variables/{variable_id} | Edit a global variable
*SyntheticsApi* | [**GetAPITestLatestResults**](docs/SyntheticsApi.md#getapitestlatestresults) | **Get** /api/v1/synthetics/tests/{public_id}/results | Get the test's latest results summaries (API)
Expand All @@ -189,10 +191,12 @@ Class | Method | HTTP request | Description
*SyntheticsApi* | [**GetBrowserTestLatestResults**](docs/SyntheticsApi.md#getbrowsertestlatestresults) | **Get** /api/v1/synthetics/tests/browser/{public_id}/results | Get the test's latest results summaries (browser)
*SyntheticsApi* | [**GetBrowserTestResult**](docs/SyntheticsApi.md#getbrowsertestresult) | **Get** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a test result (browser)
*SyntheticsApi* | [**GetGlobalVariable**](docs/SyntheticsApi.md#getglobalvariable) | **Get** /api/v1/synthetics/variables/{variable_id} | Get a global variable
*SyntheticsApi* | [**GetPrivateLocation**](docs/SyntheticsApi.md#getprivatelocation) | **Get** /api/v1/synthetics/private-locations/{location_id} | Get a private location
*SyntheticsApi* | [**GetTest**](docs/SyntheticsApi.md#gettest) | **Get** /api/v1/synthetics/tests/{public_id} | Get a test configuration (API)
*SyntheticsApi* | [**ListLocations**](docs/SyntheticsApi.md#listlocations) | **Get** /api/v1/synthetics/locations | Get all locations (public and private)
*SyntheticsApi* | [**ListTests**](docs/SyntheticsApi.md#listtests) | **Get** /api/v1/synthetics/tests | Get the list of all tests
*SyntheticsApi* | [**TriggerCITests**](docs/SyntheticsApi.md#triggercitests) | **Post** /api/v1/synthetics/tests/trigger/ci | Trigger some Synthetics tests for CI
*SyntheticsApi* | [**UpdatePrivateLocation**](docs/SyntheticsApi.md#updateprivatelocation) | **Put** /api/v1/synthetics/private-locations/{location_id} | Edit a private location
*SyntheticsApi* | [**UpdateTest**](docs/SyntheticsApi.md#updatetest) | **Put** /api/v1/synthetics/tests/{public_id} | Edit a test
*SyntheticsApi* | [**UpdateTestPauseStatus**](docs/SyntheticsApi.md#updatetestpausestatus) | **Put** /api/v1/synthetics/tests/{public_id}/status | Pause or start a test
*TagsApi* | [**CreateHostTags**](docs/TagsApi.md#createhosttags) | **Post** /api/v1/tags/hosts/{host_name} | Add tags to a host
Expand Down Expand Up @@ -511,6 +515,12 @@ Class | Method | HTTP request | Description
- [SyntheticsLocation](docs/SyntheticsLocation.md)
- [SyntheticsLocations](docs/SyntheticsLocations.md)
- [SyntheticsPlayingTab](docs/SyntheticsPlayingTab.md)
- [SyntheticsPrivateLocation](docs/SyntheticsPrivateLocation.md)
- [SyntheticsPrivateLocationCreationResponse](docs/SyntheticsPrivateLocationCreationResponse.md)
- [SyntheticsPrivateLocationCreationResponseResultEncryption](docs/SyntheticsPrivateLocationCreationResponseResultEncryption.md)
- [SyntheticsPrivateLocationSecrets](docs/SyntheticsPrivateLocationSecrets.md)
- [SyntheticsPrivateLocationSecretsAuthentication](docs/SyntheticsPrivateLocationSecretsAuthentication.md)
- [SyntheticsPrivateLocationSecretsConfigDecryption](docs/SyntheticsPrivateLocationSecretsConfigDecryption.md)
- [SyntheticsResource](docs/SyntheticsResource.md)
- [SyntheticsResourceType](docs/SyntheticsResourceType.md)
- [SyntheticsSSLCertificate](docs/SyntheticsSSLCertificate.md)
Expand Down
258 changes: 257 additions & 1 deletion api/v1/datadog/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4546,6 +4546,135 @@ paths:
summary: Get all locations (public and private)
tags:
- Synthetics
/api/v1/synthetics/private-locations:
post:
description: Create a new Synthetics private location.
operationId: CreatePrivateLocation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SyntheticsPrivateLocation'
description: Details of the private location to create.
required: true
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/SyntheticsPrivateLocationCreationResponse'
description: OK
"402":
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Quota reached for private locations
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Private locations are not activated for the user
summary: Create a private location
tags:
- Synthetics
x-codegen-request-body-name: body
/api/v1/synthetics/private-locations/{location_id}:
delete:
description: Delete a Synthetics private location.
operationId: DeletePrivateLocation
parameters:
- description: The ID of the private location.
explode: false
in: path
name: location_id
required: true
schema:
type: string
style: simple
responses:
"204":
description: OK
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: |-
- Private locations are not activated for the user
- Private location does not exist
summary: Delete a private location
tags:
- Synthetics
get:
description: Get a Synthetics private location.
operationId: GetPrivateLocation
parameters:
- description: The ID of the private location.
explode: false
in: path
name: location_id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/SyntheticsPrivateLocation'
description: OK
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic private locations are not activated for the user
- Private location does not exist
summary: Get a private location
tags:
- Synthetics
put:
description: Edit a Synthetics private location.
operationId: UpdatePrivateLocation
parameters:
- description: The ID of the private location.
explode: false
in: path
name: location_id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SyntheticsPrivateLocation'
description: Details of the private location to be updated.
required: true
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/SyntheticsPrivateLocation'
description: OK
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: |-
- Private locations are not activated for the user
- Private location does not exist
summary: Edit a private location
tags:
- Synthetics
x-codegen-request-body-name: body
/api/v1/synthetics/tests:
get:
description: Get the list of all Synthetic tests.
Expand Down Expand Up @@ -4815,7 +4944,7 @@ paths:
x-codegen-request-body-name: body
/api/v1/synthetics/tests/trigger/ci:
post:
description: Trigger a set of Synthetics tests for continuous integration
description: Trigger a set of Synthetics tests for continuous integration.
operationId: TriggerCITests
requestBody:
content:
Expand Down Expand Up @@ -14499,6 +14628,79 @@ components:
- TAB_1
- TAB_2
- TAB_3
SyntheticsPrivateLocation:
description: Object containing information about the private location to create.
example:
name: New private location
description: Description of private location
id: id
secrets:
config_decryption:
key: key
authentication:
id: id
key: key
tags:
- team:front
properties:
description:
description: Description of the private location.
example: Description of private location
type: string
id:
description: Unique identifier of the private location.
readOnly: true
type: string
name:
description: Name of the private location.
example: New private location
type: string
secrets:
$ref: '#/components/schemas/SyntheticsPrivateLocation_secrets'
tags:
description: Array of tags attached to the private location.
example:
- team:front
items:
description: A tag attached to the private location.
example: team:front
type: string
type: array
required:
- description
- name
- tags
type: object
SyntheticsPrivateLocationCreationResponse:
description: Object that contains the new private location, the public key for
result encryption, and the configuration skeleton.
example:
private_location:
name: New private location
description: Description of private location
id: id
secrets:
config_decryption:
key: key
authentication:
id: id
key: key
tags:
- team:front
config: '{}'
result_encryption:
id: id
key: key
properties:
config:
description: Configuration skeleton for the private location. See installation
instructions of the private location on how to use this configuration.
type: object
private_location:
$ref: '#/components/schemas/SyntheticsPrivateLocation'
result_encryption:
$ref: '#/components/schemas/SyntheticsPrivateLocationCreationResponse_result_encryption'
type: object
SyntheticsResource:
description: Object describing a resource which is the combination of requests
(fetch, XHR) and Assets (HTML, CSS, JS, images).
Expand Down Expand Up @@ -20242,6 +20444,60 @@ components:
description: The Synthetic test ID deleted.
type: string
type: object
SyntheticsPrivateLocation_secrets_authentication:
description: Authentication part of the secrets.
example:
id: id
key: key
properties:
id:
description: Access key for the private location.
readOnly: true
type: string
key:
description: Secret access key for the private location.
readOnly: true
type: string
type: object
SyntheticsPrivateLocation_secrets_config_decryption:
description: Private key for the private location.
example:
key: key
properties:
key:
description: Private key for the private location.
readOnly: true
type: string
type: object
SyntheticsPrivateLocation_secrets:
description: Secrets for the private location. Only present in the response
when creating the private location.
example:
config_decryption:
key: key
authentication:
id: id
key: key
properties:
authentication:
$ref: '#/components/schemas/SyntheticsPrivateLocation_secrets_authentication'
config_decryption:
$ref: '#/components/schemas/SyntheticsPrivateLocation_secrets_config_decryption'
readOnly: true
type: object
SyntheticsPrivateLocationCreationResponse_result_encryption:
description: Public key for the result encryption.
example:
id: id
key: key
properties:
id:
description: Fingerprint for the encryption key.
type: string
key:
description: Public key for result encryption.
type: string
type: object
SyntheticsSSLCertificate_issuer:
description: Object describing the issuer of a SSL certificate.
example:
Expand Down
Loading