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

update upgrade guide #2665

Merged
merged 14 commits into from
Nov 13, 2019
11 changes: 6 additions & 5 deletions products/accesscontextmanager/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -267,14 +267,15 @@ objects:
Format: "major.minor.patch" such as "10.5.301", "9.2.1".
- !ruby/object:Api::Type::Enum
name: 'osType'
required: true
description: |
The operating system type of the device.
values:
- :OS_UNSPECIFIED
- :DESKTOP_MAC
- :DESKTOP_WINDOWS
- :DESKTOP_LINUX
- :DESKTOP_CHROME_OS
- :OS_UNSPECIFIED
- :DESKTOP_MAC
- :DESKTOP_WINDOWS
- :DESKTOP_LINUX
- :DESKTOP_CHROME_OS
- !ruby/object:Api::Resource
name: 'ServicePerimeter'
# This is an unusual API, so we need to use a few fields to map the methods
Expand Down
3 changes: 3 additions & 0 deletions products/appengine/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -332,16 +332,19 @@ objects:
- :REDIRECT_HTTP_RESPONSE_CODE_307
- !ruby/object:Api::Type::NestedObject
name: 'script'
# TODO (mbang): Exactly one of script, staticFiles, or apiEndpoint must be set
description: |
Executes a script to handle the requests that match this URL pattern.
Only the auto value is supported for Node.js in the App Engine standard environment, for example "script:" "auto".
properties:
- !ruby/object:Api::Type::String
name: 'scriptPath'
required: true
description: |
Path to the script from the application root directory.
- !ruby/object:Api::Type::NestedObject
name: 'staticFiles'
# TODO (mbang): Exactly one of script, staticFiles, or apiEndpoint must be set
description: |
Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.
properties:
Expand Down
1 change: 1 addition & 0 deletions products/bigquery/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ objects:
description: An email address of a Google Group to grant access to.
- !ruby/object:Api::Type::String
name: 'role'
required: true
description: |
Describes the rights granted to the user specified by the other
member of the access object. Primitive, Predefined and custom
Expand Down
10 changes: 6 additions & 4 deletions products/bigtable/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,19 @@ objects:
Long form description of the use case for this app profile.
- !ruby/object:Api::Type::Boolean
name: 'multiClusterRoutingUseAny'
conflicts:
- singleClusterRouting
exactly_one_of:
- single_cluster_routing
- multi_cluster_routing_use_any
description: |
If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available
in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes
consistency to improve availability.
input: true
- !ruby/object:Api::Type::NestedObject
name: 'singleClusterRouting'
conflicts:
- multiClusterRoutingUseAny
exactly_one_of:
- single_cluster_routing
- multi_cluster_routing_use_any
description: |
Use a single-cluster routing policy.
input: true
Expand Down
5 changes: 5 additions & 0 deletions products/binaryauthorization/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ objects:
See the documentation on publicKey cases below for details.
- !ruby/object:Api::Type::String
name: asciiArmoredPgpPublicKey
# TODO (mbang): Exactly one of asciiArmoredPgpPublicKey or pkixPublicKey must be set
description: |
ASCII-armored representation of a PGP public key, as the
entire output by the command
Expand All @@ -108,6 +109,7 @@ objects:
be overwritten by the API-calculated ID.
- !ruby/object:Api::Type::NestedObject
name: pkixPublicKey
# TODO (mbang): Exactly one of asciiArmoredPgpPublicKey or pkixPublicKey must be set
description: |
A raw PKIX SubjectPublicKeyInfo format public key.

Expand Down Expand Up @@ -178,6 +180,7 @@ objects:
properties:
- !ruby/object:Api::Type::String
name: namePattern
required: true
description: |
An image name pattern to whitelist, in the form
`registry/path/to/image`. This supports a trailing * as a
Expand All @@ -202,6 +205,7 @@ objects:
properties:
- !ruby/object:Api::Type::Enum
name: evaluationMode
required: true
description: How this admission rule will be evaluated.
values:
- :ALWAYS_ALLOW
Expand All @@ -221,6 +225,7 @@ objects:
item_type: Api::Type::String
- !ruby/object:Api::Type::Enum
name: enforcementMode
required: true
description: |
The action when a pod creation is denied by the admission rule.
values:
Expand Down
6 changes: 5 additions & 1 deletion products/cloudbuild/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ objects:
Substitutions data for Build resource.
- !ruby/object:Api::Type::String
name: 'filename'
conflicts:
exactly_one_of:
- filename
- build
description: |
Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.
Expand Down Expand Up @@ -219,6 +220,9 @@ objects:
- github.0.push.0.tag
- !ruby/object:Api::Type::NestedObject
name: 'build'
exactly_one_of:
- filename
- build
description: |
Contents of the build template. Either a filename or build template must be provided.
properties:
Expand Down
13 changes: 13 additions & 0 deletions products/cloudfunctions/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -136,17 +136,30 @@ objects:
description: |
The Google Cloud Storage URL, starting with gs://, pointing to the zip
archive which contains the function.
exactly_one_of:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes actually don't do anything, because this resource is not currently generated. I removed the update from the upgrade guide, but I figured I could leave them all in here so that when we eventually do generate it, they'll be there.

- source_repository
- source_archive_url
- source_upload_url
- !ruby/object:Api::Type::String
name: 'sourceUploadUrl'
description: |
The Google Cloud Storage signed URL used for source uploading.
exactly_one_of:
- source_repository
- source_archive_url
- source_upload_url
- !ruby/object:Api::Type::NestedObject
name: 'sourceRepository'
description: |
The source repository where a function is hosted.
exactly_one_of:
- source_repository
- source_archive_url
- source_upload_url
properties:
- !ruby/object:Api::Type::String
name: 'url'
required: true
description: |
The URL pointing to the hosted repository where the function is defined
- !ruby/object:Api::Type::String
Expand Down
1 change: 0 additions & 1 deletion products/cloudrun/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,6 @@ objects:
properties:
- !ruby/object:Api::Type::NestedObject
name: template
required: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change intentional? Seems out of character with the rest of the changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! I took that out because i saw its all flattened in terraform.yaml, and the flattened part is already required.

description: |-
template holds the latest specification for the Revision to
be stamped out. The template references the container image, and may also
Expand Down
21 changes: 12 additions & 9 deletions products/cloudscheduler/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,10 @@ objects:
If the job providers a Pub/Sub target the cron will publish
a message to the provided topic
input: true
conflicts:
- httpTarget
- appEngineHttpTarget
exactly_one_of:
- pubsub_target
- http_target
- app_engine_http_target
properties:
- !ruby/object:Api::Type::String
name: topicName
Expand Down Expand Up @@ -191,9 +192,10 @@ objects:
If the job providers a App Engine HTTP target the cron will
send a request to the service instance
input: true
conflicts:
- pubsubTarget
- httpTarget
exactly_one_of:
- pubsub_target
- http_target
- app_engine_http_target
properties:
- !ruby/object:Api::Type::String
name: httpMethod
Expand Down Expand Up @@ -273,9 +275,10 @@ objects:
If the job providers a http_target the cron will
send a request to the targeted url
input: true
conflicts:
- pubsubTarget
- appEngineHttpTarget
exactly_one_of:
- pubsub_target
- http_target
- app_engine_http_target
properties:
- !ruby/object:Api::Type::String
name: uri
Expand Down
Loading