chore(docs): Generated API Reference (#2994)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-01-11 18:08:33 +02:00
parent f521260a8f
commit f7e23afff2
51 changed files with 4342 additions and 0 deletions
@@ -0,0 +1,44 @@
+title: Stock Location
+description: Represents a Stock Location
+type: object
+required:
+  - id
+  - name
+  - address_id
+  - created_at
+  - updated_at
+properties:
+  id:
+    type: string
+    description: The stock location's ID
+    example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42
+  address_id:
+    type: string
+    description: Stock location address' ID
+    example: laddr_05B2ZE853Y6FTXWPW85NJ81A44
+  name:
+    type: string
+    description: The name of the stock location
+    example: Main Warehouse
+  address:
+    description: The Address of the Stock Location
+    allOf:
+      - $ref: ./StockLocationAddressDTO.yaml
+      - type: object
+  metadata:
+    type: object
+    description: An optional key-value map with additional details
+    example:
+      car: white
+  created_at:
+    type: string
+    description: The date with timezone at which the resource was created.
+    format: date-time
+  updated_at:
+    type: string
+    description: The date with timezone at which the resource was updated.
+    format: date-time
+  deleted_at:
+    type: string
+    description: The date with timezone at which the resource was deleted.
+    format: date-time