@hestia-earth/caching-api 0.0.4 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +13 -2
  2. package/openapi.json +48 -27
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -37,7 +37,7 @@ export interface paths {
37
37
  };
38
38
  /**
39
39
  * Read All Sites
40
- * @description Retrieves all site records from the database.
40
+ * @description Retrieves all site records from the database, optionally filtered by version.
41
41
  */
42
42
  get: operations["read_all_sites_site_get"];
43
43
  /**
@@ -242,7 +242,9 @@ export interface operations {
242
242
  };
243
243
  read_all_sites_site_get: {
244
244
  parameters: {
245
- query?: never;
245
+ query?: {
246
+ version?: string;
247
+ };
246
248
  header?: never;
247
249
  path?: never;
248
250
  cookie?: never;
@@ -258,6 +260,15 @@ export interface operations {
258
260
  "application/json": unknown;
259
261
  };
260
262
  };
263
+ /** @description Validation Error */
264
+ 422: {
265
+ headers: {
266
+ [name: string]: unknown;
267
+ };
268
+ content: {
269
+ "application/json": components["schemas"]["HTTPValidationError"];
270
+ };
271
+ };
261
272
  };
262
273
  };
263
274
  put_site_site_put: {
package/openapi.json CHANGED
@@ -101,8 +101,24 @@
101
101
  "site"
102
102
  ],
103
103
  "summary": "Read All Sites",
104
- "description": "Retrieves all site records from the database.",
104
+ "description": "Retrieves all site records from the database, optionally filtered by version.",
105
105
  "operationId": "read_all_sites_site_get",
106
+ "security": [
107
+ {
108
+ "APIKeyHeader": []
109
+ }
110
+ ],
111
+ "parameters": [
112
+ {
113
+ "name": "version",
114
+ "in": "query",
115
+ "required": false,
116
+ "schema": {
117
+ "type": "string",
118
+ "title": "Version"
119
+ }
120
+ }
121
+ ],
106
122
  "responses": {
107
123
  "200": {
108
124
  "description": "Successful Response",
@@ -111,30 +127,40 @@
111
127
  "schema": {}
112
128
  }
113
129
  }
130
+ },
131
+ "422": {
132
+ "description": "Validation Error",
133
+ "content": {
134
+ "application/json": {
135
+ "schema": {
136
+ "$ref": "#/components/schemas/HTTPValidationError"
137
+ }
138
+ }
139
+ }
114
140
  }
115
- },
116
- "security": [
117
- {
118
- "APIKeyHeader": []
119
- }
120
- ]
141
+ }
121
142
  },
122
- "put": {
143
+ "post": {
123
144
  "tags": [
124
145
  "site"
125
146
  ],
126
147
  "summary": "Put Site",
127
148
  "description": "Creates or updates a site record via the site service.\nSupports both POST and PUT for flexibility.",
128
- "operationId": "put_site_site_put",
149
+ "operationId": "put_site_site_post",
150
+ "security": [
151
+ {
152
+ "APIKeyHeader": []
153
+ }
154
+ ],
129
155
  "requestBody": {
156
+ "required": true,
130
157
  "content": {
131
158
  "application/json": {
132
159
  "schema": {
133
160
  "$ref": "#/components/schemas/SiteCreate"
134
161
  }
135
162
  }
136
- },
137
- "required": true
163
+ }
138
164
  },
139
165
  "responses": {
140
166
  "200": {
@@ -155,29 +181,29 @@
155
181
  }
156
182
  }
157
183
  }
158
- },
159
- "security": [
160
- {
161
- "APIKeyHeader": []
162
- }
163
- ]
184
+ }
164
185
  },
165
- "post": {
186
+ "put": {
166
187
  "tags": [
167
188
  "site"
168
189
  ],
169
190
  "summary": "Put Site",
170
191
  "description": "Creates or updates a site record via the site service.\nSupports both POST and PUT for flexibility.",
171
- "operationId": "put_site_site_post",
192
+ "operationId": "put_site_site_put",
193
+ "security": [
194
+ {
195
+ "APIKeyHeader": []
196
+ }
197
+ ],
172
198
  "requestBody": {
199
+ "required": true,
173
200
  "content": {
174
201
  "application/json": {
175
202
  "schema": {
176
203
  "$ref": "#/components/schemas/SiteCreate"
177
204
  }
178
205
  }
179
- },
180
- "required": true
206
+ }
181
207
  },
182
208
  "responses": {
183
209
  "200": {
@@ -198,12 +224,7 @@
198
224
  }
199
225
  }
200
226
  }
201
- },
202
- "security": [
203
- {
204
- "APIKeyHeader": []
205
- }
206
- ]
227
+ }
207
228
  }
208
229
  },
209
230
  "/site/version/{version}": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hestia-earth/caching-api",
3
- "version": "0.0.4",
3
+ "version": "0.0.6",
4
4
  "description": "FastAPI application for caching Site data",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",