Skip to content

Commit 62f7e4b

Browse files
MarlincMarlinc
committed
Merge branch 'master' of github.com:cbws/cbws.github.io
2 parents a3544f5 + 8fd950b commit 62f7e4b

3 files changed

Lines changed: 685 additions & 0 deletions

File tree

‎protobuf/domains.md‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Protocol Documentation
2+
<a name="top"></a>
3+
4+
## Table of Contents
5+
6+
- [cbws/domains/v1alpha1/domain.proto](#cbws/domains/v1alpha1/domain.proto)
7+
- [Domain](#cbws.domains.v1alpha1.Domain)
8+
9+
- [cbws/domains/v1alpha1/domains.proto](#cbws/domains/v1alpha1/domains.proto)
10+
- [GetDomainRequest](#cbws.domains.v1alpha1.GetDomainRequest)
11+
- [ListDomainsRequest](#cbws.domains.v1alpha1.ListDomainsRequest)
12+
- [ListDomainsResponse](#cbws.domains.v1alpha1.ListDomainsResponse)
13+
14+
- [DomainsService](#cbws.domains.v1alpha1.DomainsService)
15+
16+
- [Scalar Value Types](#scalar-value-types)
17+
18+
19+
20+
<a name="cbws/domains/v1alpha1/domain.proto"></a>
21+
<p align="right"><a href="#top">Top</a></p>
22+
23+
## cbws/domains/v1alpha1/domain.proto
24+
25+
26+
27+
<a name="cbws.domains.v1alpha1.Domain"></a>
28+
29+
### Domain
30+
31+
32+
33+
| Field | Type | Label | Description |
34+
| ----- | ---- | ----- | ----------- |
35+
| name | [string](#string) | | The resource name of the domain in the following format: `domains/{domain}`
36+
37+
We have chosen to not include the project prefix as domain names are globally unique. |
38+
| parent | [string](#string) | | |
39+
| unique_id | [string](#string) | | @OutputOnly The unique and stable id of the service account. |
40+
| domain | [string](#string) | | The domain name part of the domain, in case of sidn.nl this would be sidn |
41+
| tld | [string](#string) | | The tld portion of the domain, for example nl, com, co.uk |
42+
| expiry | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | When the domain will expire |
43+
| auto_renew | [bool](#bool) | | Whether auto renew has been enabled for this domain |
44+
45+
46+
47+
48+
49+
50+
51+
52+
53+
54+
55+
56+
57+
58+
59+
<a name="cbws/domains/v1alpha1/domains.proto"></a>
60+
<p align="right"><a href="#top">Top</a></p>
61+
62+
## cbws/domains/v1alpha1/domains.proto
63+
64+
65+
66+
<a name="cbws.domains.v1alpha1.GetDomainRequest"></a>
67+
68+
### GetDomainRequest
69+
The domain get request.
70+
71+
72+
| Field | Type | Label | Description |
73+
| ----- | ---- | ----- | ----------- |
74+
| name | [string](#string) | | Required. The resource name of the domain in the following format: `domains/{domain}`. |
75+
76+
77+
78+
79+
80+
81+
<a name="cbws.domains.v1alpha1.ListDomainsRequest"></a>
82+
83+
### ListDomainsRequest
84+
The domain list request.
85+
86+
87+
| Field | Type | Label | Description |
88+
| ----- | ---- | ----- | ----------- |
89+
| parent | [string](#string) | | Required. The resource name of the project associated with the service accounts, such as `projects/my-project-123`. |
90+
| page_size | [int32](#int32) | | Optional limit on the number of domains to include in the response. Further accounts can subsequently be obtained by including the [ListDomainsResponse.next_page_token][cbws.domains.v1alpha1.ListDomainsResponse.next_page_token] in a subsequent request. |
91+
| page_token | [string](#string) | | Optional pagination token returned in an earlier [ListDomainsResponse.next_page_token][cbws.domains.v1alpha1.ListDomainsResponse.next_page_token]. |
92+
93+
94+
95+
96+
97+
98+
<a name="cbws.domains.v1alpha1.ListDomainsResponse"></a>
99+
100+
### ListDomainsResponse
101+
The domain list response.
102+
103+
104+
| Field | Type | Label | Description |
105+
| ----- | ---- | ----- | ----------- |
106+
| domains | [Domain](#cbws.domains.v1alpha1.Domain) | repeated | The list of matching domains. |
107+
| next_page_token | [string](#string) | | To retrieve the next page of results, set [ListDomainsRequest.page_token][cbws.domains.v1alpha1.ListDomainsRequest.page_token] to this value. |
108+
109+
110+
111+
112+
113+
114+
115+
116+
117+
118+
119+
120+
<a name="cbws.domains.v1alpha1.DomainsService"></a>
121+
122+
### DomainsService
123+
124+
125+
| Method Name | Request Type | Response Type | Description |
126+
| ----------- | ------------ | ------------- | ------------|
127+
| ListDomains | [ListDomainsRequest](#cbws.domains.v1alpha1.ListDomainsRequest) | [ListDomainsResponse](#cbws.domains.v1alpha1.ListDomainsResponse) | |
128+
| GetDomain | [GetDomainRequest](#cbws.domains.v1alpha1.GetDomainRequest) | [Domain](#cbws.domains.v1alpha1.Domain) | |
129+
130+
131+
132+
133+
134+
## Scalar Value Types
135+
136+
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
137+
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
138+
| <a name="double" /> double | | double | double | float | float64 | double | float | Float |
139+
| <a name="float" /> float | | float | float | float | float32 | float | float | Float |
140+
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
141+
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
142+
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
143+
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
144+
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
145+
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
146+
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
147+
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
148+
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
149+
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
150+
| <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
151+
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
152+
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
153+

‎protobuf/projects.md‎

Lines changed: 219 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,219 @@
1+
# Protocol Documentation
2+
<a name="top"></a>
3+
4+
## Table of Contents
5+
6+
- [cbws/projects/v1alpha1/project.proto](#cbws/projects/v1alpha1/project.proto)
7+
- [Project](#cbws.projects.v1alpha1.Project)
8+
9+
- [cbws/projects/v1alpha1/projects.proto](#cbws/projects/v1alpha1/projects.proto)
10+
- [CreateProjectRequest](#cbws.projects.v1alpha1.CreateProjectRequest)
11+
- [DeleteProjectMetadata](#cbws.projects.v1alpha1.DeleteProjectMetadata)
12+
- [DeleteProjectRequest](#cbws.projects.v1alpha1.DeleteProjectRequest)
13+
- [GetProjectRequest](#cbws.projects.v1alpha1.GetProjectRequest)
14+
- [ListProjectsRequest](#cbws.projects.v1alpha1.ListProjectsRequest)
15+
- [ListProjectsResponse](#cbws.projects.v1alpha1.ListProjectsResponse)
16+
- [UpdateProjectRequest](#cbws.projects.v1alpha1.UpdateProjectRequest)
17+
18+
- [ProjectsService](#cbws.projects.v1alpha1.ProjectsService)
19+
20+
- [Scalar Value Types](#scalar-value-types)
21+
22+
23+
24+
<a name="cbws/projects/v1alpha1/project.proto"></a>
25+
<p align="right"><a href="#top">Top</a></p>
26+
27+
## cbws/projects/v1alpha1/project.proto
28+
29+
30+
31+
<a name="cbws.projects.v1alpha1.Project"></a>
32+
33+
### Project
34+
35+
36+
37+
| Field | Type | Label | Description |
38+
| ----- | ---- | ----- | ----------- |
39+
| name | [string](#string) | | The name of the project in the format: projects/test-project |
40+
| display_name | [string](#string) | | |
41+
| organization | [string](#string) | | @OutputOnly The id of the project that owns the service account. |
42+
| unique_id | [string](#string) | | @OutputOnly The UUID of the project |
43+
44+
45+
46+
47+
48+
49+
50+
51+
52+
53+
54+
55+
56+
57+
58+
<a name="cbws/projects/v1alpha1/projects.proto"></a>
59+
<p align="right"><a href="#top">Top</a></p>
60+
61+
## cbws/projects/v1alpha1/projects.proto
62+
63+
64+
65+
<a name="cbws.projects.v1alpha1.CreateProjectRequest"></a>
66+
67+
### CreateProjectRequest
68+
69+
70+
71+
| Field | Type | Label | Description |
72+
| ----- | ---- | ----- | ----------- |
73+
| parent | [string](#string) | | |
74+
| name | [string](#string) | | Required. The name of the project, It is globally unique across CBWS, must be 6-30 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035. |
75+
| project | [Project](#cbws.projects.v1alpha1.Project) | | The [Project][cbws.projects.v1alpha1.Project] resource to create. Currently, only the following values are user assignable: `display_name`. |
76+
77+
78+
79+
80+
81+
82+
<a name="cbws.projects.v1alpha1.DeleteProjectMetadata"></a>
83+
84+
### DeleteProjectMetadata
85+
86+
87+
88+
89+
90+
91+
92+
<a name="cbws.projects.v1alpha1.DeleteProjectRequest"></a>
93+
94+
### DeleteProjectRequest
95+
The project delete request.
96+
97+
98+
| Field | Type | Label | Description |
99+
| ----- | ---- | ----- | ----------- |
100+
| name | [string](#string) | | The name of the project in format projects/project-name |
101+
102+
103+
104+
105+
106+
107+
<a name="cbws.projects.v1alpha1.GetProjectRequest"></a>
108+
109+
### GetProjectRequest
110+
111+
112+
113+
| Field | Type | Label | Description |
114+
| ----- | ---- | ----- | ----------- |
115+
| name | [string](#string) | | |
116+
117+
118+
119+
120+
121+
122+
<a name="cbws.projects.v1alpha1.ListProjectsRequest"></a>
123+
124+
### ListProjectsRequest
125+
The service account list request.
126+
127+
128+
| Field | Type | Label | Description |
129+
| ----- | ---- | ----- | ----------- |
130+
| page_size | [int32](#int32) | | Optional limit on the number of service accounts to include in the response. Further accounts can subsequently be obtained by including the [ListServiceAccountsResponse.next_page_token][google.iam.admin.v1.ListServiceAccountsResponse.next_page_token] in a subsequent request. |
131+
| page_token | [string](#string) | | Optional pagination token returned in an earlier [ListServiceAccountsResponse.next_page_token][google.iam.admin.v1.ListServiceAccountsResponse.next_page_token]. |
132+
133+
134+
135+
136+
137+
138+
<a name="cbws.projects.v1alpha1.ListProjectsResponse"></a>
139+
140+
### ListProjectsResponse
141+
142+
143+
144+
| Field | Type | Label | Description |
145+
| ----- | ---- | ----- | ----------- |
146+
| projects | [Project](#cbws.projects.v1alpha1.Project) | repeated | |
147+
| next_page_token | [string](#string) | | To retrieve the next page of results, set [ListServiceAccountsRequest.page_token][google.iam.admin.v1.ListServiceAccountsRequest.page_token] to this value. |
148+
149+
150+
151+
152+
153+
154+
<a name="cbws.projects.v1alpha1.UpdateProjectRequest"></a>
155+
156+
### UpdateProjectRequest
157+
158+
159+
160+
| Field | Type | Label | Description |
161+
| ----- | ---- | ----- | ----------- |
162+
| project | [Project](#cbws.projects.v1alpha1.Project) | | The project to update.
163+
164+
The project&#39;s `name` field is used to identify the project to be updated. Format: projects/{project} |
165+
| update_mask | [google.protobuf.FieldMask](#google.protobuf.FieldMask) | | The list of fields to be updated. |
166+
167+
168+
169+
170+
171+
172+
173+
174+
175+
176+
177+
178+
<a name="cbws.projects.v1alpha1.ProjectsService"></a>
179+
180+
### ProjectsService
181+
182+
183+
| Method Name | Request Type | Response Type | Description |
184+
| ----------- | ------------ | ------------- | ------------|
185+
| CreateProject | [CreateProjectRequest](#cbws.projects.v1alpha1.CreateProjectRequest) | [Project](#cbws.projects.v1alpha1.Project) | Create a project, requires the projects.cbws.xyz/Project/create permission on the organization. The principal creating a project will get the owner role on the project. |
186+
| ListProjects | [ListProjectsRequest](#cbws.projects.v1alpha1.ListProjectsRequest) | [ListProjectsResponse](#cbws.projects.v1alpha1.ListProjectsResponse) | List all projects you have access to Requires the projects.cbws.xyz/Project/get permission on the project |
187+
| GetProject | [GetProjectRequest](#cbws.projects.v1alpha1.GetProjectRequest) | [Project](#cbws.projects.v1alpha1.Project) | |
188+
| UpdateProject | [UpdateProjectRequest](#cbws.projects.v1alpha1.UpdateProjectRequest) | [Project](#cbws.projects.v1alpha1.Project) | Update a project
189+
190+
Permission: projects.cbws.xyz/Project/update |
191+
| DeleteProject | [DeleteProjectRequest](#cbws.projects.v1alpha1.DeleteProjectRequest) | [.google.longrunning.Operation](#google.longrunning.Operation) | |
192+
| GetPolicy | [.cbws.iam.policy.v1alpha1.GetPolicyRequest](#cbws.iam.policy.v1alpha1.GetPolicyRequest) | [.cbws.iam.policy.v1alpha1.Policy](#cbws.iam.policy.v1alpha1.Policy) | Returns the IAM access control policy for a Project. |
193+
| SetPolicy | [.cbws.iam.policy.v1alpha1.SetPolicyRequest](#cbws.iam.policy.v1alpha1.SetPolicyRequest) | [.cbws.iam.policy.v1alpha1.Policy](#cbws.iam.policy.v1alpha1.Policy) | Sets the IAM access control policy for a Project. |
194+
| TestPermissions | [.cbws.iam.policy.v1alpha1.TestPermissionsRequest](#cbws.iam.policy.v1alpha1.TestPermissionsRequest) | [.cbws.iam.policy.v1alpha1.TestPermissionsResponse](#cbws.iam.policy.v1alpha1.TestPermissionsResponse) | Tests the specified permissions against the IAM access control policy for a Project. |
195+
196+
197+
198+
199+
200+
## Scalar Value Types
201+
202+
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
203+
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
204+
| <a name="double" /> double | | double | double | float | float64 | double | float | Float |
205+
| <a name="float" /> float | | float | float | float | float32 | float | float | Float |
206+
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
207+
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
208+
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
209+
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
210+
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
211+
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
212+
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
213+
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
214+
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
215+
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
216+
| <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
217+
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
218+
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
219+

0 commit comments

Comments
 (0)