Submit a defect report - Gable Docs

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

POST

/ v0 /defect-report

Try it

Submit a defect report

cURL

curl --request POST \
  --url https://demo-api.gable.ai/v0/defect-report \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "description": "<string>",
  "expectedBehavior": "<string>",
  "reporterName": "<string>",
  "reporterEmail": "<string>",
  "organization": "<string>",
  "pageUrl": "<string>",
  "componentId": "<string>",
  "componentName": "<string>",
  "pathId": "<string>",
  "ingressPayloadName": "<string>",
  "egressPayloadName": "<string>"
}
'

Python

import requests

url = "https://demo-api.gable.ai/v0/defect-report"

payload = {
    "description": "<string>",
    "expectedBehavior": "<string>",
    "reporterName": "<string>",
    "reporterEmail": "<string>",
    "organization": "<string>",
    "pageUrl": "<string>",
    "componentId": "<string>",
    "componentName": "<string>",
    "pathId": "<string>",
    "ingressPayloadName": "<string>",
    "egressPayloadName": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    expectedBehavior: '<string>',
    reporterName: '<string>',
    reporterEmail: '<string>',
    organization: '<string>',
    pageUrl: '<string>',
    componentId: '<string>',
    componentName: '<string>',
    pathId: '<string>',
    ingressPayloadName: '<string>',
    egressPayloadName: '<string>'
  })
};

fetch('https://demo-api.gable.ai/v0/defect-report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://demo-api.gable.ai/v0/defect-report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([  
    'description' => '<string>',
    'expectedBehavior' => '<string>',
    'reporterName' => '<string>',
    'reporterEmail' => '<string>',
    'organization' => '<string>',
    'pageUrl' => '<string>',
    'componentId' => '<string>',
    'componentName' => '<string>',
    'pathId' => '<string>',
    'ingressPayloadName' => '<string>',
    'egressPayloadName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://demo-api.gable.ai/v0/defect-report"

payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"expectedBehavior\": \"<string>\",\n  \"reporterName\": \"<string>\",\n  \"reporterEmail\": \"<string>\",\n  \"organization\": \"<string>\",\n  \"pageUrl\": \"<string>\",\n  \"componentId\": \"<string>\",\n  \"componentName\": \"<string>\",\n  \"pathId\": \"<string>\",\n  \"ingressPayloadName\": \"<string>\",\n  \"egressPayloadName\": \"<string>\"}\n")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Unirest

HttpResponse<String> response = Unirest.post("https://demo-api.gable.ai/v0/defect-report")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"expectedBehavior\": \"<string>\",\n  \"reporterName\": \"<string>\",\n  \"reporterEmail\": \"<string>\",\n  \"organization\": \"<string>\",\n  \"pageUrl\": \"<string>\",\n  \"componentId\": \"<string>\",\n  \"componentName\": \"<string>\",\n  \"pathId\": \"<string>\",\n  \"ingressPayloadName\": \"<string>\",\n  \"egressPayloadName\": \"<string>\"}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://demo-api.gable.ai/v0/defect-report")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"expectedBehavior\": \"<string>\",\n  \"reporterName\": \"<string>\",\n  \"reporterEmail\": \"<string>\",\n  \"organization\": \"<string>\",\n  \"pageUrl\": \"<string>\",\n  \"componentId\": \"<string>\",\n  \"componentName\": \"<string>\",\n  \"pathId\": \"<string>\",\n  \"ingressPayloadName\": \"<string>\",\n  \"egressPayloadName\": \"<string>\"}\n"

response = http.request(request)
puts response.read_body

Response Codes

200

400

401

500

502

Response Body

{}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Body

application/json