feat(proto): Create Policy SDK and API Service (#793)

This commit is contained in:
Hugo authored and Louis Ruch committed 2024-01-16 13:53:41 -08:00
1 parent c43ded06a6
commit 1c3b1b42f7
10 files changed
+2999 -42

No files matched your search

@@ -0,0 +1,134 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
syntax = "proto3";
package controller.api.resources.policies.v1;
import "controller/api/resources/scopes/v1/scope.proto";
import "controller/custom_options/v1/options.proto";
import "google/api/visibility.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resources/policies;policies";
message Policy {
// Output only. The id of the storage policy.
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
// The scope id of this policy. This must be defined for policy creation, but
// is otherwise output only.
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
// Output only. Scope information for this resource.
resources.scopes.v1.ScopeInfo scope = 30;
// 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"
}
]; // @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"
}
]; // @gotags: `class:"public"`
// Output only. The time this resource was created.
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
// The policy's type.
string type = 80; // @gotags: `class:"public" eventstream:"observation"`
// 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 = 90; // @gotags: `class:"public"`
// The attributes that are applicable to each policy type.
oneof attrs {
google.protobuf.Struct attributes = 100 [
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.subtype) = "default"
];
StoragePolicyAttributes storage_policy_attributes = 101 [
(google.api.field_visibility).restriction = "INTERNAL",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.subtype) = "storage"
];
}
// Output only. The available actions on this resource for this user.
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public"`
}
message StoragePolicyAttributes {
StoragePolicyRetainFor retain_for = 10 [
json_name = "retain_for",
(custom_options.v1.generate_sdk_option) = true
];
StoragePolicyDeleteAfter delete_after = 20 [
json_name = "delete_after",
(custom_options.v1.generate_sdk_option) = true
];
}
message StoragePolicyRetainFor {
// days is the number of days for which a session recording will be
// retained. Must be provided.
int64 days = 10 [
json_name = "days",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "attributes.retain_for.days"
that: "RetainForDays"
}
]; // @gotags: `class:"public"`
// overridable signals whether this storage policy's retention duration can be
// overridden.
google.protobuf.BoolValue overridable = 20 [
json_name = "overridable",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "attributes.retain_for.overridable"
that: "RetainForDaysOverridable"
}
]; // @gotags: `class:"public"`
}
message StoragePolicyDeleteAfter {
// days is the number of days after which a session recording will be
// automatically deleted.
int64 days = 10 [
json_name = "days",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "attributes.delete_after.days"
that: "DeleteAfterDays"
}
]; // @gotags: `class:"public"`
// overridable signals whether this storage policy's deletion policy can be
// overridden.
google.protobuf.BoolValue overridable = 20 [
json_name = "overridable",
(custom_options.v1.generate_sdk_option) = true,
(custom_options.v1.mask_mapping) = {
this: "attributes.delete_after.overridable"
that: "DeleteAfterDaysOverridable"
}
]; // @gotags: `class:"public"`
}
@@ -0,0 +1,114 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
syntax = "proto3";
package controller.api.services.v1;
import "controller/api/resources/policies/v1/policy.proto";
import "controller/custom_options/v1/options.proto";
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
option go_package = "github.com/hashicorp/boundary/internal/gen/controller/api/services;services";
option (custom_options.v1.domain) = "policy";
service PolicyService {
// GetPolicy returns a policy with the given id, if it exists. The request
// must include a policy id. An error is returned if the id is missing,
// malformed, or if a policy with the provided id doesn't exist.
rpc GetPolicy(GetPolicyRequest) returns (GetPolicyResponse) {
option (google.api.http) = {
get: "/v1/policies/{id}"
response_body: "item"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Gets a single policy with the given id."};
}
// ListPolicies returns a list of stored policies in Boundary which exist
// inside the scope referenced in the request. The request must include the
// scope id for the policies being retrieved. An error is returned if the
// scope id is missing, malformed, or references a non existing scope.
rpc ListPolicies(ListPoliciesRequest) returns (ListPoliciesResponse) {
option (google.api.http) = {get: "/v1/policies"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Lists all policies."};
}
// CreatePolicy creates and stores a new policy in Boundary. The provided
// request must include the scope id in which the policy will be created. An
// error is returned if the scope id is missing, malformed or references a non
// existing scope.
rpc CreatePolicy(CreatePolicyRequest) returns (CreatePolicyResponse) {
option (google.api.http) = {
post: "/v1/policies"
body: "item"
response_body: "item"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Creates a single policy."};
}
// UpdatePolicy updates an existing policy in Boundary. The provided policy
// must not have any read-only fields set. The update mask must be included in
// the request and contain at least one mutable field. To unset a field's
// value (if unsettable), include it in the update mask and don't set it in
// the policy object.
rpc UpdatePolicy(UpdatePolicyRequest) returns (UpdatePolicyResponse) {
option (google.api.http) = {
patch: "/v1/policies/{id}"
body: "item"
response_body: "item"
};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Updates an existing policy."};
}
// DeletePolicy deletes a policy from Boundary. An error is returned if the
// policy id is malformed or not provided.
rpc DeletePolicy(DeletePolicyRequest) returns (DeletePolicyResponse) {
option (google.api.http) = {delete: "/v1/policies/{id}"};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Deletes an existing policy."};
}
}
message GetPolicyRequest {
string id = 1; // @gotags: `class:"public" eventstream:"observation"`
}
message GetPolicyResponse {
api.resources.policies.v1.Policy item = 1;
}
message ListPoliciesRequest {
string scope_id = 1; // @gotags: `class:"public" eventstream:"observation"`
bool recursive = 2 [json_name = "recursive"]; // @gotags: `class:"public" eventstream:"observation"`
string filter = 3 [json_name = "filter"]; // @gotags: `class:"public"`
}
message ListPoliciesResponse {
repeated api.resources.policies.v1.Policy items = 1;
}
message CreatePolicyRequest {
api.resources.policies.v1.Policy item = 1;
}
message CreatePolicyResponse {
string uri = 1; // @gotags: `class:"public" eventstream:"observation"`
api.resources.policies.v1.Policy item = 2;
}
message UpdatePolicyRequest {
string id = 1; // @gotags: `class:"public" eventstream:"observation"`
api.resources.policies.v1.Policy item = 2;
google.protobuf.FieldMask update_mask = 3 [json_name = "update_mask"];
}
message UpdatePolicyResponse {
api.resources.policies.v1.Policy item = 1;
}
message DeletePolicyRequest {
string id = 1; // @gotags: `class:"public" eventstream:"observation"`
}
message DeletePolicyResponse {}