swagger.yaml

swagger: '2.0'
info:
  description: >-
  version: 1.0.0
  title: Swagger Integration Services
  termsOfService: 'http://mycomp.co.nz/terms/'
  contact:
    email: support@test.co.nz
schemes:
  - http
host: "localhost:8080"
basePath: "/v1"
tags:
  - name: domain
    description: Services that governs provisioning and decomissioning of users in xyz system
  - name: subscription
    description: User's subscription management services
  - name: devices
    description: Deveice management services

paths:
  /domain/{coGUID}:
    post:
      tags:
        - domain
      summary: Provision a new  user
      description: ''
      operationId: createDomain
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: coGUID
          in: path
          description: User's unique identification number
          required: true
          type: string
        - name: subscriptionId
          in: query
          description: Subscription identification number
          required: true
          type: string
        - name: setTopBoxSerialNo
          in: query
          description: SetTopBox serialnumber
          required: true
          type: string
        - in: body
          name: userDetails
          description: Details of the User to be created
          required: true
          schema:
            $ref: '#/definitions/UserDetail'
      responses:
          '405':
            description: Invalid input
          '200':
           description: Successful Operation
           schema:
             type: string
    delete:
        tags:
          - domain
        summary: Remove a domain
        description: ''
        operationId: deleteDomain
        consumes:
            - application/json
        produces:
            - application/json
        parameters:
            - name: coGUID
              in: path
              description: User's unique identification number
              required: true
              type: string
        responses:
            '200':
              description: Successful Opeation
              schema:
                type: boolean
              
definitions:
  UserDetail:
    type: object
    properties:
      userName:
        type: string
      firstName:
        type: string
      lastName:
        type: string
      address:
        type: string
      city:
        type: string
      zip:
        type: string
      phone:
        type: string