chore(docs): Refactor API Reference (#1883)

2022-08-05 14:06:12 +02:00
parent b126ab4dec
commit 73383cc466
625 changed files with 52358 additions and 11660 deletions
@@ -0,0 +1,85 @@
+delete:
+  operationId: DeleteShippingProfilesProfile
+  summary: Delete a Shipping Profile
+  description: Deletes a Shipping Profile.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Shipping Profile.
+      schema:
+        type: string
+  tags:
+    - Shipping Profile
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              id:
+                type: string
+                description: The ID of the deleted Shipping Profile.
+              object:
+                type: string
+                description: The type of the object that was deleted.
+                default: shipping_profile
+              deleted:
+                type: boolean
+                description: Whether or not the items were deleted.
+                default: true
+get:
+  operationId: GetShippingProfilesProfile
+  summary: Retrieve a Shipping Profile
+  description: Retrieves a Shipping Profile.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Shipping Profile.
+      schema:
+        type: string
+  tags:
+    - Shipping Profile
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              shipping_profile:
+                $ref: ../components/schemas/shipping_profile.yaml
+post:
+  operationId: PostShippingProfilesProfile
+  summary: Update a Shipping Profiles
+  description: Updates a Shipping Profile
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Shipping Profile.
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        schema:
+          properties:
+            name:
+              description: The name of the Shipping Profile
+              type: string
+  tags:
+    - Shipping Profile
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              shipping_profile:
+                $ref: ../components/schemas/shipping_profile.yaml