google-cloud-apigee_registry-v1 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/apigee_registry/v1/provisioning/client.rb +1 -1
  3. data/lib/google/cloud/apigee_registry/v1/registry/client.rb +88 -82
  4. data/lib/google/cloud/apigee_registry/v1/version.rb +1 -1
  5. data/lib/google/cloud/apigeeregistry/v1/registry_service_pb.rb +2 -0
  6. data/lib/google/cloud/apigeeregistry/v1/registry_service_services_pb.rb +37 -37
  7. data/proto_docs/google/cloud/apigeeregistry/v1/provisioning_service.rb +1 -1
  8. data/proto_docs/google/cloud/apigeeregistry/v1/registry_models.rb +22 -22
  9. data/proto_docs/google/cloud/apigeeregistry/v1/registry_service.rb +50 -42
  10. data/proto_docs/google/protobuf/empty.rb +0 -2
  11. metadata +2 -2
data/lib/google/cloud/apigee_registry/v1/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ApigeeRegistry
23
23
  module V1
24
- VERSION = "0.2.0"
24
+ VERSION = "0.3.0"
25
25
  end
26
26
  end
27
27
  end
data/lib/google/cloud/apigeeregistry/v1/registry_service_pb.rb CHANGED
@@ -39,6 +39,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
39
39
  end
40
40
  add_message "google.cloud.apigeeregistry.v1.DeleteApiRequest" do
41
41
  optional :name, :string, 1
42
+ optional :force, :bool, 2
42
43
  end
43
44
  add_message "google.cloud.apigeeregistry.v1.ListApiVersionsRequest" do
44
45
  optional :parent, :string, 1
@@ -65,6 +66,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
65
66
  end
66
67
  add_message "google.cloud.apigeeregistry.v1.DeleteApiVersionRequest" do
67
68
  optional :name, :string, 1
69
+ optional :force, :bool, 2
68
70
  end
69
71
  add_message "google.cloud.apigeeregistry.v1.ListApiSpecsRequest" do
70
72
  optional :parent, :string, 1
data/lib/google/cloud/apigeeregistry/v1/registry_service_services_pb.rb CHANGED
@@ -33,90 +33,90 @@ module Google
33
33
  self.unmarshal_class_method = :decode
34
34
  self.service_name = 'google.cloud.apigeeregistry.v1.Registry'
35
35
 
36
- # ListApis returns matching APIs.
36
+ # Returns matching APIs.
37
37
  rpc :ListApis, ::Google::Cloud::ApigeeRegistry::V1::ListApisRequest, ::Google::Cloud::ApigeeRegistry::V1::ListApisResponse
38
- # GetApi returns a specified API.
38
+ # Returns a specified API.
39
39
  rpc :GetApi, ::Google::Cloud::ApigeeRegistry::V1::GetApiRequest, ::Google::Cloud::ApigeeRegistry::V1::Api
40
- # CreateApi creates a specified API.
40
+ # Creates a specified API.
41
41
  rpc :CreateApi, ::Google::Cloud::ApigeeRegistry::V1::CreateApiRequest, ::Google::Cloud::ApigeeRegistry::V1::Api
42
- # UpdateApi can be used to modify a specified API.
42
+ # Used to modify a specified API.
43
43
  rpc :UpdateApi, ::Google::Cloud::ApigeeRegistry::V1::UpdateApiRequest, ::Google::Cloud::ApigeeRegistry::V1::Api
44
- # DeleteApi removes a specified API and all of the resources that it
44
+ # Removes a specified API and all of the resources that it
45
45
  # owns.
46
46
  rpc :DeleteApi, ::Google::Cloud::ApigeeRegistry::V1::DeleteApiRequest, ::Google::Protobuf::Empty
47
- # ListApiVersions returns matching versions.
47
+ # Returns matching versions.
48
48
  rpc :ListApiVersions, ::Google::Cloud::ApigeeRegistry::V1::ListApiVersionsRequest, ::Google::Cloud::ApigeeRegistry::V1::ListApiVersionsResponse
49
- # GetApiVersion returns a specified version.
49
+ # Returns a specified version.
50
50
  rpc :GetApiVersion, ::Google::Cloud::ApigeeRegistry::V1::GetApiVersionRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
51
- # CreateApiVersion creates a specified version.
51
+ # Creates a specified version.
52
52
  rpc :CreateApiVersion, ::Google::Cloud::ApigeeRegistry::V1::CreateApiVersionRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
53
- # UpdateApiVersion can be used to modify a specified version.
53
+ # Used to modify a specified version.
54
54
  rpc :UpdateApiVersion, ::Google::Cloud::ApigeeRegistry::V1::UpdateApiVersionRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiVersion
55
- # DeleteApiVersion removes a specified version and all of the resources that
55
+ # Removes a specified version and all of the resources that
56
56
  # it owns.
57
57
  rpc :DeleteApiVersion, ::Google::Cloud::ApigeeRegistry::V1::DeleteApiVersionRequest, ::Google::Protobuf::Empty
58
- # ListApiSpecs returns matching specs.
58
+ # Returns matching specs.
59
59
  rpc :ListApiSpecs, ::Google::Cloud::ApigeeRegistry::V1::ListApiSpecsRequest, ::Google::Cloud::ApigeeRegistry::V1::ListApiSpecsResponse
60
- # GetApiSpec returns a specified spec.
60
+ # Returns a specified spec.
61
61
  rpc :GetApiSpec, ::Google::Cloud::ApigeeRegistry::V1::GetApiSpecRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
62
- # GetApiSpecContents returns the contents of a specified spec.
62
+ # Returns the contents of a specified spec.
63
63
  # If specs are stored with GZip compression, the default behavior
64
64
  # is to return the spec uncompressed (the mime_type response field
65
65
  # indicates the exact format returned).
66
66
  rpc :GetApiSpecContents, ::Google::Cloud::ApigeeRegistry::V1::GetApiSpecContentsRequest, ::Google::Api::HttpBody
67
- # CreateApiSpec creates a specified spec.
67
+ # Creates a specified spec.
68
68
  rpc :CreateApiSpec, ::Google::Cloud::ApigeeRegistry::V1::CreateApiSpecRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
69
- # UpdateApiSpec can be used to modify a specified spec.
69
+ # Used to modify a specified spec.
70
70
  rpc :UpdateApiSpec, ::Google::Cloud::ApigeeRegistry::V1::UpdateApiSpecRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
71
- # DeleteApiSpec removes a specified spec, all revisions, and all child
72
- # resources (e.g. artifacts).
71
+ # Removes a specified spec, all revisions, and all child
72
+ # resources (e.g., artifacts).
73
73
  rpc :DeleteApiSpec, ::Google::Cloud::ApigeeRegistry::V1::DeleteApiSpecRequest, ::Google::Protobuf::Empty
74
- # TagApiSpecRevision adds a tag to a specified revision of a spec.
74
+ # Adds a tag to a specified revision of a spec.
75
75
  rpc :TagApiSpecRevision, ::Google::Cloud::ApigeeRegistry::V1::TagApiSpecRevisionRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
76
- # ListApiSpecRevisions lists all revisions of a spec.
76
+ # Lists all revisions of a spec.
77
77
  # Revisions are returned in descending order of revision creation time.
78
78
  rpc :ListApiSpecRevisions, ::Google::Cloud::ApigeeRegistry::V1::ListApiSpecRevisionsRequest, ::Google::Cloud::ApigeeRegistry::V1::ListApiSpecRevisionsResponse
79
- # RollbackApiSpec sets the current revision to a specified prior revision.
79
+ # Sets the current revision to a specified prior revision.
80
80
  # Note that this creates a new revision with a new revision ID.
81
81
  rpc :RollbackApiSpec, ::Google::Cloud::ApigeeRegistry::V1::RollbackApiSpecRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
82
- # DeleteApiSpecRevision deletes a revision of a spec.
82
+ # Deletes a revision of a spec.
83
83
  rpc :DeleteApiSpecRevision, ::Google::Cloud::ApigeeRegistry::V1::DeleteApiSpecRevisionRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiSpec
84
- # ListApiDeployments returns matching deployments.
84
+ # Returns matching deployments.
85
85
  rpc :ListApiDeployments, ::Google::Cloud::ApigeeRegistry::V1::ListApiDeploymentsRequest, ::Google::Cloud::ApigeeRegistry::V1::ListApiDeploymentsResponse
86
- # GetApiDeployment returns a specified deployment.
86
+ # Returns a specified deployment.
87
87
  rpc :GetApiDeployment, ::Google::Cloud::ApigeeRegistry::V1::GetApiDeploymentRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
88
- # CreateApiDeployment creates a specified deployment.
88
+ # Creates a specified deployment.
89
89
  rpc :CreateApiDeployment, ::Google::Cloud::ApigeeRegistry::V1::CreateApiDeploymentRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
90
- # UpdateApiDeployment can be used to modify a specified deployment.
90
+ # Used to modify a specified deployment.
91
91
  rpc :UpdateApiDeployment, ::Google::Cloud::ApigeeRegistry::V1::UpdateApiDeploymentRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
92
- # DeleteApiDeployment removes a specified deployment, all revisions, and all
93
- # child resources (e.g. artifacts).
92
+ # Removes a specified deployment, all revisions, and all
93
+ # child resources (e.g., artifacts).
94
94
  rpc :DeleteApiDeployment, ::Google::Cloud::ApigeeRegistry::V1::DeleteApiDeploymentRequest, ::Google::Protobuf::Empty
95
- # TagApiDeploymentRevision adds a tag to a specified revision of a
95
+ # Adds a tag to a specified revision of a
96
96
  # deployment.
97
97
  rpc :TagApiDeploymentRevision, ::Google::Cloud::ApigeeRegistry::V1::TagApiDeploymentRevisionRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
98
- # ListApiDeploymentRevisions lists all revisions of a deployment.
98
+ # Lists all revisions of a deployment.
99
99
  # Revisions are returned in descending order of revision creation time.
100
100
  rpc :ListApiDeploymentRevisions, ::Google::Cloud::ApigeeRegistry::V1::ListApiDeploymentRevisionsRequest, ::Google::Cloud::ApigeeRegistry::V1::ListApiDeploymentRevisionsResponse
101
- # RollbackApiDeployment sets the current revision to a specified prior
101
+ # Sets the current revision to a specified prior
102
102
  # revision. Note that this creates a new revision with a new revision ID.
103
103
  rpc :RollbackApiDeployment, ::Google::Cloud::ApigeeRegistry::V1::RollbackApiDeploymentRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
104
- # DeleteApiDeploymentRevision deletes a revision of a deployment.
104
+ # Deletes a revision of a deployment.
105
105
  rpc :DeleteApiDeploymentRevision, ::Google::Cloud::ApigeeRegistry::V1::DeleteApiDeploymentRevisionRequest, ::Google::Cloud::ApigeeRegistry::V1::ApiDeployment
106
- # ListArtifacts returns matching artifacts.
106
+ # Returns matching artifacts.
107
107
  rpc :ListArtifacts, ::Google::Cloud::ApigeeRegistry::V1::ListArtifactsRequest, ::Google::Cloud::ApigeeRegistry::V1::ListArtifactsResponse
108
- # GetArtifact returns a specified artifact.
108
+ # Returns a specified artifact.
109
109
  rpc :GetArtifact, ::Google::Cloud::ApigeeRegistry::V1::GetArtifactRequest, ::Google::Cloud::ApigeeRegistry::V1::Artifact
110
- # GetArtifactContents returns the contents of a specified artifact.
110
+ # Returns the contents of a specified artifact.
111
111
  # If artifacts are stored with GZip compression, the default behavior
112
112
  # is to return the artifact uncompressed (the mime_type response field
113
113
  # indicates the exact format returned).
114
114
  rpc :GetArtifactContents, ::Google::Cloud::ApigeeRegistry::V1::GetArtifactContentsRequest, ::Google::Api::HttpBody
115
- # CreateArtifact creates a specified artifact.
115
+ # Creates a specified artifact.
116
116
  rpc :CreateArtifact, ::Google::Cloud::ApigeeRegistry::V1::CreateArtifactRequest, ::Google::Cloud::ApigeeRegistry::V1::Artifact
117
- # ReplaceArtifact can be used to replace a specified artifact.
117
+ # Used to replace a specified artifact.
118
118
  rpc :ReplaceArtifact, ::Google::Cloud::ApigeeRegistry::V1::ReplaceArtifactRequest, ::Google::Cloud::ApigeeRegistry::V1::Artifact
119
- # DeleteArtifact removes a specified artifact.
119
+ # Removes a specified artifact.
120
120
  rpc :DeleteArtifact, ::Google::Cloud::ApigeeRegistry::V1::DeleteArtifactRequest, ::Google::Protobuf::Empty
121
121
  end
122
122
 
data/proto_docs/google/cloud/apigeeregistry/v1/provisioning_service.rb CHANGED
@@ -92,7 +92,7 @@ module Google
92
92
  # @!attribute [rw] name
93
93
  # @return [::String]
94
94
  # Format: `projects/*/locations/*/instance`.
95
- # Currently only locations/global is supported.
95
+ # Currently only `locations/global` is supported.
96
96
  # @!attribute [r] create_time
97
97
  # @return [::Google::Protobuf::Timestamp]
98
98
  # Output only. Creation timestamp.
data/proto_docs/google/cloud/apigeeregistry/v1/registry_models.rb CHANGED
@@ -21,8 +21,8 @@ module Google
21
21
  module Cloud
22
22
  module ApigeeRegistry
23
23
  module V1
24
- # An Api is a top-level description of an API.
25
- # Apis are produced by producers and are commitments to provide services.
24
+ # A top-level description of an API.
25
+ # Produced by producers and are commitments to provide services.
26
26
  # @!attribute [rw] name
27
27
  # @return [::String]
28
28
  # Resource name.
@@ -42,15 +42,15 @@ module Google
42
42
  # @return [::String]
43
43
  # A user-definable description of the availability of this service.
44
44
  # Format: free-form, but we expect single words that describe availability,
45
- # e.g. "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
45
+ # e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
46
46
  # @!attribute [rw] recommended_version
47
47
  # @return [::String]
48
48
  # The recommended version of the API.
49
- # Format: apis/\\{api}/versions/\\{version}
49
+ # Format: `apis/{api}/versions/{version}`
50
50
  # @!attribute [rw] recommended_deployment
51
51
  # @return [::String]
52
52
  # The recommended deployment of the API.
53
- # Format: apis/\\{api}/deployments/\\{deployment}
53
+ # Format: `apis/{api}/deployments/{deployment}`
54
54
  # @!attribute [rw] labels
55
55
  # @return [::Google::Protobuf::Map{::String => ::String}]
56
56
  # Labels attach identifying metadata to resources. Identifying metadata can
@@ -58,13 +58,13 @@ module Google
58
58
  #
59
59
  # Label keys and values can be no longer than 64 characters
60
60
  # (Unicode codepoints), can only contain lowercase letters, numeric
61
- # characters, underscores and dashes. International characters are allowed.
61
+ # characters, underscores, and dashes. International characters are allowed.
62
62
  # No more than 64 user labels can be associated with one resource (System
63
63
  # labels are excluded).
64
64
  #
65
65
  # See https://goo.gl/xmQnxf for more information and examples of labels.
66
66
  # System reserved label keys are prefixed with
67
- # "apigeeregistry.googleapis.com/" and cannot be changed.
67
+ # `apigeeregistry.googleapis.com/` and cannot be changed.
68
68
  # @!attribute [rw] annotations
69
69
  # @return [::Google::Protobuf::Map{::String => ::String}]
70
70
  # Annotations attach non-identifying metadata to resources.
@@ -95,7 +95,7 @@ module Google
95
95
  end
96
96
  end
97
97
 
98
- # An ApiVersion describes a particular version of an API.
98
+ # Describes a particular version of an API.
99
99
  # ApiVersions are what consumers actually use.
100
100
  # @!attribute [rw] name
101
101
  # @return [::String]
@@ -116,7 +116,7 @@ module Google
116
116
  # @return [::String]
117
117
  # A user-definable description of the lifecycle phase of this API version.
118
118
  # Format: free-form, but we expect single words that describe API maturity,
119
- # e.g. "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION",
119
+ # e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION",
120
120
  # "DEPRECATED", "RETIRED".
121
121
  # @!attribute [rw] labels
122
122
  # @return [::Google::Protobuf::Map{::String => ::String}]
@@ -131,7 +131,7 @@ module Google
131
131
  #
132
132
  # See https://goo.gl/xmQnxf for more information and examples of labels.
133
133
  # System reserved label keys are prefixed with
134
- # "apigeeregistry.googleapis.com/" and cannot be changed.
134
+ # `apigeeregistry.googleapis.com/` and cannot be changed.
135
135
  # @!attribute [rw] annotations
136
136
  # @return [::Google::Protobuf::Map{::String => ::String}]
137
137
  # Annotations attach non-identifying metadata to resources.
@@ -162,11 +162,11 @@ module Google
162
162
  end
163
163
  end
164
164
 
165
- # An ApiSpec describes a version of an API in a structured way.
165
+ # Describes a version of an API in a structured way.
166
166
  # ApiSpecs provide formal descriptions that consumers can use to use a version.
167
167
  # ApiSpec resources are intended to be fully-resolved descriptions of an
168
168
  # ApiVersion. When specs consist of multiple files, these should be bundled
169
- # together (e.g. in a zip archive) and stored as a unit. Multiple specs can
169
+ # together (e.g., in a zip archive) and stored as a unit. Multiple specs can
170
170
  # exist to provide representations in different API description formats.
171
171
  # Synchronization of these representations would be provided by tooling and
172
172
  # background services.
@@ -197,8 +197,8 @@ module Google
197
197
  # @return [::String]
198
198
  # A style (format) descriptor for this spec that is specified as a Media Type
199
199
  # (https://en.wikipedia.org/wiki/Media_type). Possible values include
200
- # "application/vnd.apigee.proto", "application/vnd.apigee.openapi", and
201
- # "application/vnd.apigee.graphql", with possible suffixes representing
200
+ # `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and
201
+ # `application/vnd.apigee.graphql`, with possible suffixes representing
202
202
  # compression types. These hypothetical names are defined in the vendor tree
203
203
  # defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final.
204
204
  # Content types can specify compression. Currently only GZip compression is
@@ -235,7 +235,7 @@ module Google
235
235
  #
236
236
  # See https://goo.gl/xmQnxf for more information and examples of labels.
237
237
  # System reserved label keys are prefixed with
238
- # "apigeeregistry.googleapis.com/" and cannot be changed.
238
+ # `apigeeregistry.googleapis.com/` and cannot be changed.
239
239
  # @!attribute [rw] annotations
240
240
  # @return [::Google::Protobuf::Map{::String => ::String}]
241
241
  # Annotations attach non-identifying metadata to resources.
@@ -266,7 +266,7 @@ module Google
266
266
  end
267
267
  end
268
268
 
269
- # An ApiDeployment describes a service running at particular address that
269
+ # Describes a service running at particular address that
270
270
  # provides a particular version of an API. ApiDeployments have revisions which
271
271
  # correspond to different configurations of a single deployment in time.
272
272
  # Revision identifiers should be updated whenever the served API spec or
@@ -296,16 +296,16 @@ module Google
296
296
  # Output only. Last update timestamp: when the represented revision was last modified.
297
297
  # @!attribute [rw] api_spec_revision
298
298
  # @return [::String]
299
- # The full resource name (including revision id) of the spec of the API being
299
+ # The full resource name (including revision ID) of the spec of the API being
300
300
  # served by the deployment. Changes to this value will update the revision.
301
- # Format: apis/\\{api}/deployments/\\{deployment}
301
+ # Format: `apis/{api}/deployments/{deployment}`
302
302
  # @!attribute [rw] endpoint_uri
303
303
  # @return [::String]
304
304
  # The address where the deployment is serving. Changes to this value will
305
305
  # update the revision.
306
306
  # @!attribute [rw] external_channel_uri
307
307
  # @return [::String]
308
- # The address of the external channel of the API (e.g. the Developer
308
+ # The address of the external channel of the API (e.g., the Developer
309
309
  # Portal). Changes to this value will not affect the revision.
310
310
  # @!attribute [rw] intended_audience
311
311
  # @return [::String]
@@ -328,7 +328,7 @@ module Google
328
328
  #
329
329
  # See https://goo.gl/xmQnxf for more information and examples of labels.
330
330
  # System reserved label keys are prefixed with
331
- # "apigeeregistry.googleapis.com/" and cannot be changed.
331
+ # `apigeeregistry.googleapis.com/` and cannot be changed.
332
332
  # @!attribute [rw] annotations
333
333
  # @return [::Google::Protobuf::Map{::String => ::String}]
334
334
  # Annotations attach non-identifying metadata to resources.
@@ -363,8 +363,8 @@ module Google
363
363
  # and are used to store metadata that is too large or numerous to be stored
364
364
  # directly on the resource. Since artifacts are stored separately from parent
365
365
  # resources, they should generally be used for metadata that is needed
366
- # infrequently, i.e. not for display in primary views of the resource but
367
- # perhaps displayed or downloaded upon request. The ListArtifacts method
366
+ # infrequently, i.e., not for display in primary views of the resource but
367
+ # perhaps displayed or downloaded upon request. The `ListArtifacts` method
368
368
  # allows artifacts to be quickly enumerated and checked for presence without
369
369
  # downloading their (potentially-large) contents.
370
370
  # @!attribute [rw] name
data/proto_docs/google/cloud/apigeeregistry/v1/registry_service.rb CHANGED
@@ -25,7 +25,7 @@ module Google
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
27
  # Required. The parent, which owns this collection of APIs.
28
- # Format: projects/*/locations/*
28
+ # Format: `projects/*/locations/*`
29
29
  # @!attribute [rw] page_size
30
30
  # @return [::Integer]
31
31
  # The maximum number of APIs to return.
@@ -65,7 +65,7 @@ module Google
65
65
  # @!attribute [rw] name
66
66
  # @return [::String]
67
67
  # Required. The name of the API to retrieve.
68
- # Format: projects/*/locations/*/apis/*
68
+ # Format: `projects/*/locations/*/apis/*`
69
69
  class GetApiRequest
70
70
  include ::Google::Protobuf::MessageExts
71
71
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -75,14 +75,14 @@ module Google
75
75
  # @!attribute [rw] parent
76
76
  # @return [::String]
77
77
  # Required. The parent, which owns this collection of APIs.
78
- # Format: projects/*/locations/*
78
+ # Format: `projects/*/locations/*`
79
79
  # @!attribute [rw] api
80
80
  # @return [::Google::Cloud::ApigeeRegistry::V1::Api]
81
81
  # Required. The API to create.
82
82
  # @!attribute [rw] api_id
83
83
  # @return [::String]
84
- # Required. The ID to use for the api, which will become the final component of
85
- # the api's resource name.
84
+ # Required. The ID to use for the API, which will become the final component of
85
+ # the API's resource name.
86
86
  #
87
87
  # This value should be 4-63 characters, and valid characters
88
88
  # are /[a-z][0-9]-/.
@@ -99,16 +99,16 @@ module Google
99
99
  # Required. The API to update.
100
100
  #
101
101
  # The `name` field is used to identify the API to update.
102
- # Format: projects/*/locations/*/apis/*
102
+ # Format: `projects/*/locations/*/apis/*`
103
103
  # @!attribute [rw] update_mask
104
104
  # @return [::Google::Protobuf::FieldMask]
105
105
  # The list of fields to be updated. If omitted, all fields are updated that
106
106
  # are set in the request message (fields set to default values are ignored).
107
- # If a "*" is specified, all fields are updated, including fields that are
108
- # unspecified/default in the request.
107
+ # If an asterisk "*" is specified, all fields are updated, including fields
108
+ # that are unspecified/default in the request.
109
109
  # @!attribute [rw] allow_missing
110
110
  # @return [::Boolean]
111
- # If set to true, and the api is not found, a new api will be created.
111
+ # If set to true, and the API is not found, a new API will be created.
112
112
  # In this situation, `update_mask` is ignored.
113
113
  class UpdateApiRequest
114
114
  include ::Google::Protobuf::MessageExts
@@ -119,7 +119,11 @@ module Google
119
119
  # @!attribute [rw] name
120
120
  # @return [::String]
121
121
  # Required. The name of the API to delete.
122
- # Format: projects/*/locations/*/apis/*
122
+ # Format: `projects/*/locations/*/apis/*`
123
+ # @!attribute [rw] force
124
+ # @return [::Boolean]
125
+ # If set to true, any child resources will also be deleted.
126
+ # (Otherwise, the request will only work if there are no child resources.)
123
127
  class DeleteApiRequest
124
128
  include ::Google::Protobuf::MessageExts
125
129
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -129,7 +133,7 @@ module Google
129
133
  # @!attribute [rw] parent
130
134
  # @return [::String]
131
135
  # Required. The parent, which owns this collection of versions.
132
- # Format: projects/*/locations/*/apis/*
136
+ # Format: `projects/*/locations/*/apis/*`
133
137
  # @!attribute [rw] page_size
134
138
  # @return [::Integer]
135
139
  # The maximum number of versions to return.
@@ -169,7 +173,7 @@ module Google
169
173
  # @!attribute [rw] name
170
174
  # @return [::String]
171
175
  # Required. The name of the version to retrieve.
172
- # Format: projects/*/locations/*/apis/*/versions/*
176
+ # Format: `projects/*/locations/*/apis/*/versions/*`
173
177
  class GetApiVersionRequest
174
178
  include ::Google::Protobuf::MessageExts
175
179
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -179,7 +183,7 @@ module Google
179
183
  # @!attribute [rw] parent
180
184
  # @return [::String]
181
185
  # Required. The parent, which owns this collection of versions.
182
- # Format: projects/*/locations/*/apis/*
186
+ # Format: `projects/*/locations/*/apis/*`
183
187
  # @!attribute [rw] api_version
184
188
  # @return [::Google::Cloud::ApigeeRegistry::V1::ApiVersion]
185
189
  # Required. The version to create.
@@ -203,13 +207,13 @@ module Google
203
207
  # Required. The version to update.
204
208
  #
205
209
  # The `name` field is used to identify the version to update.
206
- # Format: projects/*/locations/*/apis/*/versions/*
210
+ # Format: `projects/*/locations/*/apis/*/versions/*`
207
211
  # @!attribute [rw] update_mask
208
212
  # @return [::Google::Protobuf::FieldMask]
209
213
  # The list of fields to be updated. If omitted, all fields are updated that
210
214
  # are set in the request message (fields set to default values are ignored).
211
- # If a "*" is specified, all fields are updated, including fields that are
212
- # unspecified/default in the request.
215
+ # If an asterisk "*" is specified, all fields are updated, including fields
216
+ # that are unspecified/default in the request.
213
217
  # @!attribute [rw] allow_missing
214
218
  # @return [::Boolean]
215
219
  # If set to true, and the version is not found, a new version will be
@@ -223,7 +227,11 @@ module Google
223
227
  # @!attribute [rw] name
224
228
  # @return [::String]
225
229
  # Required. The name of the version to delete.
226
- # Format: projects/*/locations/*/apis/*/versions/*
230
+ # Format: `projects/*/locations/*/apis/*/versions/*`
231
+ # @!attribute [rw] force
232
+ # @return [::Boolean]
233
+ # If set to true, any child resources will also be deleted.
234
+ # (Otherwise, the request will only work if there are no child resources.)
227
235
  class DeleteApiVersionRequest
228
236
  include ::Google::Protobuf::MessageExts
229
237
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -233,7 +241,7 @@ module Google
233
241
  # @!attribute [rw] parent
234
242
  # @return [::String]
235
243
  # Required. The parent, which owns this collection of specs.
236
- # Format: projects/*/locations/*/apis/*/versions/*
244
+ # Format: `projects/*/locations/*/apis/*/versions/*`
237
245
  # @!attribute [rw] page_size
238
246
  # @return [::Integer]
239
247
  # The maximum number of specs to return.
@@ -273,7 +281,7 @@ module Google
273
281
  # @!attribute [rw] name
274
282
  # @return [::String]
275
283
  # Required. The name of the spec to retrieve.
276
- # Format: projects/*/locations/*/apis/*/versions/*/specs/*
284
+ # Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
277
285
  class GetApiSpecRequest
278
286
  include ::Google::Protobuf::MessageExts
279
287
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -283,7 +291,7 @@ module Google
283
291
  # @!attribute [rw] name
284
292
  # @return [::String]
285
293
  # Required. The name of the spec whose contents should be retrieved.
286
- # Format: projects/*/locations/*/apis/*/versions/*/specs/*
294
+ # Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
287
295
  class GetApiSpecContentsRequest
288
296
  include ::Google::Protobuf::MessageExts
289
297
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -293,7 +301,7 @@ module Google
293
301
  # @!attribute [rw] parent
294
302
  # @return [::String]
295
303
  # Required. The parent, which owns this collection of specs.
296
- # Format: projects/*/locations/*/apis/*/versions/*
304
+ # Format: `projects/*/locations/*/apis/*/versions/*`
297
305
  # @!attribute [rw] api_spec
298
306
  # @return [::Google::Cloud::ApigeeRegistry::V1::ApiSpec]
299
307
  # Required. The spec to create.
@@ -317,13 +325,13 @@ module Google
317
325
  # Required. The spec to update.
318
326
  #
319
327
  # The `name` field is used to identify the spec to update.
320
- # Format: projects/*/locations/*/apis/*/versions/*/specs/*
328
+ # Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
321
329
  # @!attribute [rw] update_mask
322
330
  # @return [::Google::Protobuf::FieldMask]
323
331
  # The list of fields to be updated. If omitted, all fields are updated that
324
332
  # are set in the request message (fields set to default values are ignored).
325
- # If a "*" is specified, all fields are updated, including fields that are
326
- # unspecified/default in the request.
333
+ # If an asterisk "*" is specified, all fields are updated, including fields
334
+ # that are unspecified/default in the request.
327
335
  # @!attribute [rw] allow_missing
328
336
  # @return [::Boolean]
329
337
  # If set to true, and the spec is not found, a new spec will be created.
@@ -337,7 +345,7 @@ module Google
337
345
  # @!attribute [rw] name
338
346
  # @return [::String]
339
347
  # Required. The name of the spec to delete.
340
- # Format: projects/*/locations/*/apis/*/versions/*/specs/*
348
+ # Format: `projects/*/locations/*/apis/*/versions/*/specs/*`
341
349
  # @!attribute [rw] force
342
350
  # @return [::Boolean]
343
351
  # If set to true, any child resources will also be deleted.
@@ -398,7 +406,7 @@ module Google
398
406
  # Required. The revision ID to roll back to.
399
407
  # It must be a revision of the same spec.
400
408
  #
401
- # Example: c7cfa2a8
409
+ # Example: `c7cfa2a8`
402
410
  class RollbackApiSpecRequest
403
411
  include ::Google::Protobuf::MessageExts
404
412
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -411,7 +419,7 @@ module Google
411
419
  # with a revision ID explicitly included.
412
420
  #
413
421
  # Example:
414
- # projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8
422
+ # `projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8`
415
423
  class DeleteApiSpecRevisionRequest
416
424
  include ::Google::Protobuf::MessageExts
417
425
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -421,7 +429,7 @@ module Google
421
429
  # @!attribute [rw] parent
422
430
  # @return [::String]
423
431
  # Required. The parent, which owns this collection of deployments.
424
- # Format: projects/*/locations/*/apis/*
432
+ # Format: `projects/*/locations/*/apis/*`
425
433
  # @!attribute [rw] page_size
426
434
  # @return [::Integer]
427
435
  # The maximum number of deployments to return.
@@ -461,7 +469,7 @@ module Google
461
469
  # @!attribute [rw] name
462
470
  # @return [::String]
463
471
  # Required. The name of the deployment to retrieve.
464
- # Format: projects/*/locations/*/apis/*/deployments/*
472
+ # Format: `projects/*/locations/*/apis/*/deployments/*`
465
473
  class GetApiDeploymentRequest
466
474
  include ::Google::Protobuf::MessageExts
467
475
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -471,7 +479,7 @@ module Google
471
479
  # @!attribute [rw] parent
472
480
  # @return [::String]
473
481
  # Required. The parent, which owns this collection of deployments.
474
- # Format: projects/*/locations/*/apis/*
482
+ # Format: `projects/*/locations/*/apis/*`
475
483
  # @!attribute [rw] api_deployment
476
484
  # @return [::Google::Cloud::ApigeeRegistry::V1::ApiDeployment]
477
485
  # Required. The deployment to create.
@@ -495,13 +503,13 @@ module Google
495
503
  # Required. The deployment to update.
496
504
  #
497
505
  # The `name` field is used to identify the deployment to update.
498
- # Format: projects/*/locations/*/apis/*/deployments/*
506
+ # Format: `projects/*/locations/*/apis/*/deployments/*`
499
507
  # @!attribute [rw] update_mask
500
508
  # @return [::Google::Protobuf::FieldMask]
501
509
  # The list of fields to be updated. If omitted, all fields are updated that
502
510
  # are set in the request message (fields set to default values are ignored).
503
- # If a "*" is specified, all fields are updated, including fields that are
504
- # unspecified/default in the request.
511
+ # If an asterisk "*" is specified, all fields are updated, including fields
512
+ # that are unspecified/default in the request.
505
513
  # @!attribute [rw] allow_missing
506
514
  # @return [::Boolean]
507
515
  # If set to true, and the deployment is not found, a new deployment will be
@@ -515,7 +523,7 @@ module Google
515
523
  # @!attribute [rw] name
516
524
  # @return [::String]
517
525
  # Required. The name of the deployment to delete.
518
- # Format: projects/*/locations/*/apis/*/deployments/*
526
+ # Format: `projects/*/locations/*/apis/*/deployments/*`
519
527
  # @!attribute [rw] force
520
528
  # @return [::Boolean]
521
529
  # If set to true, any child resources will also be deleted.
@@ -576,7 +584,7 @@ module Google
576
584
  # Required. The revision ID to roll back to.
577
585
  # It must be a revision of the same deployment.
578
586
  #
579
- # Example: c7cfa2a8
587
+ # Example: `c7cfa2a8`
580
588
  class RollbackApiDeploymentRequest
581
589
  include ::Google::Protobuf::MessageExts
582
590
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -589,7 +597,7 @@ module Google
589
597
  # with a revision ID explicitly included.
590
598
  #
591
599
  # Example:
592
- # projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8
600
+ # `projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8`
593
601
  class DeleteApiDeploymentRevisionRequest
594
602
  include ::Google::Protobuf::MessageExts
595
603
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -599,7 +607,7 @@ module Google
599
607
  # @!attribute [rw] parent
600
608
  # @return [::String]
601
609
  # Required. The parent, which owns this collection of artifacts.
602
- # Format: \\{parent}
610
+ # Format: `{parent}`
603
611
  # @!attribute [rw] page_size
604
612
  # @return [::Integer]
605
613
  # The maximum number of artifacts to return.
@@ -639,7 +647,7 @@ module Google
639
647
  # @!attribute [rw] name
640
648
  # @return [::String]
641
649
  # Required. The name of the artifact to retrieve.
642
- # Format: \\{parent}/artifacts/*
650
+ # Format: `{parent}/artifacts/*`
643
651
  class GetArtifactRequest
644
652
  include ::Google::Protobuf::MessageExts
645
653
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -649,7 +657,7 @@ module Google
649
657
  # @!attribute [rw] name
650
658
  # @return [::String]
651
659
  # Required. The name of the artifact whose contents should be retrieved.
652
- # Format: \\{parent}/artifacts/*
660
+ # Format: `{parent}/artifacts/*`
653
661
  class GetArtifactContentsRequest
654
662
  include ::Google::Protobuf::MessageExts
655
663
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -659,7 +667,7 @@ module Google
659
667
  # @!attribute [rw] parent
660
668
  # @return [::String]
661
669
  # Required. The parent, which owns this collection of artifacts.
662
- # Format: \\{parent}
670
+ # Format: `{parent}`
663
671
  # @!attribute [rw] artifact
664
672
  # @return [::Google::Cloud::ApigeeRegistry::V1::Artifact]
665
673
  # Required. The artifact to create.
@@ -683,7 +691,7 @@ module Google
683
691
  # Required. The artifact to replace.
684
692
  #
685
693
  # The `name` field is used to identify the artifact to replace.
686
- # Format: \\{parent}/artifacts/*
694
+ # Format: `{parent}/artifacts/*`
687
695
  class ReplaceArtifactRequest
688
696
  include ::Google::Protobuf::MessageExts
689
697
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -693,7 +701,7 @@ module Google
693
701
  # @!attribute [rw] name
694
702
  # @return [::String]
695
703
  # Required. The name of the artifact to delete.
696
- # Format: \\{parent}/artifacts/*
704
+ # Format: `{parent}/artifacts/*`
697
705
  class DeleteArtifactRequest
698
706
  include ::Google::Protobuf::MessageExts
699
707
  extend ::Google::Protobuf::MessageExts::ClassMethods