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

Clarify required fields for SyntheticsAPIStep, SyntheticsAPITest, and SyntheticsBrowserTest #667

Merged
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.6.1",
"regenerated": "2022-01-18 11:14:27.564849",
"spec_repo_commit": "1d04508"
"regenerated": "2022-01-18 11:52:05.610616",
"spec_repo_commit": "5808ab7"
},
"v2": {
"apigentools_version": "1.6.1",
"regenerated": "2022-01-18 11:14:28.008860",
"spec_repo_commit": "1d04508"
"regenerated": "2022-01-18 11:52:06.129858",
"spec_repo_commit": "5808ab7"
}
}
}
28 changes: 26 additions & 2 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9759,6 +9759,10 @@ components:
assertions:
default: []
description: Array of assertions used for the test.
example:
- operator: lessThan
target: 1000
type: responseTime
items:
$ref: '#/components/schemas/SyntheticsAssertion'
type: array
Expand All @@ -9775,19 +9779,26 @@ components:
type: boolean
name:
description: The name of the step.
example: Example step name
type: string
request:
$ref: '#/components/schemas/SyntheticsTestRequest'
retry:
$ref: '#/components/schemas/SyntheticsTestOptionsRetry'
subtype:
$ref: '#/components/schemas/SyntheticsAPIStepSubtype'
required:
- assertions
- request
- name
- subtype
type: object
SyntheticsAPIStepSubtype:
description: The subtype of the Synthetic multistep API test step, currently
only supporting `http`.
enum:
- http
example: http
type: string
x-enum-varnames:
- HTTP
Expand Down Expand Up @@ -9816,7 +9827,7 @@ components:
type: integer
name:
description: Name of the test.
example: Test name
example: Example test name
type: string
options:
$ref: '#/components/schemas/SyntheticsTestOptions'
Expand All @@ -9839,6 +9850,12 @@ components:
type: array
type:
$ref: '#/components/schemas/SyntheticsAPITestType'
required:
- name
- config
- locations
- options
- type
type: object
SyntheticsAPITestConfig:
description: Configuration object for a Synthetic API test.
Expand Down Expand Up @@ -10314,6 +10331,8 @@ components:
$ref: '#/components/schemas/SyntheticsBrowserTestConfig'
locations:
description: Array of locations used to run the test.
example:
- example-location
items:
description: A location from which the test was run.
type: string
Expand All @@ -10330,6 +10349,7 @@ components:
type: integer
name:
description: Name of the test.
example: Example test name
type: string
options:
$ref: '#/components/schemas/SyntheticsTestOptions'
Expand All @@ -10353,7 +10373,11 @@ components:
type:
$ref: '#/components/schemas/SyntheticsBrowserTestType'
required:
- message
- config
- locations
- name
- options
- type
type: object
SyntheticsBrowserTestConfig:
description: Configuration object for a Synthetic browser test.
Expand Down
20 changes: 10 additions & 10 deletions docs/v1/SyntheticsAPIStep.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions docs/v1/SyntheticsAPITest.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 8 additions & 12 deletions docs/v1/SyntheticsApi.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions docs/v1/SyntheticsBrowserTest.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading