swagger.yaml

swagger: "2.0"

info:
  title: Community System
  description: Community-system is an system to manage community.
  version: 1.0.0
  contact:
    email: zufardhiyaulhaq@gmail.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html

host: "0.0.0.0:8080"
basePath: "/api/v1"

schemes:
- "http"

consumes:
  - application/json

paths:
  /meetups:
    get:
      tags: [meetup]
      operationId: getMeetups
      summary: Returns a list of meetups.
      description: A JSON array of meetups
      produces:
        - application/json
      responses:
        '200':
          description: A JSON array of meetups
          schema:
            type: array
            items:
              $ref: '#/definitions/Meetup'
        '404':
          description: Meetups not found
        default:
          description: Unexpected error
    put:
      tags: [meetup]
      operationId: putMeetup
      summary: Put meetup data.
      description: create meetup
      produces:
        - application/json
      parameters:
        - in: body
          name: meetup
          required: true
          description: The meetup to create.
          schema:
            $ref: '#/definitions/Meetup'
      responses:
        '200':
          description: object uuid & status
          schema:
            $ref: '#/definitions/CreateObject'
        default:
          description: Unexpected error
  /meetups/{meetup_id}:
    get:
      tags: [meetup]
      operationId: getMeetup
      summary: Returns a meetup.
      description: A meetup object in json
      produces:
        - application/json
      parameters:
        - in: path
          name: meetup_id
          required: true
          type: string
          minimum: 1
          description: The ID of the meetup to return.
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Meetup'
        '404':
          description: Meetup not found
        default:
          description: Unexpected error
    patch:
      tags: [meetup]
      operationId: patchMeetup
      summary: Patch meetup data.
      description: update meetup
      produces:
        - application/json
      parameters:
        - in: path
          name: meetup_id
          required: true
          type: string
          minimum: 1
          description: The ID of the meetup.
        - in: body
          name: meetup
          required: true
          description: The meetup to create.
          schema:
            $ref: '#/definitions/Meetup'
      responses:
        '204':
          description: updated
        default:
          description: Unexpected error 
  /meetups/{meetup_id}/speakers:
    get:
      tags: [speaker]
      operationId: getSpeakers
      summary: Returns a list of speakers in meetup.
      description: A JSON array of speakers
      produces:
        - application/json
      parameters:
        - in: path
          name: meetup_id
          required: true
          type: string
          minimum: 1
          description: The ID of the meetup to return.
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              $ref: '#/definitions/Speaker'
        '404':
          description: Speaker not found
        default:
          description: Unexpected error
    put:
      tags: [speaker]
      operationId: putSpeaker
      summary: Put speaker data.
      description: create speaker
      produces:
        - application/json
      parameters:
        - in: path
          name: meetup_id
          required: true
          type: string
          minimum: 1
          description: The ID of the meetup.
        - in: body
          name: speaker
          required: true
          description: The speaker to create.
          schema:
            $ref: '#/definitions/Speaker'
      responses:
        '200':
          description: object uuid & status
          schema:
            $ref: '#/definitions/CreateObject'
        '404':
          description: Meetup not found
        default:
          description: Unexpected error
  /meetups/{meetup_id}/speakers/{speaker_id}:
    patch:
      tags: [speaker]
      operationId: patchSpeaker
      summary: Patch speaker data.
      description: update speaker
      produces:
        - application/json
      parameters:
        - in: path
          name: meetup_id
          required: true
          type: string
          minimum: 1
          description: The ID of the meetup.
        - in: path
          name: speaker_id
          required: true
          type: string
          minimum: 1
          description: The ID of the speaker.
        - in: body
          name: speaker
          required: true
          description: The speaker to create.
          schema:
            $ref: '#/definitions/Speaker'
      responses:
        '204':
          description: updated
        default:
          description: Unexpected error 
  /meetups/sponsors:
    get:
      tags: [sponsor]
      operationId: getSponsors
      summary: Returns a list of sponsors.
      description: A JSON array of sponsors
      produces:
        - application/json
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              $ref: '#/definitions/Sponsor'
        '404':
          description: Speaker not found
        default:
          description: Unexpected error
    put:
      tags: [sponsor]
      operationId: putSponsor
      summary: Put sponsor data.
      description: create sponsor
      produces:
        - application/json
      parameters:
        - in: body
          name: sponsor
          required: true
          description: The sponsor to create.
          schema:
            $ref: '#/definitions/Sponsor'
      responses:
        '200':
          description: object uuid & status
          schema:
            $ref: '#/definitions/CreateObject'
        default:
          description: Unexpected error
  /meetups/sponsors/{sponsor_id}:
    patch:
      tags: [sponsor]
      operationId: patchSponsor
      summary: Patch sponsor data.
      description: update sponsor
      produces:
        - application/json
      parameters:
        - in: path
          name: sponsor_id
          required: true
          type: string
          minimum: 1
          description: The ID of the sponsor.
        - in: body
          name: sponsor
          required: true
          description: The sponsor to create.
          schema:
            $ref: '#/definitions/Sponsor'
      responses:
        '204':
          description: updated
        default:
          description: Unexpected error      
definitions:
  CreateObject:
    type: object
    properties:
      uuid:
        type: string
      status:
        type: string
  Meetup:
    type: object
    properties:
      uuid:
        type: string
      country:
        type: string
      city:
        type: string
      time:
        type: string
        format: date-time
      duration:
        type: integer
      location:
        type: string
      image:
        type: string
      registrationUrl:
        type: string
      tags:
        type: array
        items:
          type: string
      sponsors:
        type: array
        items:
          type: string
      speakers:
        type: array
        items:
          type: string
      status:
        type: boolean
    required:  
      - country
      - city
      - time
      - location
      - duration
      - tags
  Sponsor:
    type: object
    properties:
      uuid:
        type: string
      name:
        type: string
      image:
        type: string
    required: 
      - name
      - image
  Speaker:
    properties:
      uuid:
        type: string
      name:
        type: string
      position:
        type: string
      company:
        type: string
      title:
        type: string
      image:
        type: string
    required: 
      - name
      - position
      - company
      - title
      - image