pokemonbattleapi.yml

openapi: 3.0.0
info:
  title: Pokémon Battle Simulator API
  version: 1.0.0
  description: API for simulating Pokémon battles

paths:
  /pokemon:
    get:
      summary: List Pokémon
      description: Retrieve a paginated list of Pokémon
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: pageSize
          in: query
          schema:
            type: integer
            default: 10
      responses:
        '200':
          description: Successful response
          content:
            application/json:    
              schema:
                type: object
                properties:
                  pokemon:
                    type: array
                    items:
                      $ref: '#/components/schemas/Pokemon'
                  totalCount:
                    type: integer
                  page:
                    type: integer
                  pageSize:
                    type: integer

  /battle:
    post:
      summary: Start a battle
      description: Initiate an asynchronous battle between two Pokémon
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pokemonA:
                  type: string
                pokemonB:
                  type: string
              required:
                - pokemonA
                - pokemonB
      responses:
        '202':
          description: Battle initiated
          content:
            application/json:
              schema:
                type: object
                properties:
                  battleId:
                    type: string
                    format: uuid

  /battle/{battleId}:
    get:
      summary: Get battle status
      description: Retrieve the status and result of a battle
      parameters:
        - name: battleId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BattleStatus'

components:
  schemas:
    Pokemon:
      type: object
      properties:
        name:
          type: string
        type1:
          type: string
        type2:
          type: string
        attack:
          type: integer

    BattleStatus:
      type: object
      properties:
        status:
          type: string
          enum: [BATTLE_INPROGRESS, BATTLE_COMPLETED, BATTLE_FAILED]
        result:
          type: object
          nullable: true
          properties:
            winnerName:
              type: string
            wonByMargin:
              type: number