openapi: 3.2.0
info:
  title: Online Store Microstores API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Microstores
paths:
  /microstores:
    get:
      summary: Get Microstores
      tags:
      - Microstores
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  microstores:
                    type: array
                    items:
                      $ref: '#/components/schemas/microstores'
      operationId: get-microstores
      description: Gets an array of microstores.
    post:
      summary: Create a Microstore
      operationId: post-microstores
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microstores'
      tags:
      - Microstores
      description: Creates a Microstore.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: TheMikeRoweStore
                  address_line_1: 135 El Pollo Loco
                  address_line_2: ''
                  city: Springfield
                  state: Texas
                  country: United States
                  postal_code: '77334'
                  phone: 431-543-1234
                  fax: ''
                  parent_store_id: 1
                  is_micro_store: true
                  set_cookie: true
                  cookie_expiration: 0
                  logo_image: ''
                  path: /TheMikeRoweStore
              properties:
                name:
                  type: string
                address_line_1:
                  type: string
                address_line_2:
                  type: string
                city:
                  type: string
                state:
                  type: string
                country:
                  type: string
                postal_code:
                  type: string
                phone:
                  type: string
                fax:
                  type: string
                parent_store_id:
                  type: integer
                is_micro_store:
                  type: boolean
                set_cookie:
                  type: boolean
                cookie_expiration:
                  type: number
                activation_date:
                  type: string
                expiration_date:
                  type: string
                logo_image:
                  type: string
                path:
                  type: string
            examples:
              Example:
                value:
                  name: TheMikeRoweStore
                  address_line_1: 135 Test st
                  address_line_2: ''
                  city: Beaumont
                  state: Texas
                  country: United States
                  postal_code: '77701'
                  phone: 431-543-1234
                  fax: ''
                  parent_store_id: 1
                  is_micro_store: true
                  set_cookie: true
                  cookie_expiration: 0
                  activation_date: null
                  expiration_date: null
                  logo_image: ''
                  path: /TheMikeRoweStore
  /microstores/{id}:
    parameters:
    - schema:
        type: string
      name: id
      in: path
      required: true
      description: The ID of the `microstore`
    put:
      summary: Update a Microstore
      operationId: put-microstores-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microstores'
      tags:
      - Microstores
      description: 'Updates a microstore. '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microstores'
    delete:
      summary: Delete a Microstore
      operationId: delete-microstores-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - Microstores
      description: Deletes a microstore.
components:
  responses:
    '404':
      description: Resource Not Found
      content:
        application/json:
          schema:
            description: Not Found
            type: object
            x-examples:
              example-1:
                status_code: 404
                message: Not Found
                details: No resource found
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
          examples: {}
      headers: {}
  schemas:
    microstores:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        address_line_1:
          type: string
        address_line_2:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        postal_code:
          type: string
        phone:
          type: string
        fax:
          type: string
        parent_store_id:
          type: integer
        is_micro_store:
          type: boolean
        set_cookie:
          type: boolean
        cookie_expiration:
          type: integer
        activation_date:
          type: string
        expiration_date:
          type: string
        logo_image:
          type: string
        path:
          type: string
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header