forked from medusajs/medusa
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): Updated API Reference (automated) (medusajs#10685)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <[email protected]> Co-authored-by: Shahed Nasser <[email protected]>
- Loading branch information
3 people
authored
Dec 23, 2024
1 parent
326f190
commit 198fa53
Showing
19 changed files
with
621 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
...-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers_{id}_options/get.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| curl '{backend_url}/admin/fulfillment-providers/{id}/options' \ | ||
| -H 'Authorization: Bearer {access_token}' |
15 changes: 15 additions & 0 deletions
15
www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderOption.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| type: object | ||
| description: The fulfillment option's details. | ||
| x-schemaName: AdminFulfillmentProviderOption | ||
| required: | ||
| - id | ||
| - is_return | ||
| properties: | ||
| id: | ||
| type: string | ||
| title: id | ||
| description: The fulfillment option's ID. | ||
| is_return: | ||
| type: boolean | ||
| title: is_return | ||
| description: Whether the fulfillment option is used for returns. |
26 changes: 26 additions & 0 deletions
26
...reference/specs/admin/components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| type: object | ||
| description: The paginated list of fulfillment options. | ||
| x-schemaName: AdminFulfillmentProviderOptionsListResponse | ||
| required: | ||
| - limit | ||
| - offset | ||
| - count | ||
| - fulfillment_options | ||
| properties: | ||
| limit: | ||
| type: number | ||
| title: limit | ||
| description: The maximum number of items returned. | ||
| offset: | ||
| type: number | ||
| title: offset | ||
| description: The number of items skipped before retrieving the returned items. | ||
| count: | ||
| type: number | ||
| title: count | ||
| description: The total number of items. | ||
| fulfillment_options: | ||
| type: array | ||
| description: The list of fulfillment options. | ||
| items: | ||
| $ref: ./AdminFulfillmentProviderOption.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| type: object | ||
| description: The credit line's details. | ||
| x-schemaName: OrderCreditLine | ||
| required: | ||
| - id | ||
| - order_id | ||
| - order | ||
| - reference | ||
| - reference_id | ||
| - metadata | ||
| - created_at | ||
| - updated_at | ||
| properties: | ||
| id: | ||
| type: string | ||
| title: id | ||
| description: The credit line's ID. | ||
| order_id: | ||
| type: string | ||
| title: order_id | ||
| description: The ID of the associated order. | ||
| order: | ||
| type: object | ||
| reference: | ||
| type: string | ||
| title: reference | ||
| description: >- | ||
| The table that this credit line references. For example, | ||
| `payment_collection`. | ||
| reference_id: | ||
| type: string | ||
| title: reference_id | ||
| description: The ID of the record in the referenced table. For example, `paycol_123`. | ||
| metadata: | ||
| type: object | ||
| description: The credit line's metadata, can hold custom key-value pairs. | ||
| created_at: | ||
| type: string | ||
| format: date-time | ||
| title: created_at | ||
| description: The date the credit line was created. | ||
| updated_at: | ||
| type: string | ||
| format: date-time | ||
| title: updated_at | ||
| description: The date the credit line was updated. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
45 changes: 45 additions & 0 deletions
45
www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers_{id}_options.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| get: | ||
| operationId: GetFulfillmentProvidersIdOptions | ||
| summary: List Fulfillment Options | ||
| description: >- | ||
| Retrieve the list of fulfillment options of a fulfillment provider. These | ||
| options may be retrieved from an integrated third-party service. | ||
| x-authenticated: true | ||
| parameters: | ||
| - name: id | ||
| in: path | ||
| description: The fulfillment provider's ID. | ||
| required: true | ||
| schema: | ||
| type: string | ||
| security: | ||
| - api_token: [] | ||
| - cookie_auth: [] | ||
| - jwt_token: [] | ||
| x-codeSamples: | ||
| - lang: Shell | ||
| label: cURL | ||
| source: | ||
| $ref: ../code_samples/Shell/admin_fulfillment-providers_{id}_options/get.sh | ||
| tags: | ||
| - Fulfillment Providers | ||
| responses: | ||
| '200': | ||
| description: OK | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: >- | ||
| ../components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml | ||
| '400': | ||
| $ref: ../components/responses/400_error.yaml | ||
| '401': | ||
| $ref: ../components/responses/unauthorized.yaml | ||
| '404': | ||
| $ref: ../components/responses/not_found_error.yaml | ||
| '409': | ||
| $ref: ../components/responses/invalid_state_error.yaml | ||
| '422': | ||
| $ref: ../components/responses/invalid_request_error.yaml | ||
| '500': | ||
| $ref: ../components/responses/500_error.yaml |
15 changes: 15 additions & 0 deletions
15
www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderOption.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| type: object | ||
| description: The fulfillment option's details. | ||
| x-schemaName: AdminFulfillmentProviderOption | ||
| required: | ||
| - id | ||
| - is_return | ||
| properties: | ||
| id: | ||
| type: string | ||
| title: id | ||
| description: The fulfillment option's ID. | ||
| is_return: | ||
| type: boolean | ||
| title: is_return | ||
| description: Whether the fulfillment option is used for returns. |
26 changes: 26 additions & 0 deletions
26
...reference/specs/store/components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| type: object | ||
| description: The paginated list of fulfillment options. | ||
| x-schemaName: AdminFulfillmentProviderOptionsListResponse | ||
| required: | ||
| - limit | ||
| - offset | ||
| - count | ||
| - fulfillment_options | ||
| properties: | ||
| limit: | ||
| type: number | ||
| title: limit | ||
| description: The maximum number of items returned. | ||
| offset: | ||
| type: number | ||
| title: offset | ||
| description: The number of items skipped before retrieving the returned items. | ||
| count: | ||
| type: number | ||
| title: count | ||
| description: The total number of items. | ||
| fulfillment_options: | ||
| type: array | ||
| description: The list of fulfillment options. | ||
| items: | ||
| $ref: ./AdminFulfillmentProviderOption.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.