openapi: 3.0.1
info:
  title: API Médailles des J.O. 2024
  description: |-
    Cette API uService sert à afficher les informations sur les médailles des JO 2024.
  version: 0.0.1
servers:
  - url: /medailles/
tags:
  - name: medaille
    description: Medaille des J.O.
paths:
  /:
    get:
      tags:
        - medaille
      parameters:
      - in: query
        name: offset
        schema:
          type: integer
        description: Le nombre d'éléments à ignorer avant de commencer à collecter l'ensemble de résultats
      - in: query
        name: limit
        schema:
          type: integer
        description: Le nombre d'éléments à ignorer
      summary: Liste l'ensemble des médailles
      description: Affiche la liste des médailles enregistrés sur les J.O. 2024.
      operationId: listemédailles
      responses:
        '200':
          description: medaille
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/medaille'
    post:
      tags:
        - medaille
      summary: Créer une médaille
      operationId: createAthelte
      requestBody:
        description: Objet médaille a créer
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/medaille'
      responses:
        default:
          description: Opération avec succès
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/medaille'
  /{id}:
    parameters:
      - name: id
        in: path
        description: ID de l'médaille à récupérer
        required: true
        schema:
          type: integer
    get:
      tags:
        - medaille
      summary: Récupération d'une médaille selon son id
      operationId: getmedaille
      responses:
        '200':
          description: Opération avec succès
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/medaille'
        '400':
          description: ID donné invalide
        '404':
          description: Médaille introuvable
    patch:
      tags:
        - medaille
      summary: Mettre à jour une médaille
      operationId: updatemedaille
      requestBody:
        description: Mettre à jour une médaille existant
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/medaille'
      responses:
        default:
          description: Opération avec succès
    delete:
      tags:
        - medaille
      summary: Supprimer une médaille
      operationId: deleteMedaille
      responses:
        '400':
          description: ID donné invalide
        '404':
          description: Medaille introuvable
components:
  schemas:
    medaille:
      type: object
      properties:
        id:
          type: integer
          format: uuid
          example: 123456789
        type:
          type: string
          example: Or
        sport:
          type: integer
          example: 1234567
        categorie:
          type: str
          example: +80kg
        pays:
          type: string
          example: France
  requestBodies:
    User:
      description: Objet médaille à ajouter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/medaille'