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

2022-08-05 15:06:12 +03:00
parent b126ab4dec
commit 73383cc466
625 changed files with 52358 additions and 11660 deletions
@@ -0,0 +1,103 @@
+get:
+  operationId: GetCustomersCustomer
+  summary: Retrieve a Customer
+  description: Retrieves a Customer.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Customer.
+      schema:
+        type: string
+    - in: query
+      name: expand
+      description: (Comma separated) Which fields should be expanded in the customer.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: (Comma separated) Which fields should be included in the customer.
+      schema:
+        type: string
+  tags:
+    - Customer
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              customer:
+                $ref: ../components/schemas/customer.yaml
+post:
+  operationId: PostCustomersCustomer
+  summary: Update a Customer
+  description: Updates a Customer.
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: id
+      required: true
+      description: The ID of the Customer.
+      schema:
+        type: string
+    - in: query
+      name: expand
+      description: (Comma separated) Which fields should be expanded in each customer.
+      schema:
+        type: string
+    - in: query
+      name: fields
+      description: (Comma separated) Which fields should be retrieved in each customer.
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        schema:
+          properties:
+            email:
+              type: string
+              description: The Customer's email.
+              format: email
+            first_name:
+              type: string
+              description: The Customer's first name.
+            last_name:
+              type: string
+              description: The Customer's last name.
+            phone:
+              type: string
+              description: The Customer's phone number.
+            password:
+              type: string
+              description: The Customer's password.
+              format: password
+            groups:
+              type: array
+              items:
+                required:
+                  - id
+                properties:
+                  id:
+                    description: The ID of a customer group
+                    type: string
+              description: A list of customer groups to which the customer belongs.
+            metadata:
+              description: >-
+                An optional set of key-value pairs to hold additional
+                information.
+              type: object
+  tags:
+    - Customer
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              customer:
+                $ref: ../components/schemas/customer.yaml