API Descriptions

POSThttps://api.laminar.run/api-descriptions

Body

application/json

url*string

methodType*enum

GETPOSTPUTDELETE

authCredentialId*integer (int64)

workspaceId*integer (int64)

name*string

description*string

Response

200

OK

Body

*/*

idinteger (int64)

urlstring

methodTypeenum

GETPOSTPUTDELETE

authCredentialsAuthCredentials (object)

namestring

descriptionstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.laminar.run/api-descriptions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "authCredentialId": 0,
      "description": "text",
      "methodType": "GET",
      "name": "text",
      "url": "text",
      "workspaceId": 0
    }),
});
const data = await response.json();

Response

200

{
  "id": 0,
  "url": "text",
  "methodType": "GET",
  "authCredentials": {
    "id": 0,
    "name": "text",
    "authType": "text"
  },
  "name": "text",
  "description": "text"
}

PUThttps://api.laminar.run/api-descriptions

Body

application/json

apiDescriptionId*integer (int64)

urlstring

methodTypeenum

GETPOSTPUTDELETE

authCredentialIdinteger (int64)

namestring

descriptionstring

Response

200

OK

Body

*/*

idinteger (int64)

urlstring

methodTypeenum

GETPOSTPUTDELETE

authCredentialsAuthCredentials (object)

namestring

descriptionstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.laminar.run/api-descriptions', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "apiDescriptionId": 0
    }),
});
const data = await response.json();

Response

200

{
  "id": 0,
  "url": "text",
  "methodType": "GET",
  "authCredentials": {
    "id": 0,
    "name": "text",
    "authType": "text"
  },
  "name": "text",
  "description": "text"
}

GEThttps://api.laminar.run/api-descriptions/{id}

Path parameters

id*integer (int64)

Response

200

OK

Body

*/*

idinteger (int64)

urlstring

methodTypeenum

GETPOSTPUTDELETE

authCredentialsAuthCredentials (object)

namestring

descriptionstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.laminar.run/api-descriptions/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 0,
  "url": "text",
  "methodType": "GET",
  "authCredentials": {
    "id": 0,
    "name": "text",
    "authType": "text"
  },
  "name": "text",
  "description": "text"
}

DELETEhttps://api.laminar.run/api-descriptions/{id}

Path parameters

id*integer (int64)

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.laminar.run/api-descriptions/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();