From 655ad6b9e0d06b357c1701104fef4c4b90439da1 Mon Sep 17 00:00:00 2001 From: Matti Nannt Date: Mon, 31 Mar 2025 19:14:44 +0900 Subject: [PATCH] docs: fix response client api endpoint is missing environmentId (#5161) --- .../client-api->-response/update-response.mdx | 4 +- docs/api-reference/openapi.json | 404 +++++++++--------- 2 files changed, 204 insertions(+), 204 deletions(-) diff --git a/docs/api-reference/client-api->-response/update-response.mdx b/docs/api-reference/client-api->-response/update-response.mdx index 1f497c1ebb..2dea8c5609 100644 --- a/docs/api-reference/client-api->-response/update-response.mdx +++ b/docs/api-reference/client-api->-response/update-response.mdx @@ -1,3 +1,3 @@ --- -openapi: put /api/v1/client/responses/{responseId} ---- \ No newline at end of file +openapi: put /api/v1/client/{environmentId}/responses/{responseId} +--- diff --git a/docs/api-reference/openapi.json b/docs/api-reference/openapi.json index d1f02a3d02..801aaa301c 100644 --- a/docs/api-reference/openapi.json +++ b/docs/api-reference/openapi.json @@ -6,208 +6,6 @@ }, "openapi": "3.0.0", "paths": { - "/api/v1/client/responses/{responseId}": { - "put": { - "description": "Update an existing response for example when you want to mark a response as finished or you want to change an existing response's value.", - "parameters": [ - { - "in": "path", - "name": "responseId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "example": { - "data": { - "hs8yd14l9h8u353tjmv6rzawqqq": "clicked", - "tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?" - }, - "finished": true - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": {} - }, - "schema": { - "type": "object" - } - } - }, - "description": "OK", - "headers": { - "Access-Control-Allow-Credentials": { - "schema": { - "example": "true", - "type": "boolean" - } - }, - "Access-Control-Allow-Origin": { - "schema": { - "example": "*", - "type": "string" - } - }, - "Connection": { - "schema": { - "example": "keep-alive", - "type": "string" - } - }, - "Date": { - "schema": { - "example": "Tue, 23 Apr 2024 08:09:19 GMT", - "type": "string" - } - }, - "Keep-Alive": { - "schema": { - "example": "timeout=5", - "type": "string" - } - }, - "Transfer-Encoding": { - "schema": { - "example": "chunked", - "type": "string" - } - }, - "access-control-allow-headers": { - "schema": { - "example": "Content-Type, Authorization", - "type": "string" - } - }, - "access-control-allow-methods": { - "schema": { - "example": "GET, POST, PUT, DELETE, OPTIONS", - "type": "string" - } - }, - "cache-control": { - "schema": { - "example": "private, no-store", - "type": "string" - } - }, - "content-type": { - "schema": { - "example": "application/json", - "type": "string" - } - }, - "vary": { - "schema": { - "example": "RSC, Next-Router-State-Tree, Next-Router-Prefetch", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/json": { - "example": { - "code": "not_found", - "details": { - "resource_id": "nonexistentid", - "resource_type": "Response" - }, - "message": "Response not found" - }, - "schema": { - "type": "object" - } - } - }, - "description": "Not Found", - "headers": { - "Access-Control-Allow-Credentials": { - "schema": { - "example": "true", - "type": "boolean" - } - }, - "Access-Control-Allow-Origin": { - "schema": { - "example": "*", - "type": "string" - } - }, - "Connection": { - "schema": { - "example": "keep-alive", - "type": "string" - } - }, - "Date": { - "schema": { - "example": "Tue, 23 Apr 2024 08:13:50 GMT", - "type": "string" - } - }, - "Keep-Alive": { - "schema": { - "example": "timeout=5", - "type": "string" - } - }, - "Transfer-Encoding": { - "schema": { - "example": "chunked", - "type": "string" - } - }, - "access-control-allow-headers": { - "schema": { - "example": "Content-Type, Authorization", - "type": "string" - } - }, - "access-control-allow-methods": { - "schema": { - "example": "GET, POST, PUT, DELETE, OPTIONS", - "type": "string" - } - }, - "cache-control": { - "schema": { - "example": "private, no-store", - "type": "string" - } - }, - "content-type": { - "schema": { - "example": "application/json", - "type": "string" - } - }, - "vary": { - "schema": { - "example": "RSC, Next-Router-State-Tree, Next-Router-Prefetch", - "type": "string" - } - } - } - } - }, - "summary": "Update Response", - "tags": ["Client API > Response"] - } - }, "/api/v1/client/{environmentId}/contacts/{userId}/attributes": { "put": { "description": "Update a contact's attributes in Formbricks to keep them in sync with your app or when you want to set a custom attribute in Formbricks.", @@ -1714,6 +1512,208 @@ "tags": ["Client API > Response"] } }, + "/api/v1/client/{environmentId}/responses/{responseId}": { + "put": { + "description": "Update an existing response for example when you want to mark a response as finished or you want to change an existing response's value.", + "parameters": [ + { + "in": "path", + "name": "responseId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "data": { + "hs8yd14l9h8u353tjmv6rzawqqq": "clicked", + "tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?" + }, + "finished": true + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "data": {} + }, + "schema": { + "type": "object" + } + } + }, + "description": "OK", + "headers": { + "Access-Control-Allow-Credentials": { + "schema": { + "example": "true", + "type": "boolean" + } + }, + "Access-Control-Allow-Origin": { + "schema": { + "example": "*", + "type": "string" + } + }, + "Connection": { + "schema": { + "example": "keep-alive", + "type": "string" + } + }, + "Date": { + "schema": { + "example": "Tue, 23 Apr 2024 08:09:19 GMT", + "type": "string" + } + }, + "Keep-Alive": { + "schema": { + "example": "timeout=5", + "type": "string" + } + }, + "Transfer-Encoding": { + "schema": { + "example": "chunked", + "type": "string" + } + }, + "access-control-allow-headers": { + "schema": { + "example": "Content-Type, Authorization", + "type": "string" + } + }, + "access-control-allow-methods": { + "schema": { + "example": "GET, POST, PUT, DELETE, OPTIONS", + "type": "string" + } + }, + "cache-control": { + "schema": { + "example": "private, no-store", + "type": "string" + } + }, + "content-type": { + "schema": { + "example": "application/json", + "type": "string" + } + }, + "vary": { + "schema": { + "example": "RSC, Next-Router-State-Tree, Next-Router-Prefetch", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/json": { + "example": { + "code": "not_found", + "details": { + "resource_id": "nonexistentid", + "resource_type": "Response" + }, + "message": "Response not found" + }, + "schema": { + "type": "object" + } + } + }, + "description": "Not Found", + "headers": { + "Access-Control-Allow-Credentials": { + "schema": { + "example": "true", + "type": "boolean" + } + }, + "Access-Control-Allow-Origin": { + "schema": { + "example": "*", + "type": "string" + } + }, + "Connection": { + "schema": { + "example": "keep-alive", + "type": "string" + } + }, + "Date": { + "schema": { + "example": "Tue, 23 Apr 2024 08:13:50 GMT", + "type": "string" + } + }, + "Keep-Alive": { + "schema": { + "example": "timeout=5", + "type": "string" + } + }, + "Transfer-Encoding": { + "schema": { + "example": "chunked", + "type": "string" + } + }, + "access-control-allow-headers": { + "schema": { + "example": "Content-Type, Authorization", + "type": "string" + } + }, + "access-control-allow-methods": { + "schema": { + "example": "GET, POST, PUT, DELETE, OPTIONS", + "type": "string" + } + }, + "cache-control": { + "schema": { + "example": "private, no-store", + "type": "string" + } + }, + "content-type": { + "schema": { + "example": "application/json", + "type": "string" + } + }, + "vary": { + "schema": { + "example": "RSC, Next-Router-State-Tree, Next-Router-Prefetch", + "type": "string" + } + } + } + } + }, + "summary": "Update Response", + "tags": ["Client API > Response"] + } + }, "/api/v1/client/{environmentId}/user": { "post": { "description": "Endpoint for creating or identifying a user within the specified environment. If the user already exists, this will identify them and potentially update user attributes. If they don't exist, it will create a new user.\n",