(docs) principals api docs stubs

uatuko · Oct 23, 2024 · bd9dfde · bd9dfde
1 parent bb38c43
commit bd9dfde
Showing 1 changed file with 126 additions and 0 deletions.
diff --git a/docs/api/v1/principals.md b/docs/api/v1/principals.md
@@ -45,6 +45,92 @@ rpc Create(PrincipalsCreateRequest) returns (Principal) {
 ```
 
 
+## [RPC] Delete (`ruek.api.v1.Principals.Delete`)
+
+Delete an existing principal.
+
+```proto
+rpc Delete(PrincipalsDeleteRequest) returns (PrincipalsDeleteResponse) {
+  option (google.api.http) = {
+    delete : "/v1/principals/{id}"
+    body : "*"
+  };
+}
+```
+
+### Request message
+
+[`PrincipalsDeleteRequest`](#PrincipalsDeleteRequest)
+
+### Response message
+
+[`PrincipalsDeleteResponse`](#PrincipalsDeleteResponse)
+
+
+## [RPC] List (`ruek.api.v1.Principals.List`)
+
+List principals.
+
+```proto
+rpc List(PrincipalsListRequest) returns (PrincipalsListResponse) {
+  option (google.api.http) = {
+    get : "/v1/principals?segment={segment}&_limit={pagination_limit}&_start={pagination_token}"
+  };
+}
+```
+
+### Request message
+
+[`PrincipalsListRequest`](#PrincipalsListRequest)
+
+### Response message
+
+[`PrincipalsListResponse`](#PrincipalsListResponse)
+
+
+## [RPC] Retrieve (`ruek.api.v1.Principals.Retrieve`)
+
+Retrieve a principal.
+
+```proto
+rpc Retrieve(PrincipalsRetrieveRequest) returns (Principal) {
+  option (google.api.http) = {
+    get : "/v1/principals/{id}"
+  };
+}
+```
+
+### Request message
+
+[`PrincipalsRetrieveRequest`](#PrincipalsRetrieveRequest)
+
+### Response message
+
+[`Principal`](#Principal)
+
+
+## [RPC] Update (`ruek.api.v1.Principals.Update`)
+
+Update a principal.
+
+```proto
+  rpc Update(PrincipalsUpdateRequest) returns (Principal) {
+    option (google.api.http) = {
+      put : "/v1/principals/{id}"
+      body : "*"
+    };
+  }
+```
+
+### Request message
+
+[`PrincipalsUpdateRequest`](#PrincipalsUpdateRequest)
+
+### Response message
+
+[`Principal`](#Principal)
+
+
 ## Messages
 
 ### Principal
@@ -62,3 +148,43 @@ rpc Create(PrincipalsCreateRequest) returns (Principal) {
 | id      | (optional) `string` | |
 | attrs   | (optional) [google.protobuf.Struct](https://protobuf.dev/reference/protobuf/google.protobuf/#struct) | |
 | segment | (optional) `string` | |
+
+### PrincipalsDeleteRequest
+
+| Field   | Type      | Description |
+| ------- | --------- | ----------- |
+| id      | `string`  | |
+
+### PrincipalsDeleteResponse
+
+| Field   | Type                | Description |
+| ------- | ------------------- | ----------- |
+
+### PrincipalsListRequest
+
+| Field            | Type                | Description |
+| ---------------- | ------------------- | ----------- |
+| segment          | (optional) `string` | |
+| pagination_limit | (optional) `uint32` | |
+| pagination_token | (optional) `string` | |
+
+### PrincipalsListResponse
+
+| Field            | Type                | Description |
+| ---------------- | ------------------- | ----------- |
+| principals       | `[]Principal`       | |
+| pagination_token | (optional) `string` | |
+
+### PrincipalsRetrieveRequest
+
+| Field   | Type      | Description |
+| ------- | --------- | ----------- |
+| id      | `string`  | |
+
+### PrincipalsUpdateRequest
+
+| Field   | Type                | Description |
+| ------- | ------------------- | ----------- |
+| id      | `string`            | |
+| attrs   | (optional) [google.protobuf.Struct](https://protobuf.dev/reference/protobuf/google.protobuf/#struct) | |
+| segment | (optional) `string` | |