asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generate OAS for v2 (#7883)

Browse Source
This commit is contained in:
Shahed Nasser
2024-07-01 15:35:45 +03:00
committed by GitHub
parent 8fde57263f
commit b9036eca1a
1103 changed files with 125727 additions and 22463 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[authProvider].ts → www/utils/generated/oas-output/operations/auth/delete_auth_session.ts
+22 -27
View File
@@ -1,23 +1,10 @@
/**
* @oas [get] /auth/{scope}/{authProvider}
* operationId: GetScopeAuthprovider
* summary: "List "
* description: Retrieve a list of in a [scope]. The can be filtered by fields
* like FILTER FIELDS. The can also be paginated.
* @oas [delete] /auth/session
* operationId: DeleteSession
* summary: Delete Session
* description: Delete Session
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: authProvider
* in: path
* description: The [scope]'s authprovider.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
@@ -28,12 +15,18 @@
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
@@ -52,19 +45,25 @@
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/auth/{scope}/{authProvider}'
* source: curl -X DELETE '{backend_url}/auth/session'
* tags:
* - "[scope]"
* - Session
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -77,10 +76,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[auth_provider].ts → www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider].ts
+25 -17
View File
@@ -1,20 +1,20 @@
/**
* @oas [get] /auth/{scope}/{auth_provider}
* operationId: GetScopeAuth_provider
* @oas [get] /auth/{actor_type}/{auth_provider}
* operationId: GetActor_typeAuth_provider
* summary: "List "
* description: Retrieve a list of in a [scope]. The can be filtered by fields
* like FILTER FIELDS. The can also be paginated.
* description: Retrieve a list of in a [actor_type]. The can be filtered by
* fields like FILTER FIELDS. The can also be paginated.
* x-authenticated: false
* parameters:
* - name: scope
* - name: actor_type
* in: path
* description: The [scope]'s scope.
* description: The [actor type]'s actor type.
* required: true
* schema:
* type: string
* - name: auth_provider
* in: path
* description: The [scope]'s auth provider.
* description: The [actor type]'s auth provider.
* required: true
* schema:
* type: string
@@ -28,12 +28,18 @@
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
@@ -52,19 +58,25 @@
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/auth/{scope}/{auth_provider}'
* source: curl '{backend_url}/auth/{actor_type}/{auth_provider}'
* tags:
* - "[scope]"
* - "[actor_type]"
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -77,10 +89,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[auth_provider]_callback.ts → www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider]_callback.ts
+25 -17
View File
@@ -1,20 +1,20 @@
/**
* @oas [get] /auth/{scope}/{auth_provider}/callback
* operationId: GetScopeAuth_providerCallback
* @oas [get] /auth/{actor_type}/{auth_provider}/callback
* operationId: GetActor_typeAuth_providerCallback
* summary: List Callbacks
* description: Retrieve a list of callbacks in a [scope]. The callbacks can be
* filtered by fields like FILTER FIELDS. The callbacks can also be paginated.
* description: Retrieve a list of callbacks in a [actor_type]. The callbacks can
* be filtered by fields like FILTER FIELDS. The callbacks can also be paginated.
* x-authenticated: false
* parameters:
* - name: scope
* - name: actor_type
* in: path
* description: The [scope]'s scope.
* description: The [actor type]'s actor type.
* required: true
* schema:
* type: string
* - name: auth_provider
* in: path
* description: The [scope]'s auth provider.
* description: The [actor type]'s auth provider.
* required: true
* schema:
* type: string
@@ -28,12 +28,18 @@
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
@@ -52,19 +58,25 @@
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/auth/{scope}/{auth_provider}/callback'
* source: curl '{backend_url}/auth/{actor_type}/{auth_provider}/callback'
* tags:
* - "[scope]"
* - "[actor_type]"
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -77,10 +89,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[authProvider]_callback.ts
-86
View File
@@ -1,86 +0,0 @@
/**
* @oas [get] /auth/{scope}/{authProvider}/callback
* operationId: GetScopeAuthproviderCallback
* summary: List Callbacks
* description: Retrieve a list of callbacks in a [scope]. The callbacks can be
* filtered by fields like FILTER FIELDS. The callbacks can also be paginated.
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: authProvider
* in: path
* description: The [scope]'s authprovider.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/auth/{scope}/{authProvider}/callback'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[auth_provider].ts → www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts
+25 -17
View File
@@ -1,19 +1,19 @@
/**
* @oas [post] /auth/{scope}/{auth_provider}
* operationId: PostScopeAuth_provider
* summary: Add to [scope]
* description: Add a list of to a [scope].
* @oas [post] /auth/{actor_type}/{auth_provider}
* operationId: PostActor_typeAuth_provider
* summary: Add to [actor_type]
* description: Add a list of to a [actor_type].
* x-authenticated: false
* parameters:
* - name: scope
* - name: actor_type
* in: path
* description: The [scope]'s scope.
* description: The [actor type]'s actor type.
* required: true
* schema:
* type: string
* - name: auth_provider
* in: path
* description: The [scope]'s auth provider.
* description: The [actor type]'s auth provider.
* required: true
* schema:
* type: string
@@ -27,12 +27,18 @@
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
@@ -51,19 +57,25 @@
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/{scope}/{auth_provider}'
* source: curl -X POST '{backend_url}/auth/{actor_type}/{auth_provider}'
* tags:
* - "[scope]"
* - "[actor_type]"
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -76,10 +88,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[auth_provider]_callback.ts → www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts
+25 -17
View File
@@ -1,19 +1,19 @@
/**
* @oas [post] /auth/{scope}/{auth_provider}/callback
* operationId: PostScopeAuth_providerCallback
* summary: Add Callbacks to [scope]
* description: Add a list of callbacks to a [scope].
* @oas [post] /auth/{actor_type}/{auth_provider}/callback
* operationId: PostActor_typeAuth_providerCallback
* summary: Add Callbacks to [actor_type]
* description: Add a list of callbacks to a [actor_type].
* x-authenticated: false
* parameters:
* - name: scope
* - name: actor_type
* in: path
* description: The [scope]'s scope.
* description: The [actor type]'s actor type.
* required: true
* schema:
* type: string
* - name: auth_provider
* in: path
* description: The [scope]'s auth provider.
* description: The [actor type]'s auth provider.
* required: true
* schema:
* type: string
@@ -27,12 +27,18 @@
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
@@ -51,19 +57,25 @@
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/{scope}/{auth_provider}/callback'
* source: curl -X POST '{backend_url}/auth/{actor_type}/{auth_provider}/callback'
* tags:
* - "[scope]"
* - "[actor_type]"
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -76,10 +88,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[authProvider].ts
-85
View File
@@ -1,85 +0,0 @@
/**
* @oas [post] /auth/{scope}/{authProvider}
* operationId: PostScopeAuthprovider
* summary: Add to [scope]
* description: Add a list of to a [scope].
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: authProvider
* in: path
* description: The [scope]'s authprovider.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/{scope}/{authProvider}'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[authProvider]_callback.ts
-85
View File
@@ -1,85 +0,0 @@
/**
* @oas [post] /auth/{scope}/{authProvider}/callback
* operationId: PostScopeAuthproviderCallback
* summary: Add Callbacks to [scope]
* description: Add a list of callbacks to a [scope].
* x-authenticated: false
* parameters:
* - name: scope
* in: path
* description: The [scope]'s scope.
* required: true
* schema:
* type: string
* - name: authProvider
* in: path
* description: The [scope]'s authprovider.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/{scope}/{authProvider}/callback'
* tags:
* - "[scope]"
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/auth/post_auth_session.ts
+16 -8
View File
@@ -15,12 +15,18 @@
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
@@ -39,12 +45,16 @@
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -52,6 +62,8 @@
* tags:
* - Session
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -64,10 +76,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/