swagger.yaml

# this is an example of the Uber API
# as a demonstration of an API spec in YAML
swagger: '2.0'
info:
  title: Uber API
  description: Move your app forward with the Uber API
  version: "1.0.0"
# the domain of the service
host: api2.touchedition.com
# array of all schemes that your API supports
schemes:
  - https
# will be prefixed to all paths
basePath: /api
produces:
  - application/json
paths:
  /ssslides:
    get:
      summary: Get Published Sslides
      description: |
        
      parameters:
        - name: site
          in: query
          description: Specific site id
          required: false
          type: string
        - name: select
          in: query
          description: query only attributes
          required: false
          type: string
        - name: sortBy
          in: query
          description: Specify sort query [stats.day, stats.week, stats.month]
          required: false
          type: string
      tags:
        - Sslides
      responses:
        200:
          description: An array of sslides
          schema:
            type: array
            items:
              $ref: '#/definitions/SSlide'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /ssslides/all:
    get:
      summary: Get All Sslides
      description: Require Authorizaztion
      parameters:
        - name: site
          in: query
          description: Specific site id
          required: false
          type: string
        - name: select
          in: query
          description: query only attributes
          required: false
          type: string
        - name: sortBy
          in: query
          description: Specify sort query [stats.day, stats.week, stats.month]
          required: false
          type: string
      tags:
        - Sslides
      responses:
        200:
          description: An array of sslides
          schema:
            type: array
            items:
              $ref: '#/definitions/SSlide'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /ssslides/template:
    get:
      summary: Get All Template Sslides
      description: |
      parameters:
        - name: site
          in: query
          description: Specific site id
          required: false
          type: string
        - name: select
          in: query
          description: query only attributes
          required: false
          type: string
        - name: sortBy
          in: query
          description: Specify sort query [stats.day, stats.week, stats.month]
          required: false
          type: string
      tags:
        - Sslides
      responses:
        200:
          description: An array of sslides
          schema:
            type: array
            items:
              $ref: '#/definitions/SSlide'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'          
  /sslides/one:
    get:
      summary: Get One Sslide
      description: |
        
      parameters:
        - name: site
          in: query
          description: Specific site id
          required: false
          type: string
        - name: select
          in: query
          description: query only attributes
          required: false
          type: string
      tags:
        - Sslides
      responses:
        200:
          description: An array of sslides
          schema:
            $ref: '#/definitions/SSlide'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /sslides/seo:
    get:
      summary: Get Sslide SEO
      description: |
        
      parameters:
        - name: site
          in: query
          description: Specific site id
          required: false
          type: string
        - name: select
          in: query
          description: query only attributes
          required: false
          type: string
      tags:
        - Sslides
      responses:
        200:
          description: An array of sslides
          schema:
            type: array
            items:
              $ref: '#/definitions/SEOHTML'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
definitions:
  SEOHTML:
    type: object
    properties:
      html:
        type: string
        description: Unique identifier representing a specific sslide.
  SSlide:
    type: object
    properties:
      _id:
        type: string
        description: Unique identifier representing a specific sslide.
      title:
        type: string
        description: Display name of product.
      description:
        type: string
        description: Description of product.
  Error:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      fields:
        type: string