chore: update domain verification state

raystack · Aug 8, 2023 · b6cf3ca · b6cf3ca
1 parent 10e4be7
commit b6cf3ca
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/raystack/frontier/v1beta1/frontier.proto b/raystack/frontier/v1beta1/frontier.proto
@@ -753,7 +753,7 @@ service FrontierService {
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
       tags: "Organization";
       summary: "Verify org domain";
-      description: "Verify a domain for an organization with a verification token generated by Frontier GenerateDomainVerificationToken API. The token must be added to your domain's DNS provider as a TXT record before it can be verified.";
+      description: "Verify a domain for an organization with a verification token generated by Frontier GenerateDomainVerificationToken API. The token must be added to your domain's DNS provider as a TXT record before it can be verified. This API returns the state of the domain (pending/verified) after verification.";
     };
   }
 
@@ -762,7 +762,7 @@ service FrontierService {
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
       tags: "Organization";
       summary: "List orgs by domain";
-      description: "Returns all organizations that have a specific domain whitelisted. This API will return only those organizations in which the domain ownership   have been verified.";
+      description: "Returns all organizations that have a specific domain whitelisted. This API will return only those organizations in which the domain ownership have been verified.";
     };
   }
 
@@ -1773,8 +1773,8 @@ message ListOrganizationDomainsRequest{
     (google.api.field_behavior) = REQUIRED,
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {description: "unique id of the organization for which whitelisted domains are to be listed"}
   ];
-  bool verified = 2 [
-    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {description: "filter to list only verified domains. If not provided, all domains for an org will be listed"}
+  string state  = 2 [
+    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {description: "filter to list domains by their state (pending/verified). If not provided, all domains for an org will be listed"}
   ];
 }
 
@@ -1863,7 +1863,7 @@ message VerifyOrgDomainRequest {
 }
 
 message VerifyOrgDomainResponse {
-  bool verified = 1;
+  string state = 1;
 }
 
 message DeleteOrganizationInvitationResponse {}

diff --git a/raystack/frontier/v1beta1/models.proto b/raystack/frontier/v1beta1/models.proto
@@ -166,18 +166,18 @@ message Domain {
       example: "\"_frontier-challenge:1234567890123456\""
     }
   ];
-  bool verified = 5 [
+  string state = 5 [
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-      description: "true if the domain is verified, false otherwise",
-      example: "true"
+      description: "The domain state either pending or verified",
+      example: "pending"
     }
   ];
   google.protobuf.Timestamp created_at = 6 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
     description: "The time the domain whitelist request was created",
     example: "\"2023-06-07T05:39:56.961Z\""
   }];
-  google.protobuf.Timestamp verified_at = 7 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-    description: "The time the org domain was verified",
+  google.protobuf.Timestamp updated_at = 7 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+    description: "The time the org domain was updated",
     example: "\"2023-06-07T05:39:56.961Z\""
   }];
 }