From 6bd906137c1bcb7fd8b68836f4496971ddef0812 Mon Sep 17 00:00:00 2001 From: Svenum Date: Wed, 14 Oct 2026 12:52:21 +0100 Subject: [PATCH 1/2] fix(shared): fix interface definition --- shared/utils/cache/Configuration.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/shared/utils/cache/Configuration.ts b/shared/utils/cache/Configuration.ts index 44636eb..cc2503b 100644 --- a/shared/utils/cache/Configuration.ts +++ b/shared/utils/cache/Configuration.ts @@ -28,7 +28,7 @@ export type config = { }; server: { hostname?: string; - interface?: string; + interface: string; port: number; hashing_secret?: string | undefined; hashing_secret_file?: string | undefined; From f37cd852728ad97812d37accd50f78fb147a65ea Mon Sep 17 00:00:00 2001 From: Svenum Date: Wed, 14 Oct 2026 15:03:01 +0100 Subject: [PATCH 2/2] feat(cache): add healthcheck endpoint --- cache/routes/[tenant]/[hash].narinfo.ts | 2 +- cache/routes/api/v1/iglu/healthcheck.ts | 48 + .../cachix-agent-deployment-websocket.api.mdx | 4 +- .../cachix-agent-idle-websocket.api.mdx | 4 +- ...ray-of-narhashes-is-already-cached.api.mdx | 4 +- .../create-a-new-tenant.RequestSchema.json | 6 +- .../create-a-new-tenant.StatusCodes.json | 9 +- .../02-restapi/create-a-new-tenant.api.mdx | 4 +- .../create-access-rules.StatusCodes.json | 9 +- .../02-restapi/create-access-rules.api.mdx | 4 +- .../02-restapi/create-new-api-key.api.mdx | 4 +- .../02-restapi/delete-a-tenant.api.mdx | 4 +- .../02-restapi/delete-access-rule.api.mdx | 4 +- .../02-restapi/delete-api-key.api.mdx | 4 +- .../02-restapi/delete-derivation.api.mdx | 4 +- ...tes-public-signing-key-tenant-link.api.mdx | 4 +- .../02-restapi/fetch-a-nix-binary.api.mdx | 4 +- .../finish-a-given-upload.StatusCodes.json | 28 + .../02-restapi/finish-a-given-upload.api.mdx | 4 +- .../get-a-tenant-in-cachix-format.api.mdx | 4 +- .../get-access-rule.StatusCodes.json | 9 +- .../02-restapi/get-access-rule.api.mdx | 4 +- .../get-available-signing-keys.api.mdx | 4 +- .../get-available-tenants.StatusCodes.json | 9 +- .../02-restapi/get-available-tenants.api.mdx | 4 +- .../get-deployment-overview.api.mdx | 4 +- ...ormation-about-derivation.StatusCodes.json | 9 +- .../get-information-about-derivation.api.mdx | 4 +- .../02-restapi/get-nix-cache-info.api.mdx | 4 +- ...x-derivation-in-nix-caching-format.api.mdx | 4 +- .../get-registered-api-keys.StatusCodes.json | 9 +- .../get-registered-api-keys.api.mdx | 4 +- .../get-signing-key-information.api.mdx | 4 +- .../get-tenant-information.StatusCodes.json | 9 +- .../02-restapi/get-tenant-information.api.mdx | 4 +- .../02-restapi/healthcheck.RequestSchema.json | 1 + .../02-restapi/healthcheck.StatusCodes.json | 34 + .../02-cache/02-restapi/healthcheck.api.mdx | 61 + .../02-restapi/modify-api-key-access.api.mdx | 4 +- .../02-restapi/pin-derivation.api.mdx | 4 +- .../02-restapi/retrieve-new-upload-id.api.mdx | 4 +- .../02-restapi/retrieve-upload-url.api.mdx | 4 +- .../search-for-access-rules.StatusCodes.json | 9 +- .../search-for-access-rules.api.mdx | 4 +- .../search-for-derivation.StatusCodes.json | 9 +- .../02-restapi/search-for-derivation.api.mdx | 4 +- .../search-for-tenants.StatusCodes.json | 9 +- .../02-restapi/search-for-tenants.api.mdx | 4 +- .../02-restapi/see-logs-of-deployment.api.mdx | 4 +- .../02-cache/02-restapi/sidebar.ts | 340 +- .../update-a-tenant.RequestSchema.json | 6 +- .../update-a-tenant.StatusCodes.json | 9 +- .../02-restapi/update-a-tenant.api.mdx | 4 +- .../update-access-rule.StatusCodes.json | 9 +- .../02-restapi/update-access-rule.api.mdx | 4 +- .../02-restapi/update-signing-key.api.mdx | 4 +- .../02-restapi/upload-a-nix-binary.api.mdx | 4 +- ...load-and-activate-a-new-deployment.api.mdx | 4 +- .../upload-new-cachix-signing-key.api.mdx | 4 +- openapi/index.ts | 2 +- openapi/schema.openapi.json | 8961 +++++++++++------ 61 files changed, 6579 insertions(+), 3170 deletions(-) create mode 100644 cache/routes/api/v1/iglu/healthcheck.ts create mode 100644 docs/docs/04-development/02-cache/02-restapi/healthcheck.RequestSchema.json create mode 100644 docs/docs/04-development/02-cache/02-restapi/healthcheck.StatusCodes.json create mode 100644 docs/docs/04-development/02-cache/02-restapi/healthcheck.api.mdx diff --git a/cache/routes/[tenant]/[hash].narinfo.ts b/cache/routes/[tenant]/[hash].narinfo.ts index 2a181e2..32506e4 100644 --- a/cache/routes/[tenant]/[hash].narinfo.ts +++ b/cache/routes/[tenant]/[hash].narinfo.ts @@ -34,7 +34,7 @@ export const openapi: openapi_definiton = { path: "/{tenant}/{hash}.narinfo.ts", authentication_required: false, feature_filtered: false, - tags: [{ name: "nix", parent: "derivation" }], + tags: ["nix"], }, routes: [ { diff --git a/cache/routes/api/v1/iglu/healthcheck.ts b/cache/routes/api/v1/iglu/healthcheck.ts new file mode 100644 index 0000000..8418276 --- /dev/null +++ b/cache/routes/api/v1/iglu/healthcheck.ts @@ -0,0 +1,48 @@ +import type { openapi_definiton } from "@iglu-sh/shared"; +import { MakeRestResponse } from "@iglu-sh/shared/utils"; +import { base_response_schema } from "@iglu-sh/shared/utils/zod/zod_rest_schemas"; +import type { Request, Response } from "express"; +import z from "zod"; + +export const openapi: openapi_definiton = { + meta: { + path: "/api/v1/iglu/healthcheck", + authentication_required: false, + feature_filtered: false, + tags: ["iglu"], + }, + routes: [ + { + method: "get", + description: "Endpoint to check if Iglu is up and running", + summary: "Healthcheck", + responses: { + 200: { + description: "Informational response if Iglu is running", + content: { + "application/json": { + schema: base_response_schema.extend( + z.object({ + is_error: z.literal(false), + data: z.object({ + information: z.literal("Healthy"), + }), + }).shape, + ), + }, + }, + }, + }, + }, + ], +}; + +export const get = [ + async (_req: Request, res: Response) => { + return res.status(200).json( + MakeRestResponse(200, "Success", false, { + information: "Healthy", + }), + ); + }, +]; diff --git a/docs/docs/04-development/02-cache/02-restapi/cachix-agent-deployment-websocket.api.mdx b/docs/docs/04-development/02-cache/02-restapi/cachix-agent-deployment-websocket.api.mdx index ba62844..fc58916 100644 --- a/docs/docs/04-development/02-cache/02-restapi/cachix-agent-deployment-websocket.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/cachix-agent-deployment-websocket.api.mdx @@ -5,9 +5,9 @@ description: "Attach an agent to the required deployment websocket" sidebar_label: "Cachix agent deployment websocket" hide_title: true hide_table_of_contents: true -api: eJydVE1vEzEQ/SuWTyAtSSrEJbcKEOoNIThVUeV4J7tuvbbrmU0aVvnvzHiTdlOCQOSStefrzZs3HnQNaLNL5GLQS31NZGyrTFCmgUCKoqIWVIbH3mWoVQ3Jx30nph2sMdoHIF1pMg3q5a22HOye+GL006tKJ5NNBwRZHAaNtoXO6OWgaZ+AKyJlFxp9qPSpiF5S7qHSgePYwfTUxux+mgKx0k5wtmBqyPqwkjBMMSCgJL1aXMnfeVPfgPocGL3blG4Q8hayMvYhxJ2HugEs9zaGAFaCVJ+azBWYiFrhzhGjRiHjuWn1BgGUa3w/5aSOFtUm5omfC3zuCnjFhpGh4viWm+GSxIGM+cAMfFi8/zv6DRi+AP52qHLsiWGgYppJxY18hkgKgllzZ2cVtEnJO1ugzO9Rkl+YR1zfMwccmHJMkMmNxCJxVbyzsYaJc+i7tYyhOtk7QGTlXJyvwzvIOeaJcR2jBxPEWhv6BxglwV0NZJzHC1XOZHT7yn3FVnIMkUyXLnTxKnja8m8NTto5Yp/mXh3kV2kWfhs5mW7KmiRDLR/mO3z3IhrJXQQ5LkifveibKOFyPheBzeCJc3qY2dgVxYukBL7EjBpZzBazq4KAvHR0I7q8/npTNnEqppNBfToptUfWT1D72GdW8hZ8TAUVo08RqTNFJsdd/Diqd3wb/vAWnBUcXvT332/LOCSCJ5onb1xRS2FpOBJ6q88JZYpahi6GYVgbhB/ZHw5y/dhD3vM9f25NdrIjcuKExwdFJvAAe0FrLSSpvzW+L+/Q6+2RUTwP+Mvn7yygX9Cw3YU= +api: eJydVE1vEzEQ/SuWTyAtSSrEJbcKEOoNIThVUeV4J7tuvbbrmU0aVvnvzHiTdlOCQOSStefrzZs3HnQNaLNL5GLQS31NZGyrTFCmgUCKoqIWVIbH3mWoVQ3Jx30nph2sMdoHIF1pMg3q5a22HOye+GL006tKJ5NNBwRZHAaNtoXO6OWgaZ+AKyJlFxp9qPSpiF5S7qHSgePYwfTUxux+mgKx0k5wtmBqyPqwkjBMMSCgJL1aXMnfeVPfgPocGL3blG4Q8hayMvYhxJ2HugEs9zaGAFaCVJ+azBWYiFrhzhGjRiHjuWn1BgGUa3w/5aSOFtUm5omfC3zuCnjFhpGh4viWm+GSxIGM+cAMfFi8/zv6DRi+AP52qHLsiWGgYppJxY18hkgKgllzZ2cVtEnJO1ugzO9Rkl+YR1zfMwccmHJMkMmNxCJxVbyzsYaJc+i7tYyhOtk7QGTlXJyvwzvIOeaJcR2jBxPEWhv6BxglwV0NZJzHC1XOZHT7yn3FVnIMkUyXLnTxKnja8m8NTto5Yp/mXh3kV2kWfhs5mW7KmiRDLR/mO3z3IhrJXQQ5LkifveibKOFyPheBzeCJc3qY2djNi+RFU4JfgkaRLGaL2VWBQF5auhFhXn+9Kas4VdPJoD6dpNojCyiofewzS3kLPqYCi+GniNSZopPjMn4c5Ts+Dn94DM4KDi8C/O/HZZwSwRPNkzeuyKXQNBwZvdXnjDJFLUMXwzCsDcKP7A8HuX7sIe/5nj+3JjtZEjlxwuOLIiN4gL2gtRaS1N8a35eH6PX6yCieJ/zl83dW0C9sVt20 sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/cachix-agent-idle-websocket.api.mdx b/docs/docs/04-development/02-cache/02-restapi/cachix-agent-idle-websocket.api.mdx index 74dc711..79cd45b 100644 --- a/docs/docs/04-development/02-cache/02-restapi/cachix-agent-idle-websocket.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/cachix-agent-idle-websocket.api.mdx @@ -5,9 +5,9 @@ description: "Attach an agent to the 'idle' cachix agent websocket" sidebar_label: "Cachix agent idle websocket" hide_title: true hide_table_of_contents: true -api: eJy1VE1v2zAM/SuCLm2BIEkx7JJbsQ5Db0OxnYqgUGzGVitLqkgnzYz895GK0zpt9oGizSWWSD0+ko/sdAlYJBvJBq9n+oLIFLUyXpkKPCkKimpQJ7Z0cKIKttnH3rSGBYbiHkiPNJkK9exG7xz4ooTowkbPRzqaZBogSOLQaSxqaIyedZo2ETgiUrK+0tuRTvDQ2gSlnlFqYaQ9v2OH/DfSVujVYEpI7PwWINNSHZL9ZXKu74G44qzeCws3SNC8hJqLP8bgEVDQzqfn8nfYtGugNnkolV3mbiEkZqZMce/D2kFZAeb7IngPhTxSbawSR+BGlwrXlpguSrOfmqpOEUDZyrVq18tGel6GAtUypIGf9Xxuck0VG3qJiOMZJ8MhiR8y5y2n/nn66d/sl2D4AvjbokqhJaaBimVEKizl0wdS4M2CMzuIoE2MzhaZyuQOBfxII8LijmvAD2MKERLZXWGROCreFqGEgbNvm0Xu6N7eACLL/2hjLd5CSiENjIsQHBgv1tLQf9DIALclkLEOj0Q50M/NC/c5W8kyRTJNPJLFi8fDlF8lOEin5z7Enm/lN9I82HVgMF3lNRAN1XyYrFEAswp3U98mJ6ImijibTERVY3hkIAfjIjRZ5qIj4byfqZmejqfj8xyWnKRxJWK8+H6V18tQQXuDutzLs0UWjVeb0CaW7wpciKJf6UMMSI3J2ugn78twq8miO1htB6G6Z7m9eVXuekLwSJPojM3iyPXp+vrdaK4fV6RmpnLquoVB+JncdivXDy2kDd/z58okK3MgJ0bpl4YUvLS4G5DZ0jiEv6Rxet1L4kz9id09bJ738Mq4VlzymvuAMM879aMjPW3cg0A720VRQKSB7dVuEc0+yf/b1x88Xr8BsuOERQ== +api: eJy1VE1v2zAM/SuCLm2BIEkx7JJbsQ5Db0OxnYqgUGzGVitLqkgnzYz895GK0zpt9oGizSWWSD0+ko/sdAlYJBvJBq9n+oLIFLUyXpkKPCkKimpQJ7Z0cKIKttnH3rSGBYbiHkiPNJkK9exG7xz4ooTowkbPRzqaZBogSOLQaSxqaIyedZo2ETgiUrK+0tuRTvDQ2gSlnlFqYaQ9v2OH/DfSVujVYEpI7PwWINNSHZL9ZXKu74G44qzeCws3SNC8hJqLP8bgEVDQzqfn8nfYtGugNnkolV3mbiEkZqZMce/D2kFZAeb7IngPhTxSbawSR+BGlwrXlpguSrOfmqpOEUDZyrVq18tGel6GAtUypIGf9Xxuck0VG3qJiOMZJ8MhiR8y5y2n/nn66d/sl2D4AvjbokqhJaaBimVEKizl0wdS4M2CMzuIoE2MzhaZyuQOBfxII8LijmvAD2MKERLZXWGROCreFqGEgbNvm0Xu6N7eACLL/2hjLd5CSiENjIsQHBgv1tLQf9DIALclkLEOj0Q50M/NC/c5W8kyRTJNPJLFi8fDlF8lOEin5z7Enm/lN9I82HVgMF3lNRAN1XyYrFEAswp3U98mJ6ImijibTERVY3hkIAfjIjSTrHMRkpDeD9VMT8fT8XmOS07yuBI1Xny/yvtlKKG9QV3u9dkiq8arTWgT63cFLkQRsDQiBqTGZHH0o/dluNZk0x3stoNQ3bPe3rwrd00heKRJdMZmdeQCdX0BbzQXkCtSM1M5dd3CIPxMbruV64cW0obv+XNlkpVBkBOj9FtDKl5a3E3IbGkcwl/SOL3uNXGm/sTuHjbPi3hlXCsuec99QJjnpfrRkZ5W7kGgne2iKCDSwPZquYhmn/T/7esPnq/fyuGEdA== sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/checks-if-a-given-array-of-narhashes-is-already-cached.api.mdx b/docs/docs/04-development/02-cache/02-restapi/checks-if-a-given-array-of-narhashes-is-already-cached.api.mdx index 6ea3599..203c2f3 100644 --- a/docs/docs/04-development/02-cache/02-restapi/checks-if-a-given-array-of-narhashes-is-already-cached.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/checks-if-a-given-array-of-narhashes-is-already-cached.api.mdx @@ -5,9 +5,9 @@ description: "Checks if a given array of narhashes is already cached" sidebar_label: "Checks if a given array of narhashes is already cached" hide_title: true hide_table_of_contents: true -api: eJztV8Fy2zYQ/RUMLm1mZNNuc9LNSZuJL2kmcU8ejWdJrEQkJMAAS1mKRv/eXYCyKEvJdNx20oN1kChiudi3b3fxuNEGYxVsR9Y7PdWva6w+R2XnCtTCLtEpCAHWys+Vg1BDrJFXo4ImIJi1qqCq0eiJJlhEPb3V0NlieVmk+3xbfu1Kzya6gwAtEgYx2+jI6y3o6UbTukPeOVKwbqG3Ex3wS28De51S6HGiHT/HBoQOHLFPK4F2QDUbP8UR9FT7YL9Cwjz4qxkOhid67COGM1jgPrydu1l+BiO98mYtPg/zfbXL7ju7Uh/JB1Rvc5KpBlKx9n1jVImqEmLQCDNU45ppwWMSHodXeUcSFG8LXdfYKkEuPkXZ+wTQxLVAIGzjiQTIR3aJnXcRk8UvFxcnUKnGRhJY9QiMhOw8PYQdBS4jcoJIPdD73wT98lSc124JjTVKuJmqm9qm2g5IfXAc2X3N9b/2fVADh6pkQzERGEPcXfAdBjX3oYWnhO/LT1jJg9kR2ZzXSEB9vKu8wZGx69syVeluvcUYufBOFquNdxiCD6PF0vsGwcmqAfobYSQHdwYJbHMyueOiu31kPuNVshwiQdudQPHo4THkI4AjOEPsY9+zHcmXxyTfMEmfuWOYSHWPXIN95NB3LAas/MLZr6l/nrn7kdz9eszdGx9Kawy34Zl659XB5J4otNyAIRFrrHE/kTTj0hqejO7QVuV5rHzI/Tz8PezkV8gT6rmT/yfV8PJ0Jw+TmKdzPjCU8ZhZxFU6c4RL5pVP5CWGZxZ/IIvsjgVf7Y3INR8TGFFtU12MVWKxyUxuC1aY1s29bJbYy0qxD40IKqIuTovCLpr+HFe8SYPnlW+TxBIyP+xl1u95OWNIeZmJLGPPjFn85nK6OL84v0xhkxjra3atrt5fC6BDmTAsqN98FWU+8BGCMjXSLDG4xMZ3rRQZQxakLaTaGtThkzX1QRSbfSX/A5WeCSdcUdE1YFPlpQRvBm6SgmfL5eWg3oXq6YM421HECa2FUrbfbEqI+Gdotlu5zSwEFrq3fLlkYygTEdzKNso1F8McmojfQffzh6EIX6hvhbyTfk6EH2u4Xv7xJZ/z+zeFrdT7IMT/9QjyTgfC/yEOeYnI66+zy7MbcbG3OBpE+yeuqgo7+q7tbNRX7//4eMPG5fBy0abxpAPcy9sAf6es+AQxjYt0b6MbcIs+zSmdfcrnL3do5wE= +api: eJztV8Fy2zYQ/RUMLm1mZNNuc9LNSZuJL2kmcU8ejWdJrEQkJMAAS1mKRv/eXYCyKEvJdNx20oN1kChiudi3b3fxuNEGYxVsR9Y7PdWva6w+R2XnCtTCLtEpCAHWys+Vg1BDrJFXo4ImIJi1qqCq0eiJJlhEPb3V0NlieVmk+3xbfu1Kzya6gwAtEgYx2+jI6y3o6UbTukPeOVKwbqG3Ex3wS28De51S6HGiHT/HBoQOHLFPK4F2QDUbP8UR9FT7YL9Cwjz4qxkOhid67COGM1jgPrydu1l+BiO98mYtPg/zfbXL7ju7Uh/JB1Rvc5KpBlKx9n1jVImqEmLQCDNU45ppwWMSHodXeUcSFG8LXdfYKkEuPkXZ+wTQxLVAIGzjiQTIR3aJnXcRk8UvFxcnUKnGRhJY9QiMhOw8PYQdBS4jcoJIPdD73wT98lSc124JjTVKuJmqm9qm2g5IfXAc2X3N9b/2fVADh6pkQzERGEPcXfAdBjX3oYWnhO/LT1jJg9kR2ZzXSEB9vKu8wZGx69syVeluvcUYufBOFquNdxiCD6PF0vsGwcmqAfobYSQHdwYJbHMyueOiu31kPuNVshwiQdudQPHo4THkI4AjOEPsY9+zHcmXxyTfMEmfuWOYSHWPXIN95NB3LAas/MLZr6l/nrn7kdz9eszdGx9Kawy34Zl659XB5J4otNyAIRFrrHE/kTTj0hqejO7QVuV5rHzI/Tz8PezkV8gT6rmT/yfV8PJ0Jw+TmKdzPjCU8ZhZxFU6c4RL5pVP5CWGZxZ/IIvsjgVf7Y3INR8TGFFtU12MVWKxyUxuC1aY1s29bJbYy0qxD40IKqIuTovCLpr+HFe8SYPnlW+LpLGEzQ97nfV7Xs8gUmJmosvYNYMWx7meLs4vzi9T3CTG+pp9q6v314LoUCcMC+o3X0UZEHyGoIyNNEwMLrHxXStVxpgFagupuAZ5+GRRfRDFZl/K/0CmZ8YJV1R0DdhUeinDm4GcJOHZcnk5yHfhevqgznYccUJr4ZTtN5sSIv4Zmu1WbjMLgZXuLV8u2RjKRAT3so1yzdUwhybid9D9/GGowhfqWyHvtJ8T5ccirpd/fMkH/f5VYSsFPyjxfz2CvNOB8n+IQ94i8vrr7PLsRlzsLY4m0f6Jq6rCjr5rOxs11vs/Pt6wcTm8XbRpPukA9/I6wN8pKz5BTPMi3dvoBtyiT4NKZ5/y+Qvdpecw sidebar_class_name: "post api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.RequestSchema.json b/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.RequestSchema.json index 834b017..ac30d3a 100644 --- a/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.RequestSchema.json +++ b/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.RequestSchema.json @@ -15,7 +15,8 @@ "preferred_compression_method": { "type": "string" }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { "type": "string", "enum": ["client", "server"] } }, "required": [ "id", @@ -26,7 +27,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] } } diff --git a/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.StatusCodes.json index c3d2576..01fb2de 100644 --- a/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.StatusCodes.json @@ -21,7 +21,11 @@ "preferred_compression_method": { "type": "string" }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -32,7 +36,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, "timestamp": { "type": "number" } diff --git a/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.api.mdx b/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.api.mdx index 841a060..4513c28 100644 --- a/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/create-a-new-tenant.api.mdx @@ -5,9 +5,9 @@ description: "Create a new tenant" sidebar_label: "Create a new tenant" hide_title: true hide_table_of_contents: true -api: eJztWE2P20YM/SuDuTQBHNu7bQ/xLU17yKnBZntaGAYl0dakI406H951Df/3kjNSJK+13qIoYARwDhtLw6FIvkfOkHtZoMutarwytVzIjxbBowBR46PwWEPt5UR62Di5eJDQqNn2ZqY2OswsOj9LEo5E+J1cTmQDFir0aHnDXrq8xArkYi/9rkH6gPNW1Rt5mEiLfwVlsZALbwNOZE37SACCL41Vf0O0iBSzWSVCgZZ2/ReNwaF9BxuMrhypW6Y95MkvptixzuNo3Jd4HIjc1J71kCQ0jVZ5tHL21bH4iG0m+4o5b2ysadB6hY5XVTFq/0b5MmQrtjeZPiLz4gKpr5RzKllysqzcqgkZWTxYzYzRCHXcbXGNlmK3yk1FD1HRioAszbitwapxM6wi9PxusFiHKovgSe/1yPsj5B44OKehaB0/cnPo1CseJHsH1iVblodD+rprTO0SNrfzm1MifAl5ThpFJymYCKBqclr4RBK9E3lMnuJ/p4vz4IMjvwocDWu7XpGFRPOX4KfgGDuC/kQiqaLIr0E7XJJwAf5K4u+IxPS/IvA9VM3rlg3JdEKdAVFaGgx1t+ny01iG3KEPtibyq7VA8hut2JlgBZdzkeqteAQnKtBrYysSNDamDp0p4k/csbQggm1VQWuFQSdq4wU+KffdZNK/Tp2oYFUglRDtRr7yDLJj8Qvg/eN5vBm6QhURsBZCAVqLzowWf9dCTuWze/FIPMGeE1egLwz0+/NA+wiXcnw/hIoPP4JrTSB58UZNseNCXhqHSQYFIZsqQToVSQd4YgcdlcUupbd7e8X9srjf3p7BnXK0Tgi2d2WR0WW5L9FQRFZ4E8v5t5xvEbsie0lkf57PX0OWGzdRQiGAfjsXkEs4X3Y5vYewT8V9SanPhzjv+cGJNQR9PZwvjfArhzMn5Zr6ksA5ygBaE3ws4tSqe2HW/DNetWrI9PUMviiepK5rV2Rj4s23AV/S0+zM7IX6i203cAlW84DD+8YtZlF6ik+kX+OUWoo48mAc7/qxx29puWvpuriMdHL90vPnYd/Wvx20a2kgc75B6zfGvmyg/Vs7Nm/brzlzo14bNppdTx+eT+fTmxhUz/7IT1zaPnz+xOE+yo9uQfxqchdvKOSkUO0xV+AWtWkqTgFuBgmHCiLzW7fHh2RHn9j3SfTSTC0RyeOTnzUaVJ0a0thbJszjvI0ktzfdfC2OKuLmFntCs2SakOx+n4HDP6w+HPg1wWspYA/0cwtWcWrzE32jHX4xWQrlUs4vYu9/xoc3dy3L34qXbKcm7vmwbQs6sGAc3KX1j0nlu3tW0Uuc1Jl+x4c8x8aflV0O0ubz71/uSThrB3pVrD7SwiNHj/6SNRNpoouxGsR3e6mh3oRYhmTSyf/+AXfhbFU= +api: eJztWEtvGzkM/iuCLtsCru1kdw/1rY899LRFmj0FhkHP0B61mtGsHk68Rv77ktJMZhyPnaIoYCzWOQQeiaRIfiQlcidzdJlVtVemkjP5wSJ4FCAqvBceK6i8HEkPaydndxJqNdlcTdRah4lF5yeJwhEJr8n5SNZgoUSPlhl20mUFliBnO+m3NdIBzltVreXjSFr8OyiLuZx5G3AkK+IjAgi+MFb9A1EjEsxqFQg5WuL6EYnBoX0Da4ym7ImbJx6y5L3Jtyxz3xu3Be47IjOVZzlECXWtVRa1nHx1TD6gm1l+xYwZa2tqtF6h412VD+q/Vr4IywXrm1QfoDm6QeJL5ZxKmhxsK7eow5I07u0ujdEIVeS2uEJLvltkpqSPKGhBQBZmWNdg1bAaVhF6ftvbrEK5jOBJ7/XgulPriviPnjeSSMQcgZlWCUfy0YaY5497uN+xaw8d2bhtz0l9l7xgf7K2Z1uy5EBvUiap42pTuQT19fTqMK6+hCyjI0RLKTiuQLEs4VPM6a3IYi7mPz36nAcfHBma4zAaab8kDSlrjkUTecvYgWB6wmoF2uGciHPwl5z4/+YEbSiKJQ9lPWDoM1X7sXkQib24a6KqL7vJvt+GEu4GfbAV5ZJaCSRHoBVbE6zgy0ak20DcgxMl6JWxJREaGzORbjzxDbdMLSheNyqnvdygE5XxAh+U+88k5ndnYhSwyJEqknYDpzyDbJ/8DHj/ehpvhi5XeQSsgVCA1qJVo8HfNZBTNW4X7ilOsIuJC9BnBvrtaaB9hEs5fr1CyXcpwbUikLx4pcbYxkJWGIeJBgUhmypBumRJBniKDrp5821Kb/f6gvt5cb++PoE75WiVEGxe8mJJT/muREMeo8KbWM6fcr5B7ILsOZH9fTp9CVluK0UBuQD67VxALuH8dub07sM+FrcFpT5f4szzixMrCPpyOZ8b4RcuZ07KFbU5gXOUAbQm+FjEa7BemBX/jE+tCpb6cgefFU8S13Yjsjbx5VuDL+hrcmIylLqSNA4KVvP4xfvazSaReowPJF/jmHqMSZzIMJA33VTmj7Tftohd+3PQGXZbz7/7fWC32mv/0rzodMPXMcY+ryf9qb2bNu3c9LB9a7s0DptqZdgc9kpSaTqejq+ivz1bKj9x1Xv3+RMjsZc67Yb4aDIXHy9kvlDNDZjjBrWpy+YchqiEmBSNQ4ane3tH7Lr8OjYMTDHm8cFPag2qSq1v7GJTOMRBIVFurtrBYByKROYmLAjngiOIaHe7JTj8y+rHR14m4C258o5+bsAqznr+ojOaqR3HUa5cKgezOGU4YcOrmyYBXotjulN/93xKuAEdmDBOHNP+hyTyzS2L6CgOSlDH8S7LsPYnaee9jPr855dbIl42k8gyFiZp4Z69R/9Jm5E00cRYKOLaTmqo1iFWKJlk8t+/D8qtGA== sidebar_class_name: "post api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/create-access-rules.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/create-access-rules.StatusCodes.json index fe420f7..f97f53d 100644 --- a/docs/docs/04-development/02-cache/02-restapi/create-access-rules.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/create-access-rules.StatusCodes.json @@ -25,7 +25,11 @@ "preferred_compression_method": { "type": "string" }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -36,7 +40,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, "ip_block": { "type": "string" }, diff --git a/docs/docs/04-development/02-cache/02-restapi/create-access-rules.api.mdx b/docs/docs/04-development/02-cache/02-restapi/create-access-rules.api.mdx index 372457e..6c16f70 100644 --- a/docs/docs/04-development/02-cache/02-restapi/create-access-rules.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/create-access-rules.api.mdx @@ -5,9 +5,9 @@ description: "Create a new access rule for the given tenant" sidebar_label: "Create access rules" hide_title: true hide_table_of_contents: true -api: eJztWd9v2zYQ/lcIvnQDnDjJuj0Y2EPbbUBetiDLnorAoMSzzUYiVZJy4hr+33tHUpYUy/kxFPA6OA+BIh6Pd/fdnY5f1lyCy62qvDKaT/gHC8IDE0zDPRN5Ds4xWxfAZsYyvwA2V0vQzIMW2vMR92Lu+OQjF5UaL8/Hal7UYwvOj6OEQxF6x29HvBJWlODB0oY1d/kCSsEna+5XFeDRzlul53wz4hY+18qC5BNvaxhxjftQYHuoIksr4Rco/EJFM1G4VlNu9EzZslH1uQa7ermunlGi9gtj1RcRApgULkBIsP9SY+3Anog5tK426m7jHgzveyNXpLMP3g3i08XMG5YHPFERuuxJJW4SVVWoPBg8/uRo54CZJvsEOVlQWVOB9QocrapqmhUmvxt0qLIKQ+FXnUVdl1mIBBd5tPLxvhEHFKIckngSJ8EcKs9vN01Edk7qxe5ja1PHgu15ScntZhO3ucpoF325ODvfjeF1kmC58UJpPC+kPZXDNcb020XSeeFrN82NhMF4pfUS0cRkGIy3clOw1tjOYmZMAUK3UQ2JT7GUwr8EXzl4UqrmaW/5dSrmyi/qbErZvQfWvXjjCWBL5dxgAsVAVHWGUAxEIuQlzDBQIDHaJf4RFGFksXKHba2ten2Ce18MvH+cq5LvhiI53nOz69QzHkR7e8lPthDoT5YrZpj1U1UNegNa7ls6VJmTp51EHHULf+vL1vInmwEqUlhZXpRDLj46uFupO3XZqcJUY13dqe28Heo01K3vYMVWpmb3YIHVjrqNckwbzyzkZq7VF5DfS8t5cY8JCqYSsL8W7nnc++IHwO6nXez+MDZTUuIkdML+NKw3BIwYYH2DDcBKJfUbzzAASyXx66z7six+2pkJ0rb5M+WA0uHb8x6ExZc4gZXCH7PhwNnwdriS02AGMs3GTBqIKMKDcp4ZwhJxxZ6/BHtE8cAo/jI0+fnaagTwfoF1HcrRmhovQ+Hi4hgWYbcqc4Pf49wfy/I/AejFxROAqllALJUoy/DyRC0WgcR+rPRSFEoyOva7Ge//tzAOfGu7MEZeIlxu701dSEbjH8MqDQBfXoVvLhVqwpoGqpk15Sm7oeabI94ZYGvWJDEXVhZ0WTYxP0gXbchW6XvdXP4SXfArXdNZIAtiTzhmy0Gz5eezsxcUPeVKYEFo3JqhpbiGT5fzon7j2BVeG44wHhjGZ4qeYJwhgDXWdZih4mcZH7AKPVVvmpdx8MqK44XpoHiiuoZY4ZVxwRliaid8vI8jHq/jw2Ycycsp1Swxx3FWjnRxbQtiQr2v3GQcdJzCA55awGluysCNErrXLT/6e1wOlNSWBmnpiJbFOGtZi4acSFRsB0Y9M6SJ7ImSZ6dnp+fBf0+HcGoo7N3VJUWml8rNAvvN5C7w6LUDGj7CiClhCYWpSspW4lYwZKUISZpsaBj5ltd1j49Yt/n+egI/ZoOHBz+uCqF05L8ClRWBC+Q+Si7PGzI/8Ki+ZWPwabJV2MMQUVlQEqCS9ToTDv6xxWZDryPnTshK5WLZNiT9Hax6HD3OZzXZGEBeCqtIfHjr3rD8cJ1y/Ee2z+n0UuhV98zGnOTfhsop8fHf3IJ4Uo//b30frdP6h6jy5IZUtBI7fa7d8S5SbU/J3nbK9uqvv29QOEv/YyhD9+NW3BPw+DtExQQXQzcK79a8EHpehzbIo076+QpnLDw6 +api: eJztWd9v2zYQ/lcIvnQDnNjJuj0Y2EPbbUBetiDLngrDoMSzzUYiVZJy4hr+33tH0pYUy/kxFPA6OA+BLB6Px/vujsdPay7B5VZVXhnNx/yDBeGBCabhnok8B+eYrQtgM2OZXwCbqyVo5kEL7fmAezF3fPyRi0oNlxdDNS/qoQXnh1HCoQi945MBr4QVJXiwNGHNXb6AUvDxmvtVBbi081bpOd8MuIXPtbIg+djbGgZc4zwU2C2qyNJK+AUKv1DRTBSu0ZQbPVO23Kr6XINdvVxXxyhR+4Wx6osIDkwKFyAk2H+psXZgz8Qcmq1u1U3iHHTveyNXpLML3i3i08bMG5YHPFERbtmTSpwkqqpQeTB4+MnRzB4zTfYJcrKgsqYC6xU4GlXVNCtMfte7ocoqdIVftQZ1XWbBE1zk0crH8wYcUIhiSOJKnARzqDyfbLYe2Vup47uPjU0tC3brJSWTzSZOc5XRLu7lcnSx78ObJMFy44XSuF4Ie0qHG/Tpt/Ok88LXbpobCb3+SuMloonB0Otv5aZgrbGtwcyYAoRuvBoCn3wphX8JvrJ3pZTN087w61TMlV/U2ZSi+wCsB/HGFcCWyrneAIqOqOoMoejxRIhLmKGjQKK3S/wRFKFnMXP7ba2ten2Ae1/0A6nmFEYH12sSIC9UzHr00RInT/YiXfJ9Rya3dZzUdskz+4+77aQO7WTPboqhJ7MfA9b6qap6nQBaHho6VtWgrbfietCuI7u97Cx/sragIoWJ6kXZt8VHC7cTfy/NW0mdUratO1Wxt32Fi4r/HazYytTsHiyw2lHxUo5p45mF3CCcX0B+LxXsxSUrKJhKwHJduOdx74ofAbuf9rH7w9hMSYmN1Rn707BOTzFggAkPNgArldRvPEMHLJXEw153ZVnsFJgJ0nb7M8WA0uEoew/C4kts6ErhT9Fw5Gh425/Jqc8DmVptJg1EFOFBOc8MYYm4ppPihOJxUfylr5H0tdUI4P0C8zqkozU13q3CPcgxTMJ2VuYGD+jcn9LyPwHo5eUTgKpZQCylKMvwLkYlFoHEeqz0UhRKMlr2u7kt/G9h7Dlr2zBGmiPcle9NXUhG7R/DLA0AX12HM5cSNWFNDdXMmvKc3VLxzRHvDLA0a5KYCysLunubGB+kiyZkq3Reb++SiX34lW79LHAPsSacouWo0fLzaPSCpKdYCaQKtVsztBTH8OlqXtRvHLvGa8MJxiPD+EzSE4wzBLDGvA49VDyW8QGz0FP2pn4ZG6+sOF2YjoonqtvyJrwyLmyGiN8xHx6inIfr+LAZRi50SjnrdqxKZJ9rWxCx6n3lxsOg4xwecNUCznNTDgPXSvDeNHzr73E8UFw7HqThIxoaY9TQFlt2IlG7LRz1zJAmMihKjs5H5xfBAZ4W4VRR2LvrK3JNJ5a3A+w3k7vAy9cOqPsIPaaEJRSmKilciVxBn5UiRGmyYcvwNzyxe7zEugn4138QiOHg4cEPq0IoHfm0QI1F5MLHApRcXmw/DgRe1jd0DD6Ndwo7ICIqC4oCVLJeZ8LBP7bYbOh15PAJWqlczNst6X8Hqw7njw1aTTYGkJfCKhLvn3rQLT/cpCD/kR3adHop9Kq95tactL8N5VPi97+5BXGlzveEZu+DdRr/EFWe3ZKKRmKv0DUz3kWu7SnZSStvr//6+xaFs/TNogzlj1txT8Dj/+AVE7YYylF4t+aF0PM61EEeddLfVw6FWBU= sidebar_class_name: "post api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/create-new-api-key.api.mdx b/docs/docs/04-development/02-cache/02-restapi/create-new-api-key.api.mdx index fb4bc14..05299ef 100644 --- a/docs/docs/04-development/02-cache/02-restapi/create-new-api-key.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/create-new-api-key.api.mdx @@ -5,9 +5,9 @@ description: "Create a new API Key that is authorized for given tenants" sidebar_label: "Create new API Key" hide_title: true hide_table_of_contents: true -api: eJztV0tv40YM/iuDufQiW3Ee3ta37baHRYF2sZseisAIaImyZivNqDOUs67h/15yJNV2rLYBWsAokBwCS8Ph4/tIitzpHEPmTUPGWb3Q7zwCoQJl8Um9/fBe/YBbRSWQMkFBS6Xz5nfMVeG8WpsNWkVowVLQiSZYB7140NCYdDNLzbpqU4+B0l9xK+fyQi8T3YCHGgm9SO90yEqsQS92mrYNsg+BvLFrvU+0x99a4zHXC/ItJtryPRYY/IDoNCsWz0uEHL3eL7trbPdbl29F7WmEn6K5GEAmwbKpGCwHqs8tZs5ygCRqoGkqk0Wb6ecgukZ8d6vPmBErarxr0JPBIKed4yMRDugdzsB7EE8MYR3O7ySaPa+BPdJta3K935/g9NCZOihe7nuJ0DgbOm+ur67OcfmR7yXK5ApsrgIyNqRccZwH+j+DIxBQGx4zlx+jYtt6JQwmw3mNIcB6HDgTHtF7548OV85VCJIQyKoYiwKqgEsWzoFe4BWj+c9wJ3/NJaf5S/g6pYtfJQNnokDcJcORE9TNCDjPrh8jeYbbEUo9Bse6+8y4HUuGX1zrVV9GasV1pJ4gqBoqCYbLn4vHOu4JXP4lKm/WJak+zv9Jkrw4K6KCxxwJTDVSj88JORW/AJuzczbvmaOhl7eB6RMy0TB1HY0eM7e2sa8zsbnDEF+XsOEvQZaxfUVOBVejdARhvO8uQwIMj5zAg8Rx8rzmxIVz4ma0wiPB9itSDX8dmByU3h8/8qr7mE5fibsocXdjrfk9T1EKbeZaJsZ3nEVF6qk0FR6GGjpU/SuPF+ZxpAA/IrXeMn+ma5gF09Z67qUlT9retTyF8w+eleMYZrqWzH12VWH+yucF+WR1vL2UjpXpxoUYDFDJT+no5pNKRxVL6DfDztP6SlYWoiYs0ig/xS9socJp5uq4xAiTHw+LzPfd8WGZOAyYf+4QD/qmgK/vivnt5O7N7M3k9m5+PVndFNnkOvtmflPM51DAPOJlbOFEl3jU5ePV9Go6i9GSmOn6DPcPweG8AUlj+c5lIe5RPFPIJLCVoTHHDVauqSU32Y4AVIM9crvfME/3ihMLu0Ny/7t9tEsDwi+UNhWYmI8R+V3PWNxVWXIzG9bTuClRN4uLjsgds1EK0Sy/260g4M++2u/lNdPjeeh/4J8b8EaKU57YTr+OCtlxL9Dvupgm9+KViFdtXPeeF+8+GW685dGrob+VXR7l4oefPt2z8KrfeutY0trDkwTF/xeaf7iIcSyx+G6nK7DrNta27nTK3x851ZnX +api: eJztV0tv40YM/iuDufQiW3Ee3ta37baHRYF2sZseisAIaImyZivNqDOUs67h/15yJNV2rLYBWsAokBwCS8Ph4/tIitzpHEPmTUPGWb3Q7zwCoQJl8Um9/fBe/YBbRSWQMkFBS6Xz5nfMVeG8WpsNWkVowVLQiSZYB7140NCYdDNLzbpqU4+B0l9xK+fyQi8T3YCHGgm9SO90yEqsQS92mrYNsg+BvLFrvU+0x99a4zHXC/ItJtryPRYY/IDoNCsWz0uEHL3eL7trbPdbl29F7WmEn6K5GEAmwbKpGCwHqs8tZs5ygCRqoGkqk0Wb6ecgukZ8d6vPmBErarxr0JPBIKed4yMRDugdzsB7EE8MYR3O7ySaPa+BPdJta3K935/g9NCZOihe7nuJ0DgbOm+ur67OcfmR7yXK5ApsrgIyNqRccZwH+j+DIxBQGx4zlx+jYtt6JQwmw3mNIcB6HDgTHtF7548OV85VCJIQyKoYiwKqgEsWzoFe4BWj+c9wJ3/NJaf5S/g6pYtfJQNnokDcJcORE9TNCDjPrh8jeYbbEUo9Bse6+8y4HUuGX1zrVV9GasV1pJ4gqBoqCYbLn4vHOu4JXP4lKm/WJak+zv9Jkrw4K6KCxxwJTDVSj88JORW/AJuzczbvmaOhl7eB6RMy0TB1HY0eM7e2sa8zsbnDEF+XsOEvQZaxfUVOBVejdARhvO8uQwIMj5zAg8Rx8rzmxIVz4ma0wiPB9itSDX8dmByU3h8/8qr7mE5fibsocXdjrfk9T1EKbeZaJsZ3nEVF6qk0FR6GGjpU/SuPF+ZxpAA/IrXeMn+ma5gF09Z67qUlT9retTyF8w+eleMYZrqWzH12VWH+yucF+WR1vL2UjpXpxoUYDFDJT+no5pNKRxVL6DfDztP6SlYWoiYs0ig/xS9socJp5uo0bjFC5cfDJvN9d37YJg4T5p9LxIO+KeDru2J+O7l7M3szub2bX09WN0U2uc6+md8U8zkUMI+AGVs40SUudQl5Nb2azmK4JGa6RsMNRIA470DSWb5zWYiLFA8VMgpsZWrMcYOVa2pJTrYjCNVgj9zuV8zTxeLEwu6Q3f9uIe3ygPALpU0FJiZkhH7XUxaXVZbczIb9NK5K1A3joiOSx2yUwjTL73YrCPizr/Z7ec30eJ76H/jnBryR6pQnttPvo8J2XAz0uy6myb14JeJVG/e959W7T4Ybb3n2auhvZZdHyfjhp0/3LLzq19461rT28CRB8f+F5h8uYhxrLL7b6Qrsuo3FrTud8vcHdhGaBg== sidebar_class_name: "post api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/delete-a-tenant.api.mdx b/docs/docs/04-development/02-cache/02-restapi/delete-a-tenant.api.mdx index e45525f..dc39f26 100644 --- a/docs/docs/04-development/02-cache/02-restapi/delete-a-tenant.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/delete-a-tenant.api.mdx @@ -5,9 +5,9 @@ description: "Delete a given tenant" sidebar_label: "Delete a tenant" hide_title: true hide_table_of_contents: true -api: eJztV1Fr2zAQ/itCL9sgjZOte/FbRzsojDFK91RCUexzrE6WPElOm5r8991JTmI36ShlEAZ9iiOd7r677+6ka3kOLrOy9tJonvJzUOCBCbaQS9DMgxba8xH3YuF4esNFLZPlNJEL1SQWnE+ihEMRWuOzEa+FFRUqsXSg5S4roRI8bblf1YAmnLdSL/h6xC38bqSFnKfeNjDiGs+hwNaoJES18CUKv0aRaHxprHwUwblOXwkiB/tKjY0DeyIWsIO3UTejM6422oEjjR8nU/oZRvdSF8ZWAY5QbCPPRIHR6mLNcmIg4s2M9mQK9Yi6VjILJ5M7R8oOwDfzO8gIWW1NDdbLCMV54Rt3m5kcesK6qeYhDpv9CpxD1w6GQ7pbsNbY3ubcGAWCYAKqQqoLoRzMUDgX/gWo5C4W+ya3Svl1LyqQM9dkGeIsGqVWfLYeMHUz0ElIvESnvKjqA34/OdoP0l5IegHo3OvrRhik7fQQ49clsF+wYivTsHuwwBqH/jHpmDYeMyAzCy0fEcJ/wvaL6Q0KbnPwQip3wMqT8A/Fj8Ddp33uvho7l3mObfCEfTds0E1GDKQvsWqJ2Fzm+p1nGIClzLGc9VCWxR7BTJC2m79dDkjsspgkX0BYXIz5+5YNR86G08OVTGZQFPvQplkbiCzCg3SeGeISecVbYgn2jcWjsvh5Mtln8Qp8YzUSeF9CLLzMQqzSAmHiBn7RS+adY/iQ8WN2BQVaYt4E6WCU9e4ZqlhWGezs0dE30o9M+oFGviVdFoHEAhlvkLFQq9Y0+OCVkW5mik1fxgKfq7eL+ah8ojqcJEqDynh8AZI7NBCkPHluFEna+LEmk6ERx0GksYre697XLk3CsTE8oCkF48xU4QVPdU1e0ZmYOpPxZDwNwLwiRy/xGDv7cUmQh0/7boOdm8yFpoCzAl3u4crPYQnK1BWlETpVG+crEbKnGyy2c9d2+Bmob3dJ+PyIFqnw8OCTWgkZciI43XYxC+MbSi6nm3EtDC3h8HaMSzuFGI4SYdKptp0LBz+tWq9pGe9Au8J1/FwKK6lMQoBz6WLJpGEU+IsL76+6JPnAngPeLQq9IsBCNfQPP/ExvRsR15SP3QT2zxFES4OJb4uDpse4f4bzSN3f22sRlFjbLD6/+HZxfYGF8gfPUWwC +api: eJztV1Fr2zAQ/itCL9sgjZOte/FbRzsojDFK91RCUexzrE6WPElOm5r8991JTmI36ShlEAZ9iiOd7r677+6ka3kOLrOy9tJonvJzUOCBCbaQS9DMgxba8xH3YuF4esNFLZPlNJEL1SQWnE+ihEMRWuOzEa+FFRUqsXSg5S4roRI8bblf1YAmnLdSL/h6xC38bqSFnKfeNjDiGs+hwNaoJES18CUKv0aRaHxprHwUwblOXwkiB/tKjY0DeyIWsIO3UTejM6422oEjjR8nU/oZRvdSF8ZWAY5QbCPPRIHR6mLNcmIg4s2M9mQK9Yi6VjILJ5M7R8oOwDfzO8gIWW1NDdbLCMV54Rt3m5kcesK6qeYhDpv9CpxD1w6GQ7pbsNbY3ubcGAWCYAKqQqoLoRzMUDgX/gWo5C4W+ya3Svl1LyqQM9dkGeIsGqVWfLYeMHUz0ElIvESnvKjqA34/OdoP0l5IegHo3OvrRhik7fQQ49clsF+wYivTsHuwwBqH/jHpmDYeMyAzCy0fEcJ/wvaL6Q0KbnPwQip3wMqT8A/Fj8Ddp33uvho7l3mObfCEfTds0E1GDKQvsWqJ2Fzm+p1nGIClzLGc9VCWxR7BTJC2m79dDkjsspgkX0BYXIz5+5YNR86G08OVTGZQFPvQplkbiCzCg3SeGeISecVbYgn2jcWjsvh5Mtln8Qp8YzUSeF9CLLzMQqzSAmHiBn7RS+adY/iQ8WN2BQVaYt4E6WCU9e4ZqlhWGezs0dE30o9M+oFGviVdFoHEAhlvkLFQq9Y0+OCVkW5mik1fxgKfq7eL+ah8ojqcJEqDynh8AZI7NBCkPHluFEna+LEmk6ERx0GksYre697XLk3CsTE8oCkF48xUSXjCU2GTW3Qo5s5kPBlPAzKvyNNLPMfOflwS5uHbvttg5yZzoSvgsEC3e7jzc1iCMnVFeYRe1cb5SoT06SaL7eC1nX4G6ttdFj4/o0UuPDz4pFZChqQIXrdd0ML8hpLL6WZeC1NLOLyd49JOIYajRJh0qm3nwsFPq9ZrWsZL0K5wHT+XwkqqkxDhXLpYM2mYBf7iwvurLks+sOeAd4tCrwiwUA39w098Te9mxDUlZDeC/XME0dJg5NvioPEx7p/hQFL39/Z6BCXWNo3PL75dXF9gpfwB3sFsMQ== sidebar_class_name: "delete api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/delete-access-rule.api.mdx b/docs/docs/04-development/02-cache/02-restapi/delete-access-rule.api.mdx index d0bf963..6b7cf4f 100644 --- a/docs/docs/04-development/02-cache/02-restapi/delete-access-rule.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/delete-access-rule.api.mdx @@ -5,9 +5,9 @@ description: "Delete a given Access Rule" sidebar_label: "Delete Access Rule" hide_title: true hide_table_of_contents: true -api: eJztV1Fr2zAQ/iuaXrZBVqfd9pK3jXZQGGOU7mmUoNiXRJ0sudIpbWry33cnO42dpKyUsTDoU1Pr9Onu++6ku1oWEHKvK9TOypE8BQMIQomZXoAVn/IcQhAX0YAcSFSzIEc/pap0tjjO9MzEzEPADMEqi4FM+Ju8GshKeVUSkucNtQz5HEolR7XEZQV0TkCv7UyuBtLDTdQeCjlCH2EgLe0jgwaSEdmtSuGcjJ8DpFIIY08hhLEunoc4VSZsIHNnp9qXa6ibCH75XO8izp3X9yrx3wLOQRXgn4kYA/h3agYb8tZwV7wnVM4GCIx4Mhzyn34CnNup82VyRxlx0doLNSUtBc5BMJFCB1GkTGE+iQ7k4whLVZXRedqdXQcG3BOCm1xDzt5V3lXgUTfuBFQYwzh3BXSMbSwniYv1eklqUnh7KdFhDN4731mcOGdAMbVAUJSMScorMi4UPsErveFj98gHUNkWSiKnZUaEmD5OozHLV/Jq1dPsZw+Z/UFNoaEqqz3Rb23tUrVDTIeGNsguNrnBaB+Gx7vaX5K8v2Apli6KW/AgYqAoWWzrUHjI3czq+/9H8yeLnADGBaDSJuw5ZYv+vvkBtHu/q90X5ye6KOjOfie+OdG7VwYCNJWuT8IWurCvURABC11QYdu+rWhuC+GStV//2+aAtukO+AzK08cmf1+y4cDZ8GF/JfMxZEoXUfOWisJBoyLc6YDCsZakK70XC/AvKh5WxZM9NX0BGL0lAW/nVNcKEUpaohsZXfvIpGo0itRUnQfolqrdRUyLba8iUpMiUlv2IvVBpf647/p+kFpPk2xTIGAPTYV6EjP1XCQf1e10fRtTWU/My3N8UD0JjuacuSMw2dQkh8PDxUhmjw1KWd38WGXd6SSrt2aVFXuUbudmiorecDuPWIVRllCP4I48MXCUuzI1+NxUctC8p8ms4dHw6Dj5jYZ5OKdt4tP3c46o3/m3C+LU5YHfdmr/gF/81AcUsADjqpKzjGKuXMBSpeRq5452cuxPjL0T6k2a/mHObBRDuMOsMkqn1EnB1y21aQYly8XxeuZMsw2n0mYWHT3MkF1eeWF7JiTi5hQQ49b1RAX44c1qxZ+b2Y7JL3Roqm09DFKn3JsFF8pEdjvpsFBes/n+rY/S8uaiTc234jEe2o/KLrtnrt1pQ+bR8R+eus3niouwHTv/OgHNkb0xd0M9xd2sc0ZV3bWde5Fleijd07OvZ5dndDv8BiNj+CM= +api: eJztV1Fr2zAQ/iuaXrZBVqfd9pK3jXZQGGOU7mmUoNiXRJ0sudIpbWry33cnO42dpKyUsTDoU1Pr9Onu++6ku1oWEHKvK9TOypE8BQMIQomZXoAVn/IcQhAX0YAcSFSzIEc/pap0tjjO9MzEzEPADMEqi4FM+Ju8GshKeVUSkucNtQz5HEolR7XEZQV0TkCv7UyuBtLDTdQeCjlCH2EgLe0jgwaSEdmtSuGcjJ8DpFIIY08hhLEunoc4VSZsIHNnp9qXa6ibCH75XO8izp3X9yrx3wLOQRXgn4kYA/h3agYb8tZwV7wnVM4GCIx4Mhzyn34CnNup82VyRxlx0doLNSUtBc5BMJFCB1GkTGE+iQ7k4whLVZXRedqdXQcG3BOCm1xDzt5V3lXgUTfuBFQYwzh3BXSMbSwniYv1eklqUnh7KdFhDN4731mcOGdAMbVAUJSMScorMi4UPsErveFj98gHUNkWSiKnZUaEmD5OozHLV/Jq1dPsZw+Z/UFNoaEqqz3Rb23tUrVDTIeGNsguNrnBaB+Gx7vaX5K8v2Apli6KW/AgYqAoWWzrUHjI3czq+/9H8yeLnADGBaDSJuw5ZYv+vvkBtHu/q90X5ye6KOjOfie+OdG7VwYCNJWuT8IWurCvURABC11QYdu+rWhuC+GStV//2+aAtukO+AzK08cmf1+y4cDZ8GF/JfMxZEoXUfOWisJBoyLc6YDCsZakK70XC/AvKh5WxZM9NX0BGL0lAW/nVNcKEUpaohsZXfvIpGo0itRUnQfolqrdRUyLba8iUpMiUlv2IvVBpf647/p+kFpPk2xTIGAPTYV6EjP1XCQf1e10fRtTWU/My3N8UD0JjuacuSMw2dQkh8PDxUhmjw1KWd38WGXd6SSrt2aVFXuUbudmiorecDuPWIVRllCP4I48MXCUuzJLHT53lRw1b2pSa3g0PDpOjqNhIs5pn/j0/ZxD6rf+7YI4dXngx536P+AnPzUCBSzAuKrkNKOgKxewVCm72sGjHR37I2PvhHqTp38YNBvJEO4wq4zSKXdS9HXLbRpCyXJxvB4603DDubQZRkcPQ2SXWF7YHgqJuDkFxLh1PVEBfnizWvHnZrhj9gsdmnJbT4PUKveGwYUykd1OOiyU12y+f+ujtLy5aHPzrXiMh/ajssvumWt32pB5dvyHp27zueIqbOfOv05Ac2Rvzt1QT3E365xRVXdt52JkmR5q9/Ts69nlGV0PvwGd5PhS sidebar_class_name: "delete api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/delete-api-key.api.mdx b/docs/docs/04-development/02-cache/02-restapi/delete-api-key.api.mdx index 4fa31a9..e919206 100644 --- a/docs/docs/04-development/02-cache/02-restapi/delete-api-key.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/delete-api-key.api.mdx @@ -5,9 +5,9 @@ description: "Delete the currently used api key" sidebar_label: "Delete api key" hide_title: true hide_table_of_contents: true -api: eJztVk1v2zAM/SuCLrsEcbKPS24F2kOxHYahOwxFUCg2E6uVJVWi3GZG/vtI2WmTxofeggE9xZGoJ5KPIl8nK4hl0B61s3IhL8EAgsAaRJlCAItmK1KESiivxQNs5USi2kS5uJW0UrTzQm9MKgJELGg70j4vyOVEehVUQ2iBrTsZyxoaJRedxK0Huiti0HYjdxMZ4DHpAJVcYEgwkZbOkYFKWLug/6rsHAGzhzWoCoLcLflY9M5GiAz6eTbjn+Nwru3ahSafV0bs7QU6ocoH654MVBsQFQdNJsKthxBLZ5FiZ0DlvdFlhijuI6OOhOJW91AiHfTBeQioe58iKkzxrnQVHBjb1Kw4gsl+v4EY1QZGU6PjHYTgwsHmyjkDihMCBEW5XSsTYUnGlcJ3eKVfk3J65QuovKl1FBc/r8V32IpaRbECsH2uoJrK5e6IuNsjWHYGNcWFqvEjob85epink6wc5GCI8BCb3GC0r7P5Kfs3VMX7ALYuCUpDqyuq5cpBFNahgGcd8X/h+90EZ4C7ClBpE0dueZP9Y/MzUPfllLo/RFetWrCfkGiDSORwD7KCe4Loe8D0g7izEvdttONS8xdgS5eImNBzloHEU63NvtfaTR4xw+P84PHMPI48wF+AKVjiT68zVWsg4MDKgKZCcIlEAn3QiEeemnpop1ataKR+8HlGPgmORFftCEz2w5rDUVjT/2JUshXcU/kuCO1erKVgWGsh+rgosv0UnukOA9PSNVl98bzncPhMXzOz6Ww6zx6hgX0voDfOvp42CX78l66MgmQDS0yhLU/pQC2iBeN8w/VD0XgXsVG5bAZdOIjUV0V6hN69Ft/75GxPB8IzFt4onesix98NectSlyzb+V7dZu3JdTJI3pxByklNvrJ9161UhN/B7Ha8/JggbGmdPlsVND8S/kf3DGqWU87eLORFWYJn5FaZlEXw2+fDuX9h+PLqx9XNFRXRP9TZH8o= +api: eJztVk1v2zAM/SuCLrsEcbKPS24F2kOxHYahOwxFUCg2E6uVJVWi3GZG/vtI2WmTxofeggE9xZGoJ5KPIl8nK4hl0B61s3IhL8EAgsAaRJlCAItmK1KESiivxQNs5USi2kS5uJW0UrTzQm9MKgJELGg70j4vyOVEehVUQ2iBrTsZyxoaJRedxK0Huiti0HYjdxMZ4DHpAJVcYEgwkZbOkYFKWLug/6rsHAGzhzWoCoLcLflY9M5GiAz6eTbjn+Nwru3ahSafV0bs7QU6ocoH654MVBsQFQdNJsKthxBLZ5FiZ0DlvdFlhijuI6OOhOJW91AiHfTBeQioe58iKkzxrnQVHBjb1Kw4gsl+v4EY1QZGU6PjHYTgwsHmyjkDihMCBEW5XSsTYUnGlcJ3eKVfk3J65QuovKl1FBc/r8V32IpaRbECsH2uoJrK5e6IuNsjWHYGNcWFqvEjob85epink6wc5GCI8BCb3GC0r7P5Kfs3VMX7ALYuCUpDqyuq5cpBFNahgGcd8X/h+90EZ4C7ClBpE0dueZP9Y/MzUPfllLo/RFetWrCfkGiDSORwD7KCe4Loe8D0g7izEvdttONS8xdgS5eImNBzloHEU63NvtfaTR4xw+P84PHMPI48wF+AKVjiT68zVWsg4MDKgKZCcIlEAn3QiEeemnpop1ataKR+8HlGPgmORFftCEz2w5rDUVjT/2JUshXcU/kuCO1erKVgWGsh+rgosv0UnukOA9PSNUWWXzzwOR4+1BfNbDqbzrNLaGDfDOiRs7OnXYJf/6UroyDdwBpTaMtjOlCPaME433ABUTjeRWxUrptBGA4q9VWSHqF3r9X3Pj3b84HwjIU3SufCyAnohsRlrUuW7Xwvb7P45EIZNG9OIeWkJl/ZvutWKsLvYHY7Xn5MELa0Tp+tCppfCf+jewY5yzlnbxbyoizBM3KrTMoq+O374dy/UHx59ePq5oqq6B+5GR/5 sidebar_class_name: "delete api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/delete-derivation.api.mdx b/docs/docs/04-development/02-cache/02-restapi/delete-derivation.api.mdx index 83f95fa..3c02d0b 100644 --- a/docs/docs/04-development/02-cache/02-restapi/delete-derivation.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/delete-derivation.api.mdx @@ -5,9 +5,9 @@ description: "Manually delete a given derivation" sidebar_label: "Delete derivation" hide_title: true hide_table_of_contents: true -api: eJztV1FvGzcM/iuCXroBbs7Zuhe/tUgGBNiGoeieiiCgT7StTifdJMqNa/i/j5TOsa9ximAYZgzIk30S9YnkR0r6ttpgaqPtyQavZ/pX8Bmc2yiDDgkVqKVdo+fPaNdQjCaaYJn07KOG3jbry8YuXW4iJmoIPXhKbCJj+naie4jQMVCUBVud2hV2oGdbTZseeb9E0fql3k10xL+yjWj0jGLGifa8jg0qpCCKez3Qio2fBproRYgdEI/kbM03gA8R3bHdc/GfxoNMqxDtl32SCt4Kgff5h4g5YXwNSzyEv4e7lTWpDz5hEsQfppfyM6byxtdU8Bc4tbdXsGA2FK2wUlydbYMn2YdBoO+dbcuy5lMSpBO+h/knbMWtPoYeI9nqRyKgnO7aYPDI2OduXpKwn+8wJY7rZC5susMYQzyanIfgEMRNZCiuowW4hLdsbICe4ZU9JOJUwQyg+uqhIIbiNyrltmVfF5k7Qt/uRlR9HOGKN2Q5MIKuPxH7V0uPE/UoLUdJGEI8xmY3BO3NKco/MKt/4kZtQlafMaLKiWNUNikfiEugDUtvv6D5vzD+bIoLwJ1BAuvSiV2+Sv/Y/Azc/fiYu59DnFtj+Kx9rX4LanScTBRa7thYiDXW+FekOAFra7if/dhW1UNChWId959DDVhfWv8dQuTB4ax8qYbzVsOb050s27Apn0P1ElQmYGUR720iFYRL5pWviTXGFxbPyuJP0+ljFt8j5eiZQLtQ8iJSnyGp7GHuUFFQcq8srHOlJQe2J2qeqQyUHdWKmURvhGxBeJUUP6leWvbcZJ84wI/JFv4WyMB8B5cejSHza9pW9lRY7M9jLMXwciGfk0+GY4myCqaoAnn5STiiBGa6eUrjNNv6Z9cchAQPjlTFTtwph3NVPzk6ecQT9WnWFMgLvGc3HF60oSvPenlTSsSyppbV9GJ6cVmcJidJuJFz5O3vNxLO+L0/TKir0Ca52vn1h3Lhl2eAwTW60HdSYhxwHxJ1UCprUBtXVfCNhN5og+2hRJ8pEytrhPfU9A5sKZ+Sg+2Q3iIh2XJ9uZeMRdhIOR2k5OxBAh5lWsbHCo6Tt+KgBHS7nUPCP6Lb7WSYz9W44XH+u4ZopeEKHcam2nyzIii+Ee5374dy+149FdcwCH4j8YDL8sV/+Tl+ULGiA//DXccJ2klbDQryXw+/bjhSrA/uSNR1/i3Lqf547tFJJz3w0IxX179cf7jmfv8bqfrVww== +api: eJztV1FvGzcM/iuCXroBbs7Zuhe/tUgGBNiGoeieiiCgT7StTifdJMqNa/i/j5TOsa9ximAYZgzIk30S9YnkR0r6ttpgaqPtyQavZ/pX8Bmc2yiDDgkVqKVdo+fPaNdQjCaaYJn07KOG3jbry8YuXW4iJmoIPXhKbCJj+naie4jQMVCUBVud2hV2oGdbTZseeb9E0fql3k10xL+yjWj0jGLGifa8jg0qpCCKez3Qio2fBproRYgdEI/kbM03gA8R3bHdc/GfxoNMqxDtl32SCt4Kgff5h4g5YXwNSzyEv4e7lTWpDz5hEsQfppfyM6byxtdU8Bc4tbdXsGA2FK2wUlydbYMn2YdBoO+dbcuy5lMSpBO+h/knbMWtPoYeI9nqRyKgnO7aYPDI2OduXpKwn+8wJY7rZC5susMYQzyanIfgEMRNZCiuowW4hLdsbICe4ZU9JOJUwQyg+uqhIIbiNyrltmVfF5k7Qt/uRlR9HOGKN2Q5MIKuPxH7V0uPE/UoLUdJGEI8xmY3BO3NKco/MKt/4kZtQlafMaLKiWNUNikfiEugDUtvv6D5vzD+bIoLwJ1BAuvSiV2+Sv/Y/Azc/fiYu59DnFtj+Kx9rX4LanScTBRa7thYiDXW+FekOAFra7if/dhW1UNChWId959DDVhfWv8dQuTB4ax8qYbzVsOb050s27Apn0P1ElQmYGUR720iFYRL5pWviTXGFxbPyuJP0+ljFt8j5eiZQLtQ8iJSnyGp7GHuUFFQcq8srHOlJQe2J2qeqQyUHdWKmURvhGxBeJUUP6leWvbcZJ84wI/JFv4WyMB8B5cejSHza9pW9lRY7M9jLMXwciGfk0+GY4myCqaoAnn5STiiBGa6eUrjNNv6Z9cchAQPjlTFTtwph3NVPzk6ecQT9WnWFMgLvGc3HF60oWvKu14elRKyLKp1Nb2YXlwWr8lJFm7kIHn7+43EM37wDxPqKrRJ7nZ+/qHc+OUdYHCNLvSd1BhH3IdEHZTSGuTGVVV8I6U32mB7qNFn6sRKG+E9Nb0DW+qnJGE75LdoSLZcX+41Y1E2Uk8HLTl70IBHqZbxsYTj5K04KAHdbueQ8I/odjsZ5oM1bnic/64hWum4woexqXbfrCiKb4T73fuh3r5XT8U1DILfSDzgsnzxX36PH2SsCMH/cNdxgnbSV4OE/NfDrxuOJOuDOxJ1nX/Leqo/nnt01EkPPHTj1fUv1x+uueH/Bgc31fI= sidebar_class_name: "delete api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/deletes-public-signing-key-tenant-link.api.mdx b/docs/docs/04-development/02-cache/02-restapi/deletes-public-signing-key-tenant-link.api.mdx index 09c75bf..d9a830f 100644 --- a/docs/docs/04-development/02-cache/02-restapi/deletes-public-signing-key-tenant-link.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/deletes-public-signing-key-tenant-link.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the link between the public signing key associated with th sidebar_label: "Deletes public signing key - tenant link" hide_title: true hide_table_of_contents: true -api: eJztWN1vGzcM/1cEvawDnJyzdQ/1W4tkQNBhGLruqQgC+UT71OgkTaLsuIb/95G681d83YpimNEhTz5LFL9+JEVqLTWkOpqAxjs5kddgASEJbEBY4x7EFHAJ4MpCyFNrapHM3Bk3Fw+wEiolXxuFoMXSYNORRUjgeEkF01E5XXbqxifmBU45lCOJap7k5IMkumpxVZm5zRUdxooOJdrnBXk3kkFF1ZJekanXMtUNtEpO1hJXAUjrhJEUkpuRjPBnNhG0nGDMMJKOzhHBTqJhI4PChoi/hpHK2PhoPqnir55fA0pD/EqOOUG8UHPYq7dld8dnUvAuQWKOP4yv+OcYsFs387Et6igrtvQCvVD1g/N2CXoOQjOsRCL8jAEhSbUnhEgmMVQhEKyFRfUxMdcBO/z0I9SsYog+QETT6ZRQYU73tddwQOxyOy0O2e63kBLZOOgXk+4hRh8PNqfeW1DsXyBWhPlM2QR3RKwVfoFWZu+UU5E7pvL3g0AuHqKQTbmuSdlZtnYl7zZHuH04YszqoCHLULVhwPgnRw89deKXAy/0Nh7yJjWY28sh/N9TWrH+K5/FEiKInNgkk4TzSPFQe7LxE6nwjUD+xRgXBvcaUBmbBqQ8cf8x+Rmw+/EUu599nBqtqSJeiF8pYQ9ry0gA1VOIBVhttPsOqbD6hdFA5fSYVnQVQ/hCHbd/+xgwXfF+AyrSYhe/z9Fw5mh4OZzJLIZIqQ51N5bQHjoU4dEkFJ6xJFzpzlhAfEbxvCi+enWK4jvAHB23Q03fNc3Ngr5e/3Yr3lKd7pNSWeuXDLMXoA0Wwj3424vp7bdzVf9PMf5pPP4njLlJFeBqnx13qFydC1ehM1tUoM2BBMAzlmfGcuAO3mFpZgWpGRBjaqNKmY0+I3DK0gCC3Dv32Uu1eWqfe6qz4knsaCRsPDGTXfPO5vBkN5HV4EBZ9YNrte4u1w3LLRdpN1bmaHn6QgxpUpWzl/BI8ixc1r4t8xj3/2wan+niZ3w5vrwq2qFla2+5GlCxZ72PB7V+Q1z7OnEbRp06cHNWWjYNC7A+tBxLZFnwCVtVQqgfE7eD+cAMfrFtFnhgfyp3vQ/R/3q47+BHeMQqWGVKHBYfr3ucyuBPlIur7axfJl4+3D8A9NrQ16TnSyCQHOTD6/VUJfgj2s2Gl+nyjCtap8+FioYztMCqTeqydVKmyL/xz4t3fXx+Lz6nf7+oHF/MC2Uz/+v03T8zbDgV+in+X9egk3T0arDTg18guv3XNMWGw72T6sThvEug65tfbt7fUI7+BXsTWYQ= +api: eJztWN1vGzcM/1cEvawDnJyzdQ/1W4tkQNBhGLruqQgC+UT71OgkTaLsuIb/95G681d83YpimNEhTz5LFL9+JEVqLTWkOpqAxjs5kddgASEJbEBY4x7EFHAJ4MpCyFNrapHM3Bk3Fw+wEiolXxuFoMXSYNORRUjgeEkF01E5XXbqxifmBU45lCOJap7k5IMkumpxVZm5zRUdxooOJdrnBXk3kkFF1ZJekanXMtUNtEpO1hJXAUjrhJEUkpuRjPBnNhG0nGDMMJKOzhHBTqJhI4PChoi/hpHK2PhoPqnir55fA0pD/EqOOUG8UHPYq7dld8dnUvAuQWKOP4yv+OcYsFs387Et6igrtvQCvVD1g/N2CXoOQjOsRCL8jAEhSbUnhEgmMVQhEKyFRfUxMdcBO/z0I9SsYog+QETT6ZRQYU73tddwQOxyOy0O2e63kBLZOOgXk+4hRh8PNqfeW1DsXyBWhPlM2QR3RKwVfoFWZu+UU5E7pvL3g0AuHqKQTbmuSdlZtnYl7zZHuH04YszqoCHLULVhwPgnRw89deKXAy/0Nh7yJjWY28sh/N9TWrH+K5/FEiKInNgkk4TzSPFQe7LxE6nwjUD+xRgXBvcaUBmbBqQ8cf8x+Rmw+/EUu599nBqtqSJeiF8pYQ9ry0gA1VOIBVhttPsOqbD6hdFA5fSYVnQVQ/hCHbd/+xgwXfF+AyrSYhe/z9Fw5mh4OZzJLIZIqQ51N5bQHjoU4dEkFJ6xJFzpzlhAfEbxvCi+enWK4jvAHB23Q03fNc3Ngr5e/3Yr3lKd7pNSWeuXDLMXoA0Wwj3424vp7bdzVf9PMf5pPP4njLlJFeBqnx13qFydC1ehM1tUoM2BBMAzlmfGcuAO3mFpZgWpGRBjaqNKmY0+I3DK0gCC3Dv32Uu1eWqfe6qz4knsaCRsPDGTXfPO5vBkN5HV4EBZ9YNrte4u1w3LLRdpN1bmaHn6QgxpUpWzl/BI8ixc1r6tykDGAwDbxoe6ABpfji+vinpo2dxbLgdU7Vnx40mt3xDXvk7ch1GrDtydlZ5NwwKsDy0HE5kWfMJWlRjq58TtZD4whF9suwWe2J/KXe9j9L+e7jv8ER6xClaZEojFyeseqDL5E+Xiajvsl5GXD/cvAL029DXp+RIIJAf58Ho9VQn+iHaz4WW6PeOK1ulzoaLhFC24apO6dJ2UMfJv/PPiXR+g34vP6d8vKsc380LZzP86fffvDBvOhX6M/9c16CQdPRvs9OAniG7/NY2x4XDvpDxxOO8y6Prml5v3N5SkfwFihVmz sidebar_class_name: "delete api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/fetch-a-nix-binary.api.mdx b/docs/docs/04-development/02-cache/02-restapi/fetch-a-nix-binary.api.mdx index 7f46896..e625590 100644 --- a/docs/docs/04-development/02-cache/02-restapi/fetch-a-nix-binary.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/fetch-a-nix-binary.api.mdx @@ -5,9 +5,9 @@ description: "Fetch a nix binary" sidebar_label: "Fetch a nix binary" hide_title: true hide_table_of_contents: true -api: eJztVcFu2zAM/RVBpw1Ik6ztybdia4cCAzZk3SkoCsamY3W25Ep0msDIv4+UncXp0nbYYbssl1gkRfKRT2SrMwypNzUZZ3Wir5DSQoGyZq0WxoLf6JEmWAadzFttoUI2YqXe3o50DZ4FhL7ThrTACnTSatrUYhfIG7vU25H2+NAYj5lOyDc42jkitGCJIxiJXQMVbPwnjjL0ZgURw4GzW7kRamcDBvF3Op3K3yHmGVLjLWbK5IoK7HGrRwgqd41luY3ypVkhf8WcFbBchAH9Cj0bWwqKnAoEnlhqM844WuSmxLF6fzG7vPr2KVE3LNrlpEzgWvfxGCRCpVzelx98WnBEBpQ6y1FJMl+fsOqE7eXwbJ34N9Jn09PXsZpl2ewweMzRo00xqI1rBAxY9fVsp+ZzHtkxqFHuXSVnf5imhD9/rdQcQ2I+NBhI7amkHtmbqqDMna+40Qfwoa5Lk8ZGT+6DuDxSBbe4x1RYVXtXoyfT9Z47Q024S12GA2PbVAv0Qq1eX2EIsMSj7DPhDr13fqBcOFciWNFmQL+RRnRwlyGBKcOx3g1JPn9ifstaMpwiQVUfQfHk8hDyLwAHcPrch75vOxKdT89f7iIaaX/kRP8yPs/iaf8kVeaYUtaRwrUJ9L+j/7Cj7I6fWeHYmV5ixCKDMtGTtmvfdsIPe9Luu7eVOHECdFO+8SWbF0R1SCYTmR9jXLN/HnKpq+LINTZ3AkXudIyZjqfjdzEbKgXdtYydiy/XkucBtXYK9cGlMn69amRM2m5aZLjC0tWVcIeR1C5QBZEy/R44ur4OIrR78j2z7Lr6E65pUpdgIhEi6Lav1ZyXz25xySQe6WSwfxh/wXmJWdsuIOA3X263IuZJxxGSOX+uwBtYSCm4opkJ8s0tyaEM+ELCb2Y9Fd6q5zLthWAFywrKRk78+R03+4UrS/YvRh1UZyt8LxBYFLF3BhdpijUNru7XnPDpJ2M/Xt7wi/gBAn8EkA== +api: eJztVcFu2zAM/RVBpw1I46ztybdia4cCAzZk3SkoCsamY3W25Ep0msDIv49UnMXp0nbYYbssl1gkRfKRT2SncwyZNw0ZZ3Wqr5CyUoGyZqXmxoJf65EmWASdzjQL9e1IN+ChRkIvwk6HrMQadNppWjfIPgJ5Yxd6M9IeH1rjMdcp+RZH2vI9NiC0YIkdGwnZAJVs/CeOcvRmCTH1A2e3ciM0zgYM4u90MpG/Q6hTpNZbzJUpFJXYw1WPEFThWstyG+ULs0T+ijkrYLkIA/oleja2FBQ5FQg8sdTmnHG0KEyFY/X+Ynp59e1Tqm5YtMtJmcAl7uMxSIRauaKvOvis5IgMKHOWo5Jkvjph1Qnby+HZOvFvpM8mp69jNYuq3WHwWKBHm2FQa9cKGLDq69lOzecikmJQo8K7Ws7+ME0Jf/5aqTmGxHxoMZDaU0k9sjdVQ1U4X3OjD+BD01Qmi41O7oO4PFIFN7/HTFjVeNegJ7PtPXeG2nCXuRwHxrat5+iFWr2+xhBggUfZZ8Ideu/8QDl3rkKwos2BfiON6OAuRwJThWO9G5J89sT8lrVkOEWCujmC4snlIeRfAA7g9LkPfd9uSXQ+OX+5i2ik/ZET/cv4PI2n/ZNUuWNKWUcKVybQ/47+w46yO35mpWNneoERiwzKVCfdtn2bhB920u27t5E4cQJsp3zrKzYviZqQJonMjzGu2D8PuczVSZy5xhZOsMilLWUm48n4XUyHKoF3LXPn4su1JHrArZ1CfXCZzF+vWpmTdjsuclxi5ZpayMNQGheohsiZfhEcXVsHEbo9+55ZctsGEK4oaSowkQkRddcXa8bbZ7e5ZBSPdDpYQIy/5LzErOvmEPCbrzYbEfOo4wjpjD+X4A3MpRRc0twE+eaeFFAFfCHhN9OeC2/Vc5n2QrCCZQlVKyf+/I7r/caVLfsXow6qsxHClwgsiti3BhdZhg0Nru73nPDpJ2U/Xt7wk/gB0G8BqA== sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/finish-a-given-upload.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/finish-a-given-upload.StatusCodes.json index 77d2e1f..0b01e99 100644 --- a/docs/docs/04-development/02-cache/02-restapi/finish-a-given-upload.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/finish-a-given-upload.StatusCodes.json @@ -169,6 +169,34 @@ } } }, + "424": { + "description": "The given nar fingerprint is invalid (i.e not signed by a recognized key)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { "type": "number" }, + "status_message": { "type": "string" }, + "is_error": { "type": "boolean" }, + "data": { + "type": "object", + "properties": { "error_details": { "type": "string" } }, + "required": ["error_details"] + }, + "timestamp": { "type": "number" } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, "500": { "description": "Iglu encountered an error finishing the upload", "content": { diff --git a/docs/docs/04-development/02-cache/02-restapi/finish-a-given-upload.api.mdx b/docs/docs/04-development/02-cache/02-restapi/finish-a-given-upload.api.mdx index 6ea9b61..3c7f359 100644 --- a/docs/docs/04-development/02-cache/02-restapi/finish-a-given-upload.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/finish-a-given-upload.api.mdx @@ -5,9 +5,9 @@ description: "Finish a given upload by uploading cachix meta information about t sidebar_label: "Finish a given upload" hide_title: true hide_table_of_contents: true -api: eJztWFFv2zYQ/isEX9YCTuRkGTD4rW0aLA/Lijh7CoyAFs82O4nUSMqJa/i/746UIsmW06DI5j04D4FMHo93991H8m7NJbjUqsIro/mIXymt3IIJNldL0KwsMiMkm66qL6XnLBXpQj2xHLxgSs+MzQUtZmJqSs/8ApgEq5ZhkA+4F3PHR/dcFCpZniW0GnA4auGTAS+EFagMLImtucP5XPDRmvtVAWiS8xa35ZsBt/B3qSxIPvK2hAHXuA4FPGihPepU5EEh/AKFf0RRqeQbaBGlXxirvtUBCPoWIDAqP2qXA3si5tA4WaubxDXg/EcjV6SzC+fvrwRpe+PUaE/boUJRFJlKg2Dy1ZHWHhfM9CukZF1hTQHWK3A0q4W9xs0/WRAevi+eXpJN6FdfbNIrlcFvwi32z47Vt/YuusynIeY8vRF2/1Kc3L/yFmZgQafRwmpeWCtWhIWH3PUopYVjNe/fbuyNfcGRMD0uZzNkR6/mBqv7JmLt+LSj0fK95WnXr8rYjmlbhkw2gaf+NUHYAy7cif6AkN6bGPBdBLb8DUo6SyabbZlu0tV2k1wQdIXRLpp0PhzuUuZzXvgVc2WKoXGsludtTpCii761t+BLq0EyNWMrU1o2RVayR+GYNh55GIiXGmsxQCySkr8Z2ZwXvnQPqZH9qVzN5+gWniW9UCj3ANaaNhBTYzIQmmal8K8wIyh4kHjwqGwPNzqIdsQpz7xCE73Ii++nQ9vlHQdb7lS2t3VX+XAxPNuF8Q5R+gtWBCF7RJaw0tHFpyKMCJ6Za6SRPGJ3YOx+3sXuytipkhLfLifsxrDOZTxgoJCBNgArldQ/eYYBWCoJTOiuLItXLDM2Mrn6qTpU/gjC4uCRyf+LbLjoZ3L1QMJTOT4UmTQQUYQn5TwzhCXiio+s6iY9onhAFH99+Vol2lVVyfVl7wnNMqPnyMqlyJRk72gLyfDV+/4I7WGhPT/vJ2in1ERQ6/fSzJT6eMceFrRf+p651/OsZFg7ID5YtiO78PIMitgstA+Iig1PjwgeEEFUlwM+ayT1NIwLzlBrY8STdkMmWce7cZPkZeYVlUwnWEcl61LJTZKavMggFFPxkoydmtJm1IrwvnCjJFGYFKfwJEj0FFeE5gQhfNs0KD7H6d7WQFP814Hs1Pxbg7FgH7ZL+5bEc0U/3Krg72uhSV2ht1a1CvPt0boe3ypbYxxiZdssaRe0ww0BTh0Y8pFCFyk0PB2engW4PMUjUurDl2sCcpdrOMEuTeropYlXHdD7M7xKJSwhM0VO5CKbEOFc6Bjf0Drq7edtb7JuCPpvNABjgnt48kmRCRWYFnJnXeViaA6i5PKsagxSpo2e23qdlKSZ2Kd7zkrEckGpjXrW66lw8KfNNhsaxsSzKxzHz6WwSkwp1oiYVI6+kRQzkTl4IRzvbisyvmf7XKnbIZqaIfjoKOkXfmIF2TQnqfH3H+5KEQqZVzUK39zpapt2Y/LZCPI1zn+KKk/uSEUjsXMHNCs+pCkU/kXZSetI+/LH+A6Fp1XzMw83A7fikXqa+D+ExAQXw0kdxtY8E3pehiuCR5309w97OQpA +api: eJztWE1v4zYQ/SsEL90FHMtJU6DwbXezQXNoukjSU2AElDi2uZVIlaSceA3/986QciTZcjZYpHUPziGQyeFwZh4fP96KS3CZVaVXRvMxv1RauTkTbKYWoFlV5kZIli7rL6VnLBPZXD2xArxgSk+NLQQNZiI1lWd+DkyCVYvQyAfci5nj43suSpUsThMaDdgcvfDJgJfCCnQGlsxW3GF/Ifh4xf2yBAzJeYvT8vWAW/i7UhYkH3tbwYBrHIcGHrTQHn0qyqAUfo7GP+KoUvINvIjKz41V3zYFCP7mILAqPxqXA3siZtAkuXE3iWPA+Y9GLslnF87fXwnS9sSZ0Z6mQ4eiLHOVBcPkqyOvPSmY9CtkFF1pTQnWK3DUq4W9wsk/WRAevm+eXVBMmFdfbbJLlcNvws33996qb+1ZdFWkoeY8uxZ2/1Ds3D/yBqZgQWcxwrpfWCuWhIWHwvU4pYG3atY/3a039oVEQvdtNZ0iO3o9N1jdNxVr16ddjVburUy7edXBdkLbCmSyDjz1rynCHnDhTvQXhPxex4LvIrCVb3DSGTJZb9t0F90mbrILhq402sWQzkajXcp8Lkq/ZK7KsDSObex5mxPk6Lxv7A34ymqQTE3Z0lSWpchK9igc08YjDwPxMmMtFohFUvI3I5vzwlfuITOyfynX/QWmhXtJLxTKPYC1pg1EakwOQlOvFP4VYQQHDxI3HpXv4UYH0Y45rTOvMEQvivL7y6Gd8k6CrXTq2Nu+6/VwPjrdhfEOUfoLlgQhe0SWsMrRwacijAiemWmkkTxid2Dsft7F7tLYVEmJd5cTdm1Y5zAeMFDIQBuAlUrqnzzDAiyUBCZ015bFI5YZG5lc/1QdKn8EYbHxyOT/xWo472dyfUHCXTleFJk0EFGEJ+U8M4Ql4oqXrPokPaJ4QBR/fflYJdrVr5Kri94dmuVGz5CVC5Eryd7RFJLhrff9EdrDQnt21k/QzlMTQd3cl6am0scz9tCg7dlVI2h412ZTRXQrMXpPBFS6Jp4aQoDRqRlxN10y0bo70QXryMjDgvtL3xvmapZXDB+GSD6PO6ukm1FwREArN6d9ttmEjwgeEEF0VwDeWSUJVsaFZEi3GvOkrbYlq3jxWSdFlXtF7+ETJG6yqpRcJ5kpyhzCSznegKIMV9mcdCbvSzdOEoWLYghPgkyHOCIJ0hNBfNPIT59jf6/w00g7m0p2FJ2txijHjNrCTcviWa8Zbekz9xujyUZ/aY1qyS7brRu1ZUuUiIWIukUzpC1XjNaEOOlrlCPVLnJoNBwNTwNenuoROfXhyxUhuUs27GAXJnP0jsCLDNDrIrw5JCwgN2VB7KKYEOJC6FjfIAz2qrXbk6wahv4b8m5c4R6efFLmQgWqhcWzqhdjkH7RcnFay7601MbPom1nTVJPVGGflyViOae1jX5Wq1Q4+NPm6zU148KzS2zHz4WwSqRUa0RMKkffyIqpyB28UI53NzUb37N9qWzELk1SF55sFf3CTzy+GumZZN3/cFaqUFh5tQz85knX07Rl5+cgKNfY/ym6PLkjF43FziHQjPiQZVD6F20nrT3tyx+3d2ic1tJ2EY4GbsUjKdb4P5TEhBTDVh3aVjwXelaFM4JHn/T3D408sw8= sidebar_class_name: "post api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-a-tenant-in-cachix-format.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-a-tenant-in-cachix-format.api.mdx index 177fb2d..4880008 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-a-tenant-in-cachix-format.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-a-tenant-in-cachix-format.api.mdx @@ -5,9 +5,9 @@ description: "Get a tenant by its id in the cachix format" sidebar_label: "Get a tenant in cachix format" hide_title: true hide_table_of_contents: true -api: eJztV1FP2zAQ/iuWX7ZJHS0b2kPfGGwITZvQAGkCIeTER2uW2Jl9KZSq/313dgoJDWhDSLzw1MR3vvvO3+frZSE1hNybCo2zciz3AIUSCFZZFNlcGAzCaGGswCmIXOVTcy0unC8VyoFENQlyfCpVZYazzSGbgZaTmzwbyEp5VQKCZ7eFDGQvlRwvJM4roHQBvbETuRxID39q40HLMfoaBtLSPnJISCimYXSVwik5PyWQqnHqvLlRsdAm3hSUBv/EiHUA/15N4A7eKtwZ7wmVswECR/wwGvFP96R32mcprgxOxSoRHXdaTlBzZ5GzUAhVVYXJo2F4GThOD3KXXULOoCrvKvBoEooJpaizY0KdCuip1ISDOqMELWPmXAHKsvXBbZSkNCGYhGfd7OECPNW140p6jo7fgejQ6+4DCbYuWVO/Tujl5PBoV55xjIjr0EwseX2DeejNVHvzAAJD3OO8x9jh9/T+IbWOpKm/U+2jtfWBThBbgM6WS4awNdpcV8gR3bjfMBdzV4sr8CDqQHGECcI6JLHkjgLfgH4+iQRUWIfz3Ok20URIFm/Jyl5SnST8ByR0TufhfL+EtMJ/gBEDnGtAZYo+ou9x1nVntaAhiKjKqqeKe5vbJa8V2Cqnwd6Ofcvdx3XuvjqfGa3BivfihxOd7jMQQCoDH4nVRts3KOgAZkaDULbrK1JPES56+9Vro4GmLX8G5Wnxti2/quEl1bDVf5M5DblSd2/+XbWDxCJcm4DCMZfEK7WeGfhXFl+YxU99LBI9cadweV7zH3UGuaI5IA1HhYE2rVM1SwYeFEQcFFbXN8DrNX1Jgilc2QwgchK5iJPlWA7bk+xwkW7qknPEW5mm2NoXPOwhVmE8HJpJUW/ANcUuYCN3ZRz/eIDjMnhPEs9oY7SxGZFgwZXt0zaxfbDPGDsqWxnErssD93TWD3f62P81zKBwVcm64cHGBSxVlEszlXYGeNp1f2TvJFvcafB/J//ED8I1DqtCGZvGr4JjprOMXwXkOdtsvgiYmXEzz9MRTQk6ey0WmQpw7IvlkpepSXqa007pcaa8URmfFh26NoGfibELVQR4pJC3PxulvBMPAW0WlZ0zQFXU/EaPNG3dfXMsWZTNSP/sCFKmzifELQ7+HEn27TyHqm1b6xMstlsp7305oqvyF0Ap01I= +api: eJztV99P2zAQ/lcsv2yTOlI2tIe+7SdC0yY0QJpACDnx0ZoldmZfCqXq/747O4WEhmlDSLzw1NR3vvvuvs/OZSk1hMKbGo2zciJ3AYUSCFZZFPlCGAzCaGGswBmIQhUzcyXOna8UypFENQ1yciJVbbL5dsZmoOXkJk9HslZeVYDg2W0pA9krJSdLiYsaKF1Ab+xUrkbSw+/GeNBygr6BkbS0jxwSEoppGF2tcEbODwmkGpw5b65VLLSNNwOlwT8wYhPAv1ZTuIW3DnfKe0LtbIDAEd+Mx/zT7/THbi/FpcGZWCeidqflBLVwFjkLhVB1XZoiGrKLwHEGkLv8AgoGVXtXg0eTUEwpRZMfEepUwEClJuw3OSXoGHPnSlCWrfduoySVCcEkPJtmD+fgqa6PrqLn6PgNiA696T6SYJuKNfXzmP4cHxx+kqccI+I6MFNLXl9hEQYzNd7cg8AQ97gYMPb4PbnbpE5L2vp71f61tiHQCWIH0OlqxRB2xtubCjmkE/cLFmLhGnEJHkQTKI4wQViHJJbCUeBr0I8nkYAKm3BWON0lmgjJ4ylZ2yuqk4R/j4TOqB/OD0tIK/wHGDHAmQZUphwi+g5nfXdWCxqCiKqqB6q4s7lb8kaBnXJa7N3YN9y93eTui/O50RqseC2+O9G7fUYCSGXgI7HaaPsCBTVgbjQIZfu+It0pwkVvv/7baqC9lj+A8rR4cy0/q+Ep1bAzfJI5DbnS7d6+XbWDxCJcmYDCMZfEK109c/DPLD4xi++GWCR64k7hiqLhF3UOhaI5IA1HpYEurTM1TwYeFEQcFNbHN8DzMX1Kgilc1Q4gchq5iJPlRGbdSTZbppO64hzxVKYptvElD3uIdZhkmZmWzRZcUewStgpXZXH+4wmO6+BNST3jrfHWdoSCJZe2R/vE+/09BtmT2dogPrki8KXOAuKrPr4ANMyhdHXFwuHJxgWsVNRLO5b2JnjadXdm7yVb3orwf0f/RBDCFWZ1qYxN81fJMVMz42cBec63208CpmbSDvTUohlBZ6/lMlcBjny5WvEy3ZKeBrUTepwrb1TO3aKuaxP4mSg7V2WAvxTy8kcrlVfiPqDtorILBqjKhv/RI41btx8dK1ZlO9M/OoKUqfcNcYODv0eS/X1RQN21bVwULLYbLe9+PqSz8gezudOB sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-access-rule.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/get-access-rule.StatusCodes.json index 1287925..575e3b7 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-access-rule.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/get-access-rule.StatusCodes.json @@ -25,7 +25,11 @@ "preferred_compression_method": { "type": "string" }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -36,7 +40,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, "ip_block": { "type": "string" }, diff --git a/docs/docs/04-development/02-cache/02-restapi/get-access-rule.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-access-rule.api.mdx index 4d92c99..0eca24e 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-access-rule.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-access-rule.api.mdx @@ -5,9 +5,9 @@ description: "Get detailed information about the Access rule" sidebar_label: "Get Access Rule" hide_title: true hide_table_of_contents: true -api: eJztV1GP2zYM/iuCXrYC6Tm3dS95u2Jr0ZdiOHRPh4MhW0yi1pZcicruGuS/j5ScxM45bXcodhhwT3EkiiL5kRS/rdQQam86NM7KhXwLKDSgMg1oYezS+VbxllCViyhwDeKqriEE4WMDciZRrYJc3EjVmWJzWZhVEwsPAQsEqywGEuE1eTuTnfKqBQTPB7Yy1GtolVxsJd53QHcH9Mau5G4mPXyOxoOWC/QRZtLSORLIKlkjm9opXJPwYxSp5ELJLoTS6B+hMeLaefMlBWuvbw1Kg3+kxhjAv1QrODq8V3fLZ0LnbIDAGn+Zz/lnDOR1LyFqZwlOS5cl9NQIPd7kG+i46rrG1Mn+4mNgHRNWu+oj1GxQ510HHk22IKDCGMraaRgI29hWyf39fks3k0eTUTChBO+dH2xWzjWgOJpAqihnlqoJcEvCWuF3WEXATt3UJ2Y52v53KlYG17EqGaKM1oTM2Q1S35oQTA7xVCC6WBEUE5Hg0x6WFCjQFO2W/iRFFFlKv2lbozfTZnhDCYv3k4AhNhPro2S9kalwTkPROz5yc+jUNzzI9g6sy7Yw6KYrq8bVnya9oQzzWJpu0huw+tzWV6OgapxE6ZCQUlO2yFnqJx0mK8/APhW6QSIOvBv4crB8FI/eqv4qvhMNVRaqdsrFk4uHlfqgLgdV2NfYUPftbsfaXs0vH3abD9RZPsG9uHdR/A0eRAzccEwQ1qHwULuVNV9A/19aznf3mKSgzC9m+DbuY/EnwO7Xh9i9cb4yWoMVL8V7J0Yv2UwA1Tf4BKw22v6EggKwMZpeEjuWFfl9Ei5J+/3fPgeMTc/Pa1CeFvNc8ZwNT5wNr6Yrma8hUZoAc4sS2kFGEe5MQOEYS8KVev4G/DOKT4rib1M1fQ0YveURfpnKbgmkmNpygs3TJA9clzSQE5jLfYkS1lXz3KOfFE9St5/l5AqSL0xKFrI4R7CKbf7YFUNWU2xPOM6OzUn1mtlX9A1TCsQuLIqk9QLuyIwGLmgsSySD6R97zGdyWs0v5heXyWhsOAjv6Ji4+vMduzPKv/2G+N3Vgbs9DQTAb0B6GTRsoHFdyynGM5gL2KqUWT33YRba08zrTFRG6rfHBH0EYc34Idxh0TXEjPKQnObdHOtEZklyc7knr4lw4XFko6/FgYwOA80bp+SSIrkmD1nvdlupAH/5ZrfjZeqynibPG/rcKG+4+hI22oRciYvEeL7i/c/Xfe69EOdc6xeV5dlxo5rI/+iTxrUjpWaK+h/eehqiHVdZT29/eADylSM6fTCI/c77V3mEP+49aHxcEofafPvHB6r9fwCDhQR4 +api: eJztV02P2zYQ/SsEL20BZ+Vt04tvG7QNcimKRXpaLARKHNtMJFIlR+5uDP/3zpCyLdl0ki6CLgrsSR8khzPvzZDztlJDqL3p0DgrF/ItoNCAyjSghbFL51vFQ0JVrkeBaxA3dQ0hCN83IGcS1SrIxZ1UnSk214VZNX3hIWCBYJXFQFP4n7yfyU551QKC5wVbGeo1tEouthIfO6C9A3pjV3I3kx7+6o0HLRfoe5hJS+toQjLJFtnVTuGaJj/FkIohlBxCKI3+FhZ7XDtvPkWw9vbWoDT4J1rsA/hXagXHgPfm7nlN6JwNENjij/M5P6ZE3g4zRO0s0Wlps8iemrDHg7wDLVdd15g6+l98CGwj47WrPkDNDnXedeDRJA8CKuxDWTsNo8m2b6sY/n68pZ0poiwKJpTgvfOjwcq5BhSjCWSKcmapmgD3NFkr/AqviNjcTkNilpPhf2diZXDdVyVTlNjKzLk4QOZbE4JJEOeA6PqKqMggwas9LAko0IR2Sx/RECFL6Zf3tfcm74Y3lLD4mCUMsckTaVacSRf3O1Al68ak1CWMNrT4fjdJ9TsZy+4UyAG2CUhjSL4Qf4p2FFuK5MxvziHTlVXj6o9ZcChhPZamy4IAVl8a+iyoqsYs6UfQNCWfnMXjqcPo5YUsymE5yutRdKNYDp5PABq8GrbiPdFQoaJqcyGebDwu/LMyHxX1ULJj25QQbO31/Pr88HpPB9VHeBSPrhd/gwfRBz6/TBDWofBQO6LzE+j/ywn21UdWNFCmCzh8mffp9Gfg7qdz7n5zvjJagxWvxO9OTC7GmQAqePCRWG20/Q4FAbAxmi4mO50r0nUnXJzt959DDhgbb7M3oDz9TG3KSzY8cza8zlcyb0NTqaFMR5TQDhKL8GACCsdcEq/DTfHC4nOy+HOupm8Be29ZESxj2S2BDNOxHGnzJAyA65L6eyJzuS9R4rpqXs7oZ+WTzO1bNbmCGAtrnIUsLum1YptedsVYJBXbE8m0O3R2Scz1vmGFgtiFRRGtXsEDudHAFfVpRRQtLCc5ZF6U8mp+Nb+6jl5jwyi8o3Xi5o93HM8kAfcD4hdXBz7uqSMAvgTi1aBhA43rWs4xbsJcwFbF1Bq0FKvaQbbeJuEzMb89ZugTBHAiEOEBi64hpZWa7tg/J7CjOKaZm+u9GI4CDo89G70tDuJ2jDQPnIpVQnJNEbLd7bZSAf70zW7Hv+mY9dR63tHrRnnD5RfJ0SakUlxEBfWZ6L+/HZLvB3EptOGnstw8blTT8xe9Ur92lOgsef/DXU8h2nGZDXL5mwOQtpzI84NDHHcav0k9/HHs7OTjkjgU59tf31Px/wPTMSBT sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-available-signing-keys.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-available-signing-keys.api.mdx index 71bf027..f70c19a 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-available-signing-keys.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-available-signing-keys.api.mdx @@ -5,9 +5,9 @@ description: "Get information about signing keys associated with the tenant" sidebar_label: "Get available signing keys" hide_title: true hide_table_of_contents: true -api: eJztV8Fu2zAM/RVBl21AFidbd8mtw7ail2EoulMRBIrFxOpsyZPotGmQfx8p22ncuCvaDSsG9BRHIimSj6SeNlJDSL0p0TgrJ/IEUBi7cL5QvCLU3FUogllaY5fiB6yDUCG41CgELa4MZgIzEAhWWZQDiWoZ5ORCqtIkq3FilnmVeAiYsCrt84KcDmSpvCoAwbP0RoY0g0LJyUbiugTyI6CnA+V2ID38rIwHLSfoKxhIS3oksDvRsNulwoyEn2JIVZg5b25ivK29DJQG/0SLVQD/Vi3h1r3W3JR1QulsgMAW341G/NOF4KyREKmzqExMvMrzB0Bo08FKfDKZVWWZmzTGlVwGtt0TjZtfQsqKpXcleDS1ZwEVVmGWOg17wrYq5jEt7X4BIVCkvdkxYQbeO7+3OXcuB8VZBjJFyC9UHmBKwlrhvlfKe7Xm7CEU4WFvje71gDLVu07FOeMszjp6j7OdqZD1btRFcLDRKZcLttrYaDSmj1Pl0LqB7OyQOBoCBlVR9mB3x9o+0Aew7oHYQLRvm45ia0ej8WERn9NQIM/E2lXiCjyIKnDtmiCsQ+EhdVTMN6D/l4o9LNF73IgGZhqoc/PwMJhd8em/x+79IXZfnJ8brcGKt+KrE50BORBA4wZ8BFYbbV+hoASsjAahbFdW1GNPuCjt279NDRgbb46PoDwt1jfOSzU8czUc9XcyH0OidNnU94zQDmoU4doEFI6xJFzp4luBf0HxWVH80NfTZ4CVtwSgWcS2WwAZprEcYfPE8YD7klgZgbloW5SwnucvM/pZ8SRzxJMzR8bkEmIszHUnMuml2EnDEpNN3albPjR2ZU20K58zH0UswySJukO4psNyGKauiAyV6T/HxTp18YyGo+E4uoY5h3pKauL42yk73amydkN8cmngmU7XPvCkj/NfwwpyVxZcSBRW6QIWKtZPQ5z58aFWlGUuuw7fvXvS5rYi//zJUuOHcI1JmRPhZudinjZNruNzhiRX4/YFE3k81jyMnWtOo69JY5cSmVGArLzZzFWA7z7fbnmZRqknXnpBnyvlDccaodEm1O02iaz4NxG/PmsK7I24z/+WR1umiSuVV/yv4Y27x9OWa7l5m/x1D+qTOm+hnR/8rqr3j9MUyv29g/HCJbnrgJPP59RhvwDanCJK +api: eJztV8Fu2zAM/RVBl21AFidbd8mtw7ail2EoulMRBIrFxOpsyZPotGmQfx8p22ncuCvaDSsG9BRHIimSj6SeNlJDSL0p0TgrJ/IEUBi7cL5QvCLU3FUogllaY5fiB6yDUCG41CgELa4MZgIzEAhWWZQDiWoZ5ORCqtIkq3FilnmVeAiYsCrt84KcDmSpvCoAwbP0RoY0g0LJyUbiugTyI6CnA+V2ID38rIwHLSfoKxhIS3oksDvRsNulwoyEn2JIVZg5b25ivK29DJQG/0SLVQD/Vi3h1r3W3JR1QulsgMAW341G/NOF4KyREKmzqExMvMrzB0Bo08FKfDKZVWWZmzTGlVwGtt0TjZtfQsqKpXcleDS1ZwEVVmGWOg17wrYq5jEt7X4BIVCkvdkxYQbeO7+3OXcuB8VZBjJFyC9UHmBKwlrhvlfKe7Xm7CEU4WFvje71gDLVu07FOeMszjp6j7OdqZD1btRFcLDRKZcLttrYaDSmj1Pl0LqB7OyQOBoCBlVR9mB3x9o+0Aew7oHYQLRvm45ia0ej8WERn9NQIM/E2lXiCjyIKnDtmiCsQ+EhdVTMN6D/l4o9LNF73IgGZhqoc/PwMJhd8em/x+79IXZfnJ8brcGKt+KrE50BORBA4wZ8BFYbbV+hoASsjAahbFdW1GNPuCjt279NDRgbb46PoDwt1jfOSzU8czUc9XcyH0OidNnU94zQDmoU4doEFI6xJFzp4luBf0HxWVH80NfTZ4CVtwSgWcS2WwAZprEcYfPE8YD7klgZgbloW5SwnucvM/pZ8SRzxJMzR8bkEmIszHUnMuml2EnDEpNN3albPjR2ZU20K58zH0UswySJukO4psNyGKauSCJFZf7PgbFSXT2j4Wg4jr5hzrGekp44/nbKXnfKrN0Qn1waeKjTvQ886uMFoGEFuSsLriSKq3QBCxULqGHO/PpQK0oz112H8N49aXNbkn/+ZqkBRLjGpMyJcbNzMVGbJtnxPUOSq3H7hIlEHmsixs41p9HXpLFLicwoQFbebOYqwHefb7e8TLPUEzG9oM+V8oZjjdhoE+p+m0Ra/JuIX581FfZG3Od/S6Qt88SVyiv+1xDH3etpy8XcPE7+ugf1SZ3H0M4PfljV+8dpCuX+3sF84ZLctcDJ53NqsV+VWCJ5 sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-available-tenants.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/get-available-tenants.StatusCodes.json index 86d5247..8701f75 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-available-tenants.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/get-available-tenants.StatusCodes.json @@ -30,7 +30,11 @@ }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -41,7 +45,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] } } diff --git a/docs/docs/04-development/02-cache/02-restapi/get-available-tenants.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-available-tenants.api.mdx index 6ec26e2..b2714ad 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-available-tenants.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-available-tenants.api.mdx @@ -5,9 +5,9 @@ description: "Get all Tenants your api key has access to" sidebar_label: "Get available tenants" hide_title: true hide_table_of_contents: true -api: eJztVk1v2zAM/SuCzlmc7OOSW4EOXTFgGIb2VASFbDOxNtlyKSpoFuS/j5TjzWlctNulGNCTbYkiH/ko8+10CaFA25L1jV7oCyBlnFNX0JiGgtr6iMq0Vv2ArapMUKYoIARFXk80mXXQixvN+9lmntm1ixlCoIyNA+/Lgl5OdGvQ1ECAYr3ToaigNnqx07RtgYMGQtus9X6iEe6iRSj1gjDCRDd8jg1MpMqj/WkSSnYsUCswJaDeL+VYaH0TIIjTt7OZPI7z6vJRl+ecQVMqRmOUbVYe6+RTmdxHUlRBSjQGKHlbSVxoyBZ94MI3xAvi37StO2xk34MEGcnM59+hID7Yom8ByXYQAxmK4bbwJQyMm1jnktCk36+50mYNo5Wy4RYQPQ42c+8dGIEJ7IpLvTIuwJKNS0PPQGXL00gT3dWIV2Jkg33PyQgk6npmsGcQzVb4IqjDvwFgv2tLVcxvmRR8NPajG+y+tiHYjqCxMrYxZyJH6iinEVZcZiiZq5o/kiPmhdtxHGtEOw4DLTcwbUfpJnIj60fX4UaKc1qKQ+JHaQ6TeiKDDu8AXYdluR8NfgjV0yyNRZZ7lEzdPo1/2PMnHT7o50O3Dn0LHvb2fjY/vdjXTf9z4Cv7Rn3m29t4UgiFXzey+L/c2mdf0+TgtuQ/mHVhJMqDuh+bvwBp754k7YtXZ/ytPqU/upIuZbpeqXth6j6MUfcNKGIj43GVxuUK2DECv9ugkIcoKH7hiU/Kr+RVbiP/MXL3yueL8snu+rml15ByMVTxRzYq3zK5oRIIcNMLt4hOdBdRGxZZsp/CPQdwMOXhkpSYaCrJRc50DTObzqbzBIecpHfJx9TZ10sBetRZ/YY690VQLDtEhokKSxq0hA0439bSPDJPfaDapJ45aMSkXDdcWWk11Q+pB0F2fxrwL6Vuxw3BPWWtM7bphn2a210dkwxmy828V75Jl0qhD3I4VZRrVDF2sd/tchPgGt1+L8t3EZD1wQ2/bgxaSUO+OM5B6QoF7IphnDGyVjxvjItJaD28S8LFb7ovPl5xO/0CLkUpJA== +api: eJztVk1v2zAM/SuCzlmc7OOSW4EOXTFgGIb2VASFYjOxOtlyKSpoFuS/j5TjzklctNulGNCTZYkiH/ko6W11ASFH25D1tZ7pCyBlnFNXUJuagtr4iMo0Vv2EjSpNUCbPIQRFXo80mVXQsxvN69l6mtmVixlCoIyNA6/LhJ6PdGPQVECAYr3VIS+hMnq21bRpgIMGQluv9G6kEe6jRSj0jDDCSNe8jw1MpNKj/WUSSnYsUEswBaDezWVbaHwdIIjT95OJfA7zavNRl+ecQV0oRmOUrZceq+RTmYWPpKiElGgMUPCykrhQk827wLmviSfEv2kat1/I7oIEGcjML+4gJ97YoG8AybYQAxmK4Tb3BfSM61gtJKFRt15xpc0KBitlwy0geuwtLrx3YAQmsCsu9dK4AHM2Lgy9AJUtTiONdFsjnomRDXYdJwOQqO2Z3ppBNBvhi6AK/waA/a4slXFxy6Tgk7GfXGD3lQ3BtgQNlbGJCyZyoI6yG2HJZYaCuar4JzliXrgdh7FGtMMw0HID02aQbiI33AZ2VfP+J+M9Eq1zZ6UteQvgmjfPdweH6UZKe1rIfdkOitQvyTP5t9n2cmszOcHNYIbQ7GN3XSN9SpZbnkzVDJTjyEX/CJ0cmN7x2Dd/37fgYW8fJ9PTe+K67u4avgHeqa98GdSeFELuOSee/F8ugRef+uTgtuAL0bowEOWo7ofmr0Dah2dJ++bVGf+rL+mBUNK2TNcbda9M3ach6n4ARazltV2m13cJ7BiBxzYo5DcZFA9YQJDySxnKaeQbY+He+HxVPtld9yzpFaRcDJX8kw2qwUxO6OP71OrAiE5kHFETZlmyH8MDB3Aw5tcmS8pONJokI5vajpmMJ+NpwkNO8rvkfers+6UgPWitbkGd+zwoljEi60TVJU1bwBqcbyrpHnmffaDKpKbZa86khNdcWuk11b1SR0G2fzrwL6VzSw7BA2WNM7ZuxUPSAW0hk6xmy/W0U9JJ50ql9/I6lZRrVDJ2sd9uFybANbrdTqbvIyDrjRserg1aSUP+OM5eOQsH7IphnDGyRjyvjYtJuB0fJuHike+Lz1fcT78BuHZE/w== sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-deployment-overview.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-deployment-overview.api.mdx index 46ead89..f66e75b 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-deployment-overview.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-deployment-overview.api.mdx @@ -5,9 +5,9 @@ description: "Get an overview of a given deployment (by deployment id)" sidebar_label: "Get deployment overview" hide_title: true hide_table_of_contents: true -api: eJztVktv2zAM/iuCTi2Q1enWXXIr9ih62Yq2Ow1FoNhMrE6WVD2ypIH/+0jZTew6LfbA0EtPUSSRIvl9pL8NL8DnTtogjeYTfgaBCc3MEtxSwk9m5kywhVyCZgVYZdYV6MAOZuvuX1kc8hEPYuH55DsXVmbL46w5x/1c5KVc4aLduRlxK5yoIIAjgw33eQmV4JMND2sLGIUPTuoFr0fcwV2UDgo+CS7CiGu0wwu7x6eyQNeSYrcilGjzN/5EDKVx8l6kMrT+ShAFOF7fkJm3Rnvw5PTteEw//cKd67lxVbJnYmZiYKGETpGoEEYHWqGtsFbJPN3Obj052BO1md1CTobWGQsuyOb5XBkfHVzJe+hc1rGaYbCYUVRKzBQ0GWLKuQMRoPiqhwUZ8SZoqijeeRMkVgNN5lJLXz5l03/hKR+Iy3PvxYgX6JouYDXMA098EO4P40aTEP2++4B+iZzn+sKZBcLpcfMCdNEcfxA6B6WAuPRZyGZxFfMcoMD1TfJtHFwQxYa86hHrew+hbv17hU0Vesi/m+02je6bN3VNr5yMj4fU+2KwZ1sCQ8GCYal1/wf3msimuSn2cG8LwLTC+ooF7O1A6afgnHGdw5kxCoSmU4TzN8JIDqYFBIRqD9yP8ehfJzCJMBhrZfdk8ci4m/IgwU46bexd31vQToagXfemAysMeKYRSFhJHxgOERofHqdwaupX+F4Ovvfjd0P4LiFEp7Hb5DwhNccex5bHtfTM4fgHhgv8zgX6hMoWW01js3jF8wXxRHeoPEqDzvgCUi5ppvOsp1uyXW9mm57aqOnZ1JeNeIlOkVYIwfpJlsmFikewwucUHOWmSupBojagzMimoc/4aHx0nIIL9B3l52jGTi/Ok0rqyYr2gH00uWf41WPRI7U0W5vocIAsQRmbZjwmZo0PlUgManUNybnOlHmQdY+f2ewI+U8KsEEuwCpkVgmZKJTqs2mrnNQh3lwe7/TgiPe+VJO+tsPylZgWmW42M+Hhm1N1Tdt3Edwa93G5FE42igQBKaRv2mwyF8rDM6keXLbEOmRPRd9uCk1xLoWK9A+XP2A9kKE1UbkVjRRIc+cURYQNHetBwxNFtpw8+3SNnP8FPm8JyQ== +api: eJztVktv2zAM/iuCTi2Q1enWXXIr9ih62Yq2Ow1FoNhMrE6WVD2ypIH/+0jZTew6LfbA0EtPUSSRIvl9pL8NL8DnTtogjeYTfgaBCc3MEtxSwk9m5kywhVyCZgVYZdYV6MAOZuvuX1kc8hEPYuH55DsXVmbL46w5x/1c5KVc4aLduRlxK5yoIIAjgw33eQmV4JMND2sLGIUPTuoFr0fcwV2UDgo+CS7CiGu0wwu7x6eyQNeSYrcilGjzN/5EDKVx8l6kMrT+ShAFOF7fkJm3Rnvw5PTteEw//cKd67lxVbJnYmZiYKGETpGoEEYHWqGtsFbJPN3Obj052BO1md1CTobWGQsuyOb5XBkfHVzJe+hc1rGaYbCYUVRKzBQ0GWLKuQMRoPiqhwUZ8SZoqijeeRMkVgNN5lJLXz5l03/hKR+Iy3PvxYgX6JouYDXMA098EO4P40aTEP2++4B+iZzn+sKZBcLpcfMCdNEcfxA6B6WAuPRZyGZxFfMcoMD1TfJtHFwQxYa86hHrew+hbv17hU0Vesi/m+02je6bN3VNr5yMj4fU+2KwZ1sCQ8GCYal1/wf3msimuSn2cG8LwLTC+ooF7O1A6afgnHGdw5kxCoSmU4TzN8JIDqYFBIRqD9yP8ehfJzCJMBhrZfdk8ci4m/IgwU46bexd31vQToagXfemAysMeKYRSFhJHxgOERofHqdwaupX+F4Ovvfjd0P4LiFEp7Hb5DwhNccex5bHtfTM4fgHhgv8zgX6hMoWW01js3jF8wXxRHeoPEqDzvgCUi5ppvOsp1uyXW9mm57aqOnZ1JeNeIlOkVYIwfpJlsmFikewwucUHOWmypJ8kCgOKDUyavgzPhofHafoAn1I+TnasdOL8ySTerqiPWAfTe4ZfvZY9MgtzdYmOpwgS1DGpiGPmVnjQyUShVphQ3quM2YedN3jZzY7Rv6TBGygC7AKmVVCJg6lAm3aMid5iDeXxztBOOK9T9WkL+6wfCWmRaabzUx4+OZUXdP2XQS3xn1cLoWTjSRBRArpmz6bzIXy8EyqB5ctsw7ZU9G3m0JTnEuhIv3D5Q9YD3RoTVxuVSMF0tw5RRVhQ8d60PFEkS0pzz5dI+l/AfCXCfg= sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-information-about-derivation.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/get-information-about-derivation.StatusCodes.json index 45eea43..4409d09 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-information-about-derivation.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/get-information-about-derivation.StatusCodes.json @@ -57,7 +57,11 @@ "preferred_compression_method": { "type": "string" }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -68,7 +72,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, "pin": { "type": "boolean" }, diff --git a/docs/docs/04-development/02-cache/02-restapi/get-information-about-derivation.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-information-about-derivation.api.mdx index 0dc932b..26aa3f2 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-information-about-derivation.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-information-about-derivation.api.mdx @@ -5,9 +5,9 @@ description: "Get detailed information about a given derivation" sidebar_label: "Get information about derivation" hide_title: true hide_table_of_contents: true -api: eJztGMtu4zbwVwhe2gLeyGm3F9+2aLvYS1EE21NgGJQ0trmVSJUP17Hhf+8MKduiTWWzm6JBgZwscx6c9wxnz2uwlZGdk1rxGX8PjtXghGygZlIttWkFgZgotXdMsJXcgEIUIzcBwCfciZXls3suOllsbgu5anxhwLrCgRLKWUShMz6f8E4Y0YIDQwR7bqs1tILP9tw9dIDXW2ekWvHDhBv4y0sDNZ8542HCFdIhQmRJHEnaTrg1Io8zmvCoAZ54L+tHGJ81WiDeU/mP8xPerbWRu6ORAr81CLznKzl6C+aNWMFZ/SO7OdHYTisLljh+P53ST+rZux6DVVqhfxVextwaUlcSjC5AatF1jawCoPhkiUVGaF1+gork6YzuwDgZBbBOOG8Xla5hgKx8Wwbtj/AWrEWFskaQdgHGaDMAllo3IEhMQFYYQEvRWJgjci3cE6RCv+ZuOhvALhKUL2NTBT5g8sAlJtRa2PU41Mpd3liVEmacFIEXlAOggSUYUFUU/BpunTaPiBXA1i+XcptFwGx2I5x12yGplTFuLpOy9x/f7vDPzrqazw9J4N/zkIQnmw4tOLTXwDoDW6SaJ3peaHXUIZWYQqqvXc+JiJV0a18uKG9jCmdwRgHIvpUjBozp0fkSEzSTH0Qd9EdTLgZ6Yb5hTcrL6o3Mi2EkVjH3kI1M55rMec6Rl6boFU/UHCr1GQ2ivAPpoizkt06qvEkqK1dZFfGciuHiT3h4lruRPnuObfHZvEdzdCR+cj7o4z9QzL+MlFRLFTnxyaFfVNQkmaKHendcGz+knsTG4ETbfT64ho3mqq0MmkjfIoa8UXTi9nZ6e90rP2JfRInYg/bsb6wjzFtql9IypR0zUGmUegf1/6VjPrlFBgaLOADmKvuF+VP0F/DdD9e++1WbUtY1Dqlv2G+aJXPYhAEWIjDBsbWs1TeOoQE2sgYmVIrL4nTFdMA2x799DEgVhqefQBg87IfM12h42Wh4m89kugZR8UET6xCrNUQvwlZaxzT5Ev2KzamfNV69+GJe/DGX03fgvFH0Il2GtFsCMsayHNxm8GEKlJc0yjG9PKYo+rpsXmv0i/oT2R2HTr6CoAs9qWe8GFsWFPv4cSgGU0SxT57nB5IlJGtcI3jT0GvYuc7OisDyBrYoQwM3ODyG9zGtMkhdookxNb2Z3twGiV1DFviAZOzd7x/C/DIMviOA/awrS6UepwGgBhDaQg0baHTXUnzR+Kmta0UIq/7ZThuV60VK8upO7tufw/XrtjHRoQ62rugafOjH8T5M6tH4YVODmJvb42Ym7A/ceVDDr9lp0zLwA52nixI07RpVJqb7fSks/GGaw4GOseYaHIjv8XMjjKRcDM6qpY15OQvP90e0//auj8Tv2Jhe/aFQNJ9uROPpXz+wnpZFtG75D29NDXSgjOsXNf+6+vHCZDF0Eoe0jvB3VQXdEHZVBClDTnn6/pePWAf+AeWUAyM= +api: eJztGMtu4zbwVwhe2gLeyGm3F9920Xaxl6IItqfAMGhpbHMrkSofrmPD/94ZUrJFm0qzm6JBgZwscx6c9wznwCuwpZGtk1rxGf8AjlXghKyhYlKttGkEgZhYau+YYGu5BYUoRm4DgE+4E2vLZ/dctLLY3hZyXfvCgHWFAyWUs4hCZ3w+4a0wogEHhggO3JYbaASfHbh7aAGvt85ItebHCTfwp5cGKj5zxsOEK6RDhMiSOJK0rXAbRB5nNOFRAzzxXlaPMD5rtEC8p/If5ye822gj972RAr8NCLznKzl6C+aNWMNZ/Z7dnGhsq5UFSxy/n07pJ/XsXYfBSq3QvwovY24DqSsJRhcgtWjbWpYBUHy2xCIjtF5+hpLkaY1uwTgZBbBOOG8Xpa5ggKx8swza9/AGrEWFskaQdgHGaDMALrWuQZCYgKwwgFaitjBH5Eq4J0iFfs3ddDaAXSQoX8amDHzA5IErTKiNsJtxqJX7vLFKJcw4KQIvKAdAAyswoMoo+DXcOm0eESuArV+t5C6LgNnsRjjrpkVSK2PcXCZl5z++2+OfvXUVnx+TwL/nIQlPNh1acGivgXUGtkg1T/S80KrXIZWYQqqrXc+JiLV0G79cUN7GFM7gjAKQfSNHDBjTo/VLTNBMfhB10B9NuRjohfmGNSkvqzcyL4aRWMXcQzYynavz6S3XVF5G7zsHQFnLWM/QRuTnfBhcGrIzW2KkoUn+Qf+o7UC3qMmV3BQGrVR5C5eInLVYz+QPeHhW9CB99hy77LN5j6b8SDjmnNKlU6CYfxkpqZYqcuKTQ78o0EluRg917rg2fshkiX3GiabNxOrFdcO+ddWlBj2p6zhD3ig6cXs7vb1uvZ+wzaJE7EF79heWJeYtdV9pmdKOGSg1Sr2H6v/SgJ/ccQODRZwnc43iwvwp+gv47odr3/2izVJWFc68b9ivmiVj3YQBViYwwbGVrNQ3jqEBtrICJlSKy+KwxnTANv3fLgakCrPYexAGD7uZ9TUaXjYa3uYzma5BVHwfxTrEKg3Ri7CT1jFNvkS/di3t1Ysv6cUfczl9B84bRQ/cVUi7FSBjLMvBbQbfuUB5SZMh06s+RdHXy/q1Rr+oP5FdP1PyNQRd6IU+48XY7qE4xI9jMZgiikPy2j+e5s+4lfCmpse1c62dFYHlDexQhhpucJoswnubViOkLxHFoJreTG9ug8iuJhN8RDr27rePYYAZRl8PYD/p0lKtx3EAqAOEvlDBFmrdNhRgNH9q6xoR4qpbA9CG5noxk7zik/sO53j9uu1O9KiDnSvaWkgVnwth8o/WD5sfxNze9puesI9w50kNv2anzc3AEXSeLl7QtBtUmZgeDkth4XdTH490jEXX4ER8j59bYSQlY/BWJW1MzFlYBzyi/bd3XSh+x8b06g6FogF1K2pP/7qJ9bR8ovXNf3hraqAjpVy3+PnX1Y8XJoumkzikdYS/K0toh7CrKkgZckrUDz9/wkLwN+0pHv4= sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-nix-cache-info.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-nix-cache-info.api.mdx index 06fbca3..bb5484d 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-nix-cache-info.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-nix-cache-info.api.mdx @@ -5,9 +5,9 @@ description: "Get the standardized nix cache info response" sidebar_label: "Get nix cache info" hide_title: true hide_table_of_contents: true -api: eJyVVE1P20AQ/SurPbVSiEPFyaoqIVEhDpUotOqBoGhjD8lSe3eZHUNSy/+9M2unJCFU4Ivtna/3Zt5sq0uIBdpA1jud63MgRUtQkYwrDZb2D5TK2ZUqTMHH1t15hRCDdxH0SJNZRJ3ftNqZGjicPXV3O9LBIB8QYG+NHFsbnbea1kH8IqF1C92NNMJDYxFKnRM2MNokInDGEVewgioYWqa8m9JRcn2aTOS1S+D6bcAL77gEJUiwomx1xL5HyfdIfMXwGuqRBtfUTExP3TV5hDOLuco4QRbld+p+MfZvJsbvDeA6V8dTd4nWoyX++dxTm4Xh5MvUqXc9+rbjZ6RPJicv6V8BNeiY+tMSXJpkX06VHqJynhSsbCTlUa19gwp9Q6DSuKJ6ApROpbAn9G6h7jzWhnb7ZUKobGGkYHYfpeqBVvn5PRQSGNAHQLL9yFhW1MRZ4UvYcuZuzgFFDYO9hhjNAg4KxsYZIHrcMs69r8A4sZaG3gAjJZiVQMZW8UCVHV3e7LnfspUsQyRThwMs9oK3Kb8guEVnwL6dOw2a0/EmLT0n0wtIXGQbcp21/Wi7bE+6XAXwcbN7DVbsvCQKMc8yu6iaMaw4ewXjwtdpqzaCl5heRpPxZHycsFAl3C44TJ1eXgjKHb1tDOrMF1HkopqYNJTUVcIjVD7UohzmEXyk2iTBDGsu183uku5XaJ+l9+7LqZ9L2u9QGZsEktrRDj284Vtnc9HsNZHbsmS44tO2cxPhJ1ZdJ8cPstR8zp+PBq2ZS4e40aWN8s1zujNVhP/w+HA16OOjeg3mcGjcWkuZqpE//vwN6+fbsRMpLsGULDtB0BtPiwICbYUdvuBk8P+Edf71Bwv3L0WBEDE= +api: eJyVVE1v2zAM/SuCThuQxOnQkzEMKNCh6GFA127YoQkCxWYTdbakUnSbzMh/Hyk7a5KmQ+uLJfHrkXxkq0uIBdpA1jud6wsgRUtQkYwrDZb2D5TK2ZUqTMHP1t15hRCDdxH0QJNZRJ3fatbQ04EOBk0NBCiPrY5sUhudt5rWAdh7JLRuoTcDjfDQWIRS54QNDLRjO1YgcMYRO7YCJhha6s1UtLuIUXx9Go/lt4/75m14C+84BCVIsKJsNWTdYdIdiq4IXkM90OCaWrKduBvyCOcWc5WxgyzKdeJ+MfZvJsbvDeA6VycTd4XWoyW+fO5Sm4X+5cvEqXd9errhb6BPx6cv078GatBx6k9LcKmBXThVeojKeVKwspGUR7X2DSr0DYFK7YrqCVAqlcye0LuFuvNYG9qvlwmhsoWRgNl9lKhHSuXn91CIYUAfAMl2LWM2URNnhS9hR5mrOQcUNvTyGmI0CzhKGBtngOhxRzj3vgLjRFoaegOM5GBWAhlbxSNR9nh5e6A+ZSlZhkimDkeyODDeTflFgjvp9Nh3fadGszuepKVnZ3oBKReZhlxnbdfaTXZAXY4C+LidvQYrVl4ShZhnmV1UzQhW7L2CUeHrLI3VlvFi1PFoPBqPThIYqiS5S7ZTZ1eXAnOPcFuBOvdFFL6oJiYSJXqV8AiVD7VQhxMJPlJtEmP6OZc1sz+lhxHaZ+69eyl1jUkDHipjE0NSPdq+iLe8drab5qCKXJYlwxWdtp2bCD+x2mzk+UGmmt/5+GjQmrlUiCtd2ihnbtSdqSL8J48P1z1BPqrXYPaPxq21hKkaufHxN6yf1+NGuLgEUzLvBEEnPCsKCLRjdnzDSeP/Mevi6w9m7l9TPQ1J sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-nix-derivation-in-nix-caching-format.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-nix-derivation-in-nix-caching-format.api.mdx index 14b5cff..c5921fe 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-nix-derivation-in-nix-caching-format.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-nix-derivation-in-nix-caching-format.api.mdx @@ -5,9 +5,9 @@ description: "Get a nix derivation in the normal nix caching format" sidebar_label: "Get nix derivation in nix caching format" hide_title: true hide_table_of_contents: true -api: eJztVU1v2zAM/SuCThuQxlnR7WAEAYq16woMRZGupyYIFJuO1dmSJ8pZMiP/faTstEmbFkMvu8wXy/zSI/lMNjIFTJyuvLZGxvICvFDC6JVIwemlYrHQRvgchLGuVEVQJirJtVmIjEVe9qRXC5TxXSONKoHikJHcTHuyUo4EHlyrxSSHUsm4kX5dsR16R3Hkpicd/Ky1g1TG3tXQ2wbyYJThGzTDq5TPyfgtgXKF+X6YKdtiZQ0CcqTjwYBf+wW5omyrQnEJYOXF1oEiJdYQOB8wkCpaHVHSR0YRjsyy9CWMPQmmLqkecmJuvHVwTXBiEZF7hPwdDcOLEY+O2jPWWaZXo4m5HX+LBV2yazMxn21ZkRES5lgMk8cv0n3RBXwls1hgro4/foqHGUk6R1be6N9AXixFOpL0SrnWY0g3dZYk6wxJ1tmNIQMHJgFsby3VDKECpzyks0Kjn9ls9oATcCQm5ox5BY4c0vZEcW70gr7bVs+4X6N4iHoxEuGZGPHKI6cbenry5FD3xuBrZyAVOhNrWzvB5AD0IvASxS+CL4jUzGNizF5TVVUVOgl/QHSPHO5AS+38HhKmZ+UsJe51SyX0ytc4S2wKO8bU9Tk45minL6lJagEHaaxxBs5Zt6OcW1uAMqxNlf8LGCHALAWvdIEHbtn7W+6emE9J6zVB9KqsDmTxxHk35WcJ7qTTYd+N/dDBk+cdPNc0elyYP13vqJstU4R1/CeI1ALScPICVkS5/038h02kcDTtc0vB5AJCLjxqYxk1bc82UcOjYNPv5mTfI18EbrldEbUreFp7X2EcRXpR1H1Y0QUF9GnChKm9HbDs07Jk0B/0PwQ4vuD0LslNnF5fMtA9Om0V4swmyOtL1Ai84MJ0SGEJha1KJg+lUln0pQqc6ZYIr8fny/HgRty7t3nk5NtXbNu5sGvCRmKIoVpNV+U7Wnnbddm0dd4rNJUup5TYsGnmCuHWFZsNi+nHcmuS03FJ9mrOVaRmpBr5TO3MVIHwSlbvxh2N3ouXsHZCZdaSrylq/qLjD1g/LvoNMzYHRbUJCFrlaZJA5XfcDmxcZsYD+S7OvxO5/wBPjBUO +api: eJztVU1P20AQ/SurPbVSiFNEe7CiSKhQilQhFMqJRNHGHsdL7V13Z50mtfLfO7N2IIGAKi691Bev5/PNzvNMI1PAxOnKa2tkLC/ACyWMXokUnF4qFgtthM9BGOtKVQRlopJcm4XIWORlT3q1QBnfSVLKaU9WyqkSPDgWNhKTHEol40b6dQWUBr0jd7npSQc/a+0glbF3NfSkIT8y8GCU4cCaUVXK52T8lkC5wnw/zJRtsbIGATnS8WDAr/17uKIiq0Jx5bDyYutAkRJrCJwPGEgVrY6o5iOjCEdmWfoSxp4EU5d8SRNz462Da4ITi4jcI+TvaBhejHh01J6xzjK9Gk3M7fhbLCjJrs3EfLZlRUZImGMxTB6/SPdFF/CVzGKBuTr++CkeZiTpHFl5o38DebEU6UjSK+VajyFl6ixJ1hmSrLMbQwYOTALYZi3VDKECpzyks0Kjn9ls9oATcCQm5ozpBI4c0vZEcW70gr7bVs+4X6N4iHoxEuGZGPHKI6cbenry5FD3xuBrZyAVOhNrWzvB5AD0IvASxS+CL4jLTF9izF5TVVUVOgnEj+6Rwx1oqZ3fQ8L0rJylwr1uqYRe+RpniU1hx5i6PgfHHO30JTVJLeAgjTXOwDnrdpRzawtQhrWp8n8BIwSYpeCVLvBAlr2/5e6J+ZS0XhNEr8rqQBVPnHdLflbgTjkd9t3YDx08ed7Bc00Tx4Wx0/WOutkyRVjHf4JILSDNJC9gRZT738R/2EQKR9M+txRMLiDUwqM2llHT9mwTNTwKNv1uTvY9ciJwy+2KqF3B09r7CuMo0oui7sOKEhTQpwkThbG9nbDs1NJk0B/0PwQ8vuD6LslPnF5fMtI9Pm0V4swmyGtL1Ai82MJ4SGEJha1KZg/VUln0pQqk6bYIr8XnS/HgJtzL2zyS8u2rtW1dWDZhJTHEcF1Nd813tPO2+7JpL3rvpunqciqJDZtmrhBuXbHZsJj+LLcmOR2XZK/mfIvUjVQjn6mfmSoQXqnq3bjj0XvxEtZOqMxacpqi5i86/oD146bfMGVzUHQ3AUGrPE0SqPyO24GVy8x4YN/F+Xdi9x+oUxIm sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-registered-api-keys.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/get-registered-api-keys.StatusCodes.json index e0dac65..2d3ebf6 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-registered-api-keys.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/get-registered-api-keys.StatusCodes.json @@ -38,7 +38,11 @@ }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -49,7 +53,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] } }, diff --git a/docs/docs/04-development/02-cache/02-restapi/get-registered-api-keys.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-registered-api-keys.api.mdx index 0365b1c..f89c70e 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-registered-api-keys.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-registered-api-keys.api.mdx @@ -5,9 +5,9 @@ description: "Get all registerd API Keys for this tenant (excluding hashes)" sidebar_label: "Get registered API Keys" hide_title: true hide_table_of_contents: true -api: eJztV1GP2zYM/iuCXtYC6TnXdS95a7GtKAoUxaF9OgSBYjGxOlvyKDq7NMh/Lyk5Pbvx7bB22GHAPSW2JOojv480edAWYomuJRe8XujXQMrUtULYukiAVr18/0a9hX1Um4CKKhcVgTee1BO4KevOOr9VlYkVxKd6pslso15ca9O6YndZuG3dFQiRij/YBK/LC72c6dagaYAvkN0HHcsKGqMXB037FhhHJGTD+jjTCH92DsHqBWEHM+35HG/IIMSiwG4NVbz5ewyZjqqA7rNJEejtVWAs4Hda7CLgM7OFW3gnc0s5E9vgI0Sx+Hw+l58xBR8qUFd9+OE2/myrDJ7EKh8xbVu7MmEuPkU5N4E0rD9BKSBaDC0guXxrJENdXJXBwmCz75p1cvm03kCM7MWk5y6uADHgYHEdQg1GIghsilndmDrCkjdbQ0NUBtHsJTIETbwfrbOTCFhgK9HUarT+z2yIbCcXMpFnCyPKr8Vqb6M/Ic5mXf4QrK2jqluvREZ3ALkTId8A2LgYXZbEFHFtt2bpTDAnpxE2TCxYVkfDD8kQK4FTZBprh24aBjpOKtpPCoyonng/Fd1vQ9E7PnJz6NQ9HmS8A3QZy3Ly7qHCRrym7eQ4P8g07f2eDPPtLLsGudRnytA2XyXWXswvp+sE41P70Km/uFSoLkot5gLtA3EBL8PWu89g/y+F47xS3AEjGVhZIOPqeH+ajrcv/3vufj7n7veAa2ctePVMvQtq9A2aKWDVAyZirbP+J1IcgJ2zoIwf71X5y6JC2o2nx14DzvMHG9QrMMgv+fvdGHpUwwOr4cV0Jss1vJU/+H17ZQNkFuGGWwEVfG6+uBLuAB9ZfFAWf5nK6SugDj0T6DYp7TbAhrksJ9owdASSl9z4MpmbU4oy1+v6sUY/KJ9s7tTh6C0kX2ScWOhicooppAIXh5ymR7kxpWQeZDqspd8nauOiSAcv4IZvquGC+5E0ATi/CeKUnMnKmV/MLy4TLqrFzzd8TPp+QTyS2GlB/RrKPJBxZyRlPhV/CzuoQ9uIiqQFC5Eak8TTDyYy3OHkZDG65nCrxR+fBzNzBDdUtLVxPjeNqf/LUU6zIu/cXZ7GwzQkCQ39zCjx5p9FP/JxCCt2TU4eDmsT4SPWx6O85gqK3HFe89+dQSeZlUixLuYsW6SZ5G/cfXLV6+qpugv8aYrx0j3uTN3JUwZ7O5YeRcL91PevI8g3jabMrzhkYs3rL8sS2uHaWVURMX4V/uvfPnBifQFNL5gl +api: eJztV1GP2zYM/iuCXtYC6Tm3dS95a7GtKAYMw6F7OgSBYjGxOlnyJDq7NMh/Hyk5d3aj7LB22GHAPSW2SOoj+ZEmD1JDrIPp0HgnF/IdoFDWigBbExGCFm9+fS9+hn0UGx8ENiYKBKccihdwV9teG7cVjYoNxJdyJlFto1zcStWZanddma3tqwARq9/JBJ3zC7mcyU4F1QJdwNIHGesGWiUXB4n7DghHxECG5XEmA/zRmwBaLjD0MJOO9Eggg2CLDLtT2JDwlxhSPTY+mE8qRWCw14DSEL7QYh8hvFJbeIB3Mrdkndh5FyGyxW/nc/6ZpuBDA+JmCD88xJ9s1d4hWyUV1XXW1Alz9TGyXgGpX3+EmkF0wXcQ0ORbIyrs46r2GkbCrm/XyeXTeQsxkhdFz01cQQg+jA7X3ltQHEEgU5TVjbIRliSsFY5RqRDUniOD0MbH0RpdREAEWzGnVpPzf2aDaVs8yIk8O5ik/JatDjYGDXY28/KrYG0NNv16xTS6AOQiQroBQmtiNJkSpcR1/ZqoU8gcawfYUGJBEztaekiGiAlUImWsfTBlGMFQUeG+SDBEWyae2TrSv3jfPbVkbU0uL4rRjpSXxdx8HsghbJMgjUPyiP/Z25Fv2ZMz3GUwY8JOaJLE0VC5oWq7QmA+szYu37NiHZXmUHhj23QVW3s9vy63HcIn9r4Xf1LnEX3k1k793nmk70HtyclPoP8vfei88VyAkQysNKAyNj5e9VPx5X+fu+/Oc/eTD2ujNTjxSvzixeSTNhNAZQAhJVYb7b5BQQHYGQ1CuamsyB8q4ZN0OD0OHDCOvv8g3oIK9JLGgVbhMxuemA2vy5XM15AozQ/DtKY95CzCHU0Wwrs8yw398zmLT5nF70s1fQPYB0cJNJtUdhsgw9SWU9qC7xG4LmmOpmRuTiVKuV7b5x79pPkkc6cBRm4h+cLbyUJWxaWo4g5cHXKZHu9HmrwX9cHy+oDYxUWVFK/gjm6ycEUDSpU2CuM2nr1ipUyd+dX86joBQ8uOvic93iMY8oRjpwPxg6/zgkezEvf51P017MD6rmUa8UjnI7YqsWdYdHhZDMVNZXLN4YGMX79f5tQh3GHVWWVcHkLTPJnDnHZPktxdn9bNtHRxHoYdlANOP4thhaQQNuQaax4OaxXht2CPR35NLTTQBHtLf3cqGC6tlBVtYi6zRdpx/sbdFzcDsV6KS+BPW5HjeXKnbM9PGezDmntkDg9b5L+OIN802VrvcfAGnM/f1DV047OztsJkvGf+ux8/UGX9BUyVtAA= sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-signing-key-information.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-signing-key-information.api.mdx index d06977e..5893e5e 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-signing-key-information.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-signing-key-information.api.mdx @@ -5,9 +5,9 @@ description: "Get the signing key your API Key is associated with" sidebar_label: "Get Signing Key information" hide_title: true hide_table_of_contents: true -api: eJztVk1v2zAM/SuCzkGcbN0ltwIbimKXYusOQxEEjM3E6mxLlWi3XZD/PlKOV7sx0HaXYEBP/hD5RPJR1NvpDEPqjSNjK73QF0iKclTBbCtTbdUvfFSPtvbq/OpSfeUPExSEYFMDhJm6N5TriSbYBr240eBM0swTsy3qxGOghN0Dr8sPvZxoBx5KJPRivdMhzbEEvdhpenTIuwfyvKneT7THu9p4zPSCfI0TXbEfG0BNufXmN8RwGVhizhEy9Hq/FLfgbBUwCOiH2UwewwS/9xK7rDbWlx1WaivCisQFnCtMGheS2yB+I8Ha9S2mxI7OW4eeTLtrIKA6rFKbYc+4qsu1xDjp1ksMAbY4mrwJK/Te+t7i2toCQcJEhuLqbaAIuGTjDOgVUZlsdCeuwuh/JnIl3K0Gfm/DziHkowstl0cLA9ZvBPWAcfBYvs1VUhsm0sMhw/UnKN0IRc/A+nwesdfj6sBEH3u53wva2Wx+3IfXfMi6M8UHTN2jR1UHac3MYlCVJYUPJtD/0pmvbsUIsMqQwBThZTKH5icg7+MxeT+ZsMxkkSTHM4fJUVCpwXRSh7H0Tt9p6Tsbpe/pQut4zKFBBeqqXjNDqrsmxOLZfafM+5k8Lamfxs7kN6TaV8yR2UQFs0EG5plKOUsWb2tC0S6sQEjZjbzGCVvBusDsnc8T8slwrAlzy2B6izEXYFW50MmonEwO0lT2Qt90WrL2hUhBIhcWSXSZ4gPvUeA0tWUUh4blnqQjPm3PzKaz6TxGRIVkeMluMhgk1kFzdQvqs02DYtXIVzX3U9Vq4wwbLKwrpX84G2cDlRDb5iBbRVX3J4oZCM/BVrunTvxXMd6yRfhAiSvAxLaJ5dkdKhuFOls2806bR+VMrWoSwd7VmKuWczbistutIeAPX+z38vuuRs/a8YZfG/BGjpF8ie5r7z0hJcpLfZ6m6AS8gaKOKv75ARN2/vbAxZdr7rE/kTJkRA== +api: eJztVk1v2zAM/SuCzkGcbN0ltwIbimKXYusOQxEEjM3E6mxLlWi3XZD/PlKOV7sx0HaXYEBP/hD5RPJR1NvpDEPqjSNjK73QF0iKclTBbCtTbdUvfFSPtvbq/OpSfeUPExSEYFMDhJm6N5TriSbYBr240eBM0swTsy3qxGOghN0Dr8sPvZxoBx5KJPRivdMhzbEEvdhpenTIuwfyvKneT7THu9p4zPSCfI0TXbEfG0BNufXmN8RwGVhizhEy9Hq/FLfgbBUwCOiH2UwewwS/9xK7rDbWlx1WaivCisQFnCtMGheS2yB+I8Ha9S2mxI7OW4eeTLtrIKA6rFKbYc+4qsu1xDjp1ksMAbY4mrwJK/Te+t7i2toCQcJEhuLqbaAIuGTjDOgVUZlsdCeuwuh/JnIl3K0Gfm/DziHkowstl0cLA9ZvBPWAcfBYvs1VUhsm0sMhw/UnKN0IRc/A+nwesdfj6sBEH3u53wva2Wx+3IfXfMi6M8UHTN2jR1UHac3MYlCVJYUPJtD/0pmvbsUIsMqQwBThZTKH5icg7+MxeT+ZsMxkkSTHM4fJUVCpwXRSh7H0Tt9p6Tsbpe/pQut4zKFBBeqqXjNDqrsmxOLZfafM+5k8Lamfxs7kN6TaV8yR2UQFs0EG5plKOUsWb2tC0S6sQEjZjbzGCVvBusDsnc8T8slwrAlzy2B6izEXYFW50MmonEwO0lT2Qt90WrL2hUhBIhcWSXSZ4gPvUeA0tWUS1aFhvSf5iFPbNLPpbDqPIVEhKV6yn0wGCXbQXd2C+mzToFg28l3NDVW14jjDBgvrSmkgTsfZQCXEvjnoVpHV/ZFiBspzsNXuqRX/VY23dBE+UOIKMLFvYn12h9JGpc6WzbwT51E6UyubRLF3Reaq5ZyNuOx2awj4wxf7vfy+q9GzeLzh1wa8kXMkXyL82otPWIn6Up+nKToBb6Coo4x/fsKEnb9NcPHlmpvsD7Q4ZHM= sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/get-tenant-information.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/get-tenant-information.StatusCodes.json index 811545d..34c8551 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-tenant-information.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/get-tenant-information.StatusCodes.json @@ -21,7 +21,11 @@ "preferred_compression_method": { "type": "string" }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -32,7 +36,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, "timestamp": { "type": "number" } diff --git a/docs/docs/04-development/02-cache/02-restapi/get-tenant-information.api.mdx b/docs/docs/04-development/02-cache/02-restapi/get-tenant-information.api.mdx index 9fed511..a832ab0 100644 --- a/docs/docs/04-development/02-cache/02-restapi/get-tenant-information.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/get-tenant-information.api.mdx @@ -5,9 +5,9 @@ description: "Get detailed information about a tenant" sidebar_label: "Get Tenant information" hide_title: true hide_table_of_contents: true -api: eJztV99P2zAQ/lcsv2yTCikbe+kb0zbEyzQx9oQQcuJra5bYmX3ugKr/++7sBlIaBkOT0CSemsbn+/nd5bul1BAqb1o0zsqJPAQUGlCZGrQwdup8o/hIqNJFFEogWGVRjiSqWZCTU6laUyz2CjOrY+EhYJElAonwO3k2kq3yqgEEzxeWMlRzaJScLCVetUBGA3pjZ3I1kh5+RuNBywn6CCNp6R4J3Bg17GOrcE7CT1GkIs6dN9cppk7fHJQG/0SNMYDfUTO4da9Td8Z3QutsgMAa347H/LOZ72+xqiAE0UmKylnKviWjAudwm25+z0ZIg2rb2lQphOIisJoBx115ARVfbL1rwaPJTgRUGMN55TT0hG1sypSB7rwhnyiowUSYcA7eO987LJ2rQXFCgVRRkaeqDnBGwlrhI7wyetDSzOA8luec4pztAZl7D0h9Y0IwOT9DUbSxpDwOhMG3PUwpStCUqob+JEWUFoLPsK/Rm2E3vCHA4dVgthHrgfcbYDvl5GynYh34Rpj9oB6IIPvb8y77whVDQ8VH1bQPe9YH0xZ0ekBZw6Cv+2y1Ym37473tnjgh3P+AK3HlovgFHkQM3A4mCOuQOqVyM2uuQf8vXfHoNkgKzvP4DQNW7qR/U/wZavduu3afnS+N1mDFjvjixMa8HQkgFINPhdVG21coKAELo0Eouykr8hQVLkn77u8aA8am4fgBlKeX+SP1goZnRsP+cCezGRIlOpG/ZUI7yFWESxNQOK4l1ZUm2wL8SxWftYrvh3r6GDB6y3xwmtpuCqSYxnIqmydaCNyXRPKomNOuRanWZf0yo5+1nqSuYyxyBikWps4TWdxH2otlflixvdSQmbJHXzOzRWzDpEjXduGS7NSwS+wicV1eFjgkvpNxM94d7+4lr7DmKI/omjj4esT+bgCsOxAfXRV4nNMXH3jIp9GvYQG1axvGEBMqF7BRCTprCs47y0meLb2N5a6V5S0Q/2bLyQVCuMSirYmYZ66XaFtOZtqASHKx1208ifenyzeb0GStkPI0J//51nJZqgDffb1a8Wsakp5I4ik9LpQ33Dwp89qE3EiTxKn/ENTr4zV03oj7HF+/VJYJ30LVkf/RI7Gt2y1rxShdLzH/3INsaWNpuvGDF7B8fkBLUds/2xocjLgbbB9+OqHe+Q3IDi2c +api: eJztV0tv2zAM/iuCLtuArE637pJbhz2wyzB03akoCtliEm225ElU1jbIfx8p2anTuHsUA4oBPcWxKD4+fqTJtdQQKm9aNM7KmXwPKDSgMjVoYezc+UbxkVCliyiUQLDKopxIVIsgZ2dStaZYHRZmUcfCQ8AiSwQS4XfyfCJb5VUDCJ4vrGWoltAoOVtLvGqBjAb0xi7kZiI9fI/Gg5Yz9BEm0tI9EtgaNexjq3BJwvdRpCIunTfXKaZe3xKUBn9PjTGAf64WcONer+6c74TW2QCBNb6YTvlnF+/PsaogBNFLispZQt+SUYFLuIGb37MR0qDatjZVCqH4GljNiOOu/AoVX2y9a8GjyU4EVBjDReU0DIRtbMqEQH/ekE8U1CgQJlyA984PDkvnalAMKJAqSvJc1QHOSVgr/AOvjB61tDC4jOUFQ5zRHpG584DUNyYEk/EZi6KNJeE4Egbf9jCnKEETVA39SYoIFqLPuK/Rm3E3vCHC4dUo2oj1eBbMghlwp70tzrKqTaYeYbSiy+ebHaqeMbT7QHaw7YA0hOQ38edoB7HlSPb8ZgKgIS6hatqRQG+5OuTmHhMHvOtYNdRNYbO2o+nhfomdUhl9gytx5aL4AR5EDFxdJgjrkAqvcuT0Nej/pcj+uKqSgovczcOIlVvw74o/QO5e7ufunfOl0RqseC4+OrHTvicCiNbgU2K10fYJCgJgZTQIZXdlRW7KwiVp3//tOGBs6rWvQXl6mb95j2x4YDYcjVcymyFRmk7yp1FoBzmLcGkCCse5pLx2/fAxiw+ZxVdjNX0CGL3l8XKeym4OpJjackqbpykTuC5pZqRkzvsSpVyX9WOPftB8krp+IJELSLHwJD6TxV07QLHOD5vtgJI3gOhrHpQR2zAr0rUDuCQ7NRzQuFGk2ZmXD46JL2XiTA+mB4fJLaw5zA90Txx/+sAO7zCsPxBvXBW4n9MnH7jLp96vYQW1axsmEQ9oLmCjEne6kZ53oNPcXAYb0G0r6xsm/s3WlDOEcIlFW9Ogn2fHNAZmNNNGRZKrw36DSntEurzdrGadQsJpSf7zrfW6VAG++Hqz4dfUJT0NnWf0uFLecPUk6LUJuZJmaUb/RVBPTzruPBN3Od69VJZHwJWqI/+jRxq3bra2DdO0W4r+uQfZ0s4StvWDF7p8fkxLVjs82+sczLgtud+/PaXi+QnxcEl3 sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/healthcheck.RequestSchema.json b/docs/docs/04-development/02-cache/02-restapi/healthcheck.RequestSchema.json new file mode 100644 index 0000000..e9fcb6d --- /dev/null +++ b/docs/docs/04-development/02-cache/02-restapi/healthcheck.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/docs/04-development/02-cache/02-restapi/healthcheck.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/healthcheck.StatusCodes.json new file mode 100644 index 0000000..04b5e15 --- /dev/null +++ b/docs/docs/04-development/02-cache/02-restapi/healthcheck.StatusCodes.json @@ -0,0 +1,34 @@ +{ + "responses": { + "200": { + "description": "Informational response if Iglu is running", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { "type": "number" }, + "status_message": { "type": "string" }, + "is_error": { "type": "boolean", "enum": [false] }, + "data": { + "type": "object", + "properties": { + "information": { "type": "string", "enum": ["Healthy"] } + }, + "required": ["information"] + }, + "timestamp": { "type": "number" } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + } + } +} diff --git a/docs/docs/04-development/02-cache/02-restapi/healthcheck.api.mdx b/docs/docs/04-development/02-cache/02-restapi/healthcheck.api.mdx new file mode 100644 index 0000000..a2cf881 --- /dev/null +++ b/docs/docs/04-development/02-cache/02-restapi/healthcheck.api.mdx @@ -0,0 +1,61 @@ +--- +id: healthcheck +title: "Healthcheck" +description: "Endpoint to check if Iglu is up and running" +sidebar_label: "Healthcheck" +hide_title: true +hide_table_of_contents: true +api: eJyVU7Fu2zAQ/RWCs2E5Hb0FaNB4y9BOhhGcqbPFhCIZ8ijEEPTvvaOdWG46tJMo8u7de4+Po24xm2Qj2eD1Wj/4NgbrSVFQpkPzquxBbY6uKJtViQp8q1Lx3vqjXmiCY9brrbZcoHcLnTDH4DPy5qi/rVbyucXf+ENIPcgfOPVRPx9yRTfBE3oSEIjRWVPbmpcsSKPOzK8HWdEpImOH/Qsa4saYQsRE9swjE1DJzya0OCv2pd9j0tPi47zHnOE4L8mUhAiX2PyMKYU0O9yH4BA8T0OGYhMO4DLuuLgF+gdW9mrE15GfoPoRwVF30rtpEnvfik3YVstn/TKVLAsg6ONfNP7ROjfki/yZ2IuUOTbTmASuR+oCg+kjVmlAHf80EG0z3DUSh6arzGuGZAqmAZOEZdQlOS7uiGJeN7V4ie+M7nBpQt/oiZMk8kSJNJ2Ts1qulneVDDkRV/Ny/7QRmrcRuxyo78FkxS6pIgnz6hRKUi0O6ELsJVgsJIZMPdQr8NAL7uMN7xvo8RrJ/30o5wshfKcmOrBeZlcfxot5W8645cpBNNb3tNBzC9mTjrlK4TjuIeOv5KZJtt8KphPv83KAZGEv9mwlE9zf8v2L56/IJfreGIxyYQO4IoS+vCvx/vNyfzz85PD8Bs7FbPU= +sidebar_class_name: "get api-method" +info_path: docs/04-development/02-cache/02-restapi/iglu-api +custom_edit_url: null +hide_send_button: true +mask_credentials: false +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Endpoint to check if Iglu is up and running + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/docs/04-development/02-cache/02-restapi/modify-api-key-access.api.mdx b/docs/docs/04-development/02-cache/02-restapi/modify-api-key-access.api.mdx index 42e4044..7737b8c 100644 --- a/docs/docs/04-development/02-cache/02-restapi/modify-api-key-access.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/modify-api-key-access.api.mdx @@ -5,9 +5,9 @@ description: "Modify which API Keys are allowed to access tenants that you have sidebar_label: "Modify API Key access" hide_title: true hide_table_of_contents: true -api: eJztV91v20YM/1cO92xHcT7c1W9ZN6DFsK0IsqfACGiJsq496bT7sOsa/t9Hnk6J4ghFHgoYA5KHWNLxeCR/JI+/vSzQ5Va1XplGLuSfplDlTmwrlVfi5vMn8QfunACLArQ2WyyENwLyHJ0THhtoPP1W4MXOBFHBBh8XjZxID2snF/cSWpVtZpla65BZdD77SlppnT/I5US2YKFGj5al99LlFdYgF3vpdy2SVc5b1azlYSIt/huUxUIuvA04kQ3tIwEIvjJWfYfoBilmXyqEAq08LLttdO6vptix2uc+/4Vb4Tx47DzxFSbXhKtM0IWwWGrMPenNTUNLnnVA22qVxwOzL44VjRhuVl+6ja01LVqv0PGqKl46N5GlsTWQbhkCCRx650aikCI/WANrYceOe6zdK5QfnsXyni1K5z1pXx6SmGtN4zrLL87PXwbwU9NppzfQopcXphEudNlgSsH+9/D8pDAyaME95KYYhqkJ9Yphn/TrNVkA6/FIKveA1ho7WFwZoxHYTCRVFJwStMMlCRfgXwPuUzTGgEhK5W2XkiI3dasp94s+WGXQesfBP0JooJaN8Yr88lC3I64fbR3G6UVUBjFIHg51pxy4GoP9jgqFXN+oArlGOndWVGJCOdEYL1QTiyk31lKgRErB/wn8r8Y7Kngo0IPSI6V3DMZz8RMgORtHMjX72MiDI0QTiASdWTfqO335+zau8m3AK4MbAQs1bJwuyvW58Yb4iRG/HEWcUNwCYyz49hTdbUmgoSOk3lA7MWrXoxctzUsRtNDASiNXXn99xOpLTfgNuhNDN1Jwt+iDbbitlhGqEkmxZdioz1oTCEF6oEHY87CUei9GmN9K8ZR4kjqiJpUhZcRTfF6xN+Ares1GeU3G7TSrI5HiE9FuemITrGZe4n3rFlncdobfgAv4jOo4MhVG9PaJrfzeLfekQV6W8Mt1Ob+aXr+bvZteXc8vpqvLMp9e5O/nl+V8DiXM5SMtehw6HwnD/es0cIx54ORz2fouh8/Pzs9mMUKeTeraEc0NHLuXfYoHit9M7nju44mCx0EaC6wocIPatDXnM53TGudriGmczE4ktJ9IOkZ5fMj+qSZ+Nmvt8snjN5+1GlRM7AjdPiEfGS1JbmY9iY00iRM9MVvOAfpJWUC4VuQlb9zvV+DwH6sPB/5MQFuipPf0uAGruNz5jQ5M7JXThnSSPR86d6d3bB6L6xCZ33E7OEz6HTfkVOt/KLscZPfnm7sPH0l6lVhyHbuEtLBl9+j/QtKDifGPVRu/7aWGZh1iu5CdUv77D+cqszs= +api: eJztV91v20YM/1cO92xHcT7c1W9ZN6DFsK0IsqfACGiJsq496bT7sOsa/t9Hnk6J4ghFHgoYA5KHWNLxeCR/JI+/vSzQ5Va1XplGLuSfplDlTmwrlVfi5vMn8QfunACLArQ2WyyENwLyHJ0THhtoPP1W4MXOBFHBBh8XjZxID2snF/cSWpVtZpla65BZdD77SlppnT/I5US2YKFGj5al99LlFdYgF3vpdy2SVc5b1azlYSIt/huUxUIuvA04kQ3tIwEIvjJWfYfoBilmXyqEAq08LLttdO6vptix2uc+/4Vb4Tx47DzxFSbXhKtM0IWwWGrMPenNTUNLnnVA22qVxwOzL44VjRhuVl+6ja01LVqv0PGqKl46N5GlsTWQbhkCCRx650aikCI/WANrYceOe6zdK5QfnsXyni1K5z1pXx6SmGtN4zrLL87PXwbwU9NppzfQopcXphEudNlgSsH+9/D8pDAyaME95KYYhqkJ9Yphn/TrNVkA6/FIKveA1ho7WFwZoxHYTCRVFJwStMMlCRfgXwPuUzTGgEhK5W2XkiI3dasp94s+WGXQesfBP0JooJaN8Yr88lC3I64fbR3G6UVUBjFIHg51pxy4GoP9jgqFXN+oArlGOndWVGJCOdEYL1QTiyk31lKgRErB/wn8r8Y7Kngo0IPSI6V3DMZz8RMgORtHMjX72MiDI0QTiASdWTfqO335+zau8m3AK4MbAQs1bJwuyvW58Yb4iRG/HEWcUNwCYyz49hTdbUmgoSOk3lA7MWrXoxctzUsRtNDASiNXXn99xOpLTfgNuhNDN1Jwt+iDbbitlhGqEkmxZdioz1oTCEF6oEHY87CUei9GmN9K8ZR4kjqiJpUhZcRTfF6xN+Ares1GeU3G7TSrI5HiE9FuemITrGZe4n3rFlncdobfgAv4jOo4i1SFIb19oiu/d+s9a5CXJfxyXc6vptfvZu+mV9fzi+nqssynF/n7+WU5n0MJc/nIix6nzkfGcP86DRxknjj5XDa/S+Lzs/OzWQyRZ5O6fkSDAwfvZaPiieI3kzse/Hik4HmQ5gIrCtygNm3NCU3ntMb5GmIeJ7MTC+1Hko5SHh+yfyqKn01bu4Ty+M1nrQYVMztit0/QR0pLkptZz2IjT+JMT9SWk4B+UhoQrhV5yRv3+xU4/Mfqw4E/E9CWOOk9PW7AKq53fqMDE33lvCGdZM+Hzt3pHZvH4jpE6nfcDw6TfscNOdX6H8ouB+n9+ebuw0eSXiWaXMc2IS1s2T36v5D0YGL8Y9nGb3upoVmH2C9kp5T//gM0kbNq sidebar_class_name: "patch api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/pin-derivation.api.mdx b/docs/docs/04-development/02-cache/02-restapi/pin-derivation.api.mdx index ec522ef..9efbd8b 100644 --- a/docs/docs/04-development/02-cache/02-restapi/pin-derivation.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/pin-derivation.api.mdx @@ -5,9 +5,9 @@ description: "Pin a given derivation so it isn't garbage collected anymore" sidebar_label: "Pin derivation" hide_title: true hide_table_of_contents: true -api: eJztV0tvGzcQ/isEL2kBxSvncdEtQdrClyIIklNgGNRypGXKJVlyqFgR9N8zw115tdY6MNKiQgGftCKHHznzzXMnNaQ6moDGO7mQ740TSqzNBpzQEM1G8YZIXhgUJrlnKNYqLtUaRO2thRpBC+W2rY8gZxLVOsnFZ6mCqTaXlVnbXEVIWCE45TCRCK/J65kMKqoWECIf2MlUN9AqudhJ3AaglySMxq3lfiYj/J1NBC0XGDPMpKNzJNBBMiI/PChsSPhhoJlc+dgqpJWcjf4B8KD3Dck9Fv9hPJWx8dF8K5AHvAYU3fOTiDlBfE4cDOof4K75TAreJUiM+GI+558xyVeuMwX9U1Yc5Gf0hTk6IvRrQ/Tz3UQd8dwGC8xzynUNKa2ytVu6uPYO+QmEr0Kwpi6I1ZfEl0yo5ZdfyF/oYIg+QETTPTGhwpxuaq/hSNjldlnsc9hv6WZSedJMJt1AjD4ebS69t6DY3EBQ5GIrZRNck7BW+IhXmcFGU77Ug8p3Q4wE49ypkY4EspsSud6PeP48upnfi4ZUR9WGCevcO3psyhPDHZmpN8IxNj2D0V7NL0/95WMD4i/Yiq3P4itEEDmRFSgdCOeR/KT2a2e+gf6/+MSjnaAA3GhAZWyauOWe+cfiZ+Du5Sl3v/u4NFpTPD8Xf3oxykUzAQYbiIVYbTRndzLAxmignD6WFV2GEb5Ix8Pf3geoahCQeAsq0mKfaJ+84bze8Go6kvu8Tnmoq6BCe+hYhFtD+d4zl8Qr1ZgNxCcWz8ri66n6/WFUp7mhEuBqnx13Uxy5BZV2jYVSljhbc3wOnc0TrWemdSJV39FqVoWtFRAwVdsSjdFnBE631DdTjK4OmZdCeGmfSu9Z+SQ4mmQaT2ByDUUXnhYWsnpoDqp23ce+GkKSFkeTx76i0OX3lDzcTUk5Wm72EUNaVAX2Am4V9+cX1KaX9p/bR1aZz3R+Nb+YX1yWV6NlK1xxwnjz/or1Gc8F/YZ45+vEVZwaPeDaXiq+hg1YH1r2MdI4+IStKq7VTyU8O44yzAh9NzjoP54yOzYRbrEKVpniVsU0u97yZQIlyc3lYeIscxFTM0yii7sJ8ogEXr8/ADIPZNmGNGbo3W6pEnyKdr/nZaqmcUvr9LlR0XA4Fq60SV1oLsro8QNz/PKhd8ZfxUPa9YtkA9ZK2cz/6JPa8mEU5mHyP7x1bKY9B10/hv7r6ncXjsbeu+ew1t3+GxqrwvHeSR7kALkL1T9++0ip4Dt3gvjE +api: eJztV0tvGzcQ/isEL2kBxSvncdEtQdrClyIIklNgGNRypGXKJVlyqFgR9N8zw115tdY6MNKiQgGftCKHHznzzXMnNaQ6moDGO7mQ740TSqzNBpzQEM1G8YZIXhgUJrlnKNYqLtUaRO2thRpBC+W2rY8gZxLVOsnFZ6mCqTaXlVnbXEVIWCE45TCRCK/J65kMKqoWECIf2MlUN9AqudhJ3AaglySMxq3lfiYj/J1NBC0XGDPMpKNzJNBBMiI/PChsSPhhoJlc+dgqpJWcjf4B8KD3Dck9Fv9hPJWx8dF8K5AHvAYU3fOTiDlBfE4cDOof4K75TAreJUiM+GI+558xyVeuMwX9U1Yc5Gf0hTk6IvRrQ/Tz3UQd8dwGC8xzynUNKa2ytVu6uPYO+QmEr0Kwpi6I1ZfEl0yo5ZdfyF/oYIg+QETTPTGhwpxuaq/hSNjldlnsc9hv6WZSedJMJt1AjD4ebS69t6DY3EBQ5GIrZRNck7BW+IhXmcFGU77Ug8p3Q4wE49ypkY4EspsSud6PeP48upnfi4ZUR9WGCevcO3psyhPDHZmpN8IxNj2D0V7NL0/95WMD4i/Yiq3P4itEEDmRFSgdCOeR/KT2a2e+gf6/+MSjnaAA3GhAZWyauOWe+cfiZ+Du5Sl3v/u4NFpTPD8Xf3oxykUzAQYbiIVYbTRndzLAxmignD6WFV2GEb5Ix8Pf3geoahCQeAsq0mKfaJ+84bze8Go6kvu8Tnmoq6BCe+hYhFtD+d4zl8Qr1ZgNxCcWz8ri66n6/WFUp7mhEuBqnx13Uxy5BZV2jYVSljhbc3wOnc0TrWemdSJV39FqVoWtFRAwVdsSjdFnBE631DdTjK4OmZdCeGmfSu9Z+SQ4mmQaT2ByDUUXnhYWsnpoDqp23ce+GkKSFkeTx76i0OX3lDzcTUk5Wm72EUNaVAX2Am4V9+cX1KZXpf/n/pF15kOdY80v5heX5dlo2QxXnDHevL9ihcaDQb8h3vk6cRmnTg+4uJeSr2ED1oeWnYxUDj5hq4pv9WMJD4+jFDNC3w0e+o/HzI5OhFusglWm+FWxza43fRlBSXJzeRg5y2DE3Ayj6OJuhDxigdfvT4BMBFm2IY0ZerdbqgSfot3veZnKadzSOn1uVDQcj4UsbVIXm4sye/zAHL986L3xV/GQdv0i2YC1UjbzP/qkvnyYhXma/A9vHZtpz1HXz6H/uvrdhaO59+45rHW3/4bmqnC8d5IIOUDuYvWP3z5SLvgO85f48w== sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/retrieve-new-upload-id.api.mdx b/docs/docs/04-development/02-cache/02-restapi/retrieve-new-upload-id.api.mdx index 538d858..c819993 100644 --- a/docs/docs/04-development/02-cache/02-restapi/retrieve-new-upload-id.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/retrieve-new-upload-id.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves a new upload id for a multipart nar upload. (Used in Cac sidebar_label: "Retrieve new upload ID" hide_title: true hide_table_of_contents: true -api: eJztV01vGzcQ/SsEL7UBWWul6UW3tEYLoUAapPEpMIzRcqRlyiU3JFcfFvTfO8PdlVaRbBepA190ErQcDmfmvRnybaTCkHtdRe2sHMuPGL3GBQYBwuJS1JVxoIRWYuY8fStrE3UFPgoLvl0diovbgGRkxW+QF3rV7ZoZt7yUAxlhHuT4s4RKZ4tRlpMR0uc8Gcu7gSSHUGJEz2YbGWi9BDneyLiukKIKFJSdy+1Aevxaa49KjqOvcSAt7SODiBZsJJ+ak6ggFmT8uKOBRFuXHNLqgf48hCjvHneeu7LyGAJXqD3ha41+/eQRT7mzFG68SvatvwJBof9Oh1DHwnn9ALEX4f/yWAf0VzDHfUk7d3e8J1TOBgzs8c31Nf8ckugPtOghEiVuGyKAVeI9+MlNEMsCreBjMUTBlTXIhqHOcyrxrDZmzdRoasSuoaqMzlNu2ZfA/k9k5KZfMOdgK+8q9FE30TU8nKiTuROBT64clOXz3ke34267ZZu3pzKn9qm9pXxSmmtXiwIWKCiqhVapRRZgqJmol0pNjLJzkagk9h0gLvQQhZ6l3eBxZxgLFD0q7rdcvlzBQoRYh/vcKewZU69ME5e69ZJCIHqcLKsO9+i9873FqXMGwfKqgvgfwkgO7hVG0CY8D9GhOXdy1BRihLI6kcU3m/spHyXYS6eNve97x4TRMRM+EVr/4DqhuESCsU4g6iCsi9QAuZtb/YDqjN0rY/fzMXa/Oz/VSlEHX4n3ThzM14FATZ3oE7BKK/tT7NqbxtyhrWimJnc7Wfvub8sBui65pX9FanLP12sJ8cyGV2bD29Od3F5YNMGbl4ZQDhsUcaXpInOMJeFK9+YC/RnF10Vx9Oa5m5k7GJtGFEHTJKbRzNMaQnC5Tk+XJbV507bvPkzEn/iCz5Izqt+B6i/Pv7f03NQCbe5qm15SsHtoLgttUES/Tg8pJ+btCzVNYHqWnrF9RWzJHb1jC6dYurmQkmEFN5ZZXzFmm2b2brOdCL2iFzkfmaZuox1rb1iuxFiFcZYxI4a4ApYZQ3o8JwGj7cxxVrynodH18Ho4SoFFw4lOmEjU9hzyAd+6BXHj8pAkMUklvsnToFAknI2rSqYRJcW5lJDY0+qqTl33pfXk5ttTNnsu/iA93sAZcRWzyoBOvEqF27SVT1qdLBejVqczkOOdyj4EgEpaMGy0a7OZQsBbb7Zb/tzIZIZF6QBTw3yZgQn4RMYXH1tqXYrHQqVJfSTLSVfVbJkQXoDXfNzLH91+BLvun9mF1BZoyw3UKuYflPyBQt/nTmq/WX9Hcrrqrx3NNK7Tru0+/PX3J+rrfwEgnFHb +api: eJztV01vGzcQ/SsEL7UBWWul6UW3tEYLoUAapPEpMIzRcqRlyiU3JFcfFvTfO8PdlVaRbBepA190ErQcDmfmvRnybaTCkHtdRe2sHMuPGL3GBQYBwuJS1JVxoIRWYuY8fStrE3UFPgoLvl0diovbgGRkxW+QF3rV7ZoZt7yUAxlhHuT4s4RKZ4tRlpMR0uc8Gcu7gSSHUGJEz2YbGWi9BDneyLiukKIKFJSdy+1Aevxaa49KjqOvcSAt7SODiBZsJJ+ak6ggFmT8uKOBRFuXHNLqgf48hCjvHneeu7LyGAJXqD3ha41+/eQRT7mzFG68SvatvwJBof9Oh1DHwnn9ALEX4f/yWAf0VzDHfUk7d3e8J1TOBgzs8c31Nf8ckugPtOghEiVuGyKAVeI9+MlNEMsCreBjMUTBlTXIhqHOcyrxrDZmzdRoasSuoaqMzlNu2ZfA/k9k5KZfMOdgK+8q9FE30TU8nKiTuROBT64clOXz3ke34267ZZu3pzKn9qm9pXxSmmtXiwIWKCiqhVapRRZgqJmol0pNjLJzkagk9h0gLvQQhZ6l3eBxZxgLFD0q7rdcvlzBQoRYh/vcKewZU69ME5e69ZJCIHqcLKsO9+i9873FqXMGwfKqgvgfwkgO7hVG0CY8D9GhOXdy1BRihLI6kcU3m/spHyXYS6eNve97x4TRMRM+EVr/4DqhuESCsU4g6iCsi9QAuZtb/YDqjN0rY/fzMXa/Oz/VSlEHX4n3ThzM14FATZ3oE7BKK/tT7NqbxtyhrWimJnc7Wfvub8sBui65pX9FanLP12sJ8cyGV2bD29Od3F5YNMGbl4ZQDhsUcaXpInOMJeFK9+YC/RnF10Vx9Oa5m5k7GJtGFEHTJKbRzNMaQnC5Tk+XJbV507bvPkzEn/iCz5Izqt+B6i/Pv7f03NQCbe5qm15SsHtoLgttUES/Tg8pJ+btCzVNYHqWnrF9RWzJHb1jC6dYurmQkmEFN5ZZXzFmm2b2brOdCL2iFzkfmaZuox1rb1iuxFiFcZYxI4a4ApYZQ3o8Z0nBaDtznBZvanh0PbwejlJk0XCmE2YS9T3HfEC4bkHcuDwkTUxaia/yNCkUKWfjqpJ5RFlxMiUk+rTCqpPXfW09ufn2lM2ejD9IkDd4RlzFrDKgE7FS5TZt6ZNYJ8vFqBXqjOR4J7MPEaCSFowb7dpsphDw1pvtlj83OplxUTrA1DBhZmACPpHxxceWW5fisVBpVB/pchJWNVsmhBfgNR/38ke3H8Gu+2d2IbUF2nIHtZL5ByV/INH3uZPcb9bfkZ6u+mtHQ43rtOu7D3/9/Yka+1/421IK sidebar_class_name: "post api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/retrieve-upload-url.api.mdx b/docs/docs/04-development/02-cache/02-restapi/retrieve-upload-url.api.mdx index d7d021f..8019532 100644 --- a/docs/docs/04-development/02-cache/02-restapi/retrieve-upload-url.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/retrieve-upload-url.api.mdx @@ -5,9 +5,9 @@ description: "Retrieve an upload url for a given upload id (uid)" sidebar_label: "Retrieve upload url" hide_title: true hide_table_of_contents: true -api: eJztWEtvGzcQ/isEL40BWWs7CVDo5sQtYKBJA8c5BYZBLUcSUy654WNtZaH/3hkuLa0etQvDqXqQD7GzM5zXNzPkTMsl+NKpOihr+IhfQXAKGmDCsFhrKySLTrOJdUywqWpg+VlJ9ioqecQHPIip56OvXNSqaE6LUpQzwM/0W93zmwGvhRMVBHDE1nKP9ErwUcvDvAbU6lGpmfLFgDv4HpUDyUfBRRhwg+eQIYARJqBMRUbWIsyQ+TmC0OKnpZhYjcE9IgX9CR87pizsewQ3f6ZNIoaZdeqHSBhkgTMQMtnwLC89uGMxhVXIHsTddGfAh3dWzknmOv7XM2AfLt4yO2EB/8Qzqkl2MfKZzW1kwkHOATJi24bSmkCaUbaoa63KdL745knBDm/s+BuUZGjtbA0uKPBEzWLQmB2er7n+tc97s1h0VF9b4ztRZycn256eLzP5y9UfOcE33B2yD2LOQGEkHBsD+/yaIZu2pdDscqpjTwB/Mb87mSRyy+0BRzMrEQhhp7aisDqZg/Bml99Y4dEZwAKeEJzoGCYC+ZXzgqVi9ewOEOdKaFKJ3MhgbGDKpLxAB9Fop0QAlm16sQD4IEL0t6WVsLMmM70C7zHFd5aF8rfgnHU94thaDcIQVYrwL8xIAm4lBKG0fzoF19lvkBoUmhhEVe/wYuNw3+UtB3vuZNv7spdQn+4u5r9gnqo2wRk9ms6UT1A6KO3UqB8gD9jtGbvX29j9bt1YSYn37TH7aNnaHTF46EkErFTS/IJV62yjZLq313hZ1/mpflO15//mHMjl/A6wqbtDJf8/suHN7krO/Rl7cfcaYtJChyLcK+zblrBEXPHub9LD5IDiPlH89fGrl8ouPx8uL7pyxJeFmWIZNkLT45pk4r0bw9EBy/1ieXa2uyLX5iFE8U509Tix0Rwu1f2C9vapt6+iBzwhFo0Ya2DBspkwkv5aNVtWWofvpKDnBzj3CCeKqwAfNZJmb+uTMzS9j3jR3zkUbXczLooq6qBohDs2whUtTv0LUpxuxm4HEZ2msTiE2o+KgpJhCPeoUMOwtFUalAnYq9Ww/FtH3pxN+7CYiSUyKekS7mR4MjxN/gQ6ydPUeP7pkjxdy8wHAruwpU/TKM7w9DxLjzYJDWhbV5R9qIdCUImUdHngX65tVjubTRXtKn+fueXpIA5wH4paC5VyLYWxzWikDRByNqd5+0Pgjpa7mzVQiELLGIzzjBDFw207Fh6+OL1Y0OdupUJYSeWpRBH9idAeHnHs1VXOuiP2TxbjQLS5wcELNxJjQr0RONaOCa2X1pw/CjPv63ywKIeJFj7/oVaCYEHVnBdEPyncawupVbjR147+vhN5fE0iVhxbbXZ14rwsoQ6P8t70usanPz9fI/M4L72q1Hy5E3e0wMJ/U0hscjE1w/St5VqYaUxdmHcy6edvsKlmQg== +api: eJztWEtvGzcQ/isEL40BWWs7CVDo5sQtYKBJA8c5BYZBLUcSUy654WNtZaH/3hkuLa0etQvDqXqQD7GzM5zXNzPkTMsl+NKpOihr+IhfQXAKGmDCsFhrKySLTrOJdUywqWpg+VlJ9ioqecQHPIip56OvXNSqaE6LUpQzwM/0W93zmwGvhRMVBHDE1nKP9ErwUcvDvAbU6lGpmfLFgDv4HpUDyUfBRRhwg+eQIYARJqBMRUbWIsyQ+TmC0OKnpZhYjcE9IgX9CR87pizsewQ3f6ZNIoaZdeqHSBhkgTMQMtnwLC89uGMxhVXIHsTddGfAh3dWzknmOv7XM2AfLt4yO2EB/8Qzqkl2MfKZzW1kwkHOATJi24bSmkCaUbaoa63KdL745knBDm/s+BuUZGjtbA0uKPBEzWLQmB2er7n+tc97s1h0VF9b4ztRZycn256eLzP5y9UfOcE33B2yD2LOQGEkHBsD+/yaIZu2pdDscqpjTwB/Mb87mSRyy+0BRzMrEQhhp7aisDqZg/Bml99Y4dEZwAKeEJzoGCYC+ZXzgqVi9ewOEOdKaFKJ3MhgbGDKpLxAB9Fop0QAlm16sQD4IEL0t6WVsLMmM70C7zHFd5aF8rfgnHU94thaDcIQVYrwL8xIAm4lBKG0fzoF19lvkBoUmhhEVe/wYuNw3+UtB3vuZNv7spdQn+4u5r9gnqo2wRk9ms6UT1A6KO3UqB8gD9jtGbvX29j9bt1YSYn37TH7aNnaHTF46EkErFTS/IJV62yjZLq313hZ1/mpflO15//mHMjl/A6wqbtDJf8/suHN7krO/Rl7cfcaYtJChyLcK+zblrBEXPHub9LD5IDiPlH89fGrl8ouPx8uL7pyxJeFmWIZNkLT45pk4r0bw9EBy/1ieXa2uyLX5iFE8U509Tix0Rwu1f2C9vapt6+iBzwhFo0Ya2DBspkwkv5aNVtWWofvpKDnBzj3CCeKqwAfNZJmb+uTMzS9j3jR3zkUbXczLooq6qBohDs2whUtTv0LUpxuxm4HEZ2msTiE2o+KgpJhCPeoUMOwtFWRJmVC9mo1Lf/W0TeH0z4uZmKJTFq6jDsZngxPk0OBTvI0Np5/uiRX11LzgcAubOnTOIpDPL3P0qtNQgPa1hWlH+qhGFQiZV2e+Jd7m9XSZlNFu0rgZ655OowD3Iei1kKlZEtxbDMcaQWEnM1pXv8QuqPl8mYNFaLQNgbjPCNI8XDbjoWHL04vFvS526kQWFJ5qlGEfyK0h0cce3WV0+6I/ZPFOBFtrnDwxo3EmFBvBM61Y0LrpTXnj8LM+zofLMphoo3Pf6iVIFhQOecN0U8K99pGahVu9LWjv+9EHl+TiBXHVp9dnTgvS6jDo7w3vbbx6c/P18g8zluvKnVf7sQdbbDw3xQSm1xM3TB9a7kWZhpTG+adTPr5G3eCZnE= sidebar_class_name: "post api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/search-for-access-rules.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/search-for-access-rules.StatusCodes.json index 0fdaec3..3086a07 100644 --- a/docs/docs/04-development/02-cache/02-restapi/search-for-access-rules.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/search-for-access-rules.StatusCodes.json @@ -29,7 +29,11 @@ }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -40,7 +44,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, "ip_block": { "type": "string" }, diff --git a/docs/docs/04-development/02-cache/02-restapi/search-for-access-rules.api.mdx b/docs/docs/04-development/02-cache/02-restapi/search-for-access-rules.api.mdx index a84589d..6202d67 100644 --- a/docs/docs/04-development/02-cache/02-restapi/search-for-access-rules.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/search-for-access-rules.api.mdx @@ -5,9 +5,9 @@ description: "Search for a given access rule by a variety of parameters" sidebar_label: "Search for access rules" hide_title: true hide_table_of_contents: true -api: eJztWN9v4zYM/lcEvWwDcnW73V7y1mE/0JfhcLs9FUEgW0yiO1vySXSuuaD/+0jJaeSLsm7dsGJAnxJbNEXy+0iR2ksNofGmR+OsnMvfQPlmI1bOCyXWZgtWqKaBEIQfWhD1jl5vlTeAO+FWoldedYDgg5xJVOsg57dS9abaXlVm3Q6Vh4AVglUWWYTfycVMZt/Nb/cyNBvolJzvJe56IDMCemPX8n4mPXwcjAct5+gHmElL35FAUska2epe4YaE/6KilWrDUVP8GfV8HMDvnqrI9E9UM3FMDbhx3nxWEZBR4QaUBv9EjUMA/0qt4Riug7oFfxN6ZwME1vjt5SX/TBnxdpQQjbOojKXNiAOtCcgEyMgRBG4UipVBsXODFyFRiVQRzkbR5qyBzaA9VN+3polOVu8Db1RwzdXvoWGre+968GiSmQEVDmHZOA2ZsB26OsbosN6RYeR2MVQmLMF757PF2rkWFIccSBXRMqK7IGGtMLdKea92HEqELjxurdFFC8acWE6W/56KtcHNUC8Z3wR1QebsAqnvTAgmhb4UoH6oCaJChPhrDysKIGhCoaOHqIgiTtwt2zp4UzbDG2I77opAIraF9xOm33JwTkMxO6R15mbu1CMeJHsz65ItTAbTL+vWNR+K3hDzPC6pEJS8AavPLf1pFFSDRZQeiCo1sUWyYAM9RivPwF4KXUbEzLvMlwfLJ/EYrRq3WrBqNJRyqLqSj1/snKfwScJm6TkmX66btmJtr8u1CgdvQQtDlckKY7eqNVrcvBHXWjPG4pMKgliiBTqRyvT/pCyd1qEzZkQFSw1Uq9vwOAem4ov/HsarUxjfbUB8gB0fI+ITeCDE+NQxQViHwkPj1tZ8Bv2C3TNj990pdj87XxutqW98JX51YtLOzARQnQYfgdVG269QUAC2RgOn60RWpCZFOJ+6ifFx5ICx1GyA+IFaDHpJ3Wqn8IUNz8yG1+VM5m1IlGtuPGqEdpBQhLvYRTKWhCud3VvwLyg+K4rfl3I6P1Y57VZAiqksR9i8GxA4L2mmiyPBmKKEdd2+1OhnxZPUHXpyuYboC0/Kc1mdm9GrffpzX6XJbhknuyrNcmxDTNI0tQ++5WESsQ/zKqq6gDvau4UL6qnjeGnsyrGb/E3i0uXF5cVVtBRb9vyGPhPXb27YhwnpDgviR9eEeCFBfRsX/ngcaNhC6/qOecUNtAvYqUincerNLzKyGfXLbfZHdv6zu4+EI8IdVn1LY3IaeuL8kmIe70VIcnt1uAeJ0zceW3D6N3+418jDH+MeAaCQbshV1rbf1yrA7769v+fXqZllWLQJKfMO9xPUSh3vOagjHtjSeJlwRjT2+kfBBT/QBF8zYKUNzkb067cjmb8R52J0GKrtLt/zYMkYjnvOm/HW4l+3IO00uSWZBCmtX6fh6rh2Uso4Tg/Z9stP7yib/wDBisEQ +api: eJztWE2P4zYM/SuCLm2B7Him3V5ym6IfmEux2G5PgyCQLSbRri15JTo72SD/vaRkJ/LG6bTTooMCc0psURT5HkmT2ksNofKmReOsnMvfQPlqI1bOCyXWZgtWqKqCEITvahDljl5vlTeAO+FWolVeNYDgg5xJVOsg5/dStabY3hRmXXeFh4AFglUWWYTfycVMZvvm93sZqg00Ss73EnctkBkBvbFreZhJDx8740HLOfoOZtLSPhJIKlkjW90q3JDwX1S0UnU4aYo/vZ6PHfjdUxWZ9olqRo6pDjfOm88qEtIr3IDS4J+osQvgX6k1nOAa1C14T2idDRBY47fX1/wzjoi3vYSonEVlLB1GMVCbgBwAWXAEgRuFYmVQ7FznRUihRKqIZ6PocNbAZtAZqm1rU0Uni/eBD5pwzZXvoWKrW+9a8GiSmQEVdmFZOQ2ZsO2aMmI0rDdkGLk9CZUJS/De+WyxdK4GxZADqaKwjOwuSFgrzK1S3qsdQ4nQhMetNXrSgj4nlqPlv6dibXDTlUvmN1E9IXNxgdQ3JgSToJ8CqO1KomgCId7tYUUAgiYWGnqIighxit1pWztvps3whqIdd5NEItbTBJs1h+HF844Uyqo2Ke4Joy1tXhxGeXLP0J4DORuKQgZSDskj/idvM9+SJ2d2c2yZdlnWrvowCQ4Fsscl1ZUpEMDqS0t/CqqqcJL0E2iagk+yYAUtRisvRNEUlllcZ95lvhwtHwHUW9UfFWlCQxmMqpny8YuT84pwlv9Ztve5nOumo1jb6+nSh523oIWhQmeFsVtVGy3u3ohbrZl08UkFQWGjBTqRqv7/pMqdl7ULZkQFSw1U+uvweAyMxRf/PY035zS+24D4ADv+KolP4IEY44+YCcI6FB4qR2n5GfQLd8/M3Xfn3P3sfGm0pjb0lfjViVF3NBNAhRt8JFYbbb9CQQBsjQZO15GsSD2PcD41J/1jHwPGUu8C4gfqWOglNb+NwpdoeOZoeD2dyXwMiXLNjZ8aoR0kFuEhNqXMJfHaf/FfWHxOFr+fyun8s8pptwJSTGU50uZdh8B5SSNinDD6FCWuy/qlRj8rn6RuaLnlGqIvPHjPZXFp5C/26c+hSIPiMg6KRRoNj215ugTofM2zKWIb5kVUdQUPdHYNV9RkF3FcNXbl2E/elILp+ur66iaaijW7fkf7xO2bO3ZiFHXDgvjRVSFecFDjxpU/fg80bKF2bcOBxR20C9ioGE/9FJ1fjGQz75fH7E/h+c/uUhKRCA9YtDWN3WmIivNQAj3es5Dk9ma4V4nTPJ56cPo3P96T5PhH4CMDBOmGXGVt+32pAvzu68OBX6dulnnRJqTUG+47qJc63ZtQS9yxpfFy4oJobPZPggt+8IYlpw+4iOjXb/to/kZcwmgY0u0uP3OwpIfjwInT34L86xakk0a3LiOQ0vptmq5Oa2e1jHE6ptsvP72jdP4DDufc6w== sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/search-for-derivation.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/search-for-derivation.StatusCodes.json index bc8b663..f173c52 100644 --- a/docs/docs/04-development/02-cache/02-restapi/search-for-derivation.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/search-for-derivation.StatusCodes.json @@ -61,7 +61,11 @@ }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -72,7 +76,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, "pin": { "type": "boolean" }, diff --git a/docs/docs/04-development/02-cache/02-restapi/search-for-derivation.api.mdx b/docs/docs/04-development/02-cache/02-restapi/search-for-derivation.api.mdx index 836e329..d41aebb 100644 --- a/docs/docs/04-development/02-cache/02-restapi/search-for-derivation.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/search-for-derivation.api.mdx @@ -5,9 +5,9 @@ description: "Search for a derivation in the given tenant. The query parameter e sidebar_label: "Search for derivation" hide_title: true hide_table_of_contents: true -api: eJztGF1v2zbwr3B6WQu4VrJ1D/VbtrZDgGIYuvapMAxKPNtsJVLlh2PH8H/fHSnZkk0vaLIt2JCHpjLveLzvr20mwJZGNk5qlU2yP4Cbcsnm2jDOBBi54gRhUjG3BLaQK8AvUFy5MfuAJ189mA1ruOE1ODAMJOIZ5vgXsEjCeynYs5ulRKIIUMyGBxBWbNj1646u4I4X3AKLmDVwZZlW1Qb/AENmlGYGSm0EEjWA384bBeL5iIBISsk1s04jaMntMhtlji9sNvmU8Ubmq8tcLiqfG7Auj8xbRKGzbDrK9szThW1mkb2aZ5Nt5jYNoE6sM1Itst0oM/DVSwMimzjjYZQpvIcIkSRRJBU23C0R+T6EgjI7OvHH/Qhx75bayNtgvI7gEjha9J4UvQXzgi/gIGdHbkp3bKOVBUsUf7i4oP+GfvW+xWClVo5LhY8Fw+NNXzm09ZxttDete4zZL1fv37z9+O7dJDgZuQfa3fANq/FfAQzqxm2+Q1aIHjGFL/KmqWQZRM4/W3o2IaguPkNJMjRGN2CcjExbx523s1IL6CErXxdBYx28BmtRCUnFSTsDY7TpAQutK3RlfA2QFHrXnFcWpohMEvUQg2ykWAe1vZtbKZIcHOLVzgYo30amDHTApIFzWUGIsbNQK2/TSiwVN+evIvDoZg9oYA4GVAk2DQ+xf552AFs/n8t1EgFTgDtDWdcNXrUy+tMQvrdrtr7FH7fWiWy6GwTRJ9JyT6d9Dfb11dNOTxdDyQdyHknVyTDkmFytTXgP8YgFJnVfzCgHxHSQwDkLQPK1PKPAGDaNLzBwE3FDt4P8qMpZTy6MQ8xvaV69kWk2jMSM6DZJz3SuSpynDHmsilbwgZh9oe6QIPLb4y7yQnZrpEqrpLRykRQRzymxzr7A5kHmxvvJc6ylD6Z9NkbP+E/KBq3/hxvTb7tKog0F2dNJoR9l1EEwRQu15jhVfiDoJFYMx+vmbu/qV6CTetOrLm3t6NPGp4jay4vL08JL5RNZourKbjCRMG+p9kqLLZULPRWyfQviv1JKT2vnGTYCgZkA7DaqVGo/Uv8Qffrv2+7HU9u91aaQQmDX/IL9ptmgqRt1nTYZVkihvncMFbCSAhhXQ1wWWzVqlUOT1f5sfaBtwX/GzgsPsfOvuXvyhkf2hpfpSKZnEBVEO4MxoSFaEdbSOpyW0JZoV6xObbPxZMXHs+KrV6lBKE6uXdgBDtQufB1P0jfcdhEtGH6HUbrwhMwdzc6EQKafa6/E8ST9ZPtHtf1PqXx+sP082GoOSBhLcghZo70DysnUx9M83KZnjPOieqrPj2pPJNdNHNkCgiy05Jlk+bn1Ur6NH7u810LmcbtBLIT8HPdN3lS0TXGusZM8UBrDGp+uYIwDQ9ivSDXXJCXdia50Mb4YXwZGXUWCX+M1dvX7dehZ+z7XAdhrXdqw18PRhZJF6AQEpp9KNzW5FY0c2rqaB29q1z69feBBkONHtgfX/B8tEKNHOVi7vKm4VHG4DHNitH5YLiLm6rJbJoZNmDuMCfg12S8He44QPCC4Ahp3iUonYtstCfDRVLsdHcf1HzmIkDamgElYH/2F8p+9b53+OTsnQZjt9ovGFa884QQvW3Ej6aG//9Fuy6UGb3bMtBraUVC3S8V/SOzBEvMg+2jbwq/KEpo+7CTPkp72qeDXNx8w1fwJRkYfdA== +api: eJztWN1v2zYQ/1c4vawFXCvZuof6LVvbIUAxDFn7VBgGLZ5tthKp8sOxY/h/3x0p2ZJNrWiyLdiQhziS7vjjfZN3u0yALYysndQqm2R/ADfFii20YZwJMHLNicKkYm4FbCnXgE+guHJj9h6/fPFgtqzmhlfgwDCQyGeY45/BIoT3UrBntyuJoEhQzIYNkDbfsuvXLa7gjs+5BRY5K+DKMq3KLf4AQ2GUZgYKbQSCGsBn540C8XxERIRScsOs00hacbvKRpnjS5tNPma8lvn6MpfL0ucGrMuj8BZZ6Fs2HWUH4WnBLrMoXsWzyS5z2xrQJtYZqZbZfpQZ+OKlAZFNnPEwyhSuQ4YISYhkwpq7FTLfBygYs8WJL/cD4t6ttJF3wXkt4Ao4evSeiN6CecGXcNSzhZvSGltrZcES4g8XF/SvH1c3DQcrtHJcKtwsOB5X+tKhrxdsq71pwmPMfrm6efP2w7t3kxBkFB7od8O3rMK/OTCoarf9DkUhPBIKd+R1XcoiqJx/srRtQlE9/wQF6VAbXYNxMgptHXfezgotoMOsfDUPFmvpFViLRkgaTtoZGKNNhzjXusRQxt0AoTC6Fry0MEVm0qjDGHQjwzqo7NellSIpwTFf7azH8m0wRcABkyYuZAkhxwapVt6ljVgoboaXIvFkZYdoYAEGVAE2TQ+5P4wdyNYvFnKTZMAS4AaQdVXjUitjPPXpB79mmzt8ubNOZNN9L4k+kpU7Nu1asGuvjnU6tuhr3tPzRKtWh77EFGpNwXtIRCyxqPv5jGpALAcJnkECwldywIAxbWo/x8RN5A2tDvqjKWcdvTAPsb6lZfVGpsUwEiui2yYj07kynfZySaVqcL9jABSljLURbUR+TofBqSEbs/WM1DXJV/SP2nZ0i5qcyU1hUEuVtnCBzEmLtSCfYfug6MH1ye94ND8YezDlB8Ix5ZQmncKK6bctJdX6ihxwUuwnBbqXm9FDjTvOjR8AncQDyPGqTgTryX7dA+3s+OocVs1R1MXGrQjt5cXl+TlOpzGKRIc1u8W6xLylo1xavKG5cEVDse9A/FdO5vOjeECMADATgJeXMnVSnJi/zz79933347nv3mozl0LgJfwF+02z3h1x1F7cybFCCvW9Y2iAtRTAuOrzsnjzo5t3uLM1r00MNDf6n/Eihx+xkai4e4qGR46Gl+lMpm2QFUTT0jGhIXoRNtI6bL7Ql+jX5kx78uKjevHVq1RfFRvhNu0A+3MXnk4b81tu24wWDJ9DZz73xMwdteLEQK5faK/EaWP+5PtH9f1PqXp+9P0i+GoBCIxHckhZo70DqsnUFlB73ZRnzPN5+XQ+P6o/Ea5tKLIlBF1oZjTJ8qFpVb6LD/u8c4XM47Dk0HPE8ZU3JQ1nnKvtJA9IY9jg1iWMsYPIw7xGqoUmNWlRjKWL8cX4MkjqStL8Gtexq9+vw6W1G3Qtgb3WhQ1zQmxmqFqEq4DA+lPquqK4op5DW1fxEE7NGKkzXzxqcrrJ7hib/6OBZAwpBxuX1yWXKjaroe+M7g/DSuRcX7bDyTBZc8c+AZ8mh2FjJxJCCIRYQOeu0OgEttuRAh9Mud/T5zhOpAgR0sYaMAnjqL8w/rObJuqfsyENQnN3GFyueemJJ0TZmhtJG/39m7ZTM9XbsxWmsdCesroZUv5DaveGokfdR7uGflUUUHdpZ4WW7HSoBb++eY+15k+X7DtP sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/search-for-tenants.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/search-for-tenants.StatusCodes.json index cc76416..9bcabaf 100644 --- a/docs/docs/04-development/02-cache/02-restapi/search-for-tenants.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/search-for-tenants.StatusCodes.json @@ -23,7 +23,11 @@ "preferred_compression_method": { "type": "string" }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -34,7 +38,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] } }, diff --git a/docs/docs/04-development/02-cache/02-restapi/search-for-tenants.api.mdx b/docs/docs/04-development/02-cache/02-restapi/search-for-tenants.api.mdx index 06c4f21..99edc10 100644 --- a/docs/docs/04-development/02-cache/02-restapi/search-for-tenants.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/search-for-tenants.api.mdx @@ -5,9 +5,9 @@ description: "Search through all tenants that you have access too" sidebar_label: "Search for tenants" hide_title: true hide_table_of_contents: true -api: eJztV1FvGzcM/iuCnjrAzSXt9mKgGAqsGPq0It2eCiOgT7RPrU66SpQb18h/L6k7x+fkkmABtqBAnuw7UeRHfiSP3GmDqY62Ixu8nuuPCLFuFDUx5HWjwDlF6MFT4ndAahuyamCDCuoaE78MQc80wTrp+ScNna02Z5Vdu1xFTFQNd1lE3unFTHcQoUXCKBd2OtUNtqDnO03bDhlAomj9Wl/NdMSv2UY0ek4x40x7vscCXzPGrSj01w9Xs8cogkxNiPY7FNcHhQ2CwfhIjTlhfAlr9HRT3ULupC74hEk0vjo9lZ8bsc99TPeSqg6ewHo2ysHHayKEg28YUbkQvsjhKkQ2KNJimvVC1zlbF8eqz0mUT7gTlp+xFqRdDB1Gsj20REA5XdTB4EjY53ZZ4rI/bxkpuzoZHpsuMEYGdThchuAQJMzIqpj6FbiECxY2QGNUECMUegnb9DBaayYRrC01eXkhhPTcTMjcecDqW5uS7eM25V2XlxzfCffkdsQVe4+GQ9jyQ1HE4eJkm8aao52GES2nJ20nWSByE++PUvOTBOd2KAbHj9wcO/WABz3eEboey0Jsk+WsIGi7h6GNs+xWTo0yaMiPsW42Jdp+nSqhc6QcPRplV6VMjDXKB1KcNBtrsJTR76VpvFGlE/0sdXO7UO6AURRcGOTG4dKElRs8HIsv/n8Sz+4nETl7MQqXUUnDVn1HVd8gqRYcd76WBf86L8zy50d9we2ebaNMwFT4x0ub6JnrJ+b69b8vWPBj2p8ZfFIGf3uIQSnCFbLiKK3W8igTMqHiP9xsSYWV/C316GHp0Dzz+YR8srr9VKLXWHwBavihumuMr1LZDsQaxs1+hM/RyaRL1KV5VS6d4CVbcXjC80OZfa1fBXFI7vRZc3pyenJWMJETH9/zNfX2w3tBe5Re+wP1R6iTTLqKJxllff9JMLhBF7pWMkhGppCohZI4w0g+7DNy77CLHFnYHVLwsdtPTxPhJVWd44G9n+rKgNaHtGxGLLk5229CZR+QmB9QDcHlcDXshlza7ZaQ8J/orq7kdb/sSMiNTX39zMsYfY9HL86HjPlF3YWUv5ijtWoDLotM4W0D0YohNirJOTTh/wjB0fZ0gMGbWH/+lmPejc9u9QuBfJ3Sf777m0vmBwKnNLo= +api: eJztV1Fv2zYQ/isEnzrAjZJ1ezFQFAU2FH3qkG5PhRHQ4tliS5EqeXTjGv7vvSNlW47lBA2wBQPyZEu8O373fUfqbiM1xDqYDo13cio/ggp1I7AJPi0boawVCE45jPROoVj7JBq1AqHqGiK99F5OJKpllNNPUnWmWl1VZmlTFSBi1fuSCb+Ts4nsVFAtIAR22MhYN9AqOd1IXHdAACIG45ZyO5EBviYTQMsphgQT6ciPDL4mCGsO6PYP28ljAqmEjQ/mu8qp9wEbUBrCIyOmCOGlWoLDu+Fm7BM77yJEjvjr5SX/3OE+FU53lqL2DpVxtCmRD3shWINvEEBY77/w4sIH2pCteWuKq7rOmjonVn2OHHwkHT//DDUj7YLvIKAp0CIqTPGm9hoGxi6188zLbr0lpJTqKD0m3kAIBOqwOPfegmKagUKR9AtlI8zIWCscolIhqCwvQhsfRmv0KIKlwSbNb1iQos2IzdkFCt+aGE3hbSy7Ls2J35H02DvAgrIHTRS29JADEV1UbONYUzDjMIKh8sT1qAqIdlwds+R6Obvfnn9ZW1MKlThakfNse1TYn5jaUyJ72o5IGlLyQP4l20FuJZMT3BkMGioyVG03kukdrMOiPSnRQUH25TaMTVtxtN/GTuQ1YAoOtDCLfOq00cJ5FFSDK6Mhn8o3+Q56LfLF9n85hqfn7gyMHOBGA91DNo7sckeHY/PZfy/i1f0iApUzBNYyCL7/RbmgxTcVRassXaQtGX64zsrS10x8gfVObS20h5j1h1sT8VnrJ9b61c8fWOWGsj8r+KQK/v6QgnwIF0CBA1+1hjojnxAE/aHLFoVf8N98Hp2aW9DPej6hnhRu13TIJeRcFDb0UJ2bCqqYh419C1ImghQsN86IXZxW2ekCbmkXCxfUUFS5lzZu4Tkjdiplc3lxeXGVQaHlJN+Tn3j713uGe1RfuwXxh68jd86CehthXPkmaFiB9V3LJcQtmI/Yqlw5fYvfz0fsd5htjnbYHGrwsdNU0QnhFqvO0gBQusTc8BVO86RFlqur3WSV5wsm/YCqZ5foaigNdtps5irCP8Fut/y6DE/MuTaxHKBpbsvvyejFdV8yv4hzSOmTORjTVsomtsm6rVQwvBFtytXZ38L/EoKjaewAgya7sv6WOO+GaycXBkPe1/S7P/+mM/MDmG5QlQ== sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/see-logs-of-deployment.api.mdx b/docs/docs/04-development/02-cache/02-restapi/see-logs-of-deployment.api.mdx index 699fd8c..c041b08 100644 --- a/docs/docs/04-development/02-cache/02-restapi/see-logs-of-deployment.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/see-logs-of-deployment.api.mdx @@ -5,9 +5,9 @@ description: "Attach to a given deployment's log. As openapi is not designed for sidebar_label: "See logs of deployment" hide_title: true hide_table_of_contents: true -api: eJzNVcFu2zAM/RVBl7WAEScYdvEtwIaht6HbTkUQKDZja7UlVZTTBkb+faRsN3HSdj1swHJIFFIkH8lHqpMFYO61C9oamcllCCqvRLBCiVLvwIgCXG33DZjwAUVty5lYorAOjHJaaBTGBrqDujRQiK314hE2aPN7CJgIBBC6rNsTL3TcQU0OvChs3rJIcfBou219FVgDQekaZSKDKlFmd5KipbtF2vsheU4w9RMdBskqkU551QCZs0EnMa+gUTLrZNg7oNwweG1KeUikh4dWeyhkFnwLiTRkRxeOINe6INeaK+JUqMjmdX+JBNM2jPE5c7l6PUjrSq8KGN1XQH/8OwOMtm+4z60xkMdunkVYsQ06axCQgyzmC/6Z9v8WQuu5k3orQgXUQL+jfqj83tjHGooSMMqPYcQASihTCHzUgbJAJtBzNcTViJXFTAmi0XvIgVM+RdE1996aQJcJ/YEK8Wn+8c95bEGRAOhMlPW2DcDcJcYEYbcjjYnTG8pxEoGI52qdR4qmv5Cdv9Apu/lF1SBD5xl80H2Jkajd4jq31LPjZWrmJrZ81DeAqEp4kaoa1+C99SfKjbU1KMPaQoV3wIgO1uNMXUaZsOnu7DpzLWiCGFTjXsjizPg05YsET9IZsJ/6Xh34k0ia4cqSM1lCzIUHMJPpZAOkRKG0mwzsgeNFuvbz3/qa2R+CwyxNmWgzeKI4Ncxy28R50GZrOSW26Xkzn81ni4gq1JzlDfNz+e0mLppTgo0K8XnkaYvEKSP2tvUjjRkZt8lZDI2K1BnG9PswBcy+YxbnUbojEf/DzdzzIMBTSF2tdCRkLHo39Cxubbq5Wxz3dCIJKX1n02VLzaioSGzTdRuF8NPXhwOLH1rwe5LTcae85gmN7S009tOabVWN8Eblrm4Hfl6L12APQmUY4E7VLf+j4z3sL96FA0/EsFT/OpA+4PGNeMbCD8Q/iDR5LibBev0yz8GFE93FOuQ5ep7Yr19+0Eb4Df6s5mw= +api: eJzNVcFu2zAM/RVBl7WAEScYdvEtwIaht6HbTkUQKDZja7UlVZTTBkb+faRsN3HSdj1swHJIFFIkH8lHqpMFYO61C9oamcllCCqvRLBCiVLvwIgCXG33DZjwAUVty5lYorAOjHJaaBTGBrqDujRQiK314hE2aPN7CJgIBBC6rNsTL3TcQU0OvChs3rJIcfBou219FVgDQekaZSKDKlFmd5KipbtF2vsheU4w9RMdBskqkU551QCZs0EnMa+gUTLrZNg7oNwweG1KeUikh4dWeyhkFnwLiTRkRxeOINe6INeaK+JUqMjmdX+JBNM2jPE5c7l6PUjrSq8KGN1XQH/8OwOMtm+4z60xkMdunkVYsQ06axCQgyzmC/6Z9v8WQuu5k3orQgXUQL+jfqj83tjHGooSMMqPYcQASihTCHzUgbJAJtBzNcTViJXFTAmi0XvIgVM+RdE1996aQJcJ/YEK8Wn+8c95bEGRAOhMlPW2DcDcJcYEYbcjjYnTG8pxEoGI52qdR4qmv5Cdv9Apu/lF1SBD5xl80H2Jkajd4jq31LPjZWrmJrZ81DeAqEp4kaoa1+C99SfKjbU1KMPaQoV3wIgO1uNMXUaZsOnu7DpzLWiCGFTjXsjizPg05YsET9IZsJ/6Xh34k0ia4cqSM1lCzIUHMJPpZAOkRKG0mwzsgeNFuvbz3/qa2R+CwyxNmWgzeKI4Ncxy26RxILTZWs6JjXrizGfz2SLCCjWnecMEXX67iZvmlGGjQnweidoikcqIvW39yGOGxn1yFkOjIneGOf0+jAHT75jGeZTuyMT/cDX3RAjwFFJXKx0ZGaveDU2La5tu7hbHRZ1IQkrf2XTbUjMqKhLbdN1GIfz09eHA4ocW/J7kdNwpr3lEY38Ljf24ZltVI7xRuavbgaDX4jXYg1AZBrhTdcv/6HgP+4uH4cAjMWzVvw6kD3h8JJ6x8AvxDyJN3otJsF6/zHNw4UR3sQ95jp5H9uuXH7QSfgNeaeab sidebar_class_name: "get api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/sidebar.ts b/docs/docs/04-development/02-cache/02-restapi/sidebar.ts index c7a23e5..66a0241 100644 --- a/docs/docs/04-development/02-cache/02-restapi/sidebar.ts +++ b/docs/docs/04-development/02-cache/02-restapi/sidebar.ts @@ -8,67 +8,67 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/cachix-agent-deployment-websocket", + id: "04-development/02-cache/02-restapi/cachix-agent-deployment-websocket", label: "Cachix agent deployment websocket", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/cachix-agent-idle-websocket", + id: "04-development/02-cache/02-restapi/cachix-agent-idle-websocket", label: "Cachix agent idle websocket", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/upload-and-activate-a-new-deployment", - label: "Upload and activate a new deployment", - className: "api-method post", + id: "04-development/02-cache/02-restapi/get-a-tenant-in-cachix-format", + label: "Get a tenant in cachix format", + className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-a-tenant-in-cachix-format", - label: "Get a tenant in cachix format", - className: "api-method get", + id: "04-development/02-cache/02-restapi/upload-and-activate-a-new-deployment", + label: "Upload and activate a new deployment", + className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-deployment-overview", + id: "04-development/02-cache/02-restapi/get-deployment-overview", label: "Get deployment overview", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/upload-new-cachix-signing-key", - label: "Upload new cachix signing key", - className: "api-method post", + id: "04-development/02-cache/02-restapi/see-logs-of-deployment", + label: "See logs of deployment", + className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/retrieve-new-upload-id", - label: "Retrieve new upload ID", + id: "04-development/02-cache/02-restapi/upload-new-cachix-signing-key", + label: "Upload new cachix signing key", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/checks-if-a-given-array-of-narhashes-is-already-cached", + id: "04-development/02-cache/02-restapi/checks-if-a-given-array-of-narhashes-is-already-cached", label: "Checks if a given array of narhashes is already cached", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/see-logs-of-deployment", - label: "See logs of deployment", - className: "api-method get", + id: "04-development/02-cache/02-restapi/retrieve-new-upload-id", + label: "Retrieve new upload ID", + className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/retrieve-upload-url", + id: "04-development/02-cache/02-restapi/retrieve-upload-url", label: "Retrieve upload url", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/finish-a-given-upload", + id: "04-development/02-cache/02-restapi/finish-a-given-upload", label: "Finish a given upload", className: "api-method post", }, @@ -80,31 +80,31 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/cachix-agent-deployment-websocket", + id: "04-development/02-cache/02-restapi/cachix-agent-deployment-websocket", label: "Cachix agent deployment websocket", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/cachix-agent-idle-websocket", + id: "04-development/02-cache/02-restapi/cachix-agent-idle-websocket", label: "Cachix agent idle websocket", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/upload-and-activate-a-new-deployment", + id: "04-development/02-cache/02-restapi/upload-and-activate-a-new-deployment", label: "Upload and activate a new deployment", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-deployment-overview", + id: "04-development/02-cache/02-restapi/get-deployment-overview", label: "Get deployment overview", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/see-logs-of-deployment", + id: "04-development/02-cache/02-restapi/see-logs-of-deployment", label: "See logs of deployment", className: "api-method get", }, @@ -112,95 +112,65 @@ const sidebar: SidebarsConfig = { }, { type: "category", - label: { - name: "nix", - }, + label: "nix", items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/get-nix-derivation-in-nix-caching-format", - label: "Get nix derivation in nix caching format", + id: "04-development/02-cache/02-restapi/get-nix-cache-info", + label: "Get nix cache info", className: "api-method get", }, - ], - }, - { - type: "category", - label: { - name: "nix", - }, - items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/get-nix-cache-info", - label: "Get nix cache info", + id: "04-development/02-cache/02-restapi/get-nix-derivation-in-nix-caching-format", + label: "Get nix derivation in nix caching format", className: "api-method get", }, - ], - }, - { - type: "category", - label: { - name: "nix", - }, - items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/fetch-a-nix-binary", + id: "04-development/02-cache/02-restapi/fetch-a-nix-binary", label: "Fetch a nix binary", className: "api-method get", }, ], }, - { - type: "category", - label: "api/v2/deploy", - items: [ - { - type: "doc", - id: "02-cache/04-development/02-restapi/upload-and-activate-a-new-deployment", - label: "Upload and activate a new deployment", - className: "api-method post", - }, - ], - }, { type: "category", label: "api/v1/cache", items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/get-a-tenant-in-cachix-format", + id: "04-development/02-cache/02-restapi/get-a-tenant-in-cachix-format", label: "Get a tenant in cachix format", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/upload-new-cachix-signing-key", + id: "04-development/02-cache/02-restapi/upload-new-cachix-signing-key", label: "Upload new cachix signing key", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/retrieve-new-upload-id", - label: "Retrieve new upload ID", + id: "04-development/02-cache/02-restapi/checks-if-a-given-array-of-narhashes-is-already-cached", + label: "Checks if a given array of narhashes is already cached", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/checks-if-a-given-array-of-narhashes-is-already-cached", - label: "Checks if a given array of narhashes is already cached", + id: "04-development/02-cache/02-restapi/retrieve-new-upload-id", + label: "Retrieve new upload ID", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/retrieve-upload-url", + id: "04-development/02-cache/02-restapi/retrieve-upload-url", label: "Retrieve upload url", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/finish-a-given-upload", + id: "04-development/02-cache/02-restapi/finish-a-given-upload", label: "Finish a given upload", className: "api-method post", }, @@ -208,240 +178,258 @@ const sidebar: SidebarsConfig = { }, { type: "category", - label: "api/v1/deploy", + label: "api/v2/deploy", items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/get-deployment-overview", - label: "Get deployment overview", - className: "api-method get", - }, - { - type: "doc", - id: "02-cache/04-development/02-restapi/see-logs-of-deployment", - label: "See logs of deployment", - className: "api-method get", + id: "04-development/02-cache/02-restapi/upload-and-activate-a-new-deployment", + label: "Upload and activate a new deployment", + className: "api-method post", }, ], }, { type: "category", - label: "api/v1/iglu/upload", + label: "iglu", items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/upload-a-nix-binary", - label: "Upload a nix binary", - className: "api-method put", + id: "04-development/02-cache/02-restapi/healthcheck", + label: "Healthcheck", + className: "api-method get", }, - ], - }, - { - type: "category", - label: "iglu", - items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/upload-a-nix-binary", + id: "04-development/02-cache/02-restapi/upload-a-nix-binary", label: "Upload a nix binary", className: "api-method put", }, { type: "doc", - id: "02-cache/04-development/02-restapi/modify-api-key-access", - label: "Modify API Key access", - className: "api-method patch", + id: "04-development/02-cache/02-restapi/get-signing-key-information", + label: "Get Signing Key information", + className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-available-tenants", - label: "Get available tenants", - className: "api-method get", + id: "04-development/02-cache/02-restapi/create-a-new-tenant", + label: "Create a new tenant", + className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/create-new-api-key", - label: "Create new API Key", - className: "api-method post", + id: "04-development/02-cache/02-restapi/search-for-tenants", + label: "Search for tenants", + className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/delete-api-key", - label: "Delete api key", - className: "api-method delete", + id: "04-development/02-cache/02-restapi/get-tenant-information", + label: "Get Tenant information", + className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/create-a-new-tenant", - label: "Create a new tenant", - className: "api-method post", + id: "04-development/02-cache/02-restapi/update-a-tenant", + label: "Update a tenant", + className: "api-method patch", }, { type: "doc", - id: "02-cache/04-development/02-restapi/search-for-tenants", - label: "Search for tenants", - className: "api-method get", + id: "04-development/02-cache/02-restapi/delete-a-tenant", + label: "Delete a tenant", + className: "api-method delete", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-tenant-information", - label: "Get Tenant information", + id: "04-development/02-cache/02-restapi/get-available-signing-keys", + label: "Get available signing keys", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/update-a-tenant", - label: "Update a tenant", + id: "04-development/02-cache/02-restapi/update-signing-key", + label: "Update signing key", className: "api-method patch", }, { type: "doc", - id: "02-cache/04-development/02-restapi/delete-a-tenant", - label: "Delete a tenant", + id: "04-development/02-cache/02-restapi/deletes-public-signing-key-tenant-link", + label: "Deletes public signing key - tenant link", className: "api-method delete", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-access-rule", + id: "04-development/02-cache/02-restapi/get-access-rule", label: "Get Access Rule", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/delete-access-rule", + id: "04-development/02-cache/02-restapi/delete-access-rule", label: "Delete Access Rule", className: "api-method delete", }, { type: "doc", - id: "02-cache/04-development/02-restapi/update-access-rule", + id: "04-development/02-cache/02-restapi/update-access-rule", label: "Update Access Rule", className: "api-method patch", }, { type: "doc", - id: "02-cache/04-development/02-restapi/create-access-rules", + id: "04-development/02-cache/02-restapi/create-access-rules", label: "Create access rules", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/search-for-access-rules", + id: "04-development/02-cache/02-restapi/search-for-access-rules", label: "Search for access rules", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-registered-api-keys", - label: "Get registered API Keys", + id: "04-development/02-cache/02-restapi/get-information-about-derivation", + label: "Get information about derivation", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-available-signing-keys", - label: "Get available signing keys", + id: "04-development/02-cache/02-restapi/delete-derivation", + label: "Delete derivation", + className: "api-method delete", + }, + { + type: "doc", + id: "04-development/02-cache/02-restapi/search-for-derivation", + label: "Search for derivation", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/update-signing-key", - label: "Update signing key", - className: "api-method patch", + id: "04-development/02-cache/02-restapi/pin-derivation", + label: "Pin derivation", + className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/deletes-public-signing-key-tenant-link", - label: "Deletes public signing key - tenant link", - className: "api-method delete", + id: "04-development/02-cache/02-restapi/modify-api-key-access", + label: "Modify API Key access", + className: "api-method patch", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-signing-key-information", - label: "Get Signing Key information", + id: "04-development/02-cache/02-restapi/get-available-tenants", + label: "Get available tenants", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-information-about-derivation", - label: "Get information about derivation", - className: "api-method get", + id: "04-development/02-cache/02-restapi/create-new-api-key", + label: "Create new API Key", + className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/delete-derivation", - label: "Delete derivation", + id: "04-development/02-cache/02-restapi/delete-api-key", + label: "Delete api key", className: "api-method delete", }, { type: "doc", - id: "02-cache/04-development/02-restapi/search-for-derivation", - label: "Search for derivation", + id: "04-development/02-cache/02-restapi/get-registered-api-keys", + label: "Get registered API Keys", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "api/v1/deploy", + items: [ + { + type: "doc", + id: "04-development/02-cache/02-restapi/get-deployment-overview", + label: "Get deployment overview", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/pin-derivation", - label: "Pin derivation", + id: "04-development/02-cache/02-restapi/see-logs-of-deployment", + label: "See logs of deployment", className: "api-method get", }, ], }, + { + type: "category", + label: "api/v1/iglu/upload", + items: [ + { + type: "doc", + id: "04-development/02-cache/02-restapi/upload-a-nix-binary", + label: "Upload a nix binary", + className: "api-method put", + }, + ], + }, { type: "category", label: "api/v1/iglu/rest/keys", items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/modify-api-key-access", - label: "Modify API Key access", - className: "api-method patch", + id: "04-development/02-cache/02-restapi/get-signing-key-information", + label: "Get Signing Key information", + className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-available-tenants", - label: "Get available tenants", + id: "04-development/02-cache/02-restapi/get-available-signing-keys", + label: "Get available signing keys", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/create-new-api-key", - label: "Create new API Key", - className: "api-method post", + id: "04-development/02-cache/02-restapi/update-signing-key", + label: "Update signing key", + className: "api-method patch", }, { type: "doc", - id: "02-cache/04-development/02-restapi/delete-api-key", - label: "Delete api key", + id: "04-development/02-cache/02-restapi/deletes-public-signing-key-tenant-link", + label: "Deletes public signing key - tenant link", className: "api-method delete", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-registered-api-keys", - label: "Get registered API Keys", - className: "api-method get", + id: "04-development/02-cache/02-restapi/modify-api-key-access", + label: "Modify API Key access", + className: "api-method patch", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-available-signing-keys", - label: "Get available signing keys", + id: "04-development/02-cache/02-restapi/get-available-tenants", + label: "Get available tenants", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/update-signing-key", - label: "Update signing key", - className: "api-method patch", + id: "04-development/02-cache/02-restapi/create-new-api-key", + label: "Create new API Key", + className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/deletes-public-signing-key-tenant-link", - label: "Deletes public signing key - tenant link", + id: "04-development/02-cache/02-restapi/delete-api-key", + label: "Delete api key", className: "api-method delete", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-signing-key-information", - label: "Get Signing Key information", + id: "04-development/02-cache/02-restapi/get-registered-api-keys", + label: "Get registered API Keys", className: "api-method get", }, ], @@ -452,85 +440,85 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "02-cache/04-development/02-restapi/create-a-new-tenant", + id: "04-development/02-cache/02-restapi/create-a-new-tenant", label: "Create a new tenant", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/search-for-tenants", + id: "04-development/02-cache/02-restapi/search-for-tenants", label: "Search for tenants", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-tenant-information", + id: "04-development/02-cache/02-restapi/get-tenant-information", label: "Get Tenant information", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/update-a-tenant", + id: "04-development/02-cache/02-restapi/update-a-tenant", label: "Update a tenant", className: "api-method patch", }, { type: "doc", - id: "02-cache/04-development/02-restapi/delete-a-tenant", + id: "04-development/02-cache/02-restapi/delete-a-tenant", label: "Delete a tenant", className: "api-method delete", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-access-rule", + id: "04-development/02-cache/02-restapi/get-access-rule", label: "Get Access Rule", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/delete-access-rule", + id: "04-development/02-cache/02-restapi/delete-access-rule", label: "Delete Access Rule", className: "api-method delete", }, { type: "doc", - id: "02-cache/04-development/02-restapi/update-access-rule", + id: "04-development/02-cache/02-restapi/update-access-rule", label: "Update Access Rule", className: "api-method patch", }, { type: "doc", - id: "02-cache/04-development/02-restapi/create-access-rules", + id: "04-development/02-cache/02-restapi/create-access-rules", label: "Create access rules", className: "api-method post", }, { type: "doc", - id: "02-cache/04-development/02-restapi/search-for-access-rules", + id: "04-development/02-cache/02-restapi/search-for-access-rules", label: "Search for access rules", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/get-information-about-derivation", + id: "04-development/02-cache/02-restapi/get-information-about-derivation", label: "Get information about derivation", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/delete-derivation", + id: "04-development/02-cache/02-restapi/delete-derivation", label: "Delete derivation", className: "api-method delete", }, { type: "doc", - id: "02-cache/04-development/02-restapi/search-for-derivation", + id: "04-development/02-cache/02-restapi/search-for-derivation", label: "Search for derivation", className: "api-method get", }, { type: "doc", - id: "02-cache/04-development/02-restapi/pin-derivation", + id: "04-development/02-cache/02-restapi/pin-derivation", label: "Pin derivation", className: "api-method get", }, diff --git a/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.RequestSchema.json b/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.RequestSchema.json index 404315d..c677115 100644 --- a/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.RequestSchema.json +++ b/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.RequestSchema.json @@ -15,7 +15,8 @@ "preferred_compression_method": { "type": "string" }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { "type": "string", "enum": ["client", "server"] } }, "required": [ "id", @@ -26,7 +27,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] } } diff --git a/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.StatusCodes.json index 3290f72..a4fc2d0 100644 --- a/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.StatusCodes.json @@ -21,7 +21,11 @@ "preferred_compression_method": { "type": "string" }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -32,7 +36,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, "timestamp": { "type": "number" } diff --git a/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.api.mdx b/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.api.mdx index 7df80a6..27f0509 100644 --- a/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/update-a-tenant.api.mdx @@ -5,9 +5,9 @@ description: "Change aspects of a tenant" sidebar_label: "Update a tenant" hide_title: true hide_table_of_contents: true -api: eJztWF9v2zgM/yqCXnYHpEna7V7y1vU23F6GoeieiiCQbSbWzpY8iU6bBfnuR0pObC9uOxQFegPSh9QW/4jkj5RMbmUGPnW6Qm2NnMmrXJkVCOUrSNELuxRKIBhlUI4kqpWXs1upKj1Zn0/0qqgnDjxOIocnFl6T85GslFMlIDgW2Eqf5lAqOdtK3FRA+3h02qzkbiQdfK+1g0zO0NUwkobkiOGwqWazKoU5MT9Hkaoxt07/UMHDRl8OKgP3TI21B3emVtCat1c3jzIUkvc227DOfnQ/w53wqBA4sJhDG9rUGmSFJKKqqtBpMHfyzbPcgJE2+UYAkWDlbAUONXim6mzQkZXGvE4WbHj0YYDnQQKpL7X3OlpyRNZ+UdUJWdyhJtYWoEyQdrAER0FcpLakl6BoQamR22Fba6eHzXCaYMRNh2jqMgkoSsRiYL0H4S0H5zgUjeM9N7tOPeFBtLdjXbRlvtvF3X1ljY/YXEynv5wRQi2pdsJCXWVEfrkU4d1qT75kMBjKhl6Sn5TjD0FOAbFuAPGRBFJF0V6qwsOcmMn6U+L+RolL/zWBj6qsnrasm0xHqdNJlCYNurqbEnk3PT+uihvK+39hIza2FnfgqAg8BVNoL4xF4SC1K6N/QPa7VMUvl0FQsMgAlS78wC4/hb/P/grYvT3G7qN1ic4yMOJMfLaid/2OBFAW08HGwGY6M29QUADWOqNPDtPnFfFSFTZwu/1rkwPahMPxPShHi0vrSvWC1+gpG56VDe+GK7n5JIJsf7llFiKKcK89CstYEq50sq3BnVB8XRQvLo5RvAasnSEA73KIhZfQ922o4qZ8iaR6lZlaunlSPJXm/wHUv4Y+PY9BTR3Eo3dJZhKBnrife+MFtXM4Ftfhe0KgDdxhU4I7IhzE6L20dF1HR0+gvzLoA7fzAXQd240lIV4TYuEAdramRkRHuLkhaS5bOrWT4vS19ap4krp978HTkDRnb3gqMpOTh+Yxk2182PGO4XKN05jaFTy0QKz8bBLExnBPOxUwpk4hjDEY0et2lPEhkved2j5CAw1aS/r5vduOtaudLiwOWR7vu1rB0G51tB+6rGnTVU05S+h0YqPZ9bjxdDwdn4fwIvsjP5H34vLLJw58r1L2BPG3TX042shJvt3C12gGayhsVXIxcI9nPZYq1EDj9tfQtnenZz3127aUnpi5xaxCuMdJVShtYqsZusaIf5jHEef6fD9/C4OHIHyYy80ahQRtTray1HabKA9fXbHb8TJh7Sh6t/S4Vk5zxYdkybSP1T8LLf0jfvxx3eT7n+Ihw5tFZbjfXKui5jd6pGavnfntuLSakdqLWxB36o3wDnbwODDSr6LKsxtW0XIcnXmtxGWaQoWP8s47Jfzl8ubqH+JOmjlhGY5C6dQdo0e/ISw2+BiOprC2lQWlSh3ORBmV8t9/cfiiJA== +api: eJztWFFv4zYM/iuCXm4D0jjtbi9563Ubdi+HQ9F7KoJAtplYN1vSJDltLsh/Hyk5sV07vUNRoBuWPhSxRFIkP5ISueM5uMxK46VWfM5vCqHWwIQzkHnH9IoJ5kEJ5fmEe7F2fH7PhZHJ5jKR67JOLDifRAqHJLTGFxNuhBUVeLDEsOMuK6ASfL7jfmsAz3HeSrXm+wm38HctLeR87m0NE66QDwmOh0pSywhfIPFLBInaF9rKbyJY2MgrQORgXyixdmAvxBpa9Q7iFpEHXfJB51uS2ffuJ3hgzgsP5FhfQOvaTCtPApFFGFPKLKibfHXEN6KkTr8iQMhorDZgvQRHuzIfNWQtfVGnS1I82jBCc3IDxVfSORk1GWxLtzR1ihp3dlOtSxAqcFtYgUUnLjNd4UcQtMTQKPS4rrWV42pYiTD6bWdT1VUaUOTel6PrTq4V8p88b8IBiSmms1JGQNFHG2Re7HsBcE+uHTqycVvPSV2XfMf+aG3HtmjJQG9UJqrjjFYuQn01m/1wgDGxwlQMC7XJcfv1Io5Oqx0al8M4AnG/QsMxZU5FEHpI25EAOuKzEqWDBRKj9uc8+P/mAW5IjCUvKjNi6BNVu7E5iMRO3DVR1ZXdZNz72eUwye4wjf6CLdvqmj2AxZxyqCOTjintmYVMo9LfIP+vJNkPZ1UQsMzBC1m6kVOeuL9P/gbY/TLE7g9tU5nnoNgF+6RZ73EwYYBhjXWSgM1lrt55hg7YyBwfRKpPy+KVz3SgtofPJgakCrX2AwiLiyttK/GKl/w5Gl4UDe/HM7l5sEF+uCtzDRFFeJTOM01YIq5NPTyj+KYoXl0NUbwFX1uFAD4UEBMvxdd3yOImfXFL9DIz03gVZf6cmv8GUH8de8kOQc0sxNK7QjVxA39Rt/nOMWw2/ZTdhgcG8zpQh0MR7ohwYMPvSuN1HQ09g/7GoI/czkfQZexeVoh4jYiFAmx1jX2NjHBTf9Nctli10/L82npTPFHcobWgWU1WkDU0s5nz5NS0KNnFH/tjsxFnRbUtaaTivXHzJLBN4RFPKmGKrUMSpiwE6W07afk97h86v7arGTR87dbT72571652uro4A3q+j2sZQ/vWkX7s2mZNlzYbdmWH5osCCAsXmUNeiSrNprPpZfC8J0v5R3QMu/78kTDpJdFhg/2mMxeqHppPF194qOawgVKbqjnHaOcrEdKjcciXMCDojv164ndtln1nWBgDzsOjT0wppIpNbehPY2iEQSJSbi4Pg8Mw4gjMx4HivBGIoBeoK3Htdqlw8MWW+z0tYxRY9Os9/twIK6kYhDjKpYuFYR6GB8/Y8dNtkwo/s1OKN4tCUW+6EWVNX/gT+8B2WLmnrGtmga+uQTypN3s86kFzzLh/E0Ve3JGIlmJQDluO6ywD45+lXXSy+/P13c2fSJ02A84qVEluxQOhh/+DW3SwMVStsLbjJYZKHcolj0Lp7x8gb+Ln sidebar_class_name: "patch api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/update-access-rule.StatusCodes.json b/docs/docs/04-development/02-cache/02-restapi/update-access-rule.StatusCodes.json index f14c00a..430ca34 100644 --- a/docs/docs/04-development/02-cache/02-restapi/update-access-rule.StatusCodes.json +++ b/docs/docs/04-development/02-cache/02-restapi/update-access-rule.StatusCodes.json @@ -25,7 +25,11 @@ "preferred_compression_method": { "type": "string" }, "uri": { "type": "string" }, "priority": { "type": "number" }, - "ttl": { "type": "number" } + "ttl": { "type": "number" }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -36,7 +40,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, "ip_block": { "type": "string" }, diff --git a/docs/docs/04-development/02-cache/02-restapi/update-access-rule.api.mdx b/docs/docs/04-development/02-cache/02-restapi/update-access-rule.api.mdx index be696ce..d83baa8 100644 --- a/docs/docs/04-development/02-cache/02-restapi/update-access-rule.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/update-access-rule.api.mdx @@ -5,9 +5,9 @@ description: "Update a given Access Rule" sidebar_label: "Update Access Rule" hide_title: true hide_table_of_contents: true -api: eJztWEtvGzcQ/isEL0kB2ZLd9KKbk7aoL4VhOKfAELjLkcRkl9zyIVsR9N87Q1LeXXllJ4FRIYV9MLR8zHDmm2/ImQ2X4EqrGq+M5lP+sZHCAxNsoVag2UVZgnPsOlTAR9yLhePTT1w0arw6G6tFFcYWnB970EJ7h0tojN+OeCOsqMGDpQ0b7sol1IJPN9yvG0A9zlulF3w74hb+CcqC5FNvA4y4xn24IIkkiXSsRvglLv4RQSKaMLNogpsp+RISg18aq76K6LMsbwlCgv1BicGBPRELaA3eibtNe9DJ741ck8w+XjdLYBrumPMEm8evZC8je5lbmlBJZmFeQUmy9/WXRnvSinJF01SqjDaNPzsSPmCJKT4nQY01DVivwNGsamZFZcovgzY3VqG3/LozqUNdRGchOsmQ/X0jDriIgk2iJj6KMDae3253TnukqefeT+2ZOid40JeF3G63aZtrjHbJlvPJ5LGbr8EHq110cOtuM48DiSodv/MXcyzpCW5WGgmD7svzNWrG8Bl0v3IzsNbYzmRhTAVCt06ei8oBuRbJ/y1wy0FNOQvMetPfJ2Kh/DIUM+LDAZQPwo8awNbKucF4So5oQoFQDHgihinM0VEg0ds1fkRB6Fnk+vBZg1XfH+/eVwPj+6FLWWrfFdnwnpldo56xIJ23xwU6C4H+JHsxwqyfqWbQGtDy0NSxWE+WdgJx1M0DD7Y8nPzJ3ICCFDLLi3rIxD3FXaY+4mWHhZljXdk5C72bnA3n9y+wZmsT2B1YYMGh2Uw5po3HxF6ahVZfQf4sKeebc0wUMJPgharc87j3lx8Bu18fY/ensYWSEu+GE/a3Yb1nw4gB8htsBFYqqd94hg5YKYk3uO6vZekxwExcbXefOQaUjpfQexAWB+fG1sK/RsORo+HdMJPzUw4kSymKSQMJRbhXzjNDWCKumPNXYF9RPC6K5+eHHoII4N0SEvEyayUr8IHO7oQjRiKFlV6JSkl8g4vmp3kR/m+hHEjPfShFqphCqn/vct3kQhUzLD0g6N41wUfQM5HZ5dUpuyHG5n0lAl8AqzFB45qFsLKioiAWCsKPmEoVA8bCXNmaoRC7ZrFWpnS+C6XXaDlqtPx2uALEaMkQJsBlJHzQLsTqbx6qipI4dUHeOAL29So+NpZPMT9jOQcUbCHdvRY5DpGNiB4xN7+z8MIuqlduHhVPFLcryKmBVy7JGmrkTfn4UFNyvEk/tuNuJ3C82esLbulA8dmVOpbBVtSG875x03GUegr3eJAKTrG6jo05Avy6bc79kab7/bC2sm0L4klbAO/q3NwH7CCr54Yk0XnSysnp5PQsusSTEn6JR2IXV5fkrF507ybY76Z0VBBgzQh0icXiQcIKKtPUFMBUphvnaxHjNp8hd4D7nd+ehk3LgGf6xSkYPNz7cVMJpVPbJHZAEmyxl4wrV2e73nHsxvm2iMdf04decBczmtjv7SIoSzSI5G42hXDw0VbbLQ3HmxbH8edKWEVUjjBL5RKtp7EH9oSlb69zIP/CDpmWB4WmbgK+/gJ94U8s4NuONnWI/0Ot+y7aEmVzd/nFHZBU9rrZDwciu9P8hyTy5GYdH8a7FY9yabvjIrWBnlp720kNVxc3H/7C1UVumdcxxXIr7ii88H/0j4k2xpQXxza8EnoRYq7lSSj9/QsgnssZ +api: eJztWEtvGzcQ/isEL0kB2ZLd9KKbk7aoL4VhOKdAELjLkcRkd7nlQ7Ii6L93hqS0u9LKTgKjQgr7YGj5mOF838yQMxsuweZG1U7pio/5x1oKB0ywuVpCxW7yHKxl974APuBOzC0ff+KiVsPl1VDNCz80YN3QQSUqZ3EJjfHJgNfCiBIcGNqw4TZfQCn4eMPdugbUY51R1ZxvB9zAP14ZkHzsjIcBr3AfLogiSSIdqxZugYt/RJAIJkwNmmCnSr6ERO8W2qivImCW5C1ASDA/KNFbMBdiDo3BO3GTuAdBfq/lmmR2+XpYAKtgxawj2hx+RXsZ2cvsQvtCMgOzAnKSfag/15UjrShX1HWh8mDT8LMl4T2W6OxzFFQbXYNxCizNqnqaFTr/0mtzbRSi5datycqXWQAL2YmGHO4bcMBF5GwSNfFBoLF2fLLdgXakqQPvp+ZMrRPs9SUhk+02brO1rmy05Xo0Oob5Hpw3lQ0AN3DrWRiIodLCnb8YsKTH22muJfTCl+ZL1Izu0wu/slMwRpvWZKZ1AaJqQJ6JwgJBi8H/LXTLXk0pC0w7098nYq7cwmdTiocTLJ+kHzWAKZW1vf4Ugah9hlT0IBHcFGYIFEhEu8SPIAiRxVjvP6s36vv93bmin0g1r3D/SX1NPOSFinkCMVri5smR41OOOwQywdYBqQ3JM/ZHazuRRJYcnZt86MlkgA5r3FTVvSBAJU9NnSuJkOktvx6008relv3Jn0w1KEhhoDpR9pl4oLgd+Edh3grqFLJt2SmpvRtd9V8XX2DN1tqzFRhg3qLZTFlWaYf3RK6Rzq8gf5YM9s0pKwiYSnBCFfZ53rvLz8Ddr8fc/alNpqTEq+aC/a1Z5xUyYIABDyYQK5Ws3jiGACyVxAdB1V3L4tuC6bDa7D6TD6gq3GnvQRgcnGlTCvfqDWf2hnf9kZxehiBZTFFMaogswqOyjmniEnlNN8Uri2dl8fr61LsSCVwtIAZeilrJMnzvs5WwFJEYwqpaikJJfNKL+qd5YP5vqexJz10qRSzAfCynV6kMs74IGZYeEHTvau8C6SmQ2e3dJXugiE37ciQ+A1ZigsY1c2FkQTVGqDuEGzAVCxD0hZkyJUMhZs1C6U3pfOdKr95yVm/57XRBid6SKIyEyxDwvrI+FJMzXxSUxKmp8sYSsa9X8bm5fCryE5czQMEG4t1rMMYhRCOyR5Gb3ll4YWfFa2yelU8Ut6u3qR+YL8ga6guO+fBUj3O4iT+2w3Zjcbg5aDNu9wV6bIB6U1BXz7najodB6iU84kEKuMRyexgafcT4fdPs+yPOd/trTWnbVMSjpgLeFbqpr9iitpppkkQHiitHl6PLq4CJIyX8Fs/Ebu5uCa2Oe+8m2O86t1QRYNEIdIuF6kHCEgpdl+TBVKdr60oRHDedIXWUu53kjoZNEwLP9J+jNzh4dMO6EKqKbZjQUYm8hd40rlxe7XrRobvnmioef433veU2aTRx2CtGUhZoEMndbDJh4aMptlsaDlctjuPPpTCKYjnwLJWNcT0OPbUnLH17nzz5F3bKtDQoKmon4PPP0xf+xAq+6ZBTx/k/1HoI0ZZiNnWrXxyAqLLTHd8fiOyO8x+iyIuHdXgZ71YcJdNmx03sAz21dtLKDXc3Dx/+wtVZasGXIcdyI1bkXvg/4KODjSHnhbENL0Q19yHZ8iiU/v4FGpbm9A== sidebar_class_name: "patch api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/update-signing-key.api.mdx b/docs/docs/04-development/02-cache/02-restapi/update-signing-key.api.mdx index b2dfdeb..94c1dae 100644 --- a/docs/docs/04-development/02-cache/02-restapi/update-signing-key.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/update-signing-key.api.mdx @@ -5,9 +5,9 @@ description: "Update the name of a given Signing Key" sidebar_label: "Update signing key" hide_title: true hide_table_of_contents: true -api: eJztWE1vGzcQ/SsEL00AySvJtlLr5qQtGhQoAsc5FIEgUMtZickuuSW5shVB/70zJPWxkZrWRgC1gHww7OXwkTPvDTmcFZfgcqtqr4zmI/6hlsID83NgWlTATMEEm6kFaPZezbTSM/YbLHmHezFzfPSRi1pli36mZmWTWXA++wxLh+P0gY87vBYWcTxYsl5xl8+hEny04n5ZAy7ovEVQvu5wC382yoLkI28b6HBaHw08aKE9IdL+auHnaPwcINH4ubHqiwiuJrw5CAn2mYiNA9sVM9htbwM3jnMwHq+NXBJmO8zvw1qsMJY1FHGKK8XcpRh/DjH+etncaE+LIZyo61LlwZXskyPMIw6Y6SfIaW+1NTVYr8DRqJKHTnY47qUSnrxq0GC9cfIgGq1wfCSwZDper+Ogq412calBr3fo/F2yYOSPUHrjPLqGqKxupugahYBZyI2V7IXSednIjV2IGMg06l7y7xYZ54Vv3CQ3ct9z3VTToJHNeAXOIe1HpaLcBKw1dm9wakwJgiQHCIVBK0TpYIzG6Mcz+cLJpJFj3zEjJ5SEk9a8p2HPhZsfHXiCKALGVhtPmhrlv+/IHo5XGH8vqvoIRV+B7fN5wN4eV4mJfeyk5qte/1DA9yhCkufSNOwBULKNI20qx7TxQZaYxV9A/l+E+a+VGAAmEjBrS/fPXLbNT8Dd5SF3vxg7VVLifdZlvxvWuhQ6DBQeMDYQK5XUP3iGAVgoCUzoti2LRz0zwdpu/k0aUDqcVK9BWPyYjtazGk6rhqvjmZwuarxQYqnBpIHIIjwq55khLpFXvOwXYM8snpbFweCQxT8oARONbIoFF3sQrTzEOgFPZX9OxP8EhTc3x2pC31iNOfgwh8hZfHTcvntLD47NuSrK0jxQphoGUvlguMvf9gvlzPHpOL4+Xvfvc0wPRCz5c9Noeh3SBRtQmWxsu9I/c3liLo+UUVsuVRGYKgCBLcSb0prGA6UsPv49tRBS9uL1Oi3PZfFJ+US4CrCOlbGZktMTLTRVRjw72svJUk8iW8XyaE3LhlIodnQaW1Ljw/vajbIw9wIecbkSLnJThVYI0Xq3a4f8HIc3z09+WYgfr4vhVff6Vf9V9+p6OOhOL4u8O8hvhpfFcCgKMeTbpssedbowBEJbiarsXfQu+sFnT/j8LZ0xeIVQNFry3Qywn0zuYhvGAVULoZaXsIDS1BUpFNepjfOVCMJMe0hdsna3prXCaifxJ/TUIvMeHn1Wl0IFCYb4rhJHod+Glov+psUWGi4+vpmp75b2hH+NUucMCZijBzR5tZoKBx9suV7TZ2TELvE7/rkQVlFyBkqlcjFRR6FT8Q3XXtwlab5kf7f/9FFo8nAhyob+S2/8bXdvTVmQmmfffQdxpVazbrsPavzF8TcRsntPEDuLg+NpN+M2z6H237Qd72Xbu9v7N7+i9TR1BKtwanErHohE/B3CYoKP4RQJ31a8FHrWhOOLR1D6+Qs4IZQz +api: eJztWE1vGzcQ/SsEL00AySvJtlLr5qQtGhQoAsc5FIEgUMtZickuuSW5shVB/70zJPWxkZrWRgC1gHww7OXwkTPvDTmcFZfgcqtqr4zmI/6hlsID83NgWlTATMEEm6kFaPZezbTSM/YbLHmHezFzfPSRi1pli36mZmWTWXA++wxLh+P0gY87vBYWcTxYsl5xl8+hEny04n5ZAy7ovEVQvu5wC382yoLkI28b6HBaHw08aKE9IdL+auHnaPwcINH4ubHqiwiuJrw5CAn2mYiNA9sVM9htbwM3jnMwHq+NXBJmO8zvw1qsMJY1FHGKK8XcpRh/DjH+etncaE+LIZyo61LlwZXskyPMIw6Y6SfIaW+1NTVYr8DRqJKHTnY47qUSnrxq0GC9cfIgGq1wfCSwZDper+Ogq412calBr3fo/F2yYOSPUHrjPLqGqKxupugahYBZyI2V7IXSednIjV2IGMg06l7y7xYZ54Vv3CQ3ct9z3VTToJHNeAXOIe1HpaLcBKw1dm9wakwJgiQHCIVBK0TpYIzG6Mcz+cLJpJFj3zEjJ5SEk9a8p2HPhZsfHXiCKALGVhtPmhrlv+/IHo5XGH8vqvoIRV+B7fN5wN4eV4mJfeyk5qte/1DA9yhCkufSNOwBULKNI20qx7TxQZaYxV9A/l+E+a+VGAAmEjBrS/fPXLbNT8Dd5SF3vxg7VVLifdZlvxvWuhQ6DBQeMDYQK5XUP3iGAVgoCUzoti2LRz0zwdpu/k0aUDqcVK9BWPyYjtazGk6rhqvjmZwuarxQYqnBpIHIIjwq55khLpFXvOwXYM8snpbFweCQxT8oARONbIoFF3sQrTzEOgFPZX9OxP8EhTc3x2pC31iNOfgwh8hZfHTcvntLD47NuSrK0jxQphoGUvlguMvf9gvlzPHpOL4+Xvfvc0wPRCz5c9Noeh3SBRtQmWxsu9I/c3liLo+UUVsuVRGYKgCBLcSb0prGA6UsPv49tRBS9uL1Oi3PZfFJ+US4CrCOlbGZktMTLTRVRjw72svJUk8iW8XyaE3LhlIodnQaW1Ljw/vajbIw9wIecbkSLnJTZaEXQrze7fohP8fxzfuTXxbix+tieNW9ftV/1b26Hg6608si7w7ym+FlMRyKQgz5tuuyx50uDIHQXqIsexe9i35w2hM+f0uHDN4hFI6WfjcD7CeTu9iHcUDlQijmJSygNHVFEsV1auN8JYIy0x5Sm6zdrmmtsNpp/AlNtUi9h0ef1aVQQYMhwKtEUmi4oeWiv+mxhY6Lj49marylPeFfo9Q6QwLm6AFNXq2mwsEHW67X9BkZsUv8jn8uhFWUnYFTqVzM1FFoVXzDtRd3SZsv2d/tP30UmjxciLKh/9Ijf9veW1MapO7Zd99BXKnVrdvugzp/cfxNhOzeE8TO4uB82s24zXOo/Tdtx3vp9u72/s2vaD1NLcEqHFvcigciEX+HsJjgYzhGwrcVL4WeNeH84hGUfv4CTvyUYg== sidebar_class_name: "patch api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/upload-a-nix-binary.api.mdx b/docs/docs/04-development/02-cache/02-restapi/upload-a-nix-binary.api.mdx index 1e0c010..e839488 100644 --- a/docs/docs/04-development/02-cache/02-restapi/upload-a-nix-binary.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/upload-a-nix-binary.api.mdx @@ -5,9 +5,9 @@ description: "Upload a binary to a given tenant using an upload id" sidebar_label: "Upload a nix binary" hide_title: true hide_table_of_contents: true -api: eJztV01PGzEQ/SuWTyBRNlT0QG5IvXCpEC0nFKHJ7iRr8NrGHyHRKv+9M95NmoQUEK2KKnFKsjPz5uONvS+trDCUXrmorJFDee20hUqAGCsDfiGipe9TNUMjIhowUaSgzFSAEalzVZU8khGmQQ5vJDhVzE4KNdWp6Oxk5F9ydCQdeGgwomfXVoayxgbksJVx4ZByh+gJWi6PpMeHpDxWchh9wiNpKI4cugoYkUt1EGtyfgtQykX/KQr1E7+lZox+BfaQ0C/kcsQhwVkTMDDg58GAP7YnfWEm1jfAv0CLlb+ACQ1IhFSWGMIkaU1zriAipSitoQlEhgLntCpzcHEXGG9PA3Z8hyWPy3nr0EfVVRMixBRuS1vhhrPpGqFue3tD+WGKeweiwi16b/2GcWytRjCUDQmKCJ6ADjgiZ6r+FVU1Yfo01Rqs30usxPdfk1nI0XKLnZuMwjmjovIjNG5Phzshm+N40vxGq30jm9iUntFO99F7hTF5QwWriYg1Ck5JYQL8NDXEYhAHWt1jZ7MporBe5P0R+ZyEQ/GIHkUDmveEgMiuTGm978b3X2zDq+nPALcVRlA67MmyQ9q2+zswfvoy4/19WVkMwtgocK7CB3HvTNzZ2cvE9S+2RwiCj1tykW3m00Sraf3B4Psy+OX5y5akRiYuGRhrZPlSg6k0bt7BHwy+I4MERxqwthULqJR7YQU2lMVT7Vi03R26LFpSbEvOh3620o/JawqrY3RhWOSwY5xTHo3HpW2yClOksbgljuk2ZXA8OD7JVUXNXV7wwpxfXnC92/KsN4ivtgyCXsEkfJFuAbGwyYsKZ6it4xc50+RsiA3k1em14VpHGzXvtfRuivbXFr5ZdndURZzHwmlQeWfyXNp+rFmSk+fsZCXEyWElzIdrQT1kRUwDq6kRDmrbMQS89nq55MedruWhVyrwwSL2sr57pqWDq35rDsXvKr3Hxa6MnoFO7Jjpm4FXnO3vZ+4fglls5lxV1I+F/xX8w6xMwZJPY42kdH1uurOck+R1cSPmyZ3F01ofq8vrH3RsfwIF5dR6 +api: eJztV01PGzEQ/SuWTyBRNlT0QG5IvXCpEC0nFKHJ7iRr8NrGHyHRKv+9M95NmoQUEK2KKnFKsjPz5uONvS+trDCUXrmorJFDee20hUqAGCsDfiGipe9TNUMjIhowUaSgzFSAEalzVZU8khGmQQ5vJDhVzE4KNdWp6Oxk5F9ydCQdeGgwomfXVoayxgbksJVx4ZByh+gJWi6PpMeHpDxWchh9wiNpKI4cugoYkUt1EGtyfgtQykX/KQr1E7+lZox+BfaQ0C/kcsQhwVkTMDDg58GAP7YnfWEm1jfAv0CLlb+ACQ1IhFSWGMIkaU1zriAipSitoQlEhgLntCpzcHEXGG9PA3Z8hyWPy3nr0EfVVRMixBRuS1vhhrPpGqFue3tD+WGKeweiwi16b/2GcWytRjCUDQmKCJ6ADjgiZ6r+FVU1Yfo01Rqs30usxPdfk1nI0XKLnZuMwjmjovIjNG5Phzshm+N40vxGq30jm9iUntFO99F7hTF5QwWriYg1Ck5JYQL8NDXEYhAHWt1jZ7MporBe5P0R+ZyEQ/GIHkUDmveEgMiuTGm978b3X2zDq+nPALcVRlA67MmyQ9q2+zswfvoy4/19WVkMwtgocK7CB3HvTNzZ2cvE9S+2RwiCj1tykW3m00Sraf3B4Psy+OX5y5akRiYuGRhrZPlSg6k0bt7BHwy+I4MERxqwthULqJR7YQU2lMVT7Vi03R26LFpSbEvOh3620o/JawqrY3RhWOSwY5xTHo3HpW2KLMMUiSzuiYO6VRkcD45PcllRc5sXvDHnlxdc8LY+6w3iqy2DoHcwKV+ka0AsbPKiwhlq6/hNzjw5G2IDeXd6cbgW0kbNezG9m6L9tYZv1t0dVxHnsXAaVF6aPJi2n2vW5OQ5O1kpcXJYKfPhWlEPWRLTwGpqhIPadgwBr71eLvlxJ2x56pUKfLKIvizwnmnp4Kpfm0Pxu0rvcbGro2egEztm+mbgFWf7+5n7h2AWmzlXFfVj4b8F/zArU7Dk41gjSV2fm+4s56R5XdyIeXJp8bTW5+ry+ged259nm9Sp sidebar_class_name: "put api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/upload-and-activate-a-new-deployment.api.mdx b/docs/docs/04-development/02-cache/02-restapi/upload-and-activate-a-new-deployment.api.mdx index 8cf604b..7194b3f 100644 --- a/docs/docs/04-development/02-cache/02-restapi/upload-and-activate-a-new-deployment.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/upload-and-activate-a-new-deployment.api.mdx @@ -5,9 +5,9 @@ description: "Upload and activate a new deployment" sidebar_label: "Upload and activate a new deployment" hide_title: true hide_table_of_contents: true -api: eJztVktv2zAM/iuCLtuALEmz7ZJb9zj0tKKPUxEUjM3GamXJk+ikXZD/PlKOVzvpum4r0MsKpJD5Jj9S4lrnGLNgKjLe6ak+r6yHXIHjX0ZmCYQKlMOVypFZdyU60gNNsIh6eqGhMqPlZNTwmJ5BVphbPmwps4GuIECJhEEU1jpmBZagp2tNdxWyx0jBuIXeDHTAb7UJmOsphRoH2rEeC0BNhQ/mO6QQB9pInAVCjkFvZo0aRvro8zsx28/nrMBO5Oo6eqfufK1WwF/kfyYpsXtHkh3bgKqyJksOR6IitL3A/fwaMylGFXyFgQzGpLtgI/EhOchzIybBHvc0dgohlfDWziG7OU2Z/JOxXl0v2uhmmy0nVt7FRnMyHu/X78hd+VBC40m18kpqBcaxC0X9CpumeYTa+FLGLb1dYs6HHeHnK7rJ93Mf6CZ0ptQ1C3C+f43NH7hlN3Wwj4cTjN4Fhk01irM9zBKrD9z78cE+VidIdXBS6KvU4xBQOU8KrPUrJnfavQNCfD4UIgHV8TLzOXaEXV3OZVQHLb/EGDmdB0tn4iWG4EOHOffeIjjh5kBPCCMZuMyRO9T+asA65e2Lz5hLhkMkKKsHsthR7qa8l2AnnW3sXdstlJPJb6EMe3fYCqJ7Re1IBbMoSDX9pV5H5AFNF7HKfRaFrkrPzWDuh/nNf9RfFPUP43ePoy6wXiEbZtyoMFEFX/Pc8oEfVFL+So4y3ehgbjH/j+cL4snmeMUpPBvTlY8pGaCCv0a9DWnUWTcihmW7FKUHQxdEVZyORmZh6yHesnWLw8yXacsRFE/uN50vDbu3cDy4OEhsMvciKf6aThsPx8ODlAeJEX3ELtXh8VHa3Hrv/5ahPrc3SR3lImlvpSVaX6W3nP1I6iWkZtvubk9cJ3s+1/eN/OR1tEGX8JZGleXFpPMKN0CkVZUll5P75ZQf1RYOLnAhuLHcej2HiOfBbjZC5ooH3isv+LiEYGTW5Ivtb1dQwe8GWUR/asJ+eybRiLit0/66O4ubQatxmGVY0aOys05rHX89PWPh+XbTLdOE6gArJsr/qeaDT2VME5Noa23BLeo0qrqxKX8/ALI/NJo= +api: eJztVktv2zAM/iuCLtuArE6z7ZJb9zj0tKJrT0VQMDYbq5UlT6KTdkH++0g5Xu2k67oH0MsKpJD5Jj9S4loXGPNgajLe6ak+r62HQoHjX05mCYQKlMOVKpBZdxU60iNNsIh6eqGhNtlykrU8pueQl+aWD1vKbKRrCFAhYRCFtY55iRXo6VrTXY3sMVIwbqE3Ix3wa2MCFnpKocGRdqzHAtBQ6YP5BinEkTYSZ4lQYNCbWauGkd774k7MDvM5K7EXubqO3qk736gV8Bf5H0lK7N6RZMc2oK6tyZPDTFSEthe4n19jLsWog68xkMGYdBdsJD4kB0VhxCTYk4HGTiGkEt7aOeQ3X1Imf2VsUNeLLrrZZsuJtXex1ZyMx/v1O3ZXPlTQelKdvJJagXHsQtGwwqZtHqG2vpRxS2+XWPBhR/jfFd0U+7mPdBs6U5qGBTjfP8bmN9yymybYx8MJRu8Cw6ZaxdkeZok1BO7t+HAfq1OkJjgp9FXqcQionCcF1voVk3vt3gMh/jsUIgE18TL3BfaEXVPNZVRHHb/CGDmdB0tn4iWG4EOPOffeIjjhFkBPCCMZuCyQO9T+bMB65R2Kz5hLhkMkqOoHsthR7qe8l2AvnW3sfdsdlJPJL6EMe3fYCqJ7Qd1IBbMoSbX9pV5G5AFNF7EqfB6FrirPzWDuh/nVf9SfFfV34zePoy6wXiEbZtyoNFEF3/Dc8oEfVFL+So4y3ehgbrH4j+cz4snmeMUpPRvTtY8pGaCSv7LBhpT11o2IYdktRenB0CVRHadZZha2OcBbtm7xIPdVltYcgfH0ftX51PIHG8eDm4MEJ4MvkuKwbbXxwfjgMCVCYkQfs091dHKcVrfBArBlqI/dVdJEuUm6a2mJ1tfpMWc/knsFqdu2y9sT98mBz/V9Jz95H23hJbylrLa8mfSe4RaJtKuy5HJyv53yq9rhwQUuBTiWW6/nEPE82M1GyFzxwIvlBR+XEIwMm3yx/e0OKgDeIIvoD23Yr88kGhG3TVpgd4dxM+o0jvIca3pUdtbrrZPPX85YeL5ddas0ojrAionyf6r54FMZ08gk2lpbcIsmzapubcrfd4mBNMk= sidebar_class_name: "post api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/docs/docs/04-development/02-cache/02-restapi/upload-new-cachix-signing-key.api.mdx b/docs/docs/04-development/02-cache/02-restapi/upload-new-cachix-signing-key.api.mdx index b4507c5..862aba1 100644 --- a/docs/docs/04-development/02-cache/02-restapi/upload-new-cachix-signing-key.api.mdx +++ b/docs/docs/04-development/02-cache/02-restapi/upload-new-cachix-signing-key.api.mdx @@ -5,9 +5,9 @@ description: "Upload a new public signingkey for use with the cachix client" sidebar_label: "Upload new cachix signing key" hide_title: true hide_table_of_contents: true -api: eJztV0tvGzcQ/isEL20B2Wu36UW3pA/AKNAarnMyBGN2OdEy5ZJbkitZWei/d4ak7FWkOEDiwChgHQSJM5zXNyTnG6XC0HjdR+2snMu3vXGgBAiLa9EPtdGNCHpptV3+gxvxznkxBBRrHVsRWxQNNK2+E43RaKOcyQjLIOc3Enpdrc4rFiMtZzW5mMkePHQY0bPaKAPJO5DzUcZNjxRAiJ58ye1Mevx30B6VnEc/4Exa2kcKES0kV5rj7SG2pPwlhhpnyVY8SfrFXIug0H+hQRhi67z+AKmWT2GRSu1PYIkP+e7MLfIeDPGNUxu2uY/jZYaOMRsypMX7oa9SB7YBfU+7UvzV+8CGjkTt6vfYcEC9dz36qDGwNDfLH7g5kuBehjcT1cV2m4WhdzZkQz+enR3mc2Gp9boUGRhxVfTFukUrwtA0iIo9PVk2IUIcwm3jFE6U7dDVCcydvMMQCJ+jmOpwi947PxHWzhkEy1IFMYVhB2OgNpjRIEHUZDRC1x/x+1Edp0EehDQJYGq0VPzVsSJfYRy8RZXLCqIDw1WnhZqaTKwhCKrSSity//+r9ONhJAO3CiNoEz7fwvvqi2+FW4r9KHznh/Bd033MB37jBrFGj3RTU+hCB2FdFB4bR/f4hxfsnh27nw6x+935WitFx+5E/OnE3lMyE0jPLfoErNLKfhd351CA3dcV+YEQLmn73d/SA9qmR/sNgqfFfKO+dMMzd8Or4ye5PO90+eaJRyiHGUW80yEKx1gSrjQirNC/oPisKP78+eeUD55emqEAJtA2biDEKAY+xckDaVL4kUY2ckSHlVY0jTlUFL7HbXTJCgdRQ8AXzJ8RczJHNKZ1ikmICykZ5iJzWU25TzXm07ut6GVmRwn8zH0Gb3iij7EP86ri3jjFO3Jg8LRxXZrxGcirhzn/tyz+aNyeokBjMkvZR27Cs9Oz0/MUfuSN8oJb8PXlBSe2P2EXgfjVNeGe6FETpndE4QqN6ztuNvLDGXeQeqxQlUIcmTYWTlhoo8iJ7zkbHxr36xlnhjniXax6Azr1WyrtWBBJbJQ0V+eFiTLA83seyfFRqVsGkXTHkc/WW2+2W16m2nuq8Q39XIHXeVQn8JQO/Jvgfwcm4CMJfn9V2u4H8alwyyJYrtQKzMD/Smj3jHfLHV7435NHkD3t8c37OJi7ZvkvhTJfZ8q80zi4eh52vCZq1sdHdReTk3T519/XpFwXTtulC0l6WDNvpe9UFZdSTBdEWhulAbsc0s0ks03+/AdEqumH +api: eJztV0tvGzcQ/isEL20B2Wu36UW3pA/AKNAarnMyBGN2OdEy5ZJbkitZWei/d4ak7FWkOEDiwChgHQSJM5zXNyTnG6XC0HjdR+2snMu3vXGgBAiLa9EPtdGNCHpptV3+gxvxznkxBBRrHVsRWxQNNK2+E43RaKOcyQjLIOc3Enpdrc4rFiMtZzW5mMkePHQY0bPaKAPJO5DzUcZNjxRAiJ58ye1Mevx30B6VnEc/4Exa2kcKES0kV5rj7SG2pPwlhhpnyVY8SfrFXIug0H+hQRhi67z+AKmWT2GRSu1PYIkP+e7MLfIeDPGNUxu2uY/jZYaOMRsypMX7oa9SB7YBfU+7UvzV+8CGjkTt6vfYcEC9dz36qDGwNDfLH7g5kuBehjcT1cV2m4WhdzZkQz+enR3mc2Gp9boUGRhxVfTFukUrwtA0iIo9PVk2IUIcwm3jFE6U7dDVCcydvMMQCJ+jmOpwi947PxHWzhkEy1IFMYVhB2OgNpjRIEHUZDRC1x/x+1Edp0EehDQJYGq0VPzVsSJfYRy8RZXLCqIDw1WnhZqaTKwhCKrSSity//+r9ONhJAO3CiNoEz7fwvvqi2+FW4r9KHznh/Bd033MB37jBrFGj3RTU+hCB2FdFB4bR/f4hxfsnh27nw6x+935WitFx+5E/OnE3lMyE0jPLfoErNLKfhd351CA3dcV+YEQLmn73d/SA9qmR/sNgqfFfKO+dMMzd8Or4ye5PO90+eaJRyiHGUW80yEKx1gSrjQirNC/oPisKP78+eeUD55emqEAJtA2biDEKAY+xckDaVL4kUY2ckSHlVY0jTlUFL7HbXTJCgdRQ8AXzJ8RczJHNKZ1ikmICykZ5iJzWU25TzXm07ut6GVmRwn8zH0Gb3iij7EP86ri3jjFO3Jg8LRxXZWGfEby6mHQ/y3LP5q3pzDQnMxSdpK78Oz07PQ8xR95o7zgHnx9ecGZ7Y/YRSB+dU24Z3rUhekhUbhC4/qOu438cModpCYrXKUwR+aNhRQW3ihy5nvOxofO/XrKmXGOeBer3oBODZdqOxZIEh0lzdV5oaKM8PyeSHJ8VOqWUSTdceTD9dab7ZaXqfaeanxDP1fgdZ7VCT2lA/8m/N+BCfhIgt9flb77QXwq3LIIliu1AjPwvxLaPeXdcosXAvjkEWRPe4TzPg4mr1n+S+HM15kz7zQO7p6HHa+Jm/XxUd3F5Chd/vX3NSnXhdR26UaSHtZMXOk7VcWlFNMNkdZGacAuh3Q1yWyTP/8Brnnptg== sidebar_class_name: "post api-method" -info_path: docs/02-cache/04-development/02-restapi/iglu-api +info_path: docs/04-development/02-cache/02-restapi/iglu-api custom_edit_url: null hide_send_button: true mask_credentials: false diff --git a/openapi/index.ts b/openapi/index.ts index e95aa5b..1719273 100644 --- a/openapi/index.ts +++ b/openapi/index.ts @@ -104,7 +104,7 @@ const out = generator.generateDocument({ title: "Iglu API", description: "Iglu API Docs for use in your development", }, - servers: [{ url: "/" }], + servers: [{ url: "https://iglu.example.com/" }], }); const schema_doc = Bun.file("./schema.openapi.json"); diff --git a/openapi/schema.openapi.json b/openapi/schema.openapi.json index 3dd6831..71ce3b3 100644 --- a/openapi/schema.openapi.json +++ b/openapi/schema.openapi.json @@ -5,8 +5,15 @@ "title": "Iglu API", "description": "Iglu API Docs for use in your development" }, - "servers": [{ "url": "/" }], - "components": { "schemas": {}, "parameters": {} }, + "servers": [ + { + "url": "https://iglu.example.com/" + } + ], + "components": { + "schemas": {}, + "parameters": {} + }, "paths": { "/ws-deployment": { "get": { @@ -15,7 +22,9 @@ "tags": ["cachix", "deploy"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" @@ -33,15 +42,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -64,25 +85,33 @@ "tags": ["cachix", "deploy"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "name", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "version", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "system", "in": "header" @@ -100,15 +129,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -131,7 +172,9 @@ "tags": ["nix"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" @@ -158,15 +201,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -189,13 +244,17 @@ "tags": ["nix"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "hash", "in": "path" @@ -222,15 +281,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -250,15 +321,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -274,50 +357,153 @@ } } }, - "/{tenant}/nar/{derivation}": { + "/api/v1/cache/{tenant}": { "get": { - "description": "Fetch a nix binary", - "summary": "Fetch a nix binary", - "tags": ["nix"], + "description": "Get a tenant by its id in the cachix format", + "summary": "Get a tenant in cachix format", + "tags": ["api/v1/cache", "cachix"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, - "name": "derivation", - "in": "path" + "name": "authorization", + "in": "header" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "user-agent", + "in": "header" } ], "responses": { "200": { - "description": "Returned if the binary was found in the given tenant and the server wants to start sending the file. CAREFUL: The response is a binary stream of a nix archive", - "content": { "x-nix-nar": { "schema": { "type": "string" } } } + "description": "Cachix format with required information", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "githubUsername": { + "type": "string" + }, + "isPublic": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "preferredCompressionMethod": { + "type": "string", + "enum": ["XZ", "ZSTD"] + }, + "publicSigningKeys": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "string" + } + }, + "required": [ + "githubUsername", + "isPublic", + "name", + "permission", + "preferredCompressionMethod", + "publicSigningKeys", + "uri", + "priority" + ] + } + } + } }, - "302": { - "description": "Returned if the iglu server references you to an S3 server to fetch the binary from there", - "content": {} + "401": { + "description": "The key you were using is not recognized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } }, - "400": { - "description": "Returned if your request parameters were malformed", + "403": { + "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -331,21 +517,73 @@ } }, "404": { - "description": "Returned if either the tenant OR the derivation does not exist", + "description": "The requested tenant does not exist on this server", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "406": { + "description": "This error occured because the client does not have the user agent header set", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -368,7 +606,9 @@ "tags": ["api/v2/deploy", "cachix", "deploy"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" @@ -383,11 +623,15 @@ "properties": { "agents": { "type": "object", - "additionalProperties": { "type": "string" } + "additionalProperties": { + "type": "string" + } }, "rollbackScripts": { "type": "object", - "additionalProperties": { "type": "string" } + "additionalProperties": { + "type": "string" + } } }, "required": ["agents"] @@ -403,14 +647,22 @@ "schema": { "type": "object", "properties": { - "id": { "type": "string", "format": "uuid" }, + "id": { + "type": "string", + "format": "uuid" + }, "agents": { "type": "object", "additionalProperties": { "type": "object", "properties": { - "id": { "type": "string" }, - "url": { "type": "string", "format": "uri" } + "id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } }, "required": ["id", "url"] } @@ -428,15 +680,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -456,15 +720,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -484,15 +760,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -508,109 +796,72 @@ } } }, - "/api/v1/cache/{tenant}": { + "/{tenant}/nar/{derivation}": { "get": { - "description": "Get a tenant by its id in the cachix format", - "summary": "Get a tenant in cachix format", - "tags": ["api/v1/cache", "cachix"], + "description": "Fetch a nix binary", + "summary": "Fetch a nix binary", + "tags": ["nix"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, - "required": true, - "name": "authorization", - "in": "header" - }, - { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, - "name": "user-agent", - "in": "header" + "name": "derivation", + "in": "path" } ], "responses": { "200": { - "description": "Cachix format with required information", + "description": "Returned if the binary was found in the given tenant and the server wants to start sending the file. CAREFUL: The response is a binary stream of a nix archive", "content": { - "application/json": { + "x-nix-nar": { "schema": { - "type": "object", - "properties": { - "githubUsername": { "type": "string" }, - "isPublic": { "type": "boolean" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "preferredCompressionMethod": { - "type": "string", - "enum": ["XZ", "ZSTD"] - }, - "publicSigningKeys": { "type": "string" }, - "uri": { "type": "string" }, - "priority": { "type": "string" } - }, - "required": [ - "githubUsername", - "isPublic", - "name", - "permission", - "preferredCompressionMethod", - "publicSigningKeys", - "uri", - "priority" - ] + "type": "string" } } } }, - "401": { - "description": "The key you were using is not recognized", + "302": { + "description": "Returned if the iglu server references you to an S3 server to fetch the binary from there", + "content": {} + }, + "400": { + "description": "Returned if your request parameters were malformed", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "403": { - "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -624,21 +875,33 @@ } }, "404": { - "description": "The requested tenant does not exist on this server", + "description": "Returned if either the tenant OR the derivation does not exist", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -650,23 +913,46 @@ } } } - }, - "406": { - "description": "This error occured because the client does not have the user agent header set", + } + } + } + }, + "/api/v1/iglu/healthcheck": { + "get": { + "description": "Endpoint to check if Iglu is up and running", + "summary": "Healthcheck", + "tags": ["iglu"], + "responses": { + "200": { + "description": "Informational response if Iglu is running", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "properties": { + "information": { + "type": "string", + "enum": ["Healthy"] + } + }, + "required": ["information"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -682,75 +968,117 @@ } } }, - "/api/v1/cache/{tenant}/multipart-nar": { - "post": { - "description": "Retrieves a new upload id for a multipart nar upload. (Used in Cachix upload flow)", - "summary": "Retrieve new upload ID", - "tags": ["api/v1/cache", "cachix"], + "/api/v1/deploy/deployment/{deployment_id}": { + "get": { + "description": "Get an overview of a given deployment (by deployment id)", + "summary": "Get deployment overview", + "tags": ["api/v1/deploy", "cachix", "deploy"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, - "name": "tenant", + "name": "deployment_id", "in": "path" }, { - "schema": { "type": "string", "enum": ["xz", "zst"] }, - "required": true, - "name": "compression", - "in": "query" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "content-type", - "in": "header" - }, - { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "user-agent", - "in": "header" } ], "responses": { "200": { - "description": "Generated Upload and NarIDs when request completed successfully", + "description": "Information about the deployment", "content": { "application/json": { "schema": { "type": "object", "properties": { - "uploadId": { "type": "string" }, - "narId": { "type": "string" } + "closureSize": { + "type": "number", + "nullable": true + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "finishedOn": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "id": { + "type": "string", + "format": "uuid" + }, + "index": { + "type": "number" + }, + "startedOn": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "InProgress", + "Pending", + "Cancelled", + "Failed", + "Succeeded" + ] + }, + "storePath": { + "type": "string" + } }, - "required": ["uploadId", "narId"] + "required": [ + "closureSize", + "createdOn", + "finishedOn", + "id", + "index", + "startedOn", + "status", + "storePath" + ] } } } }, - "400": { - "description": "Returned when you have provided invalid or missing query parameters (i.e if you are missing the compression parameter)", + "401": { + "description": "Not authorized to view deployment", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -763,22 +1091,34 @@ } } }, - "401": { - "description": "The key you were using is not recognized", + "404": { + "description": "The deployment does not exist on the server", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -791,22 +1131,34 @@ } } }, - "403": { - "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", + "503": { + "description": "Returned if the feature this route is part of is not enabled", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -818,23 +1170,76 @@ } } } + } + } + } + }, + "/api/v1/deploy/log/{deployment_id}": { + "get": { + "description": "Attach to a given deployment's log. As openapi is not designed for websockets, see iglu deployment developer documentation for furhter details", + "summary": "See logs of deployment", + "tags": ["api/v1/deploy", "cachix", "deploy"], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "deployment_id", + "in": "path" }, - "404": { - "description": "The requested tenant does not exist on this server", + { + "schema": { + "type": "string", + "enum": ["websocket"] + }, + "required": true, + "name": "upgrade", + "in": "header" + }, + { + "schema": { + "type": "string", + "enum": ["upgrade"] + }, + "required": true, + "name": "connection", + "in": "header" + } + ], + "responses": { + "101": { + "description": "Returned if the server acknowledges the connection upgrade and switches to websocket (required to see logs, see iglu deployment developer docs for websocket docs)", + "content": {} + }, + "503": { + "description": "Returned if the feature this route is part of is not enabled", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -846,23 +1251,72 @@ } } } + } + } + } + }, + "/api/v1/iglu/upload/{tenant}/{uid}": { + "put": { + "description": "Upload a binary to a given tenant using an upload id", + "summary": "Upload a nix binary", + "tags": ["api/v1/iglu/upload", "iglu"], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "tenant", + "in": "path" }, - "412": { - "description": "Returned when there is no signing key associated with your API Key", + { + "schema": { + "type": "string" + }, + "required": true, + "name": "uid", + "in": "path" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "partNumber", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Informational response after successfull update", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "properties": { + "msg": { + "type": "string", + "enum": ["Uploaded Successfully"] + } + }, + "required": ["msg"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -875,22 +1329,34 @@ } } }, - "500": { - "description": "Returned when iglu encounters a request while trying to generate the IDs", + "400": { + "description": "Returned if the request arguments (like the route or query params) were malformed or incorrect", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -902,97 +1368,35 @@ } } } - } - } - } - }, - "/api/v1/cache/{tenant}/narinfo": { - "post": { - "description": "Checks if a given array of narhashes is already cached", - "summary": "Checks if a given array of narhashes is already cached", - "tags": ["api/v1/cache", "cachix"], - "parameters": [ - { - "schema": { "type": "string" }, - "required": true, - "name": "tenant", - "in": "path" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "authorization", - "in": "header" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "user-agent", - "in": "header" - } - ], - "requestBody": { - "description": "Array of Nix Store Hashes that should be checked if they are already cached", - "required": true, - "content": { - "application/json": { - "schema": { "type": "array", "items": { "type": "string" } } - } - } - }, - "responses": { - "200": { - "description": "A list of hashes that are not already stored in the tenant", - "content": { - "application/json": { - "schema": { "type": "array", "items": { "type": "string" } } - } - } }, - "400": { - "description": "Invalid Body: This is returned when your request body is not in the proper format", + "404": { + "description": "Returned if the tenant does not exist", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "401": { - "description": "The key you were using is not recognized", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1005,22 +1409,34 @@ } } }, - "403": { - "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", + "499": { + "description": "Returned if the upload was corrupted in-flight", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1033,22 +1449,34 @@ } } }, - "404": { - "description": "The requested tenant does not exist on this server", + "500": { + "description": "Returned iglu was unable to handle the request", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1071,25 +1499,33 @@ "tags": ["api/v1/cache", "cachix"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "content-type", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" @@ -1102,7 +1538,11 @@ "application/json": { "schema": { "type": "object", - "properties": { "publicKey": { "type": "string" } }, + "properties": { + "publicKey": { + "type": "string" + } + }, "required": ["publicKey"] } } @@ -1116,11 +1556,21 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { "nullable": true }, - "timestamp": { "type": "number" } + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "nullable": true + }, + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1139,15 +1589,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1167,15 +1629,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1195,15 +1669,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1223,15 +1709,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1251,15 +1749,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1275,52 +1785,93 @@ } } }, - "/api/v1/deploy/log/{deployment_id}": { - "get": { - "description": "Attach to a given deployment's log. As openapi is not designed for websockets, see iglu deployment developer documentation for furhter details", - "summary": "See logs of deployment", - "tags": ["api/v1/deploy", "cachix", "deploy"], + "/api/v1/cache/{tenant}/narinfo": { + "post": { + "description": "Checks if a given array of narhashes is already cached", + "summary": "Checks if a given array of narhashes is already cached", + "tags": ["api/v1/cache", "cachix"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, - "name": "deployment_id", + "name": "tenant", "in": "path" }, { - "schema": { "type": "string", "enum": ["websocket"] }, + "schema": { + "type": "string" + }, "required": true, - "name": "upgrade", + "name": "authorization", "in": "header" }, { - "schema": { "type": "string", "enum": ["upgrade"] }, + "schema": { + "type": "string" + }, "required": true, - "name": "connection", + "name": "user-agent", "in": "header" } ], + "requestBody": { + "description": "Array of Nix Store Hashes that should be checked if they are already cached", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, "responses": { - "101": { - "description": "Returned if the server acknowledges the connection upgrade and switches to websocket (required to see logs, see iglu deployment developer docs for websocket docs)", - "content": {} + "200": { + "description": "A list of hashes that are not already stored in the tenant", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", + "400": { + "description": "Invalid Body: This is returned when your request body is not in the proper format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1332,89 +1883,35 @@ } } } - } - } - } - }, - "/api/v1/deploy/deployment/{deployment_id}": { - "get": { - "description": "Get an overview of a given deployment (by deployment id)", - "summary": "Get deployment overview", - "tags": ["api/v1/deploy", "cachix", "deploy"], - "parameters": [ - { - "schema": { "type": "string" }, - "required": true, - "name": "deployment_id", - "in": "path" }, - { - "schema": { "type": "string" }, - "required": true, - "name": "authorization", - "in": "header" - } - ], - "responses": { - "200": { - "description": "Information about the deployment", + "401": { + "description": "The key you were using is not recognized", "content": { "application/json": { "schema": { "type": "object", "properties": { - "closureSize": { "type": "number", "nullable": true }, - "createdOn": { "type": "string", "format": "date-time" }, - "finishedOn": { - "type": "string", - "nullable": true, - "format": "date-time" + "status_code": { + "type": "number" }, - "id": { "type": "string", "format": "uuid" }, - "index": { "type": "number" }, - "startedOn": { "type": "string", "format": "date-time" }, - "status": { - "type": "string", - "enum": [ - "InProgress", - "Pending", - "Cancelled", - "Failed", - "Succeeded" - ] + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] }, - "storePath": { "type": "string" } - }, - "required": [ - "closureSize", - "createdOn", - "finishedOn", - "id", - "index", - "startedOn", - "status", - "storePath" - ] - } - } - } - }, - "401": { - "description": "Not authorized to view deployment", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1427,22 +1924,34 @@ } } }, - "404": { - "description": "The deployment does not exist on the server", + "403": { + "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1455,22 +1964,34 @@ } } }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", + "404": { + "description": "The requested tenant does not exist on this server", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1486,87 +2007,102 @@ } } }, - "/api/v1/cache/{tenant}/multipart-nar/{uid}": { + "/api/v1/cache/{tenant}/multipart-nar": { "post": { - "description": "Retrieve an upload url for a given upload id (uid)", - "summary": "Retrieve upload url", + "description": "Retrieves a new upload id for a multipart nar upload. (Used in Cachix upload flow)", + "summary": "Retrieve new upload ID", "tags": ["api/v1/cache", "cachix"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string", + "enum": ["xz", "zst"] + }, "required": true, - "name": "uid", - "in": "path" + "name": "compression", + "in": "query" }, { - "schema": { "type": "number" }, + "schema": { + "type": "string" + }, "required": true, - "name": "partNumber", - "in": "query" + "name": "content-type", + "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" } ], - "requestBody": { - "description": "The MD5 of the derivation part you are uploading", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { "contentMD5": { "type": "string" } }, - "required": ["contentMD5"] - } - } - } - }, "responses": { "200": { - "description": "An upload URL for a derivation part. May either be S3 or local Iglu upload URL", + "description": "Generated Upload and NarIDs when request completed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { - "uploadURL": { "type": "string", "format": "uri" } + "uploadId": { + "type": "string" + }, + "narId": { + "type": "string" + } }, - "required": ["uploadURL"] + "required": ["uploadId", "narId"] } } } }, "400": { - "description": "Returned if your body or request params were malformed or not in the appropriate format", + "description": "Returned when you have provided invalid or missing query parameters (i.e if you are missing the compression parameter)", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1586,15 +2122,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1614,15 +2162,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1642,43 +2202,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "408": { - "description": "Returned if the upload ID is no longer valid (timed out)", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1691,22 +2235,34 @@ } } }, - "422": { - "description": "The given upload ID was not found", + "412": { + "description": "Returned when there is no signing key associated with your API Key", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1720,21 +2276,33 @@ } }, "500": { - "description": "Returned if iglu was unable to handle the request correctly", + "description": "Returned when iglu encounters a request while trying to generate the IDs", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1757,7 +2325,9 @@ "tags": ["api/v1/iglu/rest/keys", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" @@ -1771,28 +2341,49 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", "properties": { - "id": { "type": "string" }, - "key": { "type": "string" }, + "id": { + "type": "string" + }, + "key": { + "type": "string" + }, "api_keys_id": { "type": "object", "properties": { - "id": { "type": "string" }, - "hash": { "type": "string" }, - "name": { "type": "string" } + "id": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "name": { + "type": "string" + } }, "required": ["id", "hash", "name"] }, - "name": { "type": "string" } + "name": { + "type": "string" + } }, "required": ["id", "key", "api_keys_id", "name"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1812,15 +2403,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1840,15 +2443,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1868,15 +2483,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1896,15 +2523,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -1927,13 +2566,17 @@ "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" @@ -1946,15 +2589,37 @@ "schema": { "type": "object", "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, - "preferred_compression_method": { "type": "string" }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, + "preferred_compression_method": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -1965,7 +2630,8 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] } } @@ -1979,23 +2645,50 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, "preferred_compression_method": { "type": "string" }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -2006,10 +2699,13 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2029,15 +2725,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2057,15 +2765,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2085,15 +2805,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2113,16 +2845,28 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } - }, + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, "required": [ "status_code", "status_message", @@ -2141,15 +2885,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2169,15 +2925,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2200,19 +2968,25 @@ "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "query", "in": "query" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" @@ -2226,25 +3000,52 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "array", "items": { "type": "object", "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, "preferred_compression_method": { "type": "string" }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -2255,11 +3056,14 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] } }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2279,15 +3083,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2307,15 +3123,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2335,15 +3163,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2363,15 +3203,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2387,53 +3239,106 @@ } } }, - "/api/v1/iglu/upload/{tenant}/{uid}": { - "put": { - "description": "Upload a binary to a given tenant using an upload id", - "summary": "Upload a nix binary", - "tags": ["api/v1/iglu/upload", "iglu"], + "/api/v1/iglu/rest/tenants/{tenant}": { + "get": { + "description": "Get detailed information about a tenant", + "summary": "Get Tenant information", + "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, - "name": "uid", - "in": "path" + "name": "authorization", + "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, - "name": "partNumber", - "in": "query" + "name": "user-agent", + "in": "header" } ], "responses": { "200": { - "description": "Informational response after successfull update", + "description": "Success response containing the tenant", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", "properties": { - "msg": { + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, + "preferred_compression_method": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { "type": "string", - "enum": ["Uploaded Successfully"] + "enum": ["client", "server"] } }, - "required": ["msg"] + "required": [ + "id", + "github_username", + "name", + "permission", + "is_public", + "preferred_compression_method", + "uri", + "priority", + "ttl", + "signing_method" + ] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2446,22 +3351,34 @@ } } }, - "400": { - "description": "Returned if the request arguments (like the route or query params) were malformed or incorrect", + "401": { + "description": "The key you were using is not recognized", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2474,22 +3391,34 @@ } } }, - "404": { - "description": "Returned if the tenant does not exist", + "403": { + "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2502,22 +3431,34 @@ } } }, - "499": { - "description": "Returned if the upload was corrupted in-flight", + "404": { + "description": "The requested tenant does not exist on this server", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2530,22 +3471,34 @@ } } }, - "500": { - "description": "Returned iglu was unable to handle the request", + "503": { + "description": "Returned if the feature this route is part of is not enabled", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2559,94 +3512,201 @@ } } } - } - }, - "/api/v1/iglu/rest/keys/signing/{tenant}": { - "get": { - "description": "Get information about signing keys associated with the tenant", - "summary": "Get available signing keys", - "tags": ["api/v1/iglu/rest/keys", "iglu"], + }, + "patch": { + "description": "Change aspects of a tenant", + "summary": "Update a tenant", + "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" } ], + "requestBody": { + "description": "New state of the tenant", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, + "preferred_compression_method": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } + }, + "required": [ + "id", + "github_username", + "name", + "permission", + "is_public", + "preferred_compression_method", + "uri", + "priority", + "ttl", + "signing_method" + ] + } + } + } + }, "responses": { "200": { - "description": "Response containing all signing keys associated with tenant", + "description": "New state of the tenant after the update", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "key": { "type": "string" }, - "api_keys_id": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "hash": { "type": "string" }, - "name": { "type": "string" } - }, - "required": ["id", "hash", "name"] - }, - "name": { "type": "string" } + "type": "object", + "properties": { + "id": { + "type": "string" }, - "required": ["id", "key", "api_keys_id", "name"] - } - }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "401": { - "description": "The key you were using is not recognized", - "content": { + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, + "preferred_compression_method": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } + }, + "required": [ + "id", + "github_username", + "name", + "permission", + "is_public", + "preferred_compression_method", + "uri", + "priority", + "ttl", + "signing_method" + ] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "401": { + "description": "The key you were using is not recognized", + "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2666,15 +3726,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2694,15 +3766,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2715,22 +3799,34 @@ } } }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", + "422": { + "description": "Returned when the body you provided was not in the correct format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2742,79 +3838,35 @@ } } } - } - } - }, - "patch": { - "description": "Update the name of a given Signing Key", - "summary": "Update signing key", - "tags": ["api/v1/iglu/rest/keys", "iglu"], - "parameters": [ - { - "schema": { "type": "string" }, - "required": true, - "name": "tenant", - "in": "path" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "authorization", - "in": "header" }, - { - "schema": { "type": "string" }, - "required": true, - "name": "user-agent", - "in": "header" - } - ], - "requestBody": { - "description": "Schema for updating the signing key", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "string", "format": "uuid" }, - "name": { "type": "string" } - }, - "required": ["id", "name"] - } - } - } - }, - "responses": { - "200": { - "description": "Response containing the entire public key record (including the updated records)", + "500": { + "description": "Returned when the creation failed on iglu's part. Referr to the error information for more detail", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", "properties": { - "id": { "type": "string" }, - "key": { "type": "string" }, - "api_keys_id": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "hash": { "type": "string" }, - "name": { "type": "string" } - }, - "required": ["id", "hash", "name"] - }, - "name": { "type": "string" } + "error_details": { + "type": "string" + } }, - "required": ["id", "key", "api_keys_id", "name"] + "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2827,22 +3879,34 @@ } } }, - "401": { - "description": "The key you were using is not recognized", + "503": { + "description": "Returned if the feature this route is part of is not enabled", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2854,23 +3918,70 @@ } } } + } + } + }, + "delete": { + "description": "Delete a given tenant", + "summary": "Delete a tenant", + "tags": ["api/v1/iglu/rest/tenants", "iglu"], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "tenant", + "in": "path" }, - "403": { - "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", + { + "schema": { + "type": "string" + }, + "required": true, + "name": "authorization", + "in": "header" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "user-agent", + "in": "header" + } + ], + "responses": { + "201": { + "description": "Informational response after tenant deletion", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "properties": { + "information": { + "type": "string", + "enum": ["Tenant deleted successfully"] + } + }, + "required": ["information"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2883,22 +3994,34 @@ } } }, - "404": { - "description": "The requested tenant does not exist on this server", + "401": { + "description": "The key you were using is not recognized", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2911,22 +4034,34 @@ } } }, - "422": { - "description": "Your request body was not in the correct format", + "403": { + "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2939,22 +4074,34 @@ } } }, - "499": { - "description": "Returned when the given API Key is not allowed to edit the requested Signing Key", + "404": { + "description": "The requested tenant does not exist on this server", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -2968,21 +4115,33 @@ } }, "500": { - "description": "Returned when iglu encounters an error during the update", + "description": "Returned when the creation failed on iglu's part. Referr to the error information for more detail", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3002,15 +4161,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3024,53 +4195,93 @@ } } } - }, - "delete": { - "description": "Deletes the link between the public signing key associated with the presented api key and the chosen tenant", - "summary": "Deletes public signing key - tenant link", + } + }, + "/api/v1/iglu/rest/keys/signing/{tenant}": { + "get": { + "description": "Get information about signing keys associated with the tenant", + "summary": "Get available signing keys", "tags": ["api/v1/iglu/rest/keys", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" } ], "responses": { - "201": { - "description": "Informational response to acknolwedge deletion of key", + "200": { + "description": "Response containing all signing keys associated with tenant", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { - "type": "object", - "properties": { - "information": { - "type": "string", - "enum": ["Signing key deleted successfully"] - } - }, - "required": ["information"] + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "key": { + "type": "string" + }, + "api_keys_id": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": ["id", "hash", "name"] + }, + "name": { + "type": "string" + } + }, + "required": ["id", "key", "api_keys_id", "name"] + } }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3090,15 +4301,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3118,15 +4341,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3146,71 +4381,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_code": { + "type": "number" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "499": { - "description": "Returned when the given API Key is not allowed to edit the requested Signing Key", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "500": { - "description": "Returned when iglu encounters an error during the update", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3230,15 +4421,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3252,110 +4455,109 @@ } } } - } - }, - "/api/v1/cache/{tenant}/multipart-nar/{uid}/complete": { - "post": { - "description": "Finish a given upload by uploading cachix meta information about the derivation", - "summary": "Finish a given upload", - "tags": ["api/v1/cache", "cachix"], + }, + "patch": { + "description": "Update the name of a given Signing Key", + "summary": "Update signing key", + "tags": ["api/v1/iglu/rest/keys", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, - "required": true, - "name": "uid", - "in": "path" - }, - { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" } ], "requestBody": { - "description": "Meta information about the derivation", + "description": "Schema for updating the signing key", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "narInfoCreate": { - "type": "object", - "properties": { - "cDeriver": { "type": "string" }, - "cFileHash": { "type": "string" }, - "cFileSize": { "type": "number" }, - "cNarHash": { "type": "string" }, - "cNarSize": { "type": "number" }, - "cReferences": { - "type": "array", - "items": { "type": "string" } - }, - "cSig": { "type": "string" }, - "cStoreHash": { "type": "string" }, - "cStoreSuffix": { "type": "string" } - }, - "required": [ - "cDeriver", - "cFileHash", - "cFileSize", - "cNarHash", - "cNarSize", - "cReferences", - "cSig", - "cStoreHash", - "cStoreSuffix" - ] + "id": { + "type": "string", + "format": "uuid" }, - "parts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "eTag": { "type": "string" }, - "partNumber": { "type": "number" } - }, - "required": ["eTag", "partNumber"] - } + "name": { + "type": "string" } }, - "required": ["narInfoCreate", "parts"] + "required": ["id", "name"] } } } }, "responses": { - "200": { "description": "Empty success response", "content": {} }, - "400": { - "description": "Returned if your body was not in the correct format", + "200": { + "description": "Response containing the entire public key record (including the updated records)", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "properties": { + "id": { + "type": "string" + }, + "key": { + "type": "string" + }, + "api_keys_id": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": ["id", "hash", "name"] + }, + "name": { + "type": "string" + } + }, + "required": ["id", "key", "api_keys_id", "name"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3375,15 +4577,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3403,15 +4617,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3431,15 +4657,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3452,22 +4690,34 @@ } } }, - "408": { - "description": "Returned if the upload ID you were using is no longer valid (timed out)", + "422": { + "description": "Your request body was not in the correct format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3480,22 +4730,34 @@ } } }, - "422": { - "description": "The given upload ID was not found", + "499": { + "description": "Returned when the given API Key is not allowed to edit the requested Signing Key", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3509,100 +4771,33 @@ } }, "500": { - "description": "Iglu encountered an error finishing the upload", + "description": "Returned when iglu encounters an error during the update", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - } - } - } - }, - "/api/v1/iglu/rest/tenants/{tenant}": { - "get": { - "description": "Get detailed information about a tenant", - "summary": "Get Tenant information", - "tags": ["api/v1/iglu/rest/tenants", "iglu"], - "parameters": [ - { - "schema": { "type": "string" }, - "required": true, - "name": "tenant", - "in": "path" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "authorization", - "in": "header" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "user-agent", - "in": "header" - } - ], - "responses": { - "200": { - "description": "Success response containing the tenant", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, - "data": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, - "preferred_compression_method": { - "type": "string" - }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } - }, - "required": [ - "id", - "github_username", - "name", - "permission", - "is_public", - "preferred_compression_method", - "uri", - "priority", - "ttl" - ] - }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3615,106 +4810,34 @@ } } }, - "401": { - "description": "The key you were using is not recognized", + "503": { + "description": "Returned if the feature this route is part of is not enabled", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_code": { + "type": "number" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "403": { - "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_message": { + "type": "string" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "404": { - "description": "The requested tenant does not exist on this server", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "is_error": { + "type": "boolean" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3729,101 +4852,67 @@ } } }, - "patch": { - "description": "Change aspects of a tenant", - "summary": "Update a tenant", - "tags": ["api/v1/iglu/rest/tenants", "iglu"], + "delete": { + "description": "Deletes the link between the public signing key associated with the presented api key and the chosen tenant", + "summary": "Deletes public signing key - tenant link", + "tags": ["api/v1/iglu/rest/keys", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" } ], - "requestBody": { - "description": "New state of the tenant", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, - "preferred_compression_method": { "type": "string" }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } - }, - "required": [ - "id", - "github_username", - "name", - "permission", - "is_public", - "preferred_compression_method", - "uri", - "priority", - "ttl" - ] - } - } - } - }, "responses": { - "200": { - "description": "New state of the tenant after the update", + "201": { + "description": "Informational response to acknolwedge deletion of key", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, - "preferred_compression_method": { - "type": "string" - }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } + "information": { + "type": "string", + "enum": ["Signing key deleted successfully"] + } }, - "required": [ - "id", - "github_username", - "name", - "permission", - "is_public", - "preferred_compression_method", - "uri", - "priority", - "ttl" - ] + "required": ["information"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3843,15 +4932,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3871,15 +4972,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3899,15 +5012,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3920,22 +5045,34 @@ } } }, - "422": { - "description": "Returned when the body you provided was not in the correct format", + "499": { + "description": "Returned when the given API Key is not allowed to edit the requested Signing Key", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3949,21 +5086,33 @@ } }, "500": { - "description": "Returned when the creation failed on iglu's part. Referr to the error information for more detail", + "description": "Returned when iglu encounters an error during the update", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -3983,15 +5132,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4005,53 +5166,153 @@ } } } - }, - "delete": { - "description": "Delete a given tenant", - "summary": "Delete a tenant", + } + }, + "/api/v1/iglu/rest/tenants/{tenant}/access_rules/{access_rules_id}": { + "get": { + "description": "Get detailed information about the Access rule", + "summary": "Get Access Rule", "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, + "required": true, + "name": "access_rules_id", + "in": "path" + }, + { + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" } ], "responses": { - "201": { - "description": "Informational response after tenant deletion", - "content": { + "200": { + "description": "Response containing the access rule", + "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", "properties": { - "information": { + "id": { + "type": "string" + }, + "tenants_id": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, + "preferred_compression_method": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } + }, + "required": [ + "id", + "github_username", + "name", + "permission", + "is_public", + "preferred_compression_method", + "uri", + "priority", + "ttl", + "signing_method" + ] + }, + "ip_block": { + "type": "string" + }, + "start_ip": { + "type": "number" + }, + "end_ip": { + "type": "number" + }, + "priority": { + "type": "number" + }, + "action": { "type": "string", - "enum": ["Tenant deleted successfully"] + "enum": ["drop", "accept"] + }, + "name": { + "type": "string" } }, - "required": ["information"] + "required": [ + "id", + "tenants_id", + "ip_block", + "start_ip", + "end_ip", + "priority", + "action", + "name" + ] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4071,15 +5332,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4099,15 +5372,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4127,43 +5412,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "500": { - "description": "Returned when the creation failed on iglu's part. Referr to the error information for more detail", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4183,15 +5452,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4205,45 +5486,84 @@ } } } - } - }, - "/api/v1/iglu/rest/keys/auth": { - "get": { - "description": "Get all Tenants your api key has access to", - "summary": "Get available tenants", - "tags": ["api/v1/iglu/rest/keys", "iglu"], + }, + "delete": { + "description": "Delete a given Access Rule", + "summary": "Delete Access Rule", + "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, + "required": true, + "name": "tenant", + "in": "path" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "access_rules_id", + "in": "path" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "confirm", + "in": "query" + }, + { + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "user-agent", + "in": "header" } ], "responses": { "200": { - "description": "Tenant IDs and meta information about the key used in authentication", + "description": "Informational Response after the rule is deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", "properties": { - "id": { "type": "string", "format": "uuid" }, - "name": { "type": "string" }, - "tenants": { - "type": "array", - "items": { "type": "string", "format": "uuid" } + "information": { + "type": "string", + "enum": ["Access rule deleted successfully!"] } }, - "required": ["id", "name", "tenants"] + "required": ["information"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4257,21 +5577,33 @@ } }, "401": { - "description": "Unauthorized - Key not recognized", + "description": "The key you were using is not recognized", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4285,21 +5617,33 @@ } }, "403": { - "description": "Unauthorized - No Auth Header presented", + "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4312,22 +5656,34 @@ } } }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", + "404": { + "description": "The requested tenant does not exist on this server", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4339,61 +5695,35 @@ } } } - } - } - }, - "post": { - "description": "Create a new API Key that is authorized for given tenants", - "summary": "Create new API Key", - "tags": ["api/v1/iglu/rest/keys", "iglu"], - "parameters": [ - { - "schema": { "type": "string" }, - "required": true, - "name": "authorization", - "in": "header" - } - ], - "requestBody": { - "description": "Schema for creating new Key", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string" }, - "tenants": { - "type": "array", - "items": { "type": "string", "format": "uuid" } - } - }, - "required": ["name", "tenants"] - } - } - } - }, - "responses": { - "200": { - "description": "Name, id and secret of new API Key", + }, + "423": { + "description": "Returned when attempting to delete the last access rule without the confirm query param", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", "properties": { - "id": { "type": "string", "format": "uuid" }, - "name": { "type": "string" }, - "key": { "type": "string", "format": "uuid" } + "error_details": { + "type": "string" + } }, - "required": ["id", "name", "key"] + "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4406,22 +5736,34 @@ } } }, - "400": { - "description": "Your request body was malformed or not in the right format", + "503": { + "description": "Returned if the feature this route is part of is not enabled", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4433,51 +5775,180 @@ } } } - }, - "401": { - "description": "The API Key used was either not recognized or does not have access to some of the tenants in the tenants key of the request body", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } + } + } + }, + "patch": { + "description": "Update a given Access Rule", + "summary": "Update Access Rule", + "tags": ["api/v1/iglu/rest/tenants", "iglu"], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "tenant", + "in": "path" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "access_rules_id", + "in": "path" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "authorization", + "in": "header" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "user-agent", + "in": "header" + } + ], + "requestBody": { + "description": "The new state the access rule should reflect", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ip_block": { + "type": "string" }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } + "priority": { + "type": "number" + }, + "action": { + "type": "string", + "enum": ["drop", "accept"] + }, + "name": { + "type": "string" + } + }, + "required": ["ip_block", "priority", "action", "name"] } } - }, - "403": { - "description": "You haven't presented an auth header.", + } + }, + "responses": { + "200": { + "description": "Returns the new state of the given access rule", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "properties": { + "id": { + "type": "string" + }, + "tenants_id": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, + "preferred_compression_method": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } + }, + "required": [ + "id", + "github_username", + "name", + "permission", + "is_public", + "preferred_compression_method", + "uri", + "priority", + "ttl", + "signing_method" + ] + }, + "ip_block": { + "type": "string" + }, + "start_ip": { + "type": "number" + }, + "end_ip": { + "type": "number" + }, + "priority": { + "type": "number" + }, + "action": { + "type": "string", + "enum": ["drop", "accept"] + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "tenants_id", + "ip_block", + "start_ip", + "end_ip", + "priority", + "action", + "name" + ] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4490,22 +5961,34 @@ } } }, - "500": { - "description": "Iglu encountered an error while creating the API Key", + "401": { + "description": "The key you were using is not recognized", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4518,22 +6001,34 @@ } } }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", + "403": { + "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4545,43 +6040,35 @@ } } } - } - } - }, - "delete": { - "description": "Delete the currently used api key", - "summary": "Delete api key", - "tags": ["api/v1/iglu/rest/keys", "iglu"], - "parameters": [ - { - "schema": { "type": "string" }, - "required": true, - "name": "authorization", - "in": "header" - } - ], - "responses": { - "200": { - "description": "Informational response to acknowledge deletion of key", + }, + "404": { + "description": "The requested tenant does not exist on this server", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", "properties": { - "information": { - "type": "string", - "enum": ["This API Key has been deleted."] + "error_details": { + "type": "string" } }, - "required": ["information"] + "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4594,22 +6081,34 @@ } } }, - "401": { - "description": "The API Key you provided does not exist", + "422": { + "description": "Returned when the provided body was in an invalid shape", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4622,22 +6121,34 @@ } } }, - "403": { - "description": "You haven't presented an auth header.", + "423": { + "description": "Returned when a rule update would result in locking out the request IP. This update can be made regardless of that, if the confirm query param is provided", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4651,21 +6162,33 @@ } }, "500": { - "description": "Iglu encountered an error while deleting the API Key", + "description": "Returned if the updated was unsuccessfull on iglu's part", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4685,15 +6208,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4709,88 +6244,177 @@ } } }, - "/api/v1/iglu/rest/keys/auth/modify": { - "patch": { - "description": "Modify which API Keys are allowed to access tenants that you have access to", - "summary": "Modify API Key access", - "tags": ["api/v1/iglu/rest/keys", "iglu"], + "/api/v1/iglu/rest/tenants/{tenant}/access_rules": { + "post": { + "description": "Create a new access rule for the given tenant", + "summary": "Create access rules", + "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, + "required": true, + "name": "tenant", + "in": "path" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "confirm", + "in": "query" + }, + { + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "user-agent", + "in": "header" } ], "requestBody": { - "description": "New state that the tenant should reflect", + "description": "The access rule to create", "content": { "application/json": { "schema": { "type": "object", "properties": { - "id": { "type": "string", "format": "uuid" }, - "name": { "type": "string" }, - "tenants": { - "type": "array", - "items": { "type": "string", "format": "uuid" } + "ip_block": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "action": { + "type": "string", + "enum": ["drop", "accept"] + }, + "name": { + "type": "string" } }, - "required": ["id", "name", "tenants"] + "required": ["ip_block", "priority", "action", "name"] } } } }, "responses": { - "200": { - "description": "Informational response on success of operation", + "201": { + "description": "Response cotaining the new Rule", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", "properties": { - "information": { + "id": { + "type": "string" + }, + "tenants_id": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, + "preferred_compression_method": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } + }, + "required": [ + "id", + "github_username", + "name", + "permission", + "is_public", + "preferred_compression_method", + "uri", + "priority", + "ttl", + "signing_method" + ] + }, + "ip_block": { + "type": "string" + }, + "start_ip": { + "type": "number" + }, + "end_ip": { + "type": "number" + }, + "priority": { + "type": "number" + }, + "action": { "type": "string", - "enum": ["Request completed successfully"] + "enum": ["drop", "accept"] + }, + "name": { + "type": "string" } }, - "required": ["information"] - }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "400": { - "description": "The provided request body is not in the correct format", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "required": [ + "id", + "tenants_id", + "ip_block", + "start_ip", + "end_ip", + "priority", + "action", + "name" + ] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4804,21 +6428,33 @@ } }, "401": { - "description": "The API Key you used is not recognized OR you are not allowed to edit the tenants you provided", + "description": "The key you were using is not recognized", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4832,21 +6468,33 @@ } }, "403": { - "description": "There was no auth header presented", + "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4859,22 +6507,34 @@ } } }, - "500": { - "description": "Iglu was unable to complete the request", + "404": { + "description": "The requested tenant does not exist on this server", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4887,22 +6547,34 @@ } } }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", + "406": { + "description": "Returned when your route params are not in the correct format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -4914,121 +6586,35 @@ } } } - } - } - } - }, - "/api/v1/iglu/rest/keys/auth/{tenant}": { - "get": { - "description": "Get all registerd API Keys for this tenant (excluding hashes)", - "summary": "Get registered API Keys", - "tags": ["api/v1/iglu/rest/keys", "iglu"], - "parameters": [ - { - "schema": { "type": "string" }, - "required": true, - "name": "tenant", - "in": "path" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "authorization", - "in": "header" }, - { - "schema": { "type": "string" }, - "required": true, - "name": "user-agent", - "in": "header" - } - ], - "responses": { - "200": { - "description": "The Registered API Keys", + "422": { + "description": "Returned if the request body is in an invalid state", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "api_keys_id": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "hash": { "type": "string" }, - "name": { "type": "string" } - }, - "required": ["id", "hash", "name"] - }, - "tenants_id": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, - "preferred_compression_method": { - "type": "string" - }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } - }, - "required": [ - "id", - "github_username", - "name", - "permission", - "is_public", - "preferred_compression_method", - "uri", - "priority", - "ttl" - ] - } - }, - "required": ["id", "api_keys_id", "tenants_id"] - } + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "401": { - "description": "The key you were using is not recognized", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5041,22 +6627,34 @@ } } }, - "403": { - "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", + "423": { + "description": "Returned if a new rule would lock out the IP you are requesting from. This can be done regardless of the locking by providing the confirm=true query param", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5069,22 +6667,34 @@ } } }, - "404": { - "description": "The requested tenant does not exist on this server", + "500": { + "description": "Returned if the rule creation failed on Iglu's Part", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5104,15 +6714,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5128,118 +6750,162 @@ } } }, - "/api/v1/iglu/rest/tenants/{tenant}/access_rules": { - "post": { - "description": "Create a new access rule for the given tenant", - "summary": "Create access rules", + "/api/v1/iglu/rest/tenants/{tenant}/access_rules/search": { + "get": { + "description": "Search for a given access rule by a variety of parameters", + "summary": "Search for access rules", "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": false, - "name": "confirm", + "name": "name", "in": "query" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, + "required": false, + "name": "ip", + "in": "query" + }, + { + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" } ], - "requestBody": { - "description": "The access rule to create", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ip_block": { "type": "string" }, - "priority": { "type": "number" }, - "action": { "type": "string", "enum": ["drop", "accept"] }, - "name": { "type": "string" } - }, - "required": ["ip_block", "priority", "action", "name"] - } - } - } - }, "responses": { - "201": { - "description": "Response cotaining the new Rule", + "200": { + "description": "Response containing a list of access rules that fit your search criteria", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "tenants_id": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, - "preferred_compression_method": { - "type": "string" + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tenants_id": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, + "preferred_compression_method": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } + "required": [ + "id", + "github_username", + "name", + "permission", + "is_public", + "preferred_compression_method", + "uri", + "priority", + "ttl", + "signing_method" + ] }, - "required": [ - "id", - "github_username", - "name", - "permission", - "is_public", - "preferred_compression_method", - "uri", - "priority", - "ttl" - ] - }, - "ip_block": { "type": "string" }, - "start_ip": { "type": "number" }, - "end_ip": { "type": "number" }, - "priority": { "type": "number" }, - "action": { - "type": "string", - "enum": ["drop", "accept"] + "ip_block": { + "type": "string" + }, + "start_ip": { + "type": "number" + }, + "end_ip": { + "type": "number" + }, + "priority": { + "type": "number" + }, + "action": { + "type": "string", + "enum": ["drop", "accept"] + }, + "name": { + "type": "string" + } }, - "name": { "type": "string" } - }, - "required": [ - "id", - "tenants_id", - "ip_block", - "start_ip", - "end_ip", - "priority", - "action", - "name" - ] + "required": [ + "id", + "tenants_id", + "ip_block", + "start_ip", + "end_ip", + "priority", + "action", + "name" + ] + } }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5252,106 +6918,34 @@ } } }, - "401": { - "description": "The key you were using is not recognized", + "400": { + "description": "Returned if an invalid IP Address was used to query", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_code": { + "type": "number" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "403": { - "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_message": { + "type": "string" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "404": { - "description": "The requested tenant does not exist on this server", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "is_error": { + "type": "boolean" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "406": { - "description": "Returned when your route params are not in the correct format", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5364,22 +6958,34 @@ } } }, - "422": { - "description": "Returned if the request body is in an invalid state", + "401": { + "description": "The key you were using is not recognized", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5392,22 +6998,34 @@ } } }, - "423": { - "description": "Returned if a new rule would lock out the IP you are requesting from. This can be done regardless of the locking by providing the confirm=true query param", + "403": { + "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5420,22 +7038,34 @@ } } }, - "500": { - "description": "Returned if the rule creation failed on Iglu's Part", + "404": { + "description": "The requested tenant does not exist on this server", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5455,15 +7085,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5479,138 +7121,116 @@ } } }, - "/api/v1/iglu/rest/tenants/{tenant}/access_rules/search": { - "get": { - "description": "Search for a given access rule by a variety of parameters", - "summary": "Search for access rules", - "tags": ["api/v1/iglu/rest/tenants", "iglu"], + "/api/v1/cache/{tenant}/multipart-nar/{uid}": { + "post": { + "description": "Retrieve an upload url for a given upload id (uid)", + "summary": "Retrieve upload url", + "tags": ["api/v1/cache", "cachix"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, - "required": false, - "name": "name", - "in": "query" + "schema": { + "type": "string" + }, + "required": true, + "name": "uid", + "in": "path" }, { - "schema": { "type": "string" }, - "required": false, - "name": "ip", + "schema": { + "type": "number" + }, + "required": true, + "name": "partNumber", "in": "query" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" } ], + "requestBody": { + "description": "The MD5 of the derivation part you are uploading", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "contentMD5": { + "type": "string" + } + }, + "required": ["contentMD5"] + } + } + } + }, "responses": { "200": { - "description": "Response containing a list of access rules that fit your search criteria", + "description": "An upload URL for a derivation part. May either be S3 or local Iglu upload URL", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "tenants_id": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, - "preferred_compression_method": { - "type": "string" - }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } - }, - "required": [ - "id", - "github_username", - "name", - "permission", - "is_public", - "preferred_compression_method", - "uri", - "priority", - "ttl" - ] - }, - "ip_block": { "type": "string" }, - "start_ip": { "type": "number" }, - "end_ip": { "type": "number" }, - "priority": { "type": "number" }, - "action": { - "type": "string", - "enum": ["drop", "accept"] - }, - "name": { "type": "string" } - }, - "required": [ - "id", - "tenants_id", - "ip_block", - "start_ip", - "end_ip", - "priority", - "action", - "name" - ] - } - }, - "timestamp": { "type": "number" } + "uploadURL": { + "type": "string", + "format": "uri" + } }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] + "required": ["uploadURL"] } } } }, "400": { - "description": "Returned if an invalid IP Address was used to query", + "description": "Returned if your body or request params were malformed or not in the appropriate format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5630,15 +7250,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5658,15 +7290,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5686,153 +7330,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_code": { + "type": "number" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - } - } - } - }, - "/api/v1/iglu/rest/tenants/{tenant}/access_rules/{access_rules_id}": { - "get": { - "description": "Get detailed information about the Access rule", - "summary": "Get Access Rule", - "tags": ["api/v1/iglu/rest/tenants", "iglu"], - "parameters": [ - { - "schema": { "type": "string" }, - "required": true, - "name": "tenant", - "in": "path" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "access_rules_id", - "in": "path" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "authorization", - "in": "header" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "user-agent", - "in": "header" - } - ], - "responses": { - "200": { - "description": "Response containing the access rule", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, "data": { "type": "object", "properties": { - "id": { "type": "string" }, - "tenants_id": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, - "preferred_compression_method": { - "type": "string" - }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } - }, - "required": [ - "id", - "github_username", - "name", - "permission", - "is_public", - "preferred_compression_method", - "uri", - "priority", - "ttl" - ] - }, - "ip_block": { "type": "string" }, - "start_ip": { "type": "number" }, - "end_ip": { "type": "number" }, - "priority": { "type": "number" }, - "action": { - "type": "string", - "enum": ["drop", "accept"] - }, - "name": { "type": "string" } + "error_details": { + "type": "string" + } }, - "required": [ - "id", - "tenants_id", - "ip_block", - "start_ip", - "end_ip", - "priority", - "action", - "name" - ] + "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5845,22 +7363,34 @@ } } }, - "401": { - "description": "The key you were using is not recognized", + "408": { + "description": "Returned if the upload ID is no longer valid (timed out)", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5873,22 +7403,34 @@ } } }, - "403": { - "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", + "422": { + "description": "The given upload ID was not found", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5901,50 +7443,34 @@ } } }, - "404": { - "description": "The requested tenant does not exist on this server", + "500": { + "description": "Returned if iglu was unable to handle the request correctly", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -5958,65 +7484,155 @@ } } } - }, - "delete": { - "description": "Delete a given Access Rule", - "summary": "Delete Access Rule", - "tags": ["api/v1/iglu/rest/tenants", "iglu"], + } + }, + "/api/v1/cache/{tenant}/multipart-nar/{uid}/complete": { + "post": { + "description": "Finish a given upload by uploading cachix meta information about the derivation", + "summary": "Finish a given upload", + "tags": ["api/v1/cache", "cachix"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, - "name": "access_rules_id", + "name": "uid", "in": "path" }, { - "schema": { "type": "string" }, - "required": false, - "name": "confirm", - "in": "query" - }, - { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" } ], + "requestBody": { + "description": "Meta information about the derivation", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "narInfoCreate": { + "type": "object", + "properties": { + "cDeriver": { + "type": "string" + }, + "cFileHash": { + "type": "string" + }, + "cFileSize": { + "type": "number" + }, + "cNarHash": { + "type": "string" + }, + "cNarSize": { + "type": "number" + }, + "cReferences": { + "type": "array", + "items": { + "type": "string" + } + }, + "cSig": { + "type": "string" + }, + "cStoreHash": { + "type": "string" + }, + "cStoreSuffix": { + "type": "string" + } + }, + "required": [ + "cDeriver", + "cFileHash", + "cFileSize", + "cNarHash", + "cNarSize", + "cReferences", + "cSig", + "cStoreHash", + "cStoreSuffix" + ] + }, + "parts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eTag": { + "type": "string" + }, + "partNumber": { + "type": "number" + } + }, + "required": ["eTag", "partNumber"] + } + } + }, + "required": ["narInfoCreate", "parts"] + } + } + } + }, "responses": { "200": { - "description": "Informational Response after the rule is deleted", + "description": "Empty success response", + "content": {} + }, + "400": { + "description": "Returned if your body was not in the correct format", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", "properties": { - "information": { - "type": "string", - "enum": ["Access rule deleted successfully!"] + "error_details": { + "type": "string" } }, - "required": ["information"] + "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6036,15 +7652,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6064,15 +7692,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6092,15 +7732,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6113,22 +7765,34 @@ } } }, - "423": { - "description": "Returned when attempting to delete the last access rule without the confirm query param", + "408": { + "description": "Returned if the upload ID you were using is no longer valid (timed out)", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6141,22 +7805,34 @@ } } }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", + "422": { + "description": "The given upload ID was not found", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6168,121 +7844,35 @@ } } } - } - } - }, - "patch": { - "description": "Update a given Access Rule", - "summary": "Update Access Rule", - "tags": ["api/v1/iglu/rest/tenants", "iglu"], - "parameters": [ - { - "schema": { "type": "string" }, - "required": true, - "name": "tenant", - "in": "path" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "access_rules_id", - "in": "path" - }, - { - "schema": { "type": "string" }, - "required": true, - "name": "authorization", - "in": "header" }, - { - "schema": { "type": "string" }, - "required": true, - "name": "user-agent", - "in": "header" - } - ], - "requestBody": { - "description": "The new state the access rule should reflect", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ip_block": { "type": "string" }, - "priority": { "type": "number" }, - "action": { "type": "string", "enum": ["drop", "accept"] }, - "name": { "type": "string" } - }, - "required": ["ip_block", "priority", "action", "name"] - } - } - } - }, - "responses": { - "200": { - "description": "Returns the new state of the given access rule", + "424": { + "description": "The given nar fingerprint is invalid (i.e not signed by a recognized key)", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", "properties": { - "id": { "type": "string" }, - "tenants_id": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, - "preferred_compression_method": { - "type": "string" - }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } - }, - "required": [ - "id", - "github_username", - "name", - "permission", - "is_public", - "preferred_compression_method", - "uri", - "priority", - "ttl" - ] - }, - "ip_block": { "type": "string" }, - "start_ip": { "type": "number" }, - "end_ip": { "type": "number" }, - "priority": { "type": "number" }, - "action": { - "type": "string", - "enum": ["drop", "accept"] - }, - "name": { "type": "string" } + "error_details": { + "type": "string" + } }, - "required": [ - "id", - "tenants_id", - "ip_block", - "start_ip", - "end_ip", - "priority", - "action", - "name" - ] + "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6295,190 +7885,34 @@ } } }, - "401": { - "description": "The key you were using is not recognized", + "500": { + "description": "Iglu encountered an error finishing the upload", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "403": { - "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "404": { - "description": "The requested tenant does not exist on this server", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "422": { - "description": "Returned when the provided body was in an invalid shape", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "423": { - "description": "Returned when a rule update would result in locking out the request IP. This update can be made regardless of that, if the confirm query param is provided", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "500": { - "description": "Returned if the updated was unsuccessfull on iglu's part", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "503": { - "description": "Returned if the feature this route is part of is not enabled", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6501,25 +7935,34 @@ "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string", "format": "uuid" }, + "schema": { + "type": "string", + "format": "uuid" + }, "required": true, "name": "derivation_id", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" @@ -6533,26 +7976,55 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", "properties": { - "id": { "type": "string" }, + "id": { + "type": "string" + }, "derivations_id": { "type": "object", "properties": { - "id": { "type": "string" }, - "cderiver": { "type": "string" }, - "cfilehash": { "type": "string" }, - "cfilesize": { "type": "number" }, - "cnarhash": { "type": "string" }, - "cnarsize": { "type": "string" }, - "creferences": { "type": "string" }, - "cstorehash": { "type": "string" }, - "cstoresuffix": { "type": "string" }, - "parts": { "type": "string" }, + "id": { + "type": "string" + }, + "cderiver": { + "type": "string" + }, + "cfilehash": { + "type": "string" + }, + "cfilesize": { + "type": "number" + }, + "cnarhash": { + "type": "string" + }, + "cnarsize": { + "type": "string" + }, + "creferences": { + "type": "string" + }, + "cstorehash": { + "type": "string" + }, + "cstoresuffix": { + "type": "string" + }, + "parts": { + "type": "string" + }, "compression": { "type": "string", "enum": ["xz", "zstd"] @@ -6575,17 +8047,37 @@ "tenants_id": { "type": "object", "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, "preferred_compression_method": { "type": "string" }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -6596,26 +8088,43 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, - "pin": { "type": "boolean" }, - "csig": { "type": "string" }, + "pin": { + "type": "boolean" + }, + "csig": { + "type": "string" + }, "signing_keys_id": { "type": "object", "properties": { - "id": { "type": "string" }, - "key": { "type": "string" }, + "id": { + "type": "string" + }, + "key": { + "type": "string" + }, "api_keys_id": { "type": "object", "properties": { - "id": { "type": "string" }, - "hash": { "type": "string" }, - "name": { "type": "string" } + "id": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "name": { + "type": "string" + } }, "required": ["id", "hash", "name"] }, - "name": { "type": "string" } + "name": { + "type": "string" + } }, "required": ["id", "key", "api_keys_id", "name"] } @@ -6629,7 +8138,9 @@ "signing_keys_id" ] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6649,15 +8160,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6677,15 +8200,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6705,15 +8240,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6733,15 +8280,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6762,25 +8321,34 @@ "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string", "format": "uuid" }, + "schema": { + "type": "string", + "format": "uuid" + }, "required": true, "name": "derivation_id", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" @@ -6794,9 +8362,16 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "object", "properties": { @@ -6807,7 +8382,9 @@ }, "required": ["information"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6827,15 +8404,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6855,15 +8444,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6883,15 +8484,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6911,15 +8524,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -6939,16 +8564,28 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] - }, - "timestamp": { "type": "number" } - }, + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, "required": [ "status_code", "status_message", @@ -6970,25 +8607,33 @@ "tags": ["api/v1/iglu/rest/tenants", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "query", "in": "query" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" @@ -7002,28 +8647,57 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { "type": "array", "items": { "type": "object", "properties": { - "id": { "type": "string" }, + "id": { + "type": "string" + }, "derivations_id": { "type": "object", "properties": { - "id": { "type": "string" }, - "cderiver": { "type": "string" }, - "cfilehash": { "type": "string" }, - "cfilesize": { "type": "number" }, - "cnarhash": { "type": "string" }, - "cnarsize": { "type": "string" }, - "creferences": { "type": "string" }, - "cstorehash": { "type": "string" }, - "cstoresuffix": { "type": "string" }, - "parts": { "type": "string" }, + "id": { + "type": "string" + }, + "cderiver": { + "type": "string" + }, + "cfilehash": { + "type": "string" + }, + "cfilesize": { + "type": "number" + }, + "cnarhash": { + "type": "string" + }, + "cnarsize": { + "type": "string" + }, + "creferences": { + "type": "string" + }, + "cstorehash": { + "type": "string" + }, + "cstoresuffix": { + "type": "string" + }, + "parts": { + "type": "string" + }, "compression": { "type": "string", "enum": ["xz", "zstd"] @@ -7046,17 +8720,37 @@ "tenants_id": { "type": "object", "properties": { - "id": { "type": "string" }, - "github_username": { "type": "string" }, - "name": { "type": "string" }, - "permission": { "type": "string" }, - "is_public": { "type": "boolean" }, + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, "preferred_compression_method": { "type": "string" }, - "uri": { "type": "string" }, - "priority": { "type": "number" }, - "ttl": { "type": "number" } + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } }, "required": [ "id", @@ -7067,26 +8761,43 @@ "preferred_compression_method", "uri", "priority", - "ttl" + "ttl", + "signing_method" ] }, - "pin": { "type": "boolean" }, - "csig": { "type": "string" }, + "pin": { + "type": "boolean" + }, + "csig": { + "type": "string" + }, "signing_keys_id": { "type": "object", "properties": { - "id": { "type": "string" }, - "key": { "type": "string" }, + "id": { + "type": "string" + }, + "key": { + "type": "string" + }, "api_keys_id": { "type": "object", "properties": { - "id": { "type": "string" }, - "hash": { "type": "string" }, - "name": { "type": "string" } + "id": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "name": { + "type": "string" + } }, "required": ["id", "hash", "name"] }, - "name": { "type": "string" } + "name": { + "type": "string" + } }, "required": [ "id", @@ -7106,7 +8817,1271 @@ ] } }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "401": { + "description": "The key you were using is not recognized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "403": { + "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "404": { + "description": "The requested tenant does not exist on this server", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "499": { + "description": "Returned in the event the query parameter was provided as uuid but that ID was not found in the database", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "503": { + "description": "Returned if the feature this route is part of is not enabled", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + } + } + } + }, + "/api/v1/iglu/rest/tenants/{tenant}/derivations/{derivation_id}/pin": { + "get": { + "description": "Pin a given derivation so it isn't garbage collected anymore", + "summary": "Pin derivation", + "tags": ["api/v1/iglu/rest/tenants", "iglu"], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "tenant", + "in": "path" + }, + { + "schema": { + "type": "string", + "format": "uuid" + }, + "required": true, + "name": "derivation_id", + "in": "path" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "authorization", + "in": "header" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "user-agent", + "in": "header" + } + ], + "responses": { + "200": { + "description": "Informational response, returned when request completed successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, + "data": { + "type": "object", + "properties": { + "information": { + "type": "string", + "enum": [ + "Derivation pinned successfully", + "Derivation unpinned successfully" + ] + } + }, + "required": ["information"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "401": { + "description": "The key you were using is not recognized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "403": { + "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "404": { + "description": "The requested tenant does not exist on this server", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "500": { + "description": "Returned when iglu encounters an error while pinning the derivation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "503": { + "description": "Returned if the feature this route is part of is not enabled", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + } + } + } + }, + "/api/v1/iglu/rest/keys/auth/modify": { + "patch": { + "description": "Modify which API Keys are allowed to access tenants that you have access to", + "summary": "Modify API Key access", + "tags": ["api/v1/iglu/rest/keys", "iglu"], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "authorization", + "in": "header" + } + ], + "requestBody": { + "description": "New state that the tenant should reflect", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string" + }, + "tenants": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + }, + "required": ["id", "name", "tenants"] + } + } + } + }, + "responses": { + "200": { + "description": "Informational response on success of operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, + "data": { + "type": "object", + "properties": { + "information": { + "type": "string", + "enum": ["Request completed successfully"] + } + }, + "required": ["information"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "400": { + "description": "The provided request body is not in the correct format", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "401": { + "description": "The API Key you used is not recognized OR you are not allowed to edit the tenants you provided", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "403": { + "description": "There was no auth header presented", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "500": { + "description": "Iglu was unable to complete the request", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "503": { + "description": "Returned if the feature this route is part of is not enabled", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + } + } + } + }, + "/api/v1/iglu/rest/keys/auth": { + "get": { + "description": "Get all Tenants your api key has access to", + "summary": "Get available tenants", + "tags": ["api/v1/iglu/rest/keys", "iglu"], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "authorization", + "in": "header" + } + ], + "responses": { + "200": { + "description": "Tenant IDs and meta information about the key used in authentication", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, + "data": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string" + }, + "tenants": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, + "preferred_compression_method": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } + }, + "required": [ + "id", + "github_username", + "name", + "permission", + "is_public", + "preferred_compression_method", + "uri", + "priority", + "ttl", + "signing_method" + ] + } + } + }, + "required": ["id", "name", "tenants"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "401": { + "description": "Unauthorized - Key not recognized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "403": { + "description": "Unauthorized - No Auth Header presented", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "503": { + "description": "Returned if the feature this route is part of is not enabled", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + } + } + }, + "post": { + "description": "Create a new API Key that is authorized for given tenants", + "summary": "Create new API Key", + "tags": ["api/v1/iglu/rest/keys", "iglu"], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "authorization", + "in": "header" + } + ], + "requestBody": { + "description": "Schema for creating new Key", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "tenants": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + }, + "required": ["name", "tenants"] + } + } + } + }, + "responses": { + "200": { + "description": "Name, id and secret of new API Key", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, + "data": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string" + }, + "key": { + "type": "string", + "format": "uuid" + } + }, + "required": ["id", "name", "key"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "400": { + "description": "Your request body was malformed or not in the right format", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "401": { + "description": "The API Key used was either not recognized or does not have access to some of the tenants in the tenants key of the request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "403": { + "description": "You haven't presented an auth header.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + }, + "500": { + "description": "Iglu encountered an error while creating the API Key", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "error_details": { + "type": "string" + } + }, + "required": ["error_details"] + }, + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -7119,22 +10094,93 @@ } } }, - "401": { - "description": "The key you were using is not recognized", + "503": { + "description": "Returned if the feature this route is part of is not enabled", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } + }, + "required": [ + "status_code", + "status_message", + "is_error", + "data", + "timestamp" + ] + } + } + } + } + } + }, + "delete": { + "description": "Delete the currently used api key", + "summary": "Delete api key", + "tags": ["api/v1/iglu/rest/keys", "iglu"], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "authorization", + "in": "header" + } + ], + "responses": { + "200": { + "description": "Informational response to acknowledge deletion of key", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, + "data": { + "type": "object", + "properties": { + "information": { + "type": "string", + "enum": ["This API Key has been deleted."] + } + }, + "required": ["information"] + }, + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -7147,22 +10193,34 @@ } } }, - "403": { - "description": "Forbidden - No authorization, either you didn't provide an authorization header or your header is not in the Bearer format", + "401": { + "description": "The API Key you provided does not exist", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -7175,22 +10233,34 @@ } } }, - "404": { - "description": "The requested tenant does not exist on this server", + "403": { + "description": "You haven't presented an auth header.", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -7203,22 +10273,34 @@ } } }, - "499": { - "description": "Returned in the event the query parameter was provided as uuid but that ID was not found in the database", + "500": { + "description": "Iglu encountered an error while deleting the API Key", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -7238,15 +10320,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -7262,32 +10356,32 @@ } } }, - "/api/v1/iglu/rest/tenants/{tenant}/derivations/{derivation_id}/pin": { + "/api/v1/iglu/rest/keys/auth/{tenant}": { "get": { - "description": "Pin a given derivation so it isn't garbage collected anymore", - "summary": "Pin derivation", - "tags": ["api/v1/iglu/rest/tenants", "iglu"], + "description": "Get all registerd API Keys for this tenant (excluding hashes)", + "summary": "Get registered API Keys", + "tags": ["api/v1/iglu/rest/keys", "iglu"], "parameters": [ { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "tenant", "in": "path" }, { - "schema": { "type": "string", "format": "uuid" }, - "required": true, - "name": "derivation_id", - "in": "path" - }, - { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "authorization", "in": "header" }, { - "schema": { "type": "string" }, + "schema": { + "type": "string" + }, "required": true, "name": "user-agent", "in": "header" @@ -7295,29 +10389,100 @@ ], "responses": { "200": { - "description": "Informational response, returned when request completed successfully", + "description": "The Registered API Keys", "content": { "application/json": { "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean", "enum": [false] }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean", + "enum": [false] + }, "data": { - "type": "object", - "properties": { - "information": { - "type": "string", - "enum": [ - "Derivation pinned successfully", - "Derivation unpinned successfully" - ] - } - }, - "required": ["information"] + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "api_keys_id": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": ["id", "hash", "name"] + }, + "tenants_id": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "github_username": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "is_public": { + "type": "boolean" + }, + "preferred_compression_method": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "ttl": { + "type": "number" + }, + "signing_method": { + "type": "string", + "enum": ["client", "server"] + } + }, + "required": [ + "id", + "github_username", + "name", + "permission", + "is_public", + "preferred_compression_method", + "uri", + "priority", + "ttl", + "signing_method" + ] + } + }, + "required": ["id", "api_keys_id", "tenants_id"] + } }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -7337,15 +10502,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -7365,15 +10542,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -7393,43 +10582,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, - "data": { - "type": "object", - "properties": { "error_details": { "type": "string" } }, - "required": ["error_details"] + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" }, - "timestamp": { "type": "number" } - }, - "required": [ - "status_code", - "status_message", - "is_error", - "data", - "timestamp" - ] - } - } - } - }, - "500": { - "description": "Returned when iglu encounters an error while pinning the derivation", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code", @@ -7449,15 +10622,27 @@ "schema": { "type": "object", "properties": { - "status_code": { "type": "number" }, - "status_message": { "type": "string" }, - "is_error": { "type": "boolean" }, + "status_code": { + "type": "number" + }, + "status_message": { + "type": "string" + }, + "is_error": { + "type": "boolean" + }, "data": { "type": "object", - "properties": { "error_details": { "type": "string" } }, + "properties": { + "error_details": { + "type": "string" + } + }, "required": ["error_details"] }, - "timestamp": { "type": "number" } + "timestamp": { + "type": "number" + } }, "required": [ "status_code",