Skip to content

Commit 6ac9524

Browse files
github-actions[bot]olivermrblshahednasser
authored
chore(docs): Updated API Reference (automated) (#14892)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
1 parent 5447184 commit 6ac9524

27 files changed

+798
-328
lines changed

www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}_roles_{role_id}/delete.sh

Lines changed: 0 additions & 2 deletions
This file was deleted.

www/apps/api-reference/specs/admin/components/schemas/AdminCreditStoreCreditAccountParams.yaml

Lines changed: 0 additions & 14 deletions
This file was deleted.

www/apps/api-reference/specs/admin/components/schemas/StoreClaimStoreCreditAccountParams.yaml

Lines changed: 0 additions & 10 deletions
This file was deleted.

www/apps/api-reference/specs/admin/components/schemas/StoreClaimStoreCreditAccountResponse.yaml

Lines changed: 0 additions & 8 deletions
This file was deleted.

www/apps/api-reference/specs/admin/openapi.full.yaml

Lines changed: 28 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -39915,6 +39915,20 @@ paths:
3991539915
type: boolean
3991639916
title: with_deleted
3991739917
description: Whether to include deleted products.
39918+
- name: external_id
39919+
in: query
39920+
required: false
39921+
schema:
39922+
oneOf:
39923+
- type: string
39924+
title: external_id
39925+
description: Filter by the product's external ID.
39926+
- type: array
39927+
description: Filter by external IDs.
39928+
items:
39929+
type: string
39930+
title: external_id
39931+
description: The external ID.
3991839932
security:
3991939933
- api_token: []
3992039934
- cookie_auth: []
@@ -40880,6 +40894,20 @@ paths:
4088040894
type: string
4088140895
title: price_list_id
4088240896
description: A price list ID.
40897+
- name: external_id
40898+
in: query
40899+
required: false
40900+
schema:
40901+
oneOf:
40902+
- type: string
40903+
title: external_id
40904+
description: Filter by the product's external ID.
40905+
- type: array
40906+
description: Filter by external IDs.
40907+
items:
40908+
type: string
40909+
title: external_id
40910+
description: The external ID.
4088340911
security:
4088440912
- api_token: []
4088540913
- cookie_auth: []
@@ -65363,53 +65391,6 @@ paths:
6536365391
```
6536465392
description: Emitted when users are deleted.
6536565393
deprecated: false
65366-
/admin/users/{id}/roles/{role_id}:
65367-
delete:
65368-
operationId: DeleteUsersIdRolesRole_id
65369-
summary: Remove Role from User
65370-
description: Remove a Role from a user.
65371-
x-authenticated: true
65372-
parameters:
65373-
- name: id
65374-
in: path
65375-
description: The user's ID.
65376-
required: true
65377-
schema:
65378-
type: string
65379-
- name: role_id
65380-
in: path
65381-
description: The user's role id.
65382-
required: true
65383-
schema:
65384-
type: string
65385-
security:
65386-
- cookie_auth: []
65387-
- jwt_token: []
65388-
x-codeSamples:
65389-
- lang: Shell
65390-
label: cURL
65391-
source: |-
65392-
curl -X DELETE '{backend_url}/admin/users/{id}/roles/{role_id}' \
65393-
-H 'Authorization: Bearer {access_token}'
65394-
tags:
65395-
- Users
65396-
responses:
65397-
'200':
65398-
description: OK
65399-
'400':
65400-
$ref: '#/components/responses/400_error'
65401-
'401':
65402-
$ref: '#/components/responses/unauthorized'
65403-
'404':
65404-
$ref: '#/components/responses/not_found_error'
65405-
'409':
65406-
$ref: '#/components/responses/invalid_state_error'
65407-
'422':
65408-
$ref: '#/components/responses/invalid_request_error'
65409-
'500':
65410-
$ref: '#/components/responses/500_error'
65411-
x-workflow: removeUserRolesWorkflow
65412-
x-events: []
6541365394
/admin/views/{entity}/columns:
6541465395
get:
6541565396
operationId: GetViewsEntityColumns
@@ -71296,21 +71277,6 @@ components:
7129671277
type: string
7129771278
title: transaction_id
7129871279
description: The ID of the workflow execution's transaction.
71299-
AdminCreditStoreCreditAccountParams:
71300-
type: object
71301-
description: The details of the credits to add to the store credit account.
71302-
x-schemaName: AdminCreditStoreCreditAccountParams
71303-
required:
71304-
- amount
71305-
properties:
71306-
amount:
71307-
type: number
71308-
title: amount
71309-
description: The credits to add to the store credit account.
71310-
note:
71311-
type: string
71312-
title: note
71313-
description: An internal note with more details on the credit addition.
7131471280
AdminCurrency:
7131571281
type: object
7131671282
description: The currency's currencies.
@@ -90675,26 +90641,6 @@ components:
9067590641
type: boolean
9067690642
title: insufficient_inventory
9067790643
description: Whether the shipping option's location doesn't have sufficient quantity for any of the cart's items.
90678-
StoreClaimStoreCreditAccountParams:
90679-
type: object
90680-
description: The details of claiming the credit.
90681-
x-schemaName: StoreClaimStoreCreditAccountParams
90682-
required:
90683-
- code
90684-
properties:
90685-
code:
90686-
type: string
90687-
title: code
90688-
description: The code of the store credit account to claim.
90689-
StoreClaimStoreCreditAccountResponse:
90690-
type: object
90691-
description: The claimed store credit account's details.
90692-
x-schemaName: StoreClaimStoreCreditAccountResponse
90693-
required:
90694-
- store_credit_account
90695-
properties:
90696-
store_credit_account:
90697-
$ref: '#/components/schemas/StoreStoreCreditAccount'
9069890644
StoreCollection:
9069990645
type: object
9070090646
description: The collection's details.

www/apps/api-reference/specs/admin/openapi.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1212,8 +1212,6 @@ paths:
12121212
$ref: paths/admin_users_me.yaml
12131213
/admin/users/{id}:
12141214
$ref: paths/admin_users_{id}.yaml
1215-
/admin/users/{id}/roles/{role_id}:
1216-
$ref: paths/admin_users_{id}_roles_{role_id}.yaml
12171215
/admin/views/{entity}/columns:
12181216
$ref: paths/admin_views_{entity}_columns.yaml
12191217
/admin/views/{entity}/configurations:

www/apps/api-reference/specs/admin/paths/admin_products.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1227,6 +1227,20 @@ get:
12271227
type: boolean
12281228
title: with_deleted
12291229
description: Whether to include deleted products.
1230+
- name: external_id
1231+
in: query
1232+
required: false
1233+
schema:
1234+
oneOf:
1235+
- type: string
1236+
title: external_id
1237+
description: Filter by the product's external ID.
1238+
- type: array
1239+
description: Filter by external IDs.
1240+
items:
1241+
type: string
1242+
title: external_id
1243+
description: The external ID.
12301244
security:
12311245
- api_token: []
12321246
- cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_products_export.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -712,6 +712,20 @@ post:
712712
type: string
713713
title: price_list_id
714714
description: A price list ID.
715+
- name: external_id
716+
in: query
717+
required: false
718+
schema:
719+
oneOf:
720+
- type: string
721+
title: external_id
722+
description: Filter by the product's external ID.
723+
- type: array
724+
description: Filter by external IDs.
725+
items:
726+
type: string
727+
title: external_id
728+
description: The external ID.
715729
security:
716730
- api_token: []
717731
- cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_users_{id}_roles_{role_id}.yaml

Lines changed: 0 additions & 45 deletions
This file was deleted.

www/apps/api-reference/specs/store/components/schemas/AdminCreditStoreCreditAccountParams.yaml

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)