Noticias/api-notas-openapi.yaml at main · eliascipre/Noticias · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
openapi: 3.0.0
info:
  title: API de Notas
  description: API para consultar notas con filtros de fecha y palabras clave.
  version: 1.0.0

servers:
  - url: https://evat.oblek.com.mx/notas-api

paths:
  /notas:
    get:
      summary: Consultar notas
      description: Obtiene una lista de notas filtradas por palabras clave y opcionalmente por fecha.
      parameters:
        - name: palabras
          in: query
          required: true
          description: "Palabras de búsqueda separadas por comas. Permitidas: leyes, ley, comercio exterior, aduanas, aduana, turismo."
          schema:
            type: string
            example: "aduanas,turismo"
        - name: fechaInicio
          in: query
          required: false
          description: "Fecha de inicio (formato: YYYY-MM-DD)."
          schema:
            type: string
            format: date
        - name: fechaFin
          in: query
          required: false
          description: "Fecha de fin (formato: YYYY-MM-DD)."
          schema:
            type: string
            format: date
        - name: limit
          in: query
          required: false
          description: "Número máximo de resultados (default: 50, max: 500)."
          schema:
            type: integer
            default: 50
      responses:
        '200':
          description: Una lista de notas.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Identificador único de la nota
                    titulo:
                      type: string
                      description: Título de la nota
                    contenido:
                      type: string
                      description: Contenido completo de la nota
                    resumen:
                      type: string
                      description: Resumen de la nota
                    fecha:
                      type: string
                      format: date
                      description: Fecha de publicación
                    fuente:
                      type: string
                      description: Fuente de la noticia
        '400':
          description: Error en los parámetros de la consulta
        '401':
          description: No autorizado - Token de acceso inválido
        '500':
          description: Error interno del servidor

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

security:
  - bearerAuth: []