Swagger.yaml

openapi: 3.0.0   # Open api version

info:
  title: GPT2-Superhero
  version: "v0.1"
  contact:
    name: AInizer - Lee hoseop
  description: |
    This app is generate Superhero story and power.
    ---
      How to use:

      * First, Fill what the text. This will be base of story and power.
      * And then, Fill number in length. Text is created as long as "length". I recommend between 100 and 300.
      * If length is so big, generate time will be long.
    ---
    And you can use this in [demo page](https://master-gpt2-superheroes-fpem123.endpoint.ainize.ai/).

    Fine tuning data reference >> [superheroes_nlp_dataset](https://www.kaggle.com/jonathanbesomi/superheroes-nlp-dataset)

servers:
  - url: https://master-gpt2-superheroes-fpem123.endpoint.ainize.ai/

paths:
  /superhero/story:
    post:
      requestBody:
        required: true
        description: |
          This request will generate superhero story.

          Request body example

              text: Superman is
              length: 150

          curl example

              curl -X POST "https://master-gpt2-superheroes-fpem123.endpoint.ainize.ai/superhero/story" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "text=superman is" -F "length=50"


        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: "Base text for generate."
                length:
                  type: string
                  description: "The size of text."
              required:
                - text
                - length
      responses: # Set response
        '200':
          description: "Successful Response"
          content:
            application/json:
              schema:
                type: object
        '400':
          description: "Bad Request Error"
        '429':
          description: "Too many requests"
        '500':
          description: "Server-side Error"


  /superhero/power:
    post:
      requestBody:
        required: true
        description: |
          This request will generate superhero power.

          Request body example

              text: Superman is
              length: 150

          curl example

              curl -X POST "https://master-gpt2-superheroes-fpem123.endpoint.ainize.ai/superhero/power" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "text=Superman is" -F "length=50"


        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: "Base text for generate"
                length:
                  type: string
                  description: "The size of text."
              required:
                - text
                - length
      responses: # Set response
        '200':
          description: "Successful Response"
          content:
            application/json:
              schema:
                type: object
        '400':
          description: "Bad Request Error"
        '429':
          description: "Too many requests"
        '500':
          description: "Server-side Error"