Skip to content

Commit

Permalink
docs: fix remaining broken links (#133)
Browse files Browse the repository at this point in the history
* build: fix broken links

PiperOrigin-RevId: 443188324

Source-Link: googleapis/googleapis@775267e

Source-Link: googleapis/googleapis-gen@166b6e3
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTY2YjZlM2FjNDZlMjgyMWIyYmM5Y2E0NDNjM2FjYTRkMWNiZTc4MiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* docs: fix remaining broken links

PiperOrigin-RevId: 443508623

Source-Link: googleapis/googleapis@fd6935f

Source-Link: googleapis/googleapis-gen@4f659e3
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGY2NTllM2I4YWNlMmU4NmMwMjdjNGZlY2E5ZGVjZDZlZTU4YzY0YyJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Apr 26, 2022
1 parent 57414ff commit 771ac37
Show file tree
Hide file tree
Showing 14 changed files with 165 additions and 115 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ option ruby_package = "Google::Cloud::ServiceManagement::V1";
// The full representation of a Service that is managed by
// Google Service Management.
message ManagedService {
// The name of the service. See the [overview](/service-management/overview)
// The name of the service. See the
// [overview](https://cloud.google.com/service-infrastructure/docs/overview)
// for naming requirements.
string service_name = 2;

Expand Down Expand Up @@ -226,9 +227,7 @@ message Rollout {

// Strategy used to delete a service. This strategy is a placeholder only
// used by the system generated rollout to delete a service.
message DeleteServiceStrategy {

}
message DeleteServiceStrategy {}

// Status of a Rollout.
enum RolloutStatus {
Expand Down Expand Up @@ -256,8 +255,9 @@ message Rollout {
FAILED_ROLLED_BACK = 6;
}

// Optional. Unique identifier of this Rollout. Must be no longer than 63 characters
// and only lower case letters, digits, '.', '_' and '-' are allowed.
// Optional. Unique identifier of this Rollout. Must be no longer than 63
// characters and only lower case letters, digits, '.', '_' and '-' are
// allowed.
//
// If not specified by client, the server will generate one. The generated id
// will have the form of <date><revision number>, where "date" is the create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ option objc_class_prefix = "GASM";
option php_namespace = "Google\\Cloud\\ServiceManagement\\V1";
option ruby_package = "Google::Cloud::ServiceManagement::V1";

// [Google Service Management API](/service-management/overview)
// [Google Service Management
// API](https://cloud.google.com/service-infrastructure/docs/overview)
service ServiceManager {
option (google.api.default_host) = "servicemanagement.googleapis.com";
option (google.api.oauth_scopes) =
Expand Down Expand Up @@ -74,7 +75,8 @@ service ServiceManager {
// dedicated producer project.
//
// Operation<response: ManagedService>
rpc CreateService(CreateServiceRequest) returns (google.longrunning.Operation) {
rpc CreateService(CreateServiceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/services"
body: "service"
Expand All @@ -88,11 +90,14 @@ service ServiceManager {

// Deletes a managed service. This method will change the service to the
// `Soft-Delete` state for 30 days. Within this period, service producers may
// call [UndeleteService][google.api.servicemanagement.v1.ServiceManager.UndeleteService] to restore the service.
// After 30 days, the service will be permanently deleted.
// call
// [UndeleteService][google.api.servicemanagement.v1.ServiceManager.UndeleteService]
// to restore the service. After 30 days, the service will be permanently
// deleted.
//
// Operation<response: google.protobuf.Empty>
rpc DeleteService(DeleteServiceRequest) returns (google.longrunning.Operation) {
rpc DeleteService(DeleteServiceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/services/{service_name}"
};
Expand All @@ -109,7 +114,8 @@ service ServiceManager {
// last 30 days.
//
// Operation<response: UndeleteServiceResponse>
rpc UndeleteService(UndeleteServiceRequest) returns (google.longrunning.Operation) {
rpc UndeleteService(UndeleteServiceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/services/{service_name}:undelete"
};
Expand All @@ -122,7 +128,8 @@ service ServiceManager {

// Lists the history of the service configuration for a managed service,
// from the newest to the oldest.
rpc ListServiceConfigs(ListServiceConfigsRequest) returns (ListServiceConfigsResponse) {
rpc ListServiceConfigs(ListServiceConfigsRequest)
returns (ListServiceConfigsResponse) {
option (google.api.http) = {
get: "/v1/services/{service_name}/configs"
};
Expand All @@ -133,9 +140,7 @@ service ServiceManager {
rpc GetServiceConfig(GetServiceConfigRequest) returns (google.api.Service) {
option (google.api.http) = {
get: "/v1/services/{service_name}/configs/{config_id}"
additional_bindings {
get: "/v1/services/{service_name}/config"
}
additional_bindings { get: "/v1/services/{service_name}/config" }
};
option (google.api.method_signature) = "service_name,config_id,view";
}
Expand All @@ -148,7 +153,8 @@ service ServiceManager {
// Only the 100 most recent service configurations and ones referenced by
// existing rollouts are kept for each service. The rest will be deleted
// eventually.
rpc CreateServiceConfig(CreateServiceConfigRequest) returns (google.api.Service) {
rpc CreateServiceConfig(CreateServiceConfigRequest)
returns (google.api.Service) {
option (google.api.http) = {
post: "/v1/services/{service_name}/configs"
body: "service_config"
Expand All @@ -162,19 +168,22 @@ service ServiceManager {
// Specification). This method stores the source configurations as well as the
// generated service configuration. To rollout the service configuration to
// other services,
// please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].
// please call
// [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].
//
// Only the 100 most recent configuration sources and ones referenced by
// existing service configurtions are kept for each service. The rest will be
// deleted eventually.
//
// Operation<response: SubmitConfigSourceResponse>
rpc SubmitConfigSource(SubmitConfigSourceRequest) returns (google.longrunning.Operation) {
rpc SubmitConfigSource(SubmitConfigSourceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/services/{service_name}/configs:submit"
body: "*"
};
option (google.api.method_signature) = "service_name,config_source,validate_only";
option (google.api.method_signature) =
"service_name,config_source,validate_only";
option (google.longrunning.operation_info) = {
response_type: "google.api.servicemanagement.v1.SubmitConfigSourceResponse"
metadata_type: "google.api.servicemanagement.v1.OperationMetadata"
Expand All @@ -183,14 +192,16 @@ service ServiceManager {

// Lists the history of the service configuration rollouts for a managed
// service, from the newest to the oldest.
rpc ListServiceRollouts(ListServiceRolloutsRequest) returns (ListServiceRolloutsResponse) {
rpc ListServiceRollouts(ListServiceRolloutsRequest)
returns (ListServiceRolloutsResponse) {
option (google.api.http) = {
get: "/v1/services/{service_name}/rollouts"
};
option (google.api.method_signature) = "service_name,filter";
}

// Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].
// Gets a service configuration
// [rollout][google.api.servicemanagement.v1.Rollout].
rpc GetServiceRollout(GetServiceRolloutRequest) returns (Rollout) {
option (google.api.http) = {
get: "/v1/services/{service_name}/rollouts/{rollout_id}"
Expand All @@ -212,7 +223,8 @@ service ServiceManager {
// service. The rest will be deleted eventually.
//
// Operation<response: Rollout>
rpc CreateServiceRollout(CreateServiceRolloutRequest) returns (google.longrunning.Operation) {
rpc CreateServiceRollout(CreateServiceRolloutRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/services/{service_name}/rollouts"
body: "rollout"
Expand All @@ -235,7 +247,8 @@ service ServiceManager {
// If GenerateConfigReportRequest.old_value is not specified, this method
// will compare GenerateConfigReportRequest.new_value with the last pushed
// service configuration.
rpc GenerateConfigReport(GenerateConfigReportRequest) returns (GenerateConfigReportResponse) {
rpc GenerateConfigReport(GenerateConfigReportRequest)
returns (GenerateConfigReportResponse) {
option (google.api.http) = {
post: "/v1/services:generateConfigReport"
body: "*"
Expand Down Expand Up @@ -276,8 +289,8 @@ message ListServicesResponse {

// Request message for `GetService` method.
message GetServiceRequest {
// Required. The name of the service. See the `ServiceManager` overview for naming
// requirements. For example: `example.googleapis.com`.
// Required. The name of the service. See the `ServiceManager` overview for
// naming requirements. For example: `example.googleapis.com`.
string service_name = 1 [(google.api.field_behavior) = REQUIRED];
}

Expand All @@ -289,15 +302,17 @@ message CreateServiceRequest {

// Request message for DeleteService method.
message DeleteServiceRequest {
// Required. The name of the service. See the [overview](/service-management/overview)
// for naming requirements. For example: `example.googleapis.com`.
// Required. The name of the service. See the
// [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
// example: `example.googleapis.com`.
string service_name = 1 [(google.api.field_behavior) = REQUIRED];
}

// Request message for UndeleteService method.
message UndeleteServiceRequest {
// Required. The name of the service. See the [overview](/service-management/overview)
// for naming requirements. For example: `example.googleapis.com`.
// Required. The name of the service. See the
// [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
// example: `example.googleapis.com`.
string service_name = 1 [(google.api.field_behavior) = REQUIRED];
}

Expand All @@ -320,8 +335,9 @@ message GetServiceConfigRequest {
FULL = 1;
}

// Required. The name of the service. See the [overview](/service-management/overview)
// for naming requirements. For example: `example.googleapis.com`.
// Required. The name of the service. See the
// [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
// example: `example.googleapis.com`.
string service_name = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The id of the service configuration resource.
Expand All @@ -337,8 +353,9 @@ message GetServiceConfigRequest {

// Request message for ListServiceConfigs method.
message ListServiceConfigsRequest {
// Required. The name of the service. See the [overview](/service-management/overview)
// for naming requirements. For example: `example.googleapis.com`.
// Required. The name of the service. See the
// [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
// example: `example.googleapis.com`.
string service_name = 1 [(google.api.field_behavior) = REQUIRED];

// The token of the page to retrieve.
Expand All @@ -360,18 +377,21 @@ message ListServiceConfigsResponse {

// Request message for CreateServiceConfig method.
message CreateServiceConfigRequest {
// Required. The name of the service. See the [overview](/service-management/overview)
// for naming requirements. For example: `example.googleapis.com`.
// Required. The name of the service. See the
// [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
// example: `example.googleapis.com`.
string service_name = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The service configuration resource.
google.api.Service service_config = 2 [(google.api.field_behavior) = REQUIRED];
google.api.Service service_config = 2
[(google.api.field_behavior) = REQUIRED];
}

// Request message for SubmitConfigSource method.
message SubmitConfigSourceRequest {
// Required. The name of the service. See the [overview](/service-management/overview)
// for naming requirements. For example: `example.googleapis.com`.
// Required. The name of the service. See the
// [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
// example: `example.googleapis.com`.
string service_name = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The source configuration for the service.
Expand All @@ -391,8 +411,9 @@ message SubmitConfigSourceResponse {

// Request message for 'CreateServiceRollout'
message CreateServiceRolloutRequest {
// Required. The name of the service. See the [overview](/service-management/overview)
// for naming requirements. For example: `example.googleapis.com`.
// Required. The name of the service. See the
// [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
// example: `example.googleapis.com`.
string service_name = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The rollout resource. The `service_name` field is output only.
Expand All @@ -401,8 +422,9 @@ message CreateServiceRolloutRequest {

// Request message for 'ListServiceRollouts'
message ListServiceRolloutsRequest {
// Required. The name of the service. See the [overview](/service-management/overview)
// for naming requirements. For example: `example.googleapis.com`.
// Required. The name of the service. See the
// [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
// example: `example.googleapis.com`.
string service_name = 1 [(google.api.field_behavior) = REQUIRED];

// The token of the page to retrieve.
Expand All @@ -415,10 +437,10 @@ message ListServiceRolloutsRequest {
// Required. Use `filter` to return subset of rollouts.
// The following filters are supported:
// -- To limit the results to only those in
// [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',
// status (google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',
// use filter='status=SUCCESS'
// -- To limit the results to those in
// [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'
// status (google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'
// or 'FAILED', use filter='status=CANCELLED OR status=FAILED'
string filter = 4 [(google.api.field_behavior) = REQUIRED];
}
Expand All @@ -434,8 +456,9 @@ message ListServiceRolloutsResponse {

// Request message for GetServiceRollout method.
message GetServiceRolloutRequest {
// Required. The name of the service. See the [overview](/service-management/overview)
// for naming requirements. For example: `example.googleapis.com`.
// Required. The name of the service. See the
// [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
// example: `example.googleapis.com`.
string service_name = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The id of the rollout resource.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ function main(serviceName, serviceConfig) {
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the service. See the overview (/service-management/overview)
* for naming requirements. For example: `example.googleapis.com`.
* Required. The name of the service. See the
* overview (https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
* example: `example.googleapis.com`.
*/
// const serviceName = 'abc123'
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ function main(serviceName, rollout) {
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the service. See the overview (/service-management/overview)
* for naming requirements. For example: `example.googleapis.com`.
* Required. The name of the service. See the
* overview (https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
* example: `example.googleapis.com`.
*/
// const serviceName = 'abc123'
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ function main(serviceName) {
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the service. See the overview (/service-management/overview)
* for naming requirements. For example: `example.googleapis.com`.
* Required. The name of the service. See the
* overview (https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
* example: `example.googleapis.com`.
*/
// const serviceName = 'abc123'

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ function main(serviceName) {
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the service. See the `ServiceManager` overview for naming
* requirements. For example: `example.googleapis.com`.
* Required. The name of the service. See the `ServiceManager` overview for
* naming requirements. For example: `example.googleapis.com`.
*/
// const serviceName = 'abc123'

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ function main(serviceName, configId) {
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the service. See the overview (/service-management/overview)
* for naming requirements. For example: `example.googleapis.com`.
* Required. The name of the service. See the
* overview (https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
* example: `example.googleapis.com`.
*/
// const serviceName = 'abc123'
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ function main(serviceName, rolloutId) {
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the service. See the overview (/service-management/overview)
* for naming requirements. For example: `example.googleapis.com`.
* Required. The name of the service. See the
* overview (https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
* example: `example.googleapis.com`.
*/
// const serviceName = 'abc123'
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ function main(serviceName) {
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the service. See the overview (/service-management/overview)
* for naming requirements. For example: `example.googleapis.com`.
* Required. The name of the service. See the
* overview (https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. For
* example: `example.googleapis.com`.
*/
// const serviceName = 'abc123'
/**
Expand Down
Loading

0 comments on commit 771ac37

Please sign in to comment.