feat(hostcatalogs): Classify all proto fields

This commit is contained in:
Johan Brandhorst-Satzkorn committed 2022-04-20 13:32:31 -04:00
1 parent 5440195cce
commit 8fa3e8dee0
11 files changed
+446 -219

No files matched your search

@@ -14,51 +14,53 @@ import "controller/custom_options/v1/options.proto";
// HostCatalog manages Hosts and Host Sets
message HostCatalog {
// Output only. The ID of the host.
string id = 10;
string id = 10; // @gotags: `class:"public"`
// The ID of the Scope of which this Host Catalog is a part.
string scope_id = 20 [json_name="scope_id"];
string scope_id = 20 [json_name="scope_id"]; // @gotags: `class:"public"`
// Output only. Scope information for this resource.
resources.scopes.v1.ScopeInfo scope = 30;
// The ID of the plugin of which this catalog is created.
string plugin_id = 34 [json_name="plugin_id", (custom_options.v1.generate_sdk_option) = true];
string plugin_id = 34 [json_name="plugin_id", (custom_options.v1.generate_sdk_option) = true]; // @gotags: `class:"public"`
// Output only. Plugin information for this resource.
resources.plugins.v1.PluginInfo plugin = 35;
// Optional name for identification purposes.
google.protobuf.StringValue name = 40 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"name" that: "name"}];
google.protobuf.StringValue name = 40 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"name" that: "name"}]; // @gotags: `class:"public"`
// Optional user-set description for identification purposes.
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}]; // @gotags: `class:"public"`
// Output only. The time this resource was created.
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
google.protobuf.Timestamp created_time = 60 [json_name="created_time"]; // @gotags: `class:"public"`
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"]; // @gotags: `class:"public"`
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80;
uint32 version = 80; // @gotags: `class:"public"`
// The type of Host Catalog.
string type = 90;
string type = 90; // @gotags: `class:"public"`
// Attributes specific to the catalog type.
google.protobuf.Struct attributes = 100 [(custom_options.v1.generate_sdk_option) = true];
oneof attrs {
// Attributes specific to the catalog type.
google.protobuf.Struct attributes = 100 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.subtype) = "default"];
}
// Secrets specific to the catalog type. These are never output.
google.protobuf.Struct secrets = 110 [(custom_options.v1.generate_sdk_option) = true];
// Output only. The HMAC of the last secrets supplied via the API, if any.
string secrets_hmac = 120;
string secrets_hmac = 120; // @gotags: `class:"public"`
// Output only. The available actions on this resource for this user.
repeated string authorized_actions = 300 [json_name="authorized_actions"];
repeated string authorized_actions = 300 [json_name="authorized_actions"]; // @gotags: `class:"public"`
// Output only. The authorized actions for the scope's collections.
map<string, google.protobuf.ListValue> authorized_collection_actions = 310 [json_name="authorized_collection_actions"];
map<string, google.protobuf.ListValue> authorized_collection_actions = 310 [json_name="authorized_collection_actions"]; // classified as public via taggable implementation
}
@@ -8,6 +8,9 @@ import "protoc-gen-openapiv2/options/annotations.proto";
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "controller/api/resources/hostcatalogs/v1/host_catalog.proto";
import "controller/custom_options/v1/options.proto";
option (custom_options.v1.domain) = "host";
service HostCatalogService {
@@ -84,7 +87,7 @@ service HostCatalogService {
}
message GetHostCatalogRequest {
string id = 1;
string id = 1; // @gotags: `class:"public"`
}
message GetHostCatalogResponse {
@@ -92,9 +95,9 @@ message GetHostCatalogResponse {
}
message ListHostCatalogsRequest {
string scope_id = 1 [json_name="scope_id"];
bool recursive = 20 [json_name="recursive"];
string filter = 30 [json_name="filter"];
string scope_id = 1 [json_name="scope_id"]; // @gotags: `class:"public"`
bool recursive = 20 [json_name="recursive"]; // @gotags: `class:"public"`
string filter = 30 [json_name="filter"]; // @gotags: `class:"public"`
}
message ListHostCatalogsResponse {
@@ -105,16 +108,16 @@ message CreateHostCatalogRequest {
api.resources.hostcatalogs.v1.HostCatalog item = 1;
// As an alternative to providing the plugin id in the provided HostCatalog,
// this field can be used to lookup the plugin using its name.
string plugin_name = 2 [json_name="plugin_name"];
string plugin_name = 2 [json_name="plugin_name"]; // @gotags: `class:"public"`
}
message CreateHostCatalogResponse {
string uri = 1;
string uri = 1; // @gotags: `class:"public"`
api.resources.hostcatalogs.v1.HostCatalog item = 2;
}
message UpdateHostCatalogRequest {
string id = 1;
string id = 1; // @gotags: `class:"public"`
api.resources.hostcatalogs.v1.HostCatalog item = 2;
google.protobuf.FieldMask update_mask = 3;
}
@@ -124,7 +127,7 @@ message UpdateHostCatalogResponse {
}
message DeleteHostCatalogRequest {
string id = 1;
string id = 1; // @gotags: `class:"public"`
}
message DeleteHostCatalogResponse {}