Skip to content

Commit

Permalink
more minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
anekkanti committed Oct 10, 2023
1 parent e7b54cf commit bc0cbf9
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 55 deletions.
45 changes: 23 additions & 22 deletions temporal/api/cloud/cloudservice/v1/request_response.proto
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ message GetUsersRequest {
int32 page_size = 1;
// The page token
string page_token = 2;
// Optional field to filter users by email address
// Filter users by email address - optional
string email = 3;
}

Expand Down Expand Up @@ -110,52 +110,53 @@ message GetAsyncOperationResponse {
}

message CreateNamespaceRequest {
// the prefix to use for the namespace
// The prefix to use for the namespace
// will create a namespace that's available at '<namespace_prefix>.<account>.tmprl.cloud:7233'
string namespace_prefix = 1;
// the namespace specification
// The namespace specification
temporal.api.cloud.namespace.v1.NamespaceSpec spec = 2;
// The id to use for this async operation - optional
string async_operation_id = 3;
}

message CreateNamespaceResponse {
// The namespace that was created
string namespace = 1;
// The async operation
temporal.api.cloud.operation.v1.AsyncOperation async_operation = 1;
}

message GetNamespacesRequest {
// the requested size of the page to retrieve
// The requested size of the page to retrieve
int32 page_size = 1;
// the page token
// The page token
string page_token = 2;
}

message GetNamespacesResponse {
// the list of namespaces
// The list of namespaces
repeated temporal.api.cloud.namespace.v1.Namespace namespaces = 1;
// the next page's token
// The next page's token
string next_page_token = 2;
}

message GetNamespaceRequest {
// the namespace to get
// The namespace to get
string namespace = 1;
}

message GetNamespaceResponse {
// the namespace
// The namespace
temporal.api.cloud.namespace.v1.Namespace namespace = 1;
}


message UpdateNamespaceRequest {
// the namespace to update
// The namespace to update
string namespace = 1;
// the new namespace specification
// The new namespace specification
temporal.api.cloud.namespace.v1.NamespaceSpec spec = 2;
// the version of the namespace for which this update is intended for
// the latest version can be found in the namespace status
// The version of the namespace for which this update is intended for
// The latest version can be found in the namespace status
string resource_version = 3;
// The id to use for this async operation - optional
string async_operation_id = 4;
Expand All @@ -167,14 +168,14 @@ message UpdateNamespaceResponse {
}

message RenameCustomSearchAttributeRequest {
// the namespace to rename the custom search attribute for
// The namespace to rename the custom search attribute for
string namespace = 1;
// the existing name of the custom search attribute to be renamed
// The existing name of the custom search attribute to be renamed
string existing_custom_search_attribute_name = 2;
// the new name of the custom search attribute
// The new name of the custom search attribute
string new_custom_search_attribute_name = 3;
// the version of the namespace for which this update is intended for
// the latest version can be found in the namespace status
// The version of the namespace for which this update is intended for
// The latest version can be found in the namespace status
string resource_version = 4;
// The id to use for this async operation - optional
string async_operation_id = 5;
Expand All @@ -186,10 +187,10 @@ message RenameCustomSearchAttributeResponse {
}

message DeleteNamespaceRequest {
// the namespace to delete
// The namespace to delete
string namespace = 1;
// the version of the namespace for which this delete is intended for
// the latest version can be found in the namespace status
// The version of the namespace for which this delete is intended for
// The latest version can be found in the namespace status
string resource_version = 2;
// The id to use for this async operation - optional
string async_operation_id = 3;
Expand Down
66 changes: 33 additions & 33 deletions temporal/api/cloud/namespace/v1/message.proto
Original file line number Diff line number Diff line change
Expand Up @@ -9,85 +9,85 @@ import "temporal/api/cloud/sink/v1/message.proto";
import "google/protobuf/timestamp.proto";

message CertificateFilterSpec {
// the common_name in the certificate
// The common_name in the certificate
string common_name = 1;
// the organization in the certificate
// The organization in the certificate
string organization = 2;
// the organizational_unit in the certificate
// The organizational_unit in the certificate
string organizational_unit = 3;
// the subject_alternative_name in the certificate
// The subject_alternative_name in the certificate
string subject_alternative_name = 4;
}

message CodecServerPropertySpec {
// server endpoints
// Server endpoints
string endpoint = 1;
// whether to pass access token, i.e. jwt
// Whether to pass access token, i.e. jwt
bool pass_access_token = 2;
// whether to include credentials
// Whether to include credentials
bool include_credentials = 3;
}

message NamespaceSpec {
// the region where the namespace is (or will be) active.
// The region where the namespace is (or will be) active
string region = 1;
// the base64 encoded ca cert(s) that the clients can use for authentication and authorization
// The base64 encoded ca cert(s) that the clients can use for authentication and authorization
string accepted_client_ca = 2;
// the number of days the workflows data will be retained for
// The number of days the workflows data will be retained for
int32 retention_days = 3;
// the custom search attributes to use for the namespace
// the name of the attribute is the key and the type is the value
// supported attribute types: text, keyword, int, double, bool, datetime, keyword_list
// The custom search attributes to use for the namespace
// The name of the attribute is the key and the type is the value
// Supported attribute types: text, keyword, int, double, bool, datetime, keyword_list
map<string, string> search_attributes = 4;
// certificate filters which, if specified, only allow connections from client certificates
// whose distinguished name properties match at least one of the filters.
// Certificate filters which, if specified, only allow connections from client certificates
// whose distinguished name properties match at least one of the filters
repeated CertificateFilterSpec certificate_filters = 5;
// environment of the namespace. [optional]
// Environment of the namespace. - optional
// NOTE: currently there is no additional SLA or functional guarantee implied by the value of this field.
// supported environments: dev, test, prod
string environment = 6;
// codec server property spec needed for user to set and retrieve [optional]
// Codec server property spec needed for user to set and retrieve - optional
CodecServerPropertySpec codec_spec = 7;
// the regions where the namespace is (or will be) located [optional]
// The regions where the namespace is (or will be) located - optional
repeated string passive_regions = 8;
// the export sink specifications keyed on the sink name [optional]
// The export sink specifications keyed on the sink name - optional
map<string, temporal.api.cloud.sink.v1.ExportSinkSpec> export_sinks = 9;
}

message NamespaceURI {
// the web ui address
// The web ui address
string web = 1;
// the grpc address
// The grpc address
string grpc = 2;
// the list of private links
// The list of private links
repeated string vpc_endpoint_service_names = 3;
}

message NamespaceEnvelope {
// the namespace may be throttled if its APS exceeds the limit
// The namespace may be throttled if its APS exceeds the limit
int32 actions_per_second_limit = 1;
}

message Namespace {
// the namespace name
// The namespace name
string namespace = 1;
// the current version of the namespace specification
// the next update operation will have to include this version
// The current version of the namespace specification
// The next update operation will have to include this version
string resource_version = 2;
// the namespace specification
// The namespace specification
NamespaceSpec spec = 3;
// the current state of the namespace
// The current state of the namespace
string state = 4;
// The id of the async operation that is creating/updating/deleting the namespace, if any
string async_operation_id = 5;
// the web uri for the namespace
// The web uri for the namespace
NamespaceURI uri = 6;
// the envelope is a list of service level agreements (SLAs) that can be provided around a given namespace
// The envelope is a list of service level agreements (SLAs) that can be provided around a given namespace
NamespaceEnvelope envelope = 7;
// allowed principals is a list of principals that allowed to access the private links on the namespace
// Allowed principals is a list of principals that allowed to access the private links on the namespace
repeated string allowed_principals = 8;
// the export sink status keyed on the sink name
// The export sink status keyed on the sink name
map<string, temporal.api.cloud.sink.v1.ExportSink> export_sinks = 9;
// the date and time when the namespace was last modified
// The date and time when the namespace was last modified
google.protobuf.Timestamp last_modified_time = 10;
}

0 comments on commit bc0cbf9

Please sign in to comment.