Skip to content

Commit c01dbcf

Browse files
author
gitlab-ci-token
committed
1 parent 11a6892 commit c01dbcf

File tree

6 files changed

+80
-18
lines changed

6 files changed

+80
-18
lines changed

docs/marketplace/accounts/offering-users.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
| <span class="http-badge http-get">GET</span> | `/api/marketplace-offering-users/checklist-template/` | [Get checklist template for creating new objects](#get-checklist-template-for-creating-new-objects) |
2020
| <span class="http-badge http-get">GET</span> | `/api/marketplace-offering-users/{uuid}/completion_review_status/` | [Get checklist completion status with review triggers (reviewers only)](#get-checklist-completion-status-with-review-triggers-reviewers-only) |
2121
| <span class="http-badge http-get">GET</span> | `/api/marketplace-offering-users/{uuid}/completion_status/` | [Get checklist completion status](#get-checklist-completion-status) |
22+
| <span class="http-badge http-get">GET</span> | `/api/marketplace-offering-users/profile_field_warnings/` | [Get profile field warnings](#get-profile-field-warnings) |
2223
| <span class="http-badge http-post">POST</span> | `/api/marketplace-offering-users/{uuid}/begin_creating/` | [Begin creation process](#begin-creation-process) |
2324
| <span class="http-badge http-post">POST</span> | `/api/marketplace-offering-users/{uuid}/request_deletion/` | [Request deletion of an offering user](#request-deletion-of-an-offering-user) |
2425
| <span class="http-badge http-post">POST</span> | `/api/marketplace-offering-users/{uuid}/set_deleted/` | [Set state to Deleted](#set-state-to-deleted) |
@@ -1426,6 +1427,60 @@ Get checklist completion status.
14261427
**`404`** -
14271428

14281429

1430+
---
1431+
1432+
### Get profile field warnings
1433+
1434+
Returns a mapping of user profile field names to offerings that expose those fields. When ENFORCE_OFFERING_USER_PROFILE_COMPLETENESS is enabled, clearing a field listed here would make the user invisible to the service provider for the associated offerings.
1435+
1436+
1437+
=== "HTTPie"
1438+
1439+
```bash
1440+
http \
1441+
GET \
1442+
https://api.example.com/api/marketplace-offering-users/profile_field_warnings/ \
1443+
Authorization:"Token YOUR_API_TOKEN"
1444+
```
1445+
1446+
=== "Python"
1447+
1448+
```python
1449+
from waldur_api_client.client import AuthenticatedClient
1450+
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_profile_field_warnings_retrieve # (1)
1451+
1452+
client = AuthenticatedClient(
1453+
base_url="https://api.example.com", token="YOUR_API_TOKEN"
1454+
)
1455+
response = marketplace_offering_users_profile_field_warnings_retrieve.sync(client=client)
1456+
1457+
print(response)
1458+
```
1459+
1460+
1461+
1. **API Source:** [`marketplace_offering_users_profile_field_warnings_retrieve`](https://github.com/waldur/py-client/blob/main/waldur_api_client/api/marketplace_offering_users/marketplace_offering_users_profile_field_warnings_retrieve.py)
1462+
1463+
=== "TypeScript"
1464+
1465+
```typescript
1466+
import { marketplaceOfferingUsersProfileFieldWarningsRetrieve } from 'waldur-js-client';
1467+
1468+
try {
1469+
const response = await marketplaceOfferingUsersProfileFieldWarningsRetrieve({
1470+
auth: "Token YOUR_API_TOKEN"
1471+
});
1472+
console.log('Success:', response);
1473+
} catch (error) {
1474+
console.error('Error:', error);
1475+
}
1476+
```
1477+
1478+
1479+
=== "Responses"
1480+
1481+
**`200`** - No response body
1482+
1483+
14291484
---
14301485

14311486
### Begin creation process

docs/marketplace/offerings/plans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1277,7 +1277,7 @@ Returns aggregated statistics on how many resources are currently using each pla
12771277

12781278
| Name | Type | Description |
12791279
|---|---|---|
1280-
| `customer_provider_uuid` | string (uuid) | Filter by service provider's customer UUID. |
1280+
| `customer_provider_uuid` | string (uuid) | Filter by offering customer provider UUID. |
12811281
| `o` | string | Ordering field. Available options: `usage`, `limit`, `remaining`, and their descending counterparts (e.g., `-usage`). |
12821282
| `offering` | string | |
12831283
| `offering_slug` | array | Multiple values may be separated by commas. |

docs/marketplace/offerings/public-offerings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Returns a paginated list of public offerings. The list is filtered to show only
8686
| `name` | string | Name |
8787
| `name_exact` | string | Name (exact) |
8888
| `o` | array | Ordering<br><br> |
89-
| `organization_group_uuid` | array | Organization group UUID |
89+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
9090
| `page` | integer | A page number within the paginated result set. |
9191
| `page_size` | integer | Number of results to return per page. |
9292
| `parent_uuid` | string (uuid) | Parent offering UUID |

docs/marketplace/provider-api/provider-offerings.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Returns a paginated list of offerings for the provider.
165165
| `name` | string | Name |
166166
| `name_exact` | string | Name (exact) |
167167
| `o` | array | Ordering<br><br> |
168-
| `organization_group_uuid` | array | Organization group UUID |
168+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
169169
| `page` | integer | A page number within the paginated result set. |
170170
| `page_size` | integer | Number of results to return per page. |
171171
| `parent_uuid` | string (uuid) | Parent offering UUID |
@@ -1647,7 +1647,7 @@ Returns a paginated list of course accounts for projects that have resources of
16471647
| `name` | string | Name |
16481648
| `name_exact` | string | Name (exact) |
16491649
| `o` | array | Ordering<br><br> |
1650-
| `organization_group_uuid` | array | Organization group UUID |
1650+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
16511651
| `page` | integer | A page number within the paginated result set. |
16521652
| `page_size` | integer | Number of results to return per page. |
16531653
| `parent_uuid` | string (uuid) | Parent offering UUID |
@@ -1782,7 +1782,7 @@ Returns a paginated list of customer-level service accounts for customers who ha
17821782
| `name` | string | Name |
17831783
| `name_exact` | string | Name (exact) |
17841784
| `o` | array | Ordering<br><br> |
1785-
| `organization_group_uuid` | array | Organization group UUID |
1785+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
17861786
| `page` | integer | A page number within the paginated result set. |
17871787
| `page_size` | integer | Number of results to return per page. |
17881788
| `parent_uuid` | string (uuid) | Parent offering UUID |
@@ -2061,7 +2061,7 @@ Returns a paginated list of project-level service accounts for projects that hav
20612061
| `name` | string | Name |
20622062
| `name_exact` | string | Name (exact) |
20632063
| `o` | array | Ordering<br><br> |
2064-
| `organization_group_uuid` | array | Organization group UUID |
2064+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
20652065
| `page` | integer | A page number within the paginated result set. |
20662066
| `page_size` | integer | Number of results to return per page. |
20672067
| `parent_uuid` | string (uuid) | Parent offering UUID |
@@ -6074,7 +6074,7 @@ Returns monthly usage statistics for the components of an offering within a spec
60746074
| `name` | string | Name |
60756075
| `name_exact` | string | Name (exact) |
60766076
| `o` | array | Ordering<br><br> |
6077-
| `organization_group_uuid` | array | Organization group UUID |
6077+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
60786078
| `page` | integer | A page number within the paginated result set. |
60796079
| `page_size` | integer | Number of results to return per page. |
60806080
| `parent_uuid` | string (uuid) | Parent offering UUID |
@@ -6201,7 +6201,7 @@ Returns monthly cost data for an offering within a specified date range.
62016201
| `name` | string | Name |
62026202
| `name_exact` | string | Name (exact) |
62036203
| `o` | array | Ordering<br><br> |
6204-
| `organization_group_uuid` | array | Organization group UUID |
6204+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
62056205
| `page` | integer | A page number within the paginated result set. |
62066206
| `page_size` | integer | Number of results to return per page. |
62076207
| `parent_uuid` | string (uuid) | Parent offering UUID |
@@ -6323,7 +6323,7 @@ Returns a paginated list of customers who have resources for this offering.
63236323
| `name` | string | Name |
63246324
| `name_exact` | string | Name (exact) |
63256325
| `o` | array | Ordering<br><br> |
6326-
| `organization_group_uuid` | array | Organization group UUID |
6326+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
63276327
| `page` | integer | A page number within the paginated result set. |
63286328
| `page_size` | integer | Number of results to return per page. |
63296329
| `parent_uuid` | string (uuid) | Parent offering UUID |
@@ -6432,7 +6432,7 @@ Returns a paginated list of active, shared offerings grouped by their service pr
64326432
| `name` | string | Name |
64336433
| `name_exact` | string | Name (exact) |
64346434
| `o` | array | Ordering<br><br> |
6435-
| `organization_group_uuid` | array | Organization group UUID |
6435+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
64366436
| `page` | integer | A page number within the paginated result set. |
64376437
| `page_size` | integer | Number of results to return per page. |
64386438
| `parent_uuid` | string (uuid) | Parent offering UUID |
@@ -7603,7 +7603,7 @@ Returns the version history for this object. Only accessible by staff and suppor
76037603
| `name` | string | Name |
76047604
| `name_exact` | string | Name (exact) |
76057605
| `o` | array | Ordering<br><br> |
7606-
| `organization_group_uuid` | array | Organization group UUID |
7606+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
76077607
| `page` | integer | A page number within the paginated result set. |
76087608
| `page_size` | integer | Number of results to return per page. |
76097609
| `parent_uuid` | string (uuid) | Parent offering UUID |

docs/marketplace/provider-api/service-providers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -771,7 +771,7 @@ Returns a paginated list of all billable, shared offerings provided by the speci
771771
| `name` | string | Name |
772772
| `name_exact` | string | Name (exact) |
773773
| `o` | array | Ordering<br><br> |
774-
| `organization_group_uuid` | array | Organization group UUID |
774+
| `organization_group_uuid` | string (uuid) | Organization group UUID |
775775
| `page` | integer | A page number within the paginated result set. |
776776
| `page_size` | integer | Number of results to return per page. |
777777
| `parent_uuid` | string (uuid) | Parent offering UUID |

docs/support-and-operations/support-and-issues/chat-quota.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@
2929
http \
3030
GET \
3131
https://api.example.com/api/chat-quota/usage/ \
32-
Authorization:"Token YOUR_API_TOKEN"
32+
Authorization:"Token YOUR_API_TOKEN" \
33+
user_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
3334
```
3435

3536
=== "Python"
@@ -41,7 +42,10 @@
4142
client = AuthenticatedClient(
4243
base_url="https://api.example.com", token="YOUR_API_TOKEN"
4344
)
44-
response = chat_quota_usage_retrieve.sync(client=client)
45+
response = chat_quota_usage_retrieve.sync(
46+
client=client,
47+
user_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
48+
)
4549

4650
print(response)
4751
```
@@ -56,7 +60,10 @@
5660

5761
try {
5862
const response = await chatQuotaUsageRetrieve({
59-
auth: "Token YOUR_API_TOKEN"
63+
auth: "Token YOUR_API_TOKEN",
64+
query: {
65+
"user_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
66+
}
6067
});
6168
console.log('Success:', response);
6269
} catch (error) {
@@ -67,9 +74,9 @@
6774

6875
=== "Query Parameters"
6976

70-
| Name | Type | Description |
71-
|---|---|---|
72-
| `user_uuid` | string (uuid) | UUID of user to view quota for (staff/support only). Omit to view your own quota. |
77+
| Name | Type | Required | Description |
78+
|---|---|---|---|
79+
| `user_uuid` | string (uuid) | ✓ | UUID of user to view quota for (staff/support only). Omit to view your own quota. |
7380

7481

7582
=== "Responses"

0 commit comments

Comments
 (0)