schema.yaml

openapi: 3.0.0
info:
  version: v1.0.0
  title: HackTest
  description: "This is an API for latest contest and hackathons."
servers:
  - url: "localhost:5000"
paths:
  /contests:
    get:
      summary: Details about all contest
      operationId: getcontests
      tags:
        - contests
      responses:
        "200":
          description: done
          content:
            application/json:
              schema:
                $ref: "#/models/schema"
    post:
      summary: creating the new contest 
      operationId: addcontests
      tags:
        - contests
      requestBody:
        required: true
        description: contests
        content:
          application/json:
            schema:
              $ref: "#/models/schema"
      responses:
        "201":
          description: contests
          content:
            application/json:
              schema:
                $ref: "#/models/schema"
  /contests/{id}:
    get:
      summary: get the contests by its id 
      operationId: getcontests
      parameters:
        - name: id
          in: path
          description: The unique id.
          required: true
          schema:
            type: string
      tags:
        - contests
      responses:
        "200":
          description: contests
          content:
            application/json:
              schema:
                $ref: "#/models/schema"
    put:
      summary: update the contests
      operationId: updatecontests
      parameters:
        - name: id
          in: path
          description: The unique id.
          required: true
          schema:
            type: string
      tags:
        - contests
      requestBody:
        description: contests
        content:
          application/json:
            schema:
              $ref: "#/models/schema"
      responses:
        "204":
          description: contests
    delete:
      summary: contests
      operationId: deletecontests
      parameters:
        - name: id
          in: path
          description: The unique id.
          required: true
          schema:
            type: string
      tags:
        - contests
      responses:
        "204":
          description: contests
    patch:
      summary: update a contests
      operationId: updatecontests
      parameters:
        - name: id
          in: path
          description: The unique id.
          required: true
          schema:
            type: string
      tags:
        - contests
      responses:
        "204":
          description: contests
components:
  schemas:
    HacTestListing:
      type: array
      items:
        $ref: "#/models/schema"
    contests:
      type: object
      required:
        - _id
        - name
        - url
        - start_time
        - end_time
        - duration
        - in_24_hours
        - status
      properties:
        id:
          description: Unique identifier for the restaurant
          type: string
        name:
          description: The name of the contest.
          type: string
        url:
          description: Url of the contest.
          type: string
        start_time:
          description: Starting time of the contest.
          type: string
        end_time:
          description: Ending time of the contest.
          type: string
        duration:
          description: Duration of the contest.
          type: string
        in_24_hours: 
          description: Next contest in 24 hours.
          type: string
        status:
          description: "status of of the contest."
          type: string