npm - @hestia-earth/caching-api - Versions diffs - 0.0.9 → 0.1.0 - Mend

@hestia-earth/caching-api 0.0.9 → 0.1.0

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

package/index.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@
  */
 export interface paths {
-    "/site/{key}": {
+    "/sites/{key}": {
         parameters: {
             query?: never;
             header?: never;
@@ -15,20 +15,20 @@ export interface paths {
          * Read Site Versions
          * @description Retrieves all versions of a site record by its key.
          */
-        get: operations["read_site_versions_site__key__get"];
+        get: operations["read_site_versions_sites__key__get"];
         put?: never;
         post?: never;
         /**
          * Remove Site Versions
          * @description Deletes all versions of a site record by its key.
          */
-        delete: operations["remove_site_versions_site__key__delete"];
+        delete: operations["remove_site_versions_sites__key__delete"];
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/site": {
+    "/sites": {
         parameters: {
             query?: never;
             header?: never;
@@ -37,28 +37,28 @@ export interface paths {
         };
         /**
          * Read All Sites
-         * @description Retrieves all site records from the database, optionally filtered by version.
+         * @description Retrieves site records from the database, with pagination and optional filtering by version.
          */
-        get: operations["read_all_sites_site_get"];
+        get: operations["read_all_sites_sites_get"];
         /**
          * Put Site
          * @description Creates or updates a site record via the site service.
          *     Supports both POST and PUT for flexibility.
          */
-        put: operations["put_site_site_put"];
+        put: operations["put_site_sites_put"];
         /**
          * Put Site
          * @description Creates or updates a site record via the site service.
          *     Supports both POST and PUT for flexibility.
          */
-        post: operations["put_site_site_post"];
+        post: operations["put_site_sites_post"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/site/version/{version}": {
+    "/sites/version/{version}": {
         parameters: {
             query?: never;
             header?: never;
@@ -72,13 +72,13 @@ export interface paths {
          * Remove Sites By Version
          * @description Deletes all site records for a given version.
          */
-        delete: operations["remove_sites_by_version_site_version__version__delete"];
+        delete: operations["remove_sites_by_version_sites_version__version__delete"];
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/site/{key}/{version}": {
+    "/sites/{key}/{version}": {
         parameters: {
             query?: never;
             header?: never;
@@ -89,14 +89,14 @@ export interface paths {
          * Read Site
          * @description Retrieves a site record by its key and version.
          */
-        get: operations["read_site_site__key___version__get"];
+        get: operations["read_site_sites__key___version__get"];
         put?: never;
         post?: never;
         /**
          * Remove Site
          * @description Deletes a specific site record by its key and version.
          */
-        delete: operations["remove_site_site__key___version__delete"];
+        delete: operations["remove_site_sites__key___version__delete"];
         options?: never;
         head?: never;
         patch?: never;
@@ -156,6 +156,40 @@ export interface components {
                 [key: string]: unknown;
             };
         };
+        /** SiteOut */
+        SiteOut: {
+            /** Id */
+            id: string;
+            /** Key */
+            key: string;
+            /** Version */
+            version: string;
+            /** Data */
+            data: {
+                [key: string]: unknown;
+            };
+            /**
+             * Created At
+             * Format: date-time
+             */
+            created_at: string;
+            /**
+             * Updated At
+             * Format: date-time
+             */
+            updated_at: string;
+        };
+        /** SitePaginated */
+        SitePaginated: {
+            /** Items */
+            items: components["schemas"]["SiteOut"][];
+            /** Total */
+            total: number;
+            /** Limit */
+            limit: number;
+            /** Offset */
+            offset: number;
+        };
         /** ValidationError */
         ValidationError: {
             /** Location */
@@ -178,7 +212,7 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
-    read_site_versions_site__key__get: {
+    read_site_versions_sites__key__get: {
         parameters: {
             query?: never;
             header?: never;
@@ -209,7 +243,7 @@ export interface operations {
             };
         };
     };
-    remove_site_versions_site__key__delete: {
+    remove_site_versions_sites__key__delete: {
         parameters: {
             query?: never;
             header?: never;
@@ -240,10 +274,12 @@ export interface operations {
             };
         };
     };
-    read_all_sites_site_get: {
+    read_all_sites_sites_get: {
         parameters: {
             query?: {
                 version?: string;
+                limit?: number;
+                offset?: number;
             };
             header?: never;
             path?: never;
@@ -257,7 +293,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": unknown;
+                    "application/json": components["schemas"]["SitePaginated"];
                 };
             };
             /** @description Validation Error */
@@ -271,7 +307,7 @@ export interface operations {
             };
         };
     };
-    put_site_site_put: {
+    put_site_sites_put: {
         parameters: {
             query?: never;
             header?: never;
@@ -304,7 +340,7 @@ export interface operations {
             };
         };
     };
-    put_site_site_post: {
+    put_site_sites_post: {
         parameters: {
             query?: never;
             header?: never;
@@ -337,7 +373,7 @@ export interface operations {
             };
         };
     };
-    remove_sites_by_version_site_version__version__delete: {
+    remove_sites_by_version_sites_version__version__delete: {
         parameters: {
             query?: never;
             header?: never;
@@ -368,7 +404,7 @@ export interface operations {
             };
         };
     };
-    read_site_site__key___version__get: {
+    read_site_sites__key___version__get: {
         parameters: {
             query?: {
                 years?: string[];
@@ -402,7 +438,7 @@ export interface operations {
             };
         };
     };
-    remove_site_site__key___version__delete: {
+    remove_site_sites__key___version__delete: {
         parameters: {
             query?: never;
             header?: never;

package/openapi.json CHANGED Viewed

@@ -5,14 +5,14 @@
     "version": "0.1.0"
   },
   "paths": {
-    "/site/{key}": {
+    "/sites/{key}": {
       "get": {
         "tags": [
-          "site"
+          "sites"
         ],
         "summary": "Read Site Versions",
         "description": "Retrieves all versions of a site record by its key.",
-        "operationId": "read_site_versions_site__key__get",
+        "operationId": "read_site_versions_sites__key__get",
         "security": [
           {
             "APIKeyHeader": []
@@ -52,11 +52,11 @@
       },
       "delete": {
         "tags": [
-          "site"
+          "sites"
         ],
         "summary": "Remove Site Versions",
         "description": "Deletes all versions of a site record by its key.",
-        "operationId": "remove_site_versions_site__key__delete",
+        "operationId": "remove_site_versions_sites__key__delete",
         "security": [
           {
             "APIKeyHeader": []
@@ -95,14 +95,14 @@
         }
       }
     },
-    "/site": {
+    "/sites": {
       "get": {
         "tags": [
-          "site"
+          "sites"
         ],
         "summary": "Read All Sites",
-        "description": "Retrieves all site records from the database, optionally filtered by version.",
-        "operationId": "read_all_sites_site_get",
+        "description": "Retrieves site records from the database, with pagination and optional filtering by version.",
+        "operationId": "read_all_sites_sites_get",
         "security": [
           {
             "APIKeyHeader": []
@@ -117,6 +117,29 @@
               "type": "string",
               "title": "Version"
             }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "maximum": 1000,
+              "minimum": 1,
+              "default": 10,
+              "title": "Limit"
+            }
+          },
+          {
+            "name": "offset",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 0,
+              "title": "Offset"
+            }
           }
         ],
         "responses": {
@@ -124,7 +147,9 @@
             "description": "Successful Response",
             "content": {
               "application/json": {
-                "schema": {}
+                "schema": {
+                  "$ref": "#/components/schemas/SitePaginated"
+                }
               }
             }
           },
@@ -142,11 +167,11 @@
       },
       "post": {
         "tags": [
-          "site"
+          "sites"
         ],
         "summary": "Put Site",
         "description": "Creates or updates a site record via the site service.\nSupports both POST and PUT for flexibility.",
-        "operationId": "put_site_site_post",
+        "operationId": "put_site_sites_post",
         "security": [
           {
             "APIKeyHeader": []
@@ -185,11 +210,11 @@
       },
       "put": {
         "tags": [
-          "site"
+          "sites"
         ],
         "summary": "Put Site",
         "description": "Creates or updates a site record via the site service.\nSupports both POST and PUT for flexibility.",
-        "operationId": "put_site_site_put",
+        "operationId": "put_site_sites_put",
         "security": [
           {
             "APIKeyHeader": []
@@ -227,14 +252,14 @@
         }
       }
     },
-    "/site/version/{version}": {
+    "/sites/version/{version}": {
       "delete": {
         "tags": [
-          "site"
+          "sites"
         ],
         "summary": "Remove Sites By Version",
         "description": "Deletes all site records for a given version.",
-        "operationId": "remove_sites_by_version_site_version__version__delete",
+        "operationId": "remove_sites_by_version_sites_version__version__delete",
         "security": [
           {
             "APIKeyHeader": []
@@ -273,14 +298,14 @@
         }
       }
     },
-    "/site/{key}/{version}": {
+    "/sites/{key}/{version}": {
       "get": {
         "tags": [
-          "site"
+          "sites"
         ],
         "summary": "Read Site",
         "description": "Retrieves a site record by its key and version.",
-        "operationId": "read_site_site__key___version__get",
+        "operationId": "read_site_sites__key___version__get",
         "security": [
           {
             "APIKeyHeader": []
@@ -341,11 +366,11 @@
       },
       "delete": {
         "tags": [
-          "site"
+          "sites"
         ],
         "summary": "Remove Site",
         "description": "Deletes a specific site record by its key and version.",
-        "operationId": "remove_site_site__key___version__delete",
+        "operationId": "remove_site_sites__key___version__delete",
         "security": [
           {
             "APIKeyHeader": []
@@ -478,6 +503,78 @@
         ],
         "title": "SiteCreate"
       },
+      "SiteOut": {
+        "properties": {
+          "id": {
+            "type": "string",
+            "title": "Id"
+          },
+          "key": {
+            "type": "string",
+            "title": "Key"
+          },
+          "version": {
+            "type": "string",
+            "title": "Version"
+          },
+          "data": {
+            "additionalProperties": true,
+            "type": "object",
+            "title": "Data"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "title": "Created At"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "title": "Updated At"
+          }
+        },
+        "type": "object",
+        "required": [
+          "id",
+          "key",
+          "version",
+          "data",
+          "created_at",
+          "updated_at"
+        ],
+        "title": "SiteOut"
+      },
+      "SitePaginated": {
+        "properties": {
+          "items": {
+            "items": {
+              "$ref": "#/components/schemas/SiteOut"
+            },
+            "type": "array",
+            "title": "Items"
+          },
+          "total": {
+            "type": "integer",
+            "title": "Total"
+          },
+          "limit": {
+            "type": "integer",
+            "title": "Limit"
+          },
+          "offset": {
+            "type": "integer",
+            "title": "Offset"
+          }
+        },
+        "type": "object",
+        "required": [
+          "items",
+          "total",
+          "limit",
+          "offset"
+        ],
+        "title": "SitePaginated"
+      },
       "ValidationError": {
         "properties": {
           "loc": {

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/caching-api",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "description": "FastAPI application for caching Site data",
   "main": "index.js",
   "types": "index.d.ts",