If passed, any subsequent operation with the same value for this header will return the exact same result.\nThis is true for all responses, i.e. successes and errors.
" }, { "kind": "optional", "name": "cloudzero-test-key", "type": "string", "description": "If passed, the operation executes in the namespace specified by this key.\nResource mutations in the namespace last for 1 hour.
" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "comment_new", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/comment_new", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "APIKeyAuth", "name": "Authorization", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful Operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "comment", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/comment", "customType": "comment", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "comment_new", "description": "", "modelRef": "#/components/schemas/comment_new", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ] }, { "name": "with_id", "description": "", "modelRef": "#/components/schemas/with_id", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "" } ] }, { "name": "with_created", "description": "", "modelRef": "#/components/schemas/with_created", "schema": [ { "name": "created", "kind": "required", "type": "string", "description": "UTC timestamp for the creation of this entity", "modelRef": "#/components/schemas/epoch", "customType": "epoch", "schema": [] } ] }, { "name": "with_last_updated", "description": "", "modelRef": "#/components/schemas/with_last_updated", "schema": [ { "name": "last_updated", "kind": "required", "type": "string", "description": "UTC timestamp for the last update of this entity", "modelRef": "#/components/schemas/epoch", "customType": "epoch", "schema": [] } ] }, { "name": "object", "description": "", "schema": [ { "name": "author", "kind": "required", "type": "string", "description": "" }, { "name": "insight", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/with_id", "customType": "with_id", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request Error", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "error", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/error", "customType": "error", "schema": [ { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://dev-api.cloudzero.com/v2/insights/{insight_id}/comments/{comment_id} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"message\": \"\"\n }'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"message\": \"\"\n});\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://dev-api.cloudzero.com/v2/insights/{insight_id}/comments/{comment_id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://dev-api.cloudzero.com/v2/insights/{insight_id}/comments/{comment_id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"message\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://dev-api.cloudzero.com/v2/insights/{insight_id}/comments/{comment_id}\"\n\npayload = json.dumps({\n \"message\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful Operation\n{\n \"comment\": {}\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad Request Error\n{\n \"error\": {\n \"message\": \"\",\n \"type\": \"\"\n }\n}" }, { "id": "response-2-403", "language": "403", "code": "// Forbidden\n{\n \"message\": \"\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }