docs: fix tsdocs following typedoc update + 1.20 release (#6033)

* docs: fix tsdocs following typedoc update + 1.20 release

* Fix OAS validation errors

* fixes to react-docs-generator

* fix content linting
This commit is contained in:
Shahed Nasser
2024-01-09 17:15:29 +02:00
committed by GitHub
parent 125879ada4
commit 18de90e603
32 changed files with 460 additions and 111 deletions
+7
View File
@@ -228,6 +228,13 @@
* description: The total of gift cards with taxes
* type: integer
* example: 0
* sales_channels:
* description: The associated sales channels.
* type: array
* nullable: true
* x-expandable: "sales_channels"
* items:
* $ref: "#/components/schemas/SalesChannel"
*/
import {
+8
View File
@@ -742,4 +742,12 @@ export class Order extends BaseEntity {
* externalDocs:
* description: "Learn about the metadata attribute, and how to delete and update it."
* url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute"
* sales_channels:
* description: The associated sales channels.
* type: array
* nullable: true
* x-expandable: "sales_channels"
* x-featureFlag: "medusa_v2"
* items:
* $ref: "#/components/schemas/SalesChannel"
*/
@@ -30,7 +30,14 @@ export class PublishableApiKeySalesChannel extends BaseEntity {
* required:
* - publishable_key_id
* - sales_channel_id
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* description: The relation's ID
* type: string
* example: pksc_01G8X9A7ESKAJXG2H0E6F1MW7A
* sales_channel_id:
* description: The sales channel's ID
* type: string
@@ -39,4 +46,17 @@ export class PublishableApiKeySalesChannel extends BaseEntity {
* description: The publishable API key's ID
* type: string
* example: pak_01G1G5V21KADXNGH29BJMAJ4B4
* created_at:
* description: The date with timezone at which the resource was created.
* type: string
* format: date-time
* updated_at:
* description: The date with timezone at which the resource was updated.
* type: string
* format: date-time
* deleted_at:
* description: The date with timezone at which the resource was deleted.
* nullable: true
* type: string
* format: date-time
*/
@@ -165,4 +165,27 @@ export class SalesChannel extends SoftDeletableEntity {
* externalDocs:
* description: "Learn about the metadata attribute, and how to delete and update it."
* url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute"
* carts:
* description: The associated carts.
* type: array
* nullable: true
* x-expandable: "carts"
* x-featureFlag: "medusa_v2"
* items:
* $ref: "#/components/schemas/Cart"
* orders:
* description: The associated orders.
* type: array
* nullable: true
* x-expandable: "orders"
* x-featureFlag: "medusa_v2"
* items:
* $ref: "#/components/schemas/Order"
* publishableKeys:
* description: The associated publishable API keys.
* type: array
* nullable: true
* x-expandable: "publishableKeys"
* items:
* $ref: "#/components/schemas/PublishableApiKey"
*/