xss.yaml

xss.yaml

swagger: '2.0'
info:
  title: User API
  description: |
    # User API 📌
    
    Esta API permite gestionar usuarios con operaciones CRUD. A continuación, se detallan los endpoints y ejemplos de uso.
    
    ---
    
    ## 📷 Imagen en la documentación
    ![User API](https://upload.wikimedia.org/wikipedia/commons/thumb/b/bb/1337X_logo.svg/320px-1337X_logo.svg.png)
    
    ---
    
    ## 🎥 Video de referencia
    Puedes ver un video explicativo aquí:
    [Watch this tutorial](https://www.youtube.com/watch?v=example)
    
    ---
    
    ## 🔗 Enlaces útiles
    - [Swagger OpenAPI Docs](https://swagger.io/specification/)
    - [Markdown Guide](https://www.markdownguide.org/)
    
    ---
    
    ## 📌 Ejemplo de Código en la descripción
    ```json
    {
      "id": 1,
      "name": "John Doe",
      "email": "[email protected]"
    }
    ```
    
    ---
    
    ## 📋 Tabla de Estado de Usuarios
    | Estado  | Descripción                 |
    |---------|-----------------------------|
    | `active`  | Usuario activo en el sistema |
    | `inactive` | Usuario inactivo          |
    | `banned`   | Usuario bloqueado          |
    
    ---
    
    ## 🚀 ¡Comienza ahora!
    Usa los endpoints abajo para interactuar con la API.

paths:
  /users:
    get:
      summary: Get all users
      description: |
        Retorna la lista de usuarios disponibles en el sistema.

        **Ejemplo de respuesta:**
        ```json
        [
          {
            "id": 1,
            "name": "John Doe",
            "email": "[email protected]"
          }
        ]
        ```
      operationId: getUsers
      tags:
        - users
      responses:
        '200':
          description: Éxito
          schema:
            type: array
            items:
              type: object
              properties:
                id:
                  type: integer
                name:
                  type: string
                email:
                  type: string

  /users/{userId}/profile-picture:
    get:
      summary: Get user profile picture
      description: |
        Retorna la imagen de perfil del usuario en formato **JPEG** o **PNG**.
      operationId: getUserProfilePicture
      tags:
        - users
      parameters:
        - name: userId
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Imagen de perfil del usuario
          schema:
            type: string
            format: binary
        '404':
          description: Usuario no encontrado

  /users/{userId}/video:
    get:
      summary: Get user introduction video
      description: |
        Retorna un video de presentación del usuario.
      operationId: getUserVideo
      tags:
        - users
      parameters:
        - name: userId
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Video de presentación
          schema:
            type: string
            format: binary
        '404':
          description: Usuario no encontrado