Skip to content

Commit 8fd950b

Browse files
author
CBWS
committed
Update generated protobuf docs based on v0.1.0
1 parent fda4fa0 commit 8fd950b

2 files changed

Lines changed: 113 additions & 0 deletions

File tree

protobuf/projects.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- [GetProjectRequest](#cbws.projects.v1alpha1.GetProjectRequest)
1414
- [ListProjectsRequest](#cbws.projects.v1alpha1.ListProjectsRequest)
1515
- [ListProjectsResponse](#cbws.projects.v1alpha1.ListProjectsResponse)
16+
- [UpdateProjectRequest](#cbws.projects.v1alpha1.UpdateProjectRequest)
1617

1718
- [ProjectsService](#cbws.projects.v1alpha1.ProjectsService)
1819

@@ -149,6 +150,24 @@ The service account list request.
149150

150151

151152

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+
152171

153172

154173

@@ -166,6 +185,9 @@ The service account list request.
166185
| 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. |
167186
| 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 |
168187
| 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 |
169191
| DeleteProject | [DeleteProjectRequest](#cbws.projects.v1alpha1.DeleteProjectRequest) | [.google.longrunning.Operation](#google.longrunning.Operation) | |
170192
| 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. |
171193
| 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. |

protobuf/resource-accounting.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,13 @@
66
- [cbws/service_management/resource_accounting/v1alpha1/resource_accounting.proto](#cbws/service_management/resource_accounting/v1alpha1/resource_accounting.proto)
77
- [AccountRequest](#cbws.service_management.resource_accounting.v1alpha1.AccountRequest)
88
- [AccountResponse](#cbws.service_management.resource_accounting.v1alpha1.AccountResponse)
9+
- [AggregateProjectUsageRequest](#cbws.service_management.resource_accounting.v1alpha1.AggregateProjectUsageRequest)
10+
- [AggregateProjectUsageResponse](#cbws.service_management.resource_accounting.v1alpha1.AggregateProjectUsageResponse)
11+
- [GenerateUsagePDFRequest](#cbws.service_management.resource_accounting.v1alpha1.GenerateUsagePDFRequest)
12+
- [GenerateUsagePDFResponse](#cbws.service_management.resource_accounting.v1alpha1.GenerateUsagePDFResponse)
913
- [ListResourcesRequest](#cbws.service_management.resource_accounting.v1alpha1.ListResourcesRequest)
1014
- [ListResourcesResponse](#cbws.service_management.resource_accounting.v1alpha1.ListResourcesResponse)
15+
- [ReportedUsage](#cbws.service_management.resource_accounting.v1alpha1.ReportedUsage)
1116
- [Resource](#cbws.service_management.resource_accounting.v1alpha1.Resource)
1217
- [Usage](#cbws.service_management.resource_accounting.v1alpha1.Usage)
1318
- [UsageCurrent](#cbws.service_management.resource_accounting.v1alpha1.UsageCurrent)
@@ -56,6 +61,70 @@
5661

5762

5863

64+
<a name="cbws.service_management.resource_accounting.v1alpha1.AggregateProjectUsageRequest"></a>
65+
66+
### AggregateProjectUsageRequest
67+
68+
69+
70+
| Field | Type | Label | Description |
71+
| ----- | ---- | ----- | ----------- |
72+
| projects | [string](#string) | | Required. The resource name of the project to aggregate the usage for |
73+
| start | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | |
74+
| end | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | |
75+
76+
77+
78+
79+
80+
81+
<a name="cbws.service_management.resource_accounting.v1alpha1.AggregateProjectUsageResponse"></a>
82+
83+
### AggregateProjectUsageResponse
84+
85+
86+
87+
| Field | Type | Label | Description |
88+
| ----- | ---- | ----- | ----------- |
89+
| usage | [ReportedUsage](#cbws.service_management.resource_accounting.v1alpha1.ReportedUsage) | repeated | All the usages to report by product |
90+
91+
92+
93+
94+
95+
96+
<a name="cbws.service_management.resource_accounting.v1alpha1.GenerateUsagePDFRequest"></a>
97+
98+
### GenerateUsagePDFRequest
99+
100+
101+
102+
| Field | Type | Label | Description |
103+
| ----- | ---- | ----- | ----------- |
104+
| project | [string](#string) | repeated | Required. The resource name of the project to aggregate the usage for |
105+
| start | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | |
106+
| end | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | |
107+
108+
109+
110+
111+
112+
113+
<a name="cbws.service_management.resource_accounting.v1alpha1.GenerateUsagePDFResponse"></a>
114+
115+
### GenerateUsagePDFResponse
116+
117+
118+
119+
| Field | Type | Label | Description |
120+
| ----- | ---- | ----- | ----------- |
121+
| pdf | [bytes](#bytes) | | |
122+
123+
124+
125+
126+
127+
59128
<a name="cbws.service_management.resource_accounting.v1alpha1.ListResourcesRequest"></a>
60129

61130
### ListResourcesRequest
@@ -89,6 +158,22 @@ The resource list response.
89158

90159

91160

161+
<a name="cbws.service_management.resource_accounting.v1alpha1.ReportedUsage"></a>
162+
163+
### ReportedUsage
164+
165+
166+
167+
| Field | Type | Label | Description |
168+
| ----- | ---- | ----- | ----------- |
169+
| product | [string](#string) | | The product resource name in format services/domains.cbws.xyz/products/domain-nl |
170+
| total | [double](#double) | | |
171+
172+
173+
174+
175+
176+
92177
<a name="cbws.service_management.resource_accounting.v1alpha1.Resource"></a>
93178

94179
### Resource
@@ -191,6 +276,12 @@ Hostname: resourceaccounting.cbws.xyz
191276

192277
| Method Name | Request Type | Response Type | Description |
193278
| ----------- | ------------ | ------------- | ------------|
279+
| AggregateProjectUsage | [AggregateProjectUsageRequest](#cbws.service_management.resource_accounting.v1alpha1.AggregateProjectUsageRequest) | [AggregateProjectUsageResponse](#cbws.service_management.resource_accounting.v1alpha1.AggregateProjectUsageResponse) | Request a aggregated set of all usage grouped by product.
280+
281+
Permission required: resourceaccounting.cbws.xyz/Usage/aggregate |
282+
| GenerateUsagePDF | [GenerateUsagePDFRequest](#cbws.service_management.resource_accounting.v1alpha1.GenerateUsagePDFRequest) | [GenerateUsagePDFResponse](#cbws.service_management.resource_accounting.v1alpha1.GenerateUsagePDFResponse) | Generate a usage breakdown PDF for a set of projects, this is the same document that also gets attached to invoices by the Cloudbear Webservices billing.
283+
284+
Permission required: resourceaccounting.cbws.xyz/Usage/generatePDF |
194285
| ListResources | [ListResourcesRequest](#cbws.service_management.resource_accounting.v1alpha1.ListResourcesRequest) | [ListResourcesResponse](#cbws.service_management.resource_accounting.v1alpha1.ListResourcesResponse) | Permission required: resourceaccounting.cbws.xyz/Resource/list |
195286
| Account | [AccountRequest](#cbws.service_management.resource_accounting.v1alpha1.AccountRequest) | [AccountResponse](#cbws.service_management.resource_accounting.v1alpha1.AccountResponse) | Account usage for a resource in a consumer project
196287

0 commit comments

Comments
 (0)