Skip to content

Commit

Permalink
chore: update path params and description
Browse files Browse the repository at this point in the history
  • Loading branch information
Chief-Rishab committed Aug 12, 2023
1 parent e7f0f5f commit b9805a3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions raystack/frontier/v1beta1/frontier.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.";
};
}

Expand Down Expand Up @@ -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).";
};
}

Expand Down Expand Up @@ -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"}
];
}

Expand Down
2 changes: 1 addition & 1 deletion raystack/frontier/v1beta1/models.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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 [
Expand Down

0 comments on commit b9805a3

Please sign in to comment.