From b9805a3365a5de106e8e16c1df97046f25c10095 Mon Sep 17 00:00:00 2001 From: Chief-Rishab Date: Sat, 12 Aug 2023 22:39:57 +0530 Subject: [PATCH] chore: update path params and description --- raystack/frontier/v1beta1/frontier.proto | 10 +++++----- raystack/frontier/v1beta1/models.proto | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/raystack/frontier/v1beta1/frontier.proto b/raystack/frontier/v1beta1/frontier.proto index bfa74ef9..0ab408d3 100644 --- a/raystack/frontier/v1beta1/frontier.proto +++ b/raystack/frontier/v1beta1/frontier.proto @@ -711,7 +711,7 @@ service FrontierService { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { tags: "Organization"; summary: "List org domains"; - description: "Returns all trusted domains for an organization, which are used to allow users to sign up with a specific email domain without invitation. The domain ownership must be verified before it can be used as a trusted domain. Use the verified filter to get only the verified domains."; + description: "Returns all domains whitelisted for an organization (both pending and verified if no filters are provided for the state). The verified domains allow users email with the org's whitelisted domain to join the organization without invitation."; }; } @@ -758,11 +758,11 @@ service FrontierService { } rpc ListOrganizationsByDomain(ListOrganizationsByDomainRequest) returns (ListOrganizationsByDomainResponse) { - option (google.api.http) = {get: "/v1beta1/organizations/domains/{domain_id}"}; + option (google.api.http) = {get: "/v1beta1/organizations/domains/{name}"}; 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. Useful when you want to show a list of organizations that users can join based on their email domain (by default will also show the orgs of which user is already a part of)."; }; } @@ -1783,10 +1783,10 @@ message ListOrganizationDomainsResponse{ } message ListOrganizationsByDomainRequest{ - string domain_id = 1 [ + string name = 1 [ (validate.rules).string.min_len = 3, (google.api.field_behavior) = REQUIRED, - (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {description: "domain id or domain name to be used to list all the organizations that have this domain whitelisted"} + (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {description: "domain name to be used to list all the organizations that have this domain whitelisted"} ]; } diff --git a/raystack/frontier/v1beta1/models.proto b/raystack/frontier/v1beta1/models.proto index d6c1023a..25147e7b 100644 --- a/raystack/frontier/v1beta1/models.proto +++ b/raystack/frontier/v1beta1/models.proto @@ -163,7 +163,7 @@ message Domain { string token = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { description: "The dns TXT record token to verify the domain", - example: "\"_frontier-challenge:1234567890123456\"" + example: "\"_frontier-domain-verification=LB6U2lSQgGS55HOy6kpWFqkngRC8TMEjyrakfmYC2D0s+nfy/WkFSg==\"" } ]; string state = 5 [