Open api/0.12 spec

openapi/activity-log/models/ActivityLog.yaml

@@ -3,13 +3,21 @@ type: object
 properties:
   id:
     type: string
+    example: 181398
   type:
     type: string
+    example: 'default'
   description:
     type: string
+    example: 'status-update'
   properties:
-    type: string
+    type: object
+    example: {
+      "previous": "payment-received",
+      "new": "refunded"
+    }
   created_at:
     type: string
+    example: '2020-03-24T10:11:12.000000Z'
   user:
     $ref: '../../users/responses/UserResponse.yaml'

openapi/assets/models/Asset.yaml

@@ -3,34 +3,50 @@ type: object
 properties:
   id:
     type: string
+    example: 1w2ndkgo
   title:
     type: string
+    example: Olive clog boots
   type:
     type: string
+    nullable: true
+    example: product
   caption:
     type: string
+    example: Olive clog boots
   kind:
     type: string
+    example: image
   external:
     type: boolean
+    example: false
   position:
     type: integer
+    example: 1
   primary:
     type: boolean
+    example: true
   url:
     type: string
+    example: http:\/\/cdn.test\/storage\/products\/2020\/01\/SBBsDXmM8pg.jpg
   sub_kind:
     type: string
+    example: jpeg
   extension:
     type: string
+    example: 'jpg'
   original_filename:
     type: string
+    example: 'B15Z31__58612_std.jpg'
   size:
     type: string
+    example: 88408
   width:
     type: string
+    example: 601
   height:
     type: string
+    example: 1000
   transforms:
     $ref: '../responses/AssetTransformCollection.yaml'
   tags:

openapi/categories/models/Category.yaml

@@ -1,120 +1,37 @@
 title: Category
 type: object
-x-examples:
-  Standard with mapped attributes:
-    id: v8l4pl01
-    sort: 'min_price:asc'
-    products_count: 0
-    children_count: 1
-    left_pos: 1
-    right_pos: 938
-    description: Category description
-    meta_keywords: null
-    name: Fasteners
-    page_title: Seo page title
-    short_description: Short Description
-    meta_description: Page meta description
-    layout: []
-    primary_asset: []
-  Full response:
-    id: v8l4pl01
-    sort: 'min_price:asc'
-    products_count: 0
-    children_count: 1
-    left_pos: 1
-    right_pos: 938
-    attribute_data:
-      description:
-        webstore:
-          en: Category description
-      meta_keywords:
-        webstore:
-          en: ""
-      name:
-        webstore:
-          en: Category name
-      page_title:
-        webstore:
-          en: Page title
-      short_description:
-        webstore:
-          en: Short description
-      meta_description:
-        webstore:
-          en: Meta description
-    layout: []
-    primary_asset: []
-  Full response with child:
-    id: v8l4pl01
-    sort: 'min_price:asc'
-    products_count: 0
-    children_count: 1
-    left_pos: 1
-    right_pos: 938
-    attribute_data:
-      description:
-        webstore:
-          en: Category description
-      meta_keywords:
-        webstore:
-          en: ""
-      name:
-        webstore:
-          en: Category name
-      page_title:
-        webstore:
-          en: Page title
-      short_description:
-        webstore:
-          en: Short description
-      meta_description:
-        webstore:
-          en: Meta description
-    children:
-      data:
-        - id: p09prlrn
-          sort: 'min_price:asc'
-          left_pos: 2
-          right_pos: 937
-          attribute_data:
-            description:
-              webstore:
-                en: ''
-            meta_keywords:
-              webstore:
-                en: ''
-            name:
-              webstore:
-                en: Child Category
-            page_title:
-              webstore:
-                en: Child category SEO title
-            short_description:
-              webstore:
-                en: ''
-            meta_description:
-              webstore:
-                en: Child Category meta description
-          layout: []
-          primary_asset: []
-    layout: []
-    primary_asset: []
 description: ''
 properties:
   id:
     type: string
+    example: v8l4pl01
   sort:
     type: string
+    example: min_price:asc
   products_count:
     type: integer
+    example: 778
   children_count:
     type: integer
+    example: 15
+  depth:
+    type: integer
+    example: 0
   left_pos:
     type: integer
+    example: 1
   right_pos:
     type: integer
+    example: 2
+  created_at:
+    type: string
+    example: "2020-11-19T10:28:56.000000Z"
   name:
     type: string
+    example: Fashion
+  description:
+    type: string
+    example: "<p>Discover early autumn fashion. Cotton silk leopard smock dresses. Deep v-neck knitted tank tops. Black contrast stitch denim jeans. Khaki quilted jackets with tortoiseshell toggle buttons. Tobacco gingham cotton dresses.&nbsp;Shop all of fashion below.<\/p>"
   attribute_data:
     type: object
   children:

openapi/channels/paths/channels.id.yaml

@@ -6,10 +6,6 @@ parameters:
     required: true
 get:
   summary: Get the channel resource
-  x-code-samples:
-    - lang: PHP
-      source:
-        $ref: ../examples/code/fetch-channel/laravel.php
   responses:
     '200':
       description: OK
@@ -25,11 +21,6 @@ get:
             $ref: '../../global/responses/ApiError.yaml'
   operationId: get-channels-channelId
   description: ''
-  parameters:
-    - schema:
-        type: string
-      in: query
-      name: includes
   tags:
     - Channels
 put:
@@ -50,7 +41,7 @@ put:
   operationId: put-channels-channelId
   requestBody:
     content:
-      multipart/form-data:
+      application/json:
         schema:
           $ref: '../requests/UpdateChannelBody.yaml'
     description: ''

openapi/channels/paths/channels.yaml

@@ -9,16 +9,8 @@ get:
             $ref: '../responses/ChannelCollection.yaml'
   operationId: get-channels
   parameters:
-    - schema:
-        type: string
-      in: query
-      name: includes
-      description: Comma separated includes for the resource
-    - schema:
-        type: number
-      in: query
-      name: per_page
-      description: How many results per page
+    - $ref: '../../openapi.yaml#/components/parameters/perPageParam'
+    - $ref: '../../openapi.yaml#/components/parameters/pageParam'
   description: Gets a paginated list of all channel
   tags:
     - Channels
@@ -41,10 +33,9 @@ post:
   operationId: post-channels
   requestBody:
     content:
-      multipart/form-data:
+      application/json:
         schema:
           $ref: '../requests/CreateChannelBody.yaml'
-        examples: {}
     description: ''
   tags:
     - Channels

openapi/channels/requests/CreateChannelBody.yaml

@@ -3,11 +3,18 @@ type: object
 properties:
   handle:
     type: string
+    example: "mobileapp"
   name:
     type: string
+    example: "Mobile App"
   url:
     type: string
     nullable: true
+    example: "mobileapp:Index"
   default:
     type: boolean
-    nullable: true
+    nullable: true
+    default: false
+required:
+  - name
+  - handle

openapi/channels/requests/UpdateChannelBody.yaml

@@ -4,12 +4,16 @@ properties:
   handle:
     type: string
     nullable: true
+    example: "webstore"
   name:
     type: string
     nullable: true
+    example: "Webstore"
   url:
     type: string
     nullable: true
+    example: "localhost:8080"
   default:
     type: boolean
-    nullable: true
+    nullable: true
+    example: true

openapi/collections/models/Collection.yaml

@@ -1,18 +1,10 @@
 title: Collection
 type: object
-description: |-
-  ### Available includes
-
-  - routes
-  - layout
-  - channels
-  - assets
-  - attributes
-  - products
-  - customerGroups
+description:
 properties:
   id:
     type: string
+    example: v8l4pl01
   attribute_data:
     type: object
   routes:

openapi/countries/models/Country.yaml

@@ -3,17 +3,25 @@ type: object
 properties:
   id:
     type: string
+    example: v8l4q190
   name:
     type: string
+    example: United Kingdom
   region:
     type: string
+    example: Europe
   iso_a_2:
     type: string
+    example: GB
   iso_a_3:
     type: string
+    example: GBR
   iso_numeric:
     type: string
+    example: 826
   preferred:
     type: boolean
+    example: true
   enabled:
-    type: boolean
+    type: boolean
+    example: true

openapi/currencies/models/Currency.yaml

@@ -3,19 +3,28 @@ type: object
 properties:
   id:
     type: string
-  code:
-    type: string
+    example: kdj58jom
   name:
     type: string
+    example: British Pound
+  code:
+    type: string
+    example: GBP
   enabled:
     type: boolean
+    example: true
   format:
     type: string
+    example: £{price}
   exchange_rate:
     type: string
+    example: 1
   decimal_point:
     type: string
+    example: '.'
   thousand_point:
     type: string
+    example: ','
   default:
-    type: boolean
+    type: boolean
+    example: true