diff --git a/backend/src/lib/api-docs/constants.ts b/backend/src/lib/api-docs/constants.ts index d38f9e59a..8e79d6be8 100644 --- a/backend/src/lib/api-docs/constants.ts +++ b/backend/src/lib/api-docs/constants.ts @@ -689,8 +689,8 @@ export const RAW_SECRETS = { secretPath: "The secret path to list secrets from.", includeImports: "Weather to include imported secrets or not.", tagSlugs: "The comma separated tag slugs to filter secrets.", - secretMetadata: - "The secret metadata key-value pairs to filter secrets by. When querying for multiple metadata pairs, the query is treated as an AND operation. Secret metadata format is key1:value1,key2:value2." + metadataFilter: + "The secret metadata key-value pairs to filter secrets by. When querying for multiple metadata pairs, the query is treated as an AND operation. Secret metadata format is key=value1,value=value2|key=value3,value=value4." }, CREATE: { secretName: "The name of the secret to create.", diff --git a/backend/src/server/routes/v3/secret-router.ts b/backend/src/server/routes/v3/secret-router.ts index 84227b59e..e30cfcede 100644 --- a/backend/src/server/routes/v3/secret-router.ts +++ b/backend/src/server/routes/v3/secret-router.ts @@ -216,7 +216,8 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => { if (metadata && !Array.isArray(metadata)) { ctx.addIssue({ code: z.ZodIssueCode.custom, - message: "Invalid secretMetadata format. Correct format is key1:value1,key2:value2" + message: + "Invalid secretMetadata format. Correct format is key=value1,value=value2|key=value3,value=value4." }); } @@ -233,13 +234,13 @@ export const registerSecretRouter = async (server: FastifyZodProvider) => { ctx.addIssue({ code: z.ZodIssueCode.custom, message: - "Invalid secretMetadata format, key or value must be provided. Correct format is key1:value1,key2:value2" + "Invalid secretMetadata format, key or value must be provided. Correct format is key=value1,value=value2|key=value3,value=value4." }); } } } }) - .describe(RAW_SECRETS.LIST.secretMetadata), + .describe(RAW_SECRETS.LIST.metadataFilter), workspaceId: z.string().trim().optional().describe(RAW_SECRETS.LIST.workspaceId), workspaceSlug: z.string().trim().optional().describe(RAW_SECRETS.LIST.workspaceSlug), environment: z.string().trim().optional().describe(RAW_SECRETS.LIST.environment),