compostera_backend/openapi.json at main · Hackfun-Rosario/compostera_backend · 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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
{
  "openapi": "3.0.0",
  "info": {
    "title": "API de Ideas",
    "version": "1.0.0",
    "description": "Una API para gestionar una base de datos de ideas."
  },
  "servers": [
    {
      "url": "http://localhost:3050/api"
    }
  ],
  "paths": {
    "/ideas": {
      "post": {
        "summary": "Crear una nueva idea",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "nombre": {
                    "type": "string",
                    "description": "Nombre de la idea (requerido)"
                  },
                  "descripcion": {
                    "type": "string",
                    "description": "Descripción de la idea (opcional)"
                  },
                  "alias": {
                    "type": "string",
                    "description": "Alias de la idea (opcional)"
                  }
                },
                "required": ["nombre"]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Idea creada exitosamente"
          },
          "400": {
            "description": "Datos de entrada inválidos"
          }
        }
      },
      "get": {
        "summary": "Obtener todas las ideas",
        "responses": {
          "200": {
            "description": "Una lista de ideas",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Idea"
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "Borrar una idea por ID o borrar todas las ideas",
        "description": "Borra una idea específica por su ID, o borra todas las ideas si el parámetro 'todas' es true. Se debe proveer 'id' o 'todas', pero no ambos.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "El ID de la idea a borrar.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "todas",
            "in": "query",
            "description": "Poner en true para borrar todas las ideas.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Idea(s) borrada(s) exitosamente"
          },
          "400": {
            "description": "Parámetros inválidos"
          },
          "404": {
            "description": "Idea no encontrada"
          }
        }
      }
    },
    "/ideas/voto": {
      "post": {
        "summary": "Incrementar el valor de voto de una idea",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "ID de la idea a incrementar el voto (requerido)"
                  }
                },
                "required": ["id"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Voto incrementado exitosamente"
          },
          "400": {
            "description": "Datos de entrada inválidos"
          },
          "404": {
            "description": "Idea no encontrada"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Idea": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "nombre": {
            "type": "string"
          },
          "fecha": {
            "type": "string",
            "format": "date-time"
          },
          "descripcion": {
            "type": "string"
          },
          "alias": {
            "type": "string"
          },
          "voto": {
            "type": "integer"
          }
        }
      }
    }
  }
}