w api openapi schema

api.yml

openapi: '3.0.0'
info:
  version: '1.0.0'
  title: 'Wordalike API'
  description: Base wordalike endpoints

paths:
  /words/:
    get:
      summary: Retrieves the two daily hydrated words
      responses:
        '200':
          description: Two hydrated daily words
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WordsDaily'
  /words/{word_id}/hydrated/:
    get:
      summary: Retrieves the hyrdated word data for a word ID
      parameters:
        - name: word_id
          description: ID of the word we want to retrieve hyrdated info for
          in: path
          required: true
          schema:
            description: The unique identifier of a word
            type: integer
      responses:
        '200':
          description: Hyrdated word for word_id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HydratedWord'
components:
  schemas:
    WordsDaily:
      type: object
      properties:
        fastPath:
          type: integer
          description: the fastest path for these two words
        words:
          type: array
          description: array containing two hydrated words
          items:
            $ref: '#/components/schemas/HydratedWord'
    HydratedWord:
      type: object
      properties:
        id:
          type: integer
          format: int32
          description: The unique identifier for the word
        name:
          type: string
          description: The name of the word
        phonetic:
          type: string
          description: The phonetic representation of the word
        asins:
          type: array
          description: list of AsIns connected to the root word
          items:
            type: object
            properties:
              id:
                type: integer
                format: int32
                description: The unique identifier for the ASIN
              type:
                type: string
                description: The type of the ASIN
              alias:
                type: string
                description: The alias of the ASIN
              desc:
                type: string
                description: The description of the ASIN
              synonyms:
                type: array
                description: array of synonyms connected to AsIns/Root Word
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      format: int32
                      description: The unique identifier for the synonym
                    relatedness:
                      type: string
                      description: The relatedness of the synonym
                    word:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int32
                          description: The unique identifier for the related word
                        name:
                          type: string
                          description: The name of the related word