workarea-api 4.4.6

data/app/views/workarea/api/docs/example.haml

@@ -0,0 +1,114 @@
+%article
+  %h1== #{example.resource} API
+
+  %h2= example.description
+
+  - if example.explanation?
+    %p.explanation
+      = example.explanation
+
+  - if example.parameters.present?
+    %h3 Parameters
+    %table
+      %thead
+        %tr
+          %th Name
+          %th Description
+          - example.parameters.extra_keys.each do |key|
+            %th= key
+      %tbody
+        - example.parameters.params.each do |param|
+          %tr
+            %td{:class => ("required" if param.required?)}
+              - if param.scope?
+                %span #{param.scope}[#{param.name}]
+              - else
+                %span= param.name
+            %td
+              %span= param.description
+            - example.parameters.extra_keys.each do |key|
+              %td
+                %span= param[key]
+
+  - if example.response_fields.present?
+    %h3 Response Fields
+    %table
+      %thead
+        %tr
+          %th Name
+          %th Description
+          - example.response_fields.extra_keys.each do |key|
+            %th= key
+      %tbody
+        - example.response_fields.fields.each do |field|
+          %tr
+            %td
+              - if field.scope?
+                %span #{field.scope}[#{field.name}]
+              - else
+                %span= field.name
+            %td
+              %span= field.description
+            - example.response_fields.extra_keys.each do |key|
+              %td
+                %span= field[key]
+
+  - example.requests.each_with_index do |request, index|
+    %div{ :id => "request-#{index}" }
+      %h3 Request
+      - if request.request_headers.length > 0
+        %section
+          %h4 Headers
+          %pre
+            %code
+              :preserve
+                #{request.request_headers}
+
+      %section.route
+        %h4 Route
+        %pre
+          %code== #{request.request_method} #{request.request_path}
+
+      - if request.request_query_parameters?
+        %section
+          %h4 Query Parameters
+          %pre
+            %code= request.request_query_parameters
+
+      - if request.request_body?
+        %section
+          %h4 Body
+          %pre
+            %code.format-json
+              :preserve
+                #{request.request_body}
+
+      - if request.curl?
+        %section
+          %h4 cURL
+          %pre
+            %code= request.curl
+
+      - if request.response?
+        %h3 Response
+
+        - if request.response_headers.length > 0
+          %section
+            %h4 Headers
+            %pre
+              %code
+                :preserve
+                  #{request.response_headers}
+
+          %section.status
+            %h4 Status
+            %pre
+              %code= request.response_status
+
+          - if request.response_body?
+            %section
+              %h4 Body
+              %pre
+                %code
+                  :preserve
+                    #{request.response_body}

data/app/views/workarea/api/docs/index.haml

@@ -0,0 +1,28 @@
+!!!
+%html{ lang: 'en' }
+  %head
+    %title= api_name
+    = haml :stylesheets
+    = haml :javascripts_head
+
+  %body
+    .frame.frame--row.frame--top
+      .header
+        %a{ href: "#{url_location}", class: 'header__logo clearfix' }
+          = haml :logo
+          .header__heading= api_name
+    .frame.frame--column.frame--left.frame--full-column
+      %nav.nav
+        %strong.nav__heading Sections
+        .nav
+          %ul.nav__list
+            %li.nav__item
+              %a{ href: "#{url_location}/admin", class: 'nav__class' } Admin API
+            %li.nav__item
+              %a{ href: "#{url_location}/storefront", class: 'nav__class' } Storefront API
+    .frame.frame--column.frame--center
+      %main.main.main--with-sidebar
+        .container.container--full
+          .markdown= markdown.render(content)
+
+    = haml :javascripts

data/app/views/workarea/api/docs/javascripts.haml

@@ -0,0 +1,31 @@
+%script{ src: 'https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js' }
+
+:javascript
+  // https://github.com/meowsus/prettypre
+  !function(t,e,n,i){"use strict";function s(e,n){this.element=e,this.settings=t.extend({},u,n),this._defaults=u,this._name=r,this.content=this.getContent(this.element),this.init()}var r="prettyPre",u={type:" "};t.extend(s.prototype,{getContent:function(t){return t.innerHTML.replace(/^\n*/,"").replace(/[<>]/g,function(t){return{"<":"&lt;",">":"&gt;"}[t]}).replace(/\s*$/,"")},setContent:function(t,e){return t.innerHTML=e,t},calculateOffset:function(t){for(var e=t.split("\n"),n=0,i=e.length-1;i>=0;i--){for(var s=e[i];0===s.indexOf(this.settings.type);)n+=1,s=s.substring(1);break}return n},buildRegex:function(t){var e=this.calculateOffset(t),n="^"+this.settings.type+"{"+e+"}";return new RegExp(n,"gm")},init:function(){var t=this.buildRegex(this.content);this.setContent(this.element,this.content.replace(t,""))}}),t.fn[r]=function(e){return this.each(function(){t.data(this,"plugin_"+r)||t.data(this,"plugin_"+r,new s(this,e))})}}(jQuery,window,document);
+  $('pre code').prettyPre();
+
+  // format JSON blocks
+  $('.format-json').each(function (index, element) {
+    var json = JSON.parse(element.innerHTML);
+    element.innerHTML = JSON.stringify(json, null, 4);
+  });
+
+  // recall left-frame scroll position
+  $('#left-frame').on('click', 'a', function (event) {
+    var scrollTop = $('#left-frame').scrollTop();
+    sessionStorage.setItem('scrollTop', scrollTop);
+  });
+  var timer = setTimeout(function () {
+    var scrollTop = parseInt(sessionStorage.getItem('scrollTop') || 0);
+    $('#left-frame').scrollTop(scrollTop);
+    sessionStorage.removeItem('scrollTop');
+    clearTimeout(timer);
+  }, 50);
+
+  // highlight left-frame active section
+  $('.nav__item').each(function(index, element){
+    if ($(element).find('a')[0].href.split('api/docs')[1] === "#{request.path_info}") {
+      $(element).addClass('nav__item--active');
+    }
+  });

data/app/views/workarea/api/docs/javascripts_head.haml

@@ -0,0 +1,5 @@
+-# Syntax Highlighting
+%link{ rel: 'stylesheet', href: 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.8/styles/tomorrow-night-blue.min.css' }
+%script{ src: 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.8/highlight.min.js' }
+:javascript
+  hljs.initHighlightingOnLoad();

data/app/views/workarea/api/docs/layout.haml

@@ -0,0 +1,32 @@
+!!!
+%html{ lang: 'en' }
+  %head
+    - engine_name = request.path_info.split('/')
+    %title
+      = "Workarea #{engine_name[1].capitalize} API"
+      - if engine_name[3].present?
+        = " - #{engine_name[3].split('_').join(' ').capitalize}"
+    = haml :stylesheets
+    = haml :javascripts_head
+
+  %body
+    .frame.frame--row.frame--top
+      .header
+        %a{ href: "#{url_location}", class: 'header__logo clearfix' }
+          = haml :logo
+          .header__heading= "#{api_name} | #{engine_name[1].capitalize}"
+    .frame.frame--column.frame--left.frame--full-column#left-frame
+      %nav.nav
+        %strong.nav__heading Sections
+        .nav
+          %ul.nav__list
+            %li.nav__item
+              %a{ href: "#{url_location}/admin", class: 'nav__class' } Admin API
+            %li.nav__item
+              %a{ href: "#{url_location}/storefront", class: 'nav__class' } Storefront API
+        = haml :nav, locals: { index: index, api_name: api_name }
+    .frame.frame--column.frame--center
+      %main.main.main--with-sidebar
+        .container.container--full= yield
+
+    = haml :javascripts

data/app/views/workarea/api/docs/logo.haml

@@ -0,0 +1 @@
+<svg width="56" height="56" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><defs><path d="M16.73.235C7.529.235 0 7.763 0 16.965V39.27C0 48.472 7.529 56 16.73 56h22.306c9.201 0 16.73-7.528 16.73-16.73V16.964c0-9.201-7.529-16.73-16.73-16.73H16.73z" id="a"/><linearGradient x1="50%" y1="100%" x2="50%" y2="0%" id="b"><stop stop-color="#001DFF" offset="0%"/><stop stop-color="#0060FF" offset="100%"/></linearGradient></defs><g fill="none" fill-rule="evenodd"><mask id="c" fill="#fff"><use xlink:href="#a"/></mask><path d="M16.73.235C7.529.235 0 7.763 0 16.965V39.27C0 48.472 7.529 56 16.73 56h22.306c9.201 0 16.73-7.528 16.73-16.73V16.964c0-9.201-7.529-16.73-16.73-16.73H16.73z" fill="url(#b)" mask="url(#c)"/><g fill="#FFF"><path d="M29.493 20.845c0 .204-.057.443-.17.714l-5.928 14.136c-.16.364-.409.663-.75.9-.34.239-.715.358-1.123.358h-.341c-.409 0-.783-.12-1.124-.358a2.11 2.11 0 0 1-.75-.9L13.38 21.56c-.114-.271-.171-.51-.171-.714 0-.43.148-.799.443-1.104a1.456 1.456 0 0 1 1.09-.459c.295 0 .574.085.836.255.26.17.447.38.562.63l5.212 13.183 5.212-13.184c.113-.25.3-.46.562-.629a1.5 1.5 0 0 1 .834-.255c.431 0 .794.153 1.09.459.296.305.443.675.443 1.104zM42.25 19.74a1.457 1.457 0 0 0-1.09-.458 1.5 1.5 0 0 0-.834.255c-.261.17-.449.38-.562.63L34.552 33.35l-3.378-8.544-1.616 3.854 2.95 7.035c.158.364.409.663.75.9.34.239.715.358 1.123.358h.341c.409 0 .783-.12 1.124-.358.34-.237.59-.536.75-.9l5.927-14.136c.113-.271.17-.51.17-.714 0-.43-.147-.799-.443-1.104"/></g></g></svg>

data/app/views/workarea/api/docs/nav.haml

@@ -0,0 +1,7 @@
+- index.resources.each do |resource|
+  %strong.nav__heading= resource.name
+  %nav.nav
+    %ul.nav__list
+      - resource.examples.each do |example|
+        %li.nav__item
+          = link_to example.description, "/#{example.href}"

data/app/views/workarea/api/docs/stylesheets.haml

@@ -0,0 +1,278 @@
+:css
+  @import url("https://fonts.googleapis.com/css?family=Open+Sans|Fira+Mono&display=swap");
+
+  /** RESET */
+
+  html {
+    font-family: 'Helvetica', 'Open Sans', 'Arial', sans-serif;
+    font-size: 18px;
+    font-weight: 200;
+    line-height: 1.5;
+    color: #303541;
+  }
+
+  body * {
+    margin: 0;
+    padding: 0;
+  }
+
+  a {
+    color: dodgerblue;
+    text-decoration: none;
+  }
+
+  button {
+    background: none;
+    border: none;
+    cursor: pointer;
+  }
+
+  b, strong {
+    font-weight: bold;
+  }
+
+  mark {
+    padding: 5px;
+    border-radius: 5px;
+    background: lightyellow;
+  }
+
+
+  ul,
+  ol {
+    list-style: none;
+  }
+
+  :target:before {
+    display: block;
+    content: "";
+    height: 72px;
+    margin: -72px 0 0;
+  }
+
+  .visually-hidden {
+    position: absolute;
+    left: -9999px;
+  }
+
+  .invisible {
+    visibility: hidden;
+  }
+
+  p, pre, table {
+    margin-bottom: 1.5em;
+  }
+
+
+  /** TABLES */
+  table {
+    border-collapse: collapse;
+  }
+
+  thead {
+    text-align: left;
+  }
+
+  td {
+    border: 1px solid #f7f3f7;
+  }
+
+  td.required {
+    font-weight: bold;
+  }
+
+  td.required::after {
+    content: '*';
+    color: red;
+  }
+
+  th, td {
+    padding: 0.5em;
+  }
+
+  tr td:first-of-type {
+    background: #f7f3f7;
+    border-color: #eeeeee;
+  }
+
+
+  /** TYPOGRAPHY */
+  .heading,
+  h1, h2, h3, h4, h5, h6 {
+    font-weight: 800;
+    line-height: 1.15;
+    margin: 0.75em 0;
+  }
+
+  .heading { display: block; }
+
+  .heading--no-bottom-margin { margin-bottom: 0 }
+  .heading--no-margin { margin: 0; }
+
+  h1, .heading--1 { font-size: 2rem; }
+  h2, .heading--2 { font-size: 1.75rem; }
+  h3, .heading--3 { font-size: 1.5rem; }
+  h4, .heading--4 { font-size: 1.25rem; }
+  h5, .heading--5 { font-size: 1.1rem; }
+  h6, .heading--6 { font-size: 1rem; }
+
+  .explanation {
+    font-size: 1.3em;
+    color: #666666;
+    font-style: italic;
+  }
+
+
+  /** Helpers */
+  .clearfix:after {
+    content: "";
+    display: table;
+    clear: both;
+  }
+
+
+  /** Frames */
+  .frame {
+    position: fixed;
+    overflow: auto;
+    border-color: gainsboro;
+    border-width: 1px;
+    background: white;
+  }
+  .frame--row {
+    left: 0;
+    right: 0;
+  }
+  .frame--column {
+    top: 72px;
+    bottom: 72px;
+  }
+  .frame--full-column {
+    top: 72px;
+    bottom: 0;
+  }
+  .frame--top {
+    top: 0;
+    height: 76px;
+    box-shadow: 0 0 20px rgba(0, 0, 0, 0.15);
+    z-index: 1;
+  }
+  .frame--left {
+    left: 0;
+    right: 75%;
+    border-right-style: solid;
+  }
+  .frame--center {
+    left: 25%;
+    right: 25%;
+
+    position: static;
+    overflow: visible;
+  }
+
+  /** CONTAINER */
+  .container {
+    margin: 0 auto;
+    padding: 24px;
+    max-width: 624px;
+  }
+  .container--full {
+    max-width: none;
+  }
+  .container--narrow {
+    max-width: 312px;
+  }
+
+
+  /** MAIN */
+  .main {
+    margin-top: 72px;
+    margin-left: 25%;
+  }
+
+
+  /** NAV */
+  .nav {
+    position: relative;
+    padding: 20px;
+  }
+
+    .nav > .nav {
+      padding: 0;
+    }
+    .nav__heading {
+      padding: 0.275rem 0;
+    }
+    .nav__list {
+      margin-bottom: 1.5em;
+    }
+      .nav__item {
+        margin: 0.55rem 0;
+        padding-left: 0.55rem;
+        font-size: 0.8rem;
+        line-height: 1.25;
+      }
+      .nav__item--active {
+        padding: 0.275rem 0.55rem;
+        font-weight: bolder;
+        background-color: #eee;
+        border-left: 3px solid #011eff;
+      }
+      .nav__item--active a {
+        color: black;
+      }
+        .nav__node {
+          display: block;
+          padding: 6px 0;
+        }
+        .nav__node--link {
+          color: lightslategray;
+        }
+          .nav__node--link:hover {
+            color: dodgerblue;
+          }
+        .nav__node--text {
+          font-family: 'Quattrocento', serif;
+          font-weight: bold;
+        }
+          .nav__node-text {
+            border-bottom: 2px solid dodgerblue;
+          }
+
+
+  /** HEADER */
+  .header {
+    padding: 0.55rem;
+  }
+
+    .header__logo {
+      display: inline-block;
+    }
+
+      .header__logo > svg {
+        float: left;
+      }
+
+      .header__heading {
+        float: left;
+        margin-left: 20px;
+        font-weight: bold;
+        color: #303541;
+        text-decoration: none;
+        padding-top: 15px;
+      }
+
+      .header__heading:hover {
+        color: #0060ff;
+        text-decoration: underline;
+      }
+
+
+  /** MARKDOWN */
+  .markdown p code {
+    background: #f7f3f7;
+  }
+
+  .markdown ul {
+    list-style: disc inside;
+  }

data/config/initializers/raddocs.rb

@@ -0,0 +1,12 @@
+Raddocs.configure do |config|
+  config.api_name = 'Workarea API Documentation'
+
+  host_app_docs_dir = Rails.root.join('doc', 'api')
+  plugin_docs_dir = Workarea::Api.root.join('doc', 'api')
+
+  config.docs_dir = if File.directory?(host_app_docs_dir)
+    host_app_docs_dir
+  else
+    plugin_docs_dir
+  end
+end

data/config/initializers/workarea.rb

@@ -0,0 +1,3 @@
+Workarea.configure do |config|
+  config.suppress_api_response_headers = %w[X-Flash-Messages Set-Cookie]
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Workarea::Api::Engine.routes.draw do
+  mount Workarea::Api::Admin::Engine => '/admin', as: 'admin_api'
+  mount Workarea::Api::Storefront::Engine => '/storefront', as: 'storefront_api'
+  mount Workarea::Api::Documentation => '/docs' unless Rails.env.production?
+end

data/doc/api/admin/categories/bulk_upserting_categories.json

@@ -0,0 +1,42 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "64bdf2b7-56b6-46a9-868c-a0b022971b42",
+        "X-Runtime": "0.300278",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/categories/bulk",
+      "request_body": "{\"categories\":[{\"active\":true,\"client_id\":null,\"created_at\":\"2019-08-21T21:56:19.372Z\",\"default_sort\":\"top_sellers\",\"name\":\"Test Category\",\"product_ids\":[],\"product_rules\":[{\"_id\":\"5d5dbe03d4322a4b69d79ad9\",\"created_at\":null,\"name\":\"search\",\"operator\":\"equals\",\"updated_at\":null,\"value\":\"*\"}],\"range_facets\":{},\"show_navigation\":true,\"subscribed_user_ids\":[],\"tags\":[],\"terms_facets\":[],\"updated_at\":\"2019-08-21T21:56:19.372Z\"},{\"active\":true,\"client_id\":null,\"created_at\":\"2019-08-21T21:56:19.372Z\",\"default_sort\":\"top_sellers\",\"name\":\"Test Category\",\"product_ids\":[],\"product_rules\":[{\"_id\":\"5d5dbe03d4322a4b69d79ad9\",\"created_at\":null,\"name\":\"search\",\"operator\":\"equals\",\"updated_at\":null,\"value\":\"*\"}],\"range_facets\":{},\"show_navigation\":true,\"subscribed_user_ids\":[],\"tags\":[],\"terms_facets\":[],\"updated_at\":\"2019-08-21T21:56:19.372Z\"},{\"active\":true,\"client_id\":null,\"created_at\":\"2019-08-21T21:56:19.372Z\",\"default_sort\":\"top_sellers\",\"name\":\"Test Category\",\"product_ids\":[],\"product_rules\":[{\"_id\":\"5d5dbe03d4322a4b69d79ad9\",\"created_at\":null,\"name\":\"search\",\"operator\":\"equals\",\"updated_at\":null,\"value\":\"*\"}],\"range_facets\":{},\"show_navigation\":true,\"subscribed_user_ids\":[],\"tags\":[],\"terms_facets\":[],\"updated_at\":\"2019-08-21T21:56:19.372Z\"}]}",
+      "request_content_type": "application/json",
+      "response_status": 204,
+      "response_status_text": "No Content",
+      "response_body": null,
+      "response_content_type": null,
+      "curl": "curl \"https://www.example.com/api/admin/categories/bulk\" -d '{\"categories\":[{\"active\":true,\"client_id\":null,\"created_at\":\"2019-08-21T21:56:19.372Z\",\"default_sort\":\"top_sellers\",\"name\":\"Test Category\",\"product_ids\":[],\"product_rules\":[{\"_id\":\"5d5dbe03d4322a4b69d79ad9\",\"created_at\":null,\"name\":\"search\",\"operator\":\"equals\",\"updated_at\":null,\"value\":\"*\"}],\"range_facets\":{},\"show_navigation\":true,\"subscribed_user_ids\":[],\"tags\":[],\"terms_facets\":[],\"updated_at\":\"2019-08-21T21:56:19.372Z\"},{\"active\":true,\"client_id\":null,\"created_at\":\"2019-08-21T21:56:19.372Z\",\"default_sort\":\"top_sellers\",\"name\":\"Test Category\",\"product_ids\":[],\"product_rules\":[{\"_id\":\"5d5dbe03d4322a4b69d79ad9\",\"created_at\":null,\"name\":\"search\",\"operator\":\"equals\",\"updated_at\":null,\"value\":\"*\"}],\"range_facets\":{},\"show_navigation\":true,\"subscribed_user_ids\":[],\"tags\":[],\"terms_facets\":[],\"updated_at\":\"2019-08-21T21:56:19.372Z\"},{\"active\":true,\"client_id\":null,\"created_at\":\"2019-08-21T21:56:19.372Z\",\"default_sort\":\"top_sellers\",\"name\":\"Test Category\",\"product_ids\":[],\"product_rules\":[{\"_id\":\"5d5dbe03d4322a4b69d79ad9\",\"created_at\":null,\"name\":\"search\",\"operator\":\"equals\",\"updated_at\":null,\"value\":\"*\"}],\"range_facets\":{},\"show_navigation\":true,\"subscribed_user_ids\":[],\"tags\":[],\"terms_facets\":[],\"updated_at\":\"2019-08-21T21:56:19.372Z\"}]}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Categories",
+  "description": "Bulk upserting categories",
+  "route": "/api/admin/categories/bulk",
+  "http_method": "PATCH"
+}

data/doc/api/admin/categories/creating_a_category.json

@@ -0,0 +1,46 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Location": "/api/admin/categories/5d5dbe06d4322a4b69d79b11",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"51353972a3867bf662818d50cd3a88cf\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "b8035584-0af0-4c6c-9e01-4972c81d93f9",
+        "X-Runtime": "0.092379",
+        "Expires": "0",
+        "Content-Length": "483"
+      },
+      "request_method": "POST",
+      "request_path": "/api/admin/categories",
+      "request_body": "{\"active\":true,\"client_id\":null,\"created_at\":\"2019-08-21T21:56:22.492Z\",\"default_sort\":\"top_sellers\",\"name\":\"Test Category\",\"product_ids\":[],\"product_rules\":[{\"_id\":\"5d5dbe06d4322a4b69d79b0d\",\"created_at\":null,\"name\":\"search\",\"operator\":\"equals\",\"updated_at\":null,\"value\":\"*\"}],\"range_facets\":{},\"show_navigation\":true,\"subscribed_user_ids\":[],\"tags\":[],\"terms_facets\":[],\"updated_at\":\"2019-08-21T21:56:22.492Z\"}",
+      "request_content_type": "application/json",
+      "response_status": 201,
+      "response_status_text": "Created",
+      "response_body": "{\n  \"category\": {\n    \"_id\": \"5d5dbe06d4322a4b69d79b11\",\n    \"active\": true,\n    \"client_id\": null,\n    \"created_at\": \"2019-08-21T21:56:22.492Z\",\n    \"default_sort\": \"top_sellers\",\n    \"name\": \"Test Category\",\n    \"product_ids\": [\n\n    ],\n    \"product_rules\": [\n      {\n        \"_id\": \"5d5dbe06d4322a4b69d79b0d\",\n        \"created_at\": null,\n        \"name\": \"search\",\n        \"operator\": \"equals\",\n        \"updated_at\": null,\n        \"value\": \"*\"\n      }\n    ],\n    \"range_facets\": {\n    },\n    \"show_navigation\": true,\n    \"slug\": \"test-category-1\",\n    \"subscribed_user_ids\": [\n\n    ],\n    \"tags\": [\n\n    ],\n    \"terms_facets\": [\n\n    ],\n    \"updated_at\": \"2019-08-21T21:56:22.492Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/admin/categories\" -d '{\"active\":true,\"client_id\":null,\"created_at\":\"2019-08-21T21:56:22.492Z\",\"default_sort\":\"top_sellers\",\"name\":\"Test Category\",\"product_ids\":[],\"product_rules\":[{\"_id\":\"5d5dbe06d4322a4b69d79b0d\",\"created_at\":null,\"name\":\"search\",\"operator\":\"equals\",\"updated_at\":null,\"value\":\"*\"}],\"range_facets\":{},\"show_navigation\":true,\"subscribed_user_ids\":[],\"tags\":[],\"terms_facets\":[],\"updated_at\":\"2019-08-21T21:56:22.492Z\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Categories",
+  "description": "Creating a category",
+  "route": "/api/admin/categories",
+  "http_method": "POST"
+}