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

chore(oas): [14/n] improve OAS schemas (#9202)

Browse Source 
* chore(oas): [14/n] improve OAS schemas

* fix description of required_quantity
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-09-19 18:52:46 +02:00
1 parent d6ce0688db
commit 426c39c04b
20 files changed
+133 -281
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/utils/generated/oas-output/schemas/AdminUpdateApiKey.ts
+2 -2
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUpdateApiKey * @schema AdminUpdateApiKey
* type: object * type: object
* description: SUMMARY * description: The details to update in an API key.
* x-schemaName: AdminUpdateApiKey * x-schemaName: AdminUpdateApiKey
* required: * required:
* - title * - title
@@ -9,7 +9,7 @@
* title: * title:
* type: string * type: string
* title: title * title: title
* description: The api key's title. * description: The API key's title.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateCollection.ts
+2 -2
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUpdateCollection * @schema AdminUpdateCollection
* type: object * type: object
* description: SUMMARY * description: The details to update in a collection.
* x-schemaName: AdminUpdateCollection * x-schemaName: AdminUpdateCollection
* properties: * properties:
* title: * title:
@@ -14,7 +14,7 @@
* description: The collection's handle. * description: The collection's handle.
* metadata: * metadata:
* type: object * type: object
* description: The collection's metadata. * description: The collection's metadata, can hold custom key-value pairs.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts
+2 -2
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUpdateCustomerGroup * @schema AdminUpdateCustomerGroup
* type: object * type: object
* description: SUMMARY * description: The details to update in a customer group.
* x-schemaName: AdminUpdateCustomerGroup * x-schemaName: AdminUpdateCustomerGroup
* properties: * properties:
* name: * name:
@@ -10,7 +10,7 @@
* description: The customer group's name. * description: The customer group's name.
* metadata: * metadata:
* type: object * type: object
* description: The customer group's metadata. * description: The customer group's metadata, can hold custom key-value pairs.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts
+6 -4
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUpdatePriceList * @schema AdminUpdatePriceList
* type: object * type: object
* description: SUMMARY * description: the details to update in a price list.
* x-schemaName: AdminUpdatePriceList * x-schemaName: AdminUpdatePriceList
* properties: * properties:
* title: * title:
@@ -15,11 +15,11 @@
* starts_at: * starts_at:
* type: string * type: string
* title: starts_at * title: starts_at
* description: The price list's starts at. * description: The date the price list starts.
* ends_at: * ends_at:
* type: string * type: string
* title: ends_at * title: ends_at
* description: The price list's ends at. * description: The date the price list ends.
* status: * status:
* type: string * type: string
* description: The price list's status. * description: The price list's status.
@@ -35,6 +35,8 @@
* rules: * rules:
* type: object * type: object
* description: The price list's rules. * description: The price list's rules.
* * example:
* customer_group_id:
* - "cusgrp_123"
*/ */
www/utils/generated/oas-output/schemas/AdminUpdatePricePreference.ts
+4 -2
View File
@@ -1,21 +1,23 @@
/** /**
* @schema AdminUpdatePricePreference * @schema AdminUpdatePricePreference
* type: object * type: object
* description: SUMMARY * description: The details to update in the price preference.
* x-schemaName: AdminUpdatePricePreference * x-schemaName: AdminUpdatePricePreference
* properties: * properties:
* attribute: * attribute:
* type: string * type: string
* title: attribute * title: attribute
* description: The price preference's attribute. * description: The price preference's attribute.
* example: region_id
* value: * value:
* type: string * type: string
* title: value * title: value
* description: The price preference's value. * description: The price preference's value.
* example: reg_123
* is_tax_inclusive: * is_tax_inclusive:
* type: boolean * type: boolean
* title: is_tax_inclusive * title: is_tax_inclusive
* description: The price preference's is tax inclusive. * description: Whether prices are tax inclusive for this price preference.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts
+33 -192
View File
@@ -1,53 +1,53 @@
/** /**
* @schema AdminUpdateProduct * @schema AdminUpdateProduct
* type: object * type: object
* description: The update's details. * description: The product's details.
* x-schemaName: AdminUpdateProduct * x-schemaName: AdminUpdateProduct
* properties: * properties:
* title: * title:
* type: string * type: string
* title: title * title: title
* description: The update's title. * description: The product's title.
* subtitle: * subtitle:
* type: string * type: string
* title: subtitle * title: subtitle
* description: The update's subtitle. * description: The product's subtitle.
* description: * description:
* type: string * type: string
* title: description * title: description
* description: The update's description. * description: The product's description.
* is_giftcard: * is_giftcard:
* type: boolean * type: boolean
* title: is_giftcard * title: is_giftcard
* description: The update's is giftcard. * description: Whether the product is a gift card.
* discountable: * discountable:
* type: boolean * type: boolean
* title: discountable * title: discountable
* description: The update's discountable. * description: Whether discounts can be applied on the product.
* images: * images:
* type: array * type: array
* description: The update's images. * description: The product's images.
* items: * items:
* type: object * type: object
* description: The image's images. * description: The image's details.
* required: * required:
* - url * - url
* properties: * properties:
* url: * url:
* type: string * type: string
* title: url * title: url
* description: The image's url. * description: The image's URL.
* thumbnail: * thumbnail:
* type: string * type: string
* title: thumbnail * title: thumbnail
* description: The update's thumbnail. * description: The product's thumbnail URL.
* handle: * handle:
* type: string * type: string
* title: handle * title: handle
* description: The update's handle. * description: The product's unique handle.
* status: * status:
* type: string * type: string
* description: The update's status. * description: The product's status.
* enum: * enum:
* - draft * - draft
* - proposed * - proposed
@@ -56,17 +56,17 @@
* type_id: * type_id:
* type: string * type: string
* title: type_id * title: type_id
* description: The update's type id. * description: The ID of the product's type.
* collection_id: * collection_id:
* type: string * type: string
* title: collection_id * title: collection_id
* description: The update's collection id. * description: The ID of the product's collection.
* categories: * categories:
* type: array * type: array
* description: The update's categories. * description: The product's categories.
* items: * items:
* type: object * type: object
* description: The category's categories. * description: The product's category.
* required: * required:
* - id * - id
* properties: * properties:
@@ -76,10 +76,10 @@
* description: The category's ID. * description: The category's ID.
* tags: * tags:
* type: array * type: array
* description: The update's tags. * description: The product's tags.
* items: * items:
* type: object * type: object
* description: The tag's tags. * description: The product's tag.
* required: * required:
* - id * - id
* properties: * properties:
@@ -89,181 +89,22 @@
* description: The tag's ID. * description: The tag's ID.
* options: * options:
* type: array * type: array
* description: The update's options. * description: The product's options.
* items: * items:
* $ref: "#/components/schemas/AdminUpdateProductOption" * $ref: "#/components/schemas/AdminUpdateProductOption"
* variants: * variants:
* type: array * type: array
* description: The update's variants. * description: The product's variants. You can add new variants or update existing ones, passing their IDs in the object.
* items: * items:
* oneOf: * oneOf:
* - type: object * - $ref: "#/components/schemas/AdminCreateProductVariant"
* description: The variant's variants. * - $ref: "#/components/schemas/AdminUpdateProductVariant"
* x-schemaName: AdminCreateProductVariant
* required:
* - title
* - prices
* properties:
* title:
* type: string
* title: title
* description: The variant's title.
* sku:
* type: string
* title: sku
* description: The variant's sku.
* ean:
* type: string
* title: ean
* description: The variant's ean.
* upc:
* type: string
* title: upc
* description: The variant's upc.
* barcode:
* type: string
* title: barcode
* description: The variant's barcode.
* hs_code:
* type: string
* title: hs_code
* description: The variant's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The variant's mid code.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The variant's allow backorder.
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The variant's manage inventory.
* variant_rank:
* type: number
* title: variant_rank
* description: The variant's variant rank.
* weight:
* type: number
* title: weight
* description: The variant's weight.
* length:
* type: number
* title: length
* description: The variant's length.
* height:
* type: number
* title: height
* description: The variant's height.
* width:
* type: number
* title: width
* description: The variant's width.
* origin_country:
* type: string
* title: origin_country
* description: The variant's origin country.
* material:
* type: string
* title: material
* description: The variant's material.
* metadata:
* type: object
* description: The variant's metadata.
* prices:
* type: array
* description: The variant's prices.
* items:
* $ref: "#/components/schemas/AdminCreateProductVariantPrice"
* options:
* type: object
* description: The variant's options.
* - type: object
* description: The variant's variants.
* x-schemaName: AdminUpdateProductVariant
* properties:
* title:
* type: string
* title: title
* description: The variant's title.
* sku:
* type: string
* title: sku
* description: The variant's sku.
* ean:
* type: string
* title: ean
* description: The variant's ean.
* upc:
* type: string
* title: upc
* description: The variant's upc.
* barcode:
* type: string
* title: barcode
* description: The variant's barcode.
* hs_code:
* type: string
* title: hs_code
* description: The variant's hs code.
* mid_code:
* type: string
* title: mid_code
* description: The variant's mid code.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The variant's allow backorder.
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The variant's manage inventory.
* variant_rank:
* type: number
* title: variant_rank
* description: The variant's variant rank.
* weight:
* type: number
* title: weight
* description: The variant's weight.
* length:
* type: number
* title: length
* description: The variant's length.
* height:
* type: number
* title: height
* description: The variant's height.
* width:
* type: number
* title: width
* description: The variant's width.
* origin_country:
* type: string
* title: origin_country
* description: The variant's origin country.
* material:
* type: string
* title: material
* description: The variant's material.
* metadata:
* type: object
* description: The variant's metadata.
* prices:
* type: array
* description: The variant's prices.
* items:
* $ref: "#/components/schemas/AdminCreateProductVariantPrice"
* options:
* type: object
* description: The variant's options.
* sales_channels: * sales_channels:
* type: array * type: array
* description: The update's sales channels. * description: The sales channels that the product is available in.
* items: * items:
* type: object * type: object
* description: The sales channel's sales channels. * description: The sales channel's details.
* required: * required:
* - id * - id
* properties: * properties:
@@ -274,38 +115,38 @@
* weight: * weight:
* type: number * type: number
* title: weight * title: weight
* description: The update's weight. * description: The product's weight.
* length: * length:
* type: number * type: number
* title: length * title: length
* description: The update's length. * description: The product's length.
* height: * height:
* type: number * type: number
* title: height * title: height
* description: The update's height. * description: The product's height.
* width: * width:
* type: number * type: number
* title: width * title: width
* description: The update's width. * description: The product's width.
* hs_code: * hs_code:
* type: string * type: string
* title: hs_code * title: hs_code
* description: The update's hs code. * description: The product's HS code.
* mid_code: * mid_code:
* type: string * type: string
* title: mid_code * title: mid_code
* description: The update's mid code. * description: The product's MID code.
* origin_country: * origin_country:
* type: string * type: string
* title: origin_country * title: origin_country
* description: The update's origin country. * description: The product's origin country.
* material: * material:
* type: string * type: string
* title: material * title: material
* description: The update's material. * description: The product's material.
* metadata: * metadata:
* type: object * type: object
* description: The update's metadata. * description: The product's metadata, can hold custom key-value pairs.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateProductOption.ts
+4 -4
View File
@@ -1,20 +1,20 @@
/** /**
* @schema AdminUpdateProductOption * @schema AdminUpdateProductOption
* type: object * type: object
* description: SUMMARY * description: The details to update in a product option.
* x-schemaName: AdminUpdateProductOption * x-schemaName: AdminUpdateProductOption
* properties: * properties:
* title: * title:
* type: string * type: string
* title: title * title: title
* description: The product's title. * description: The option's title.
* values: * values:
* type: array * type: array
* description: The product's values. * description: The option's values.
* items: * items:
* type: string * type: string
* title: values * title: values
* description: The value's values. * description: An option value.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateProductVariant.ts
+20 -20
View File
@@ -1,84 +1,84 @@
/** /**
* @schema AdminUpdateProductVariant * @schema AdminUpdateProductVariant
* type: object * type: object
* description: The update's details. * description: The properties to update of a product variant.
* x-schemaName: AdminUpdateProductVariant * x-schemaName: AdminUpdateProductVariant
* properties: * properties:
* title: * title:
* type: string * type: string
* title: title * title: title
* description: The update's title. * description: The product variant's title.
* sku: * sku:
* type: string * type: string
* title: sku * title: sku
* description: The update's sku. * description: The product variant's SKU.
* ean: * ean:
* type: string * type: string
* title: ean * title: ean
* description: The update's ean. * description: The product variant's EAN.
* upc: * upc:
* type: string * type: string
* title: upc * title: upc
* description: The update's upc. * description: The product variant's UPC.
* barcode: * barcode:
* type: string * type: string
* title: barcode * title: barcode
* description: The update's barcode. * description: The product variant's barcode.
* hs_code: * hs_code:
* type: string * type: string
* title: hs_code * title: hs_code
* description: The update's hs code. * description: The product variant's HS code.
* mid_code: * mid_code:
* type: string * type: string
* title: mid_code * title: mid_code
* description: The update's mid code. * description: The product variant's MID code.
* allow_backorder: * allow_backorder:
* type: boolean * type: boolean
* title: allow_backorder * title: allow_backorder
* description: The update's allow backorder. * description: Whether customers can order the variant even if it's not in stock.
* manage_inventory: * manage_inventory:
* type: boolean * type: boolean
* title: manage_inventory * title: manage_inventory
* description: The update's manage inventory. * description: Whether the Medusa application manages the variant's inventory. If disabled, the product variant is always considered in stock.
* variant_rank: * variant_rank:
* type: number * type: number
* title: variant_rank * title: variant_rank
* description: The update's variant rank. * description: The product variant's rank among its siblings.
* weight: * weight:
* type: number * type: number
* title: weight * title: weight
* description: The update's weight. * description: The product variant's weight.
* length: * length:
* type: number * type: number
* title: length * title: length
* description: The update's length. * description: The product variant's length.
* height: * height:
* type: number * type: number
* title: height * title: height
* description: The update's height. * description: The product variant's height.
* width: * width:
* type: number * type: number
* title: width * title: width
* description: The update's width. * description: The product variant's width.
* origin_country: * origin_country:
* type: string * type: string
* title: origin_country * title: origin_country
* description: The update's origin country. * description: The product variant's origin country.
* material: * material:
* type: string * type: string
* title: material * title: material
* description: The update's material. * description: The product variant's material.
* metadata: * metadata:
* type: object * type: object
* description: The update's metadata. * description: The product variant's metadata, can hold custom key-value pairs.
* prices: * prices:
* type: array * type: array
* description: The update's prices. * description: The product variant's prices.
* items: * items:
* $ref: "#/components/schemas/AdminCreateProductVariantPrice" * $ref: "#/components/schemas/AdminCreateProductVariantPrice"
* options: * options:
* type: object * type: object
* description: The update's options. * description: The product variant's options.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts
+3 -3
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUpdateSalesChannel * @schema AdminUpdateSalesChannel
* type: object * type: object
* description: SUMMARY * description: The properties to update in the sales channel.
* x-schemaName: AdminUpdateSalesChannel * x-schemaName: AdminUpdateSalesChannel
* properties: * properties:
* name: * name:
@@ -15,10 +15,10 @@
* is_disabled: * is_disabled:
* type: boolean * type: boolean
* title: is_disabled * title: is_disabled
* description: The sales channel's is disabled. * description: Whether the sales channel is disabled.
* metadata: * metadata:
* type: object * type: object
* description: The sales channel's metadata. * description: The sales channel's metadata, can hold custom key-value pairs.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts
+7 -6
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUpdateStockLocation * @schema AdminUpdateStockLocation
* type: object * type: object
* description: SUMMARY * description: The properties to update in a stock location.
* x-schemaName: AdminUpdateStockLocation * x-schemaName: AdminUpdateStockLocation
* properties: * properties:
* name: * name:
@@ -10,7 +10,7 @@
* description: The stock location's name. * description: The stock location's name.
* address: * address:
* type: object * type: object
* description: The stock location's address. * description: The stock location's address. Pass this property if you're creating a new address to associate with the location.
* required: * required:
* - address_1 * - address_1
* - country_code * - country_code
@@ -18,11 +18,11 @@
* address_1: * address_1:
* type: string * type: string
* title: address_1 * title: address_1
* description: The address's address 1. * description: The address's first line.
* address_2: * address_2:
* type: string * type: string
* title: address_2 * title: address_2
* description: The address's address 2. * description: The address's second line.
* company: * company:
* type: string * type: string
* title: company * title: company
@@ -35,6 +35,7 @@
* type: string * type: string
* title: country_code * title: country_code
* description: The address's country code. * description: The address's country code.
* example: us
* phone: * phone:
* type: string * type: string
* title: phone * title: phone
@@ -50,10 +51,10 @@
* address_id: * address_id:
* type: string * type: string
* title: address_id * title: address_id
* description: The stock location's address id. * description: The ID of an existing stock location address to associate the stock location with.
* metadata: * metadata:
* type: object * type: object
* description: The stock location's metadata. * description: The stock location's metadata, can hold custom key-value pairs.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateStore.ts
+10 -9
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUpdateStore * @schema AdminUpdateStore
* type: object * type: object
* description: SUMMARY * description: The properties to update in a store.
* x-schemaName: AdminUpdateStore * x-schemaName: AdminUpdateStore
* properties: * properties:
* name: * name:
@@ -13,37 +13,38 @@
* description: The store's supported currencies. * description: The store's supported currencies.
* items: * items:
* type: object * type: object
* description: The supported currency's supported currencies. * description: A store currency.
* required: * required:
* - currency_code * - currency_code
* properties: * properties:
* currency_code: * currency_code:
* type: string * type: string
* title: currency_code * title: currency_code
* description: The supported currency's currency code. * description: The currency's code.
* example: usd
* is_default: * is_default:
* type: boolean * type: boolean
* title: is_default * title: is_default
* description: The supported currency's is default. * description: Whether the currency is the default in the store.
* is_tax_inclusive: * is_tax_inclusive:
* type: boolean * type: boolean
* title: is_tax_inclusive * title: is_tax_inclusive
* description: The supported currency's is tax inclusive. * description: Whether prices using this currency are tax inclusive.
* default_sales_channel_id: * default_sales_channel_id:
* type: string * type: string
* title: default_sales_channel_id * title: default_sales_channel_id
* description: The store's default sales channel id. * description: The ID of the default sales channel in the store.
* default_region_id: * default_region_id:
* type: string * type: string
* title: default_region_id * title: default_region_id
* description: The store's default region id. * description: The ID of the default region in the store.
* default_location_id: * default_location_id:
* type: string * type: string
* title: default_location_id * title: default_location_id
* description: The store's default location id. * description: The ID of the default stock location in the store.
* metadata: * metadata:
* type: object * type: object
* description: The store's metadata. * description: The store's metadata, can hold custom key-value pairs.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts
+13 -9
View File
@@ -1,23 +1,23 @@
/** /**
* @schema AdminUpdateTaxRate * @schema AdminUpdateTaxRate
* type: object * type: object
* description: SUMMARY * description: The properties to update in the tax rate.
* x-schemaName: AdminUpdateTaxRate * x-schemaName: AdminUpdateTaxRate
* properties: * properties:
* rate: * rate:
* type: number * type: number
* title: rate * title: rate
* description: The tax rate's rate. * description: The rate to charge.
* code: * code:
* type: string * type: string
* title: code * title: code
* description: The tax rate's code. * description: The code that the tax rate is identified by.
* rules: * rules:
* type: array * type: array
* description: The tax rate's rules. * description: The tax rate's rules.
* items: * items:
* type: object * type: object
* description: The rule's rules. * description: A tax rate rule.
* required: * required:
* - reference * - reference
* - reference_id * - reference_id
@@ -25,11 +25,13 @@
* reference: * reference:
* type: string * type: string
* title: reference * title: reference
* description: The rule's reference. * description: The name of the table this rule references.
* example: product_type
* reference_id: * reference_id:
* type: string * type: string
* title: reference_id * title: reference_id
* description: The rule's reference id. * description: The ID of the record in the table that the rule references.
* example: ptyp_123
* name: * name:
* type: string * type: string
* title: name * title: name
@@ -37,14 +39,16 @@
* is_default: * is_default:
* type: boolean * type: boolean
* title: is_default * title: is_default
* description: The tax rate's is default. * description: Whether the tax rate is the default in the store.
* is_combinable: * is_combinable:
* type: boolean * type: boolean
* title: is_combinable * title: is_combinable
* description: The tax rate's is combinable. * description: Whether the tax rate should be combined with parent rates.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
* metadata: * metadata:
* type: object * type: object
* description: The tax rate's metadata. * description: The tax rate's metadata, can hold custom key-value pairs.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateUser.ts
+2 -2
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUpdateUser * @schema AdminUpdateUser
* type: object * type: object
* description: SUMMARY * description: The properties to update in a user.
* x-schemaName: AdminUpdateUser * x-schemaName: AdminUpdateUser
* properties: * properties:
* first_name: * first_name:
@@ -15,7 +15,7 @@
* avatar_url: * avatar_url:
* type: string * type: string
* title: avatar_url * title: avatar_url
* description: The user's avatar url. * description: The URL of the user's avatar.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpdateVariantInventoryItem.ts
+2 -2
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUpdateVariantInventoryItem * @schema AdminUpdateVariantInventoryItem
* type: object * type: object
* description: SUMMARY * description: The properties to update of the variant's inventory item association.
* x-schemaName: AdminUpdateVariantInventoryItem * x-schemaName: AdminUpdateVariantInventoryItem
* required: * required:
* - required_quantity * - required_quantity
@@ -9,7 +9,7 @@
* required_quantity: * required_quantity:
* type: number * type: number
* title: required_quantity * title: required_quantity
* description: The product's required quantity. * description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUpsertStockLocationAddress.ts
+4 -3
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUpsertStockLocationAddress * @schema AdminUpsertStockLocationAddress
* type: object * type: object
* description: The stock location's address. * description: The details of the stock location address to create.
* x-schemaName: AdminUpsertStockLocationAddress * x-schemaName: AdminUpsertStockLocationAddress
* required: * required:
* - address_1 * - address_1
@@ -10,11 +10,11 @@
* address_1: * address_1:
* type: string * type: string
* title: address_1 * title: address_1
* description: The address's address 1. * description: The address's first line.
* address_2: * address_2:
* type: string * type: string
* title: address_2 * title: address_2
* description: The address's address 2. * description: The address's second line.
* company: * company:
* type: string * type: string
* title: company * title: company
@@ -23,6 +23,7 @@
* type: string * type: string
* title: country_code * title: country_code
* description: The address's country code. * description: The address's country code.
* example: usd
* city: * city:
* type: string * type: string
* title: city * title: city
www/utils/generated/oas-output/schemas/AdminUser.ts
+5 -5
View File
@@ -34,25 +34,25 @@
* avatar_url: * avatar_url:
* type: string * type: string
* title: avatar_url * title: avatar_url
* description: The user's avatar url. * description: The URL of the user's avatar.
* metadata: * metadata:
* type: object * type: object
* description: The user's metadata. * description: The user's metadata, can hold custom key-value pairs.
* created_at: * created_at:
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The user's created at. * description: The date the user was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The user's updated at. * description: The date the user was updated.
* deleted_at: * deleted_at:
* type: string * type: string
* format: date-time * format: date-time
* title: deleted_at * title: deleted_at
* description: The user's deleted at. * description: The date the user was deleted.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts
+2 -2
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUserDeleteResponse * @schema AdminUserDeleteResponse
* type: object * type: object
* description: SUMMARY * description: The details of the deleted user.
* x-schemaName: AdminUserDeleteResponse * x-schemaName: AdminUserDeleteResponse
* required: * required:
* - id * - id
@@ -20,7 +20,7 @@
* deleted: * deleted:
* type: boolean * type: boolean
* title: deleted * title: deleted
* description: Whether the User was deleted. * description: Whether the user was deleted.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminUserListResponse.ts
+5 -5
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUserListResponse * @schema AdminUserListResponse
* type: object * type: object
* description: SUMMARY * description: The paginated list of users.
* x-schemaName: AdminUserListResponse * x-schemaName: AdminUserListResponse
* required: * required:
* - limit * - limit
@@ -12,18 +12,18 @@
* limit: * limit:
* type: number * type: number
* title: limit * title: limit
* description: The user's limit. * description: The maximum number of items returned.
* offset: * offset:
* type: number * type: number
* title: offset * title: offset
* description: The user's offset. * description: The number of items skipped before retrieving the returned items.
* count: * count:
* type: number * type: number
* title: count * title: count
* description: The user's count. * description: The total number of items.
* users: * users:
* type: array * type: array
* description: The user's users. * description: The list of users.
* items: * items:
* $ref: "#/components/schemas/AdminUser" * $ref: "#/components/schemas/AdminUser"
* *
www/utils/generated/oas-output/schemas/AdminUserResponse.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminUserResponse * @schema AdminUserResponse
* type: object * type: object
* description: SUMMARY * description: The user's details.
* x-schemaName: AdminUserResponse * x-schemaName: AdminUserResponse
* required: * required:
* - user * - user
www/utils/generated/oas-output/schemas/AdminWorkflowExecution.ts
+6 -6
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminWorkflowExecution * @schema AdminWorkflowExecution
* type: object * type: object
* description: The workflows execution's workflow execution. * description: The workflows execution's details.
* x-schemaName: AdminWorkflowExecution * x-schemaName: AdminWorkflowExecution
* required: * required:
* - id * - id
@@ -20,11 +20,11 @@
* workflow_id: * workflow_id:
* type: string * type: string
* title: workflow_id * title: workflow_id
* description: The workflow execution's workflow id. * description: The ID of the workflow.
* transaction_id: * transaction_id:
* type: string * type: string
* title: transaction_id * title: transaction_id
* description: The workflow execution's transaction id. * description: The workflow execution's transaction ID.
* execution: * execution:
* $ref: "#/components/schemas/AdminWorkflowExecutionExecution" * $ref: "#/components/schemas/AdminWorkflowExecutionExecution"
* context: * context:
@@ -44,17 +44,17 @@
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The workflow execution's created at. * description: The date the workflow execution was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The workflow execution's updated at. * description: The date the workflow execution was updated.
* deleted_at: * deleted_at:
* type: string * type: string
* format: date-time * format: date-time
* title: deleted_at * title: deleted_at
* description: The workflow execution's deleted at. * description: The date the workflow execution was deleted.
* *
*/ */