docs: Change :id to {id} in OAS comments (#2015)

2022-08-08 16:35:13 +02:00
parent 1c6fcb2ede
commit cef081d2f2
21 changed files with 3163 additions and 2970 deletions
@@ -0,0 +1,108 @@
+post:
+  operationId: PostTaxRatesTaxRateShippingOptions
+  summary: Add Tax Rate to Product Types
+  description: Associates a Tax Rate with a list of Shipping Options
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: ID of the tax rate.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Which fields should be included in the result.
+      style: form
+      explode: false
+      schema:
+        type: array
+        items:
+          type: string
+    - in: query
+      name: expand
+      description: Which fields should be expanded and retrieved in the result.
+      style: form
+      explode: false
+      schema:
+        type: array
+        items:
+          type: string
+  x-authenticated: true
+  requestBody:
+    content:
+      application/json:
+        schema:
+          required:
+            - shipping_options
+          properties:
+            shipping_options:
+              type: array
+              description: The IDs of the shipping options to associate with this tax rate
+              items:
+                type: string
+  tags:
+    - Tax Rate
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              tax_rate:
+                $ref: ../components/schemas/tax_rate.yaml
+delete:
+  operationId: DeleteTaxRatesTaxRateShippingOptions
+  summary: Removes a Tax Rate from Product Types
+  description: Removes a Tax Rate from a list of Product Types
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: ID of the tax rate.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: Which fields should be included in the result.
+      style: form
+      explode: false
+      schema:
+        type: array
+        items:
+          type: string
+    - in: query
+      name: expand
+      description: Which fields should be expanded and retrieved in the result.
+      style: form
+      explode: false
+      schema:
+        type: array
+        items:
+          type: string
+  x-authenticated: true
+  requestBody:
+    content:
+      application/json:
+        schema:
+          required:
+            - shipping_options
+          properties:
+            shipping_options:
+              type: array
+              description: >-
+                The IDs of the shipping options to remove association with this
+                tax rate
+              items:
+                type: string
+  tags:
+    - Tax Rate
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              tax_rate:
+                $ref: ../components/schemas/tax_rate.yaml