docs: fixed errors in OAS comments (#2215)

This commit is contained in:
Shahed Nasser
2022-09-15 16:01:34 +03:00
committed by GitHub
parent 9dcbefd829
commit 7c6521101e
7 changed files with 29 additions and 8 deletions
@@ -6,7 +6,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators
import TaxInclusivePricingFeatureFlag from "../../../../loaders/feature-flags/tax-inclusive-pricing"
/**
* @oas [post] /currencies/:code
* @oas [post] /currencies/{code}
* operationId: "PostCurrenciesCurrency"
* summary: "Update a Currency"
* description: "Update a Currency"
@@ -20,7 +20,7 @@ import TaxInclusivePricingFeatureFlag from "../../../../loaders/feature-flags/ta
* properties:
* includes_tax:
* type: boolean
* description: [EXPERIMENTAL] Tax included in prices of currency.
* description: "[EXPERIMENTAL] Tax included in prices of currency."
* tags:
* - Currency
* responses:
@@ -51,7 +51,7 @@ import { validator } from "../../../../utils/validator"
* tax_rate:
* description: "The tax rate to use on Orders in the Region."
* type: number
* includes_tax:
* includes_tax:
* description: "[EXPERIMENTAL] Tax included in prices of region"
* type: boolean
* payment_providers:
@@ -92,7 +92,7 @@ export class CustomShippingOption extends SoftDeletableEntity {
* type: object
* description: An optional key-value map with additional details
* example: {car: "white"}
* includes_tax:
* includes_tax:
* description: "[EXPERIMENTAL] Indicates if the custom shipping option price include tax"
* type: boolean
*/
+1 -1
View File
@@ -97,7 +97,7 @@ export class OrderEdit extends SoftDeletableEntity {
* type: array
* description: Line item changes array.
* items:
* $ref: "#/components/schemas/order_item_changes"
* $ref: "#/components/schemas/order_item_change"
* internal_note:
* description: "An optional note with additional details about the order edit."
* type: string
+1 -1
View File
@@ -449,7 +449,7 @@ export class Order extends BaseEntity {
* $ref: "#/components/schemas/line_item"
* edits:
* type: array
* description: [EXPERIMENTAL] Order edits done on the order. Available if the relation `edits` is expanded.
* description: "[EXPERIMENTAL] Order edits done on the order. Available if the relation `edits` is expanded."
* items:
* $ref: "#/components/schemas/order_edit"
* gift_card_transactions:
+3 -2
View File
@@ -122,8 +122,9 @@ export class PriceList extends SoftDeletableEntity {
* description: The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded.
* type: array
* items:
* $ref: "#/components/schemas/money_amount"
* $ref: "#/components/schemas/customer_group"
* oneOf:
* - $ref: "#/components/schemas/money_amount"
* - $ref: "#/components/schemas/customer_group"
* includes_tax:
* description: "[EXPERIMENTAL] Does the price list prices include tax"
* type: boolean