Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(oas): [21/21] improve oas schemas #9339

Merged
merged 6 commits into from
Sep 27, 2024
Merged

chore(oas): [21/21] improve oas schemas #9339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ebb1f33
improve oas
shahednasser Sep 26, 2024
da6987d
more improvements
shahednasser Sep 26, 2024
0fe027a
add missing descriptions
shahednasser Sep 26, 2024
3fe3068
Merge branch 'develop' into oas/improve-oas-schemas-21
olivermrbl Sep 26, 2024
44ad480
Merge branch 'develop' into oas/improve-oas-schemas-21
shahednasser Sep 27, 2024
228dd4e
Merge branch 'develop' into oas/improve-oas-schemas-21
shahednasser Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions www/utils/generated/oas-output/schemas/AdminWorkflowExecutionExecution.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,110 @@
* type: object
* description: The state of the step's invokation function.
* x-schemaName: WorkflowExecutionFn
* properties:
* state:
* type: string
* description: The invokation step's state.
* enum:
* - not_started
* - invoking
* - compensating
* - done
* - reverted
* - failed
* - dormant
* - skipped
* - skipped_failure
* - timeout
* status:
* type: string
* description: The invokation step's state.
* enum:
* - idle
* - ok
* - waiting_response
* - temp_failure
* - permanent_failure
* required:
* - state
* - status
* definition:
* type: object
* description: The step's definition details.
* x-schemaName: WorkflowExecutionDefinition
* properties:
* async:
* type: boolean
* title: async
* description: Whether the step is async.
* compensateAsync:
* type: boolean
* title: compensateAsync
* description: Whether the compensation function of the step is async.
* noCompensation:
* type: boolean
* title: noCompensation
* description: Whether the step doesn't have a compensation function.
* continueOnPermanentFailure:
* type: boolean
* title: continueOnPermanentFailure
* description: Whether the step continues executing even if its status is changed to failed.
* maxRetries:
* type: number
* title: maxRetries
* description: The maximum number of times to retry the step.
* noWait:
* type: boolean
* title: noWait
* description: Whether the workflow shouldn't wait for the step to finish before moving to the next step.
* default: false
* retryInterval:
* type: number
* title: retryInterval
* description: The interval in seconds between retry attempts when the step fails.
* retryIntervalAwaiting:
* type: number
* title: retryIntervalAwaiting
* description: The interval in seconds to retry a step even if its status is `waiting_response`.
* saveResponse:
* type: boolean
* title: saveResponse
* description: Whether the step's response is stored.
* timeout:
* type: number
* title: timeout
* description: The maximum time in seconds to wait for this step to complete. If the step exceeds this time, the step's state is changed to `timeout`, but the step continues executing.
* compensate:
* type: object
* description: The state of the step's compensation function.
* x-schemaName: WorkflowExecutionFn
* properties:
* state:
* type: string
* description: The compensation function's state.
* enum:
* - not_started
* - invoking
* - compensating
* - done
* - reverted
* - failed
* - dormant
* - skipped
* - skipped_failure
* - timeout
* status:
* type: string
* description: The compensation function's status.
* enum:
* - idle
* - ok
* - waiting_response
* - temp_failure
* - permanent_failure
* required:
* - state
* - status
* depth:
* type: number
* title: depth
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/schemas/StoreOrderResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @schema StoreOrderResponse
* type: object
* description: SUMMARY
* description: The order's details.
* x-schemaName: StoreOrderResponse
* required:
* - order
Expand Down
77 changes: 21 additions & 56 deletions www/utils/generated/oas-output/schemas/StorePaymentCollection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,80 +19,45 @@
* type: string
* title: currency_code
* description: The payment collection's currency code.
* example: usd
* region_id:
* type: string
* title: region_id
* description: The payment collection's region id.
* description: The ID of the associated region.
* amount:
* oneOf:
* - type: string
* title: amount
* description: The payment collection's amount.
* - type: number
* title: amount
* description: The payment collection's amount.
* - type: string
* title: amount
* description: The payment collection's amount.
* - $ref: "#/components/schemas/IBigNumber"
* type: number
* title: amount
* description: The payment collection's amount.
* authorized_amount:
* oneOf:
* - type: string
* title: authorized_amount
* description: The payment collection's authorized amount.
* - type: number
* title: authorized_amount
* description: The payment collection's authorized amount.
* - type: string
* title: authorized_amount
* description: The payment collection's authorized amount.
* - $ref: "#/components/schemas/IBigNumber"
* type: number
* title: authorized_amount
* description: The payment collection's authorized amount.
* captured_amount:
* oneOf:
* - type: string
* title: captured_amount
* description: The payment collection's captured amount.
* - type: number
* title: captured_amount
* description: The payment collection's captured amount.
* - type: string
* title: captured_amount
* description: The payment collection's captured amount.
* - $ref: "#/components/schemas/IBigNumber"
* type: number
* title: captured_amount
* description: The payment collection's captured amount.
* refunded_amount:
* oneOf:
* - type: string
* title: refunded_amount
* description: The payment collection's refunded amount.
* - type: number
* title: refunded_amount
* description: The payment collection's refunded amount.
* - type: string
* title: refunded_amount
* description: The payment collection's refunded amount.
* - $ref: "#/components/schemas/IBigNumber"
* type: number
* title: refunded_amount
* description: The payment collection's refunded amount.
* completed_at:
* oneOf:
* - type: string
* title: completed_at
* description: The payment collection's completed at.
* - type: string
* title: completed_at
* description: The payment collection's completed at.
* format: date-time
* type: string
* title: completed_at
* description: The date the payment collection was completed.
* format: date-time
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The payment collection's created at.
* description: The date the payment collection was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The payment collection's updated at.
* description: The date the payment collection was updated.
* metadata:
* type: object
* description: The payment collection's metadata.
* description: The payment collection's metadata, can hold custom key-value pairs.
* status:
* type: string
* description: The payment collection's status.
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/schemas/StorePaymentCollectionResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @schema StorePaymentCollectionResponse
* type: object
* description: SUMMARY
* description: The payment collection's details.
* x-schemaName: StorePaymentCollectionResponse
* required:
* - payment_collection
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/schemas/StorePaymentProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @schema StorePaymentProvider
* type: object
* description: The payment provider's payment providers.
* description: The payment provider's details
* x-schemaName: StorePaymentProvider
* required:
* - id
Expand Down
28 changes: 14 additions & 14 deletions www/utils/generated/oas-output/schemas/StoreProduct.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,17 @@
* description: The product's ID.
* metadata:
* type: object
* description: The product's metadata.
* description: The product's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The product's created at.
* description: The date the product was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The product's updated at.
* description: The date the product was updated.
* variants:
* type: array
* description: The product's variants.
Expand All @@ -96,11 +96,11 @@
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The product's is giftcard.
* description: Whether the product is a gift card.
* thumbnail:
* type: string
* title: thumbnail
* description: The product's thumbnail.
* description: The product's thumbnail URL.
* width:
* type: number
* title: width
Expand All @@ -120,11 +120,11 @@
* hs_code:
* type: string
* title: hs_code
* description: The product's hs code.
* description: The product's HS code.
* mid_code:
* type: string
* title: mid_code
* description: The product's mid code.
* description: The product's MID code.
* material:
* type: string
* title: material
Expand All @@ -134,34 +134,34 @@
* collection_id:
* type: string
* title: collection_id
* description: The product's collection id.
* description: The ID of the collection that the product belongs to.
* type_id:
* type: string
* title: type_id
* description: The product's type id.
* description: The ID of the product's type.
* tags:
* type: array
* description: The product's tags.
* items:
* $ref: "#/components/schemas/BaseProductTag"
* $ref: "#/components/schemas/StoreProductTag"
* images:
* type: array
* description: The product's images.
* items:
* $ref: "#/components/schemas/BaseProductImage"
* $ref: "#/components/schemas/StoreProductImage"
* discountable:
* type: boolean
* title: discountable
* description: The product's discountable.
* description: Whether the product can be discounted.
* external_id:
* type: string
* title: external_id
* description: The product's external id.
* description: The ID of the product in an external service or system.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The product's deleted at.
* description: The date the product was deleted.
*
*/

Loading
Loading