Upload an External OpenAPI Schema - Lerian

Upload an External OpenAPI Schema

curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/openapi-schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form name=kyc-provider \
  --form version=v1.0.0

package main

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

func main() {

	url := "https://flowker.sandbox.lerian.net/v1/openapi-schemas"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nkyc-provider\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\nv1.0.0\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "multipart/form-data")

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

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

	fmt.Println(string(body))

}

const form = new FormData();
form.append('file', '<string>');
form.append('name', 'kyc-provider');
form.append('version', 'v1.0.0');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://flowker.sandbox.lerian.net/v1/openapi-schemas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://flowker.sandbox.lerian.net/v1/openapi-schemas"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "name": "kyc-provider",
    "version": "v1.0.0"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

{
  "byteSize": 4096,
  "contentHash": "sha256:9f2c8b1a4d7e0f3c6b5a8d2e1f4c7b0a3d6e9f2c5b8a1d4e7f0c3b6a9d2e5f8c",
  "createdAt": "2026-01-15T10:30:00Z",
  "createdBy": "user@example.com",
  "id": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
  "name": "jd-spi",
  "openapiVersion": "3.0.3",
  "operationCount": 42,
  "title": "JD SPI API",
  "version": "1"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

POST

/

v1

/

openapi-schemas

Upload an External OpenAPI Schema

curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/openapi-schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form name=kyc-provider \
  --form version=v1.0.0

package main

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

func main() {

	url := "https://flowker.sandbox.lerian.net/v1/openapi-schemas"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nkyc-provider\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\nv1.0.0\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "multipart/form-data")

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

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

	fmt.Println(string(body))

}

const form = new FormData();
form.append('file', '<string>');
form.append('name', 'kyc-provider');
form.append('version', 'v1.0.0');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://flowker.sandbox.lerian.net/v1/openapi-schemas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://flowker.sandbox.lerian.net/v1/openapi-schemas"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "name": "kyc-provider",
    "version": "v1.0.0"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

{
  "byteSize": 4096,
  "contentHash": "sha256:9f2c8b1a4d7e0f3c6b5a8d2e1f4c7b0a3d6e9f2c5b8a1d4e7f0c3b6a9d2e5f8c",
  "createdAt": "2026-01-15T10:30:00Z",
  "createdBy": "user@example.com",
  "id": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
  "name": "jd-spi",
  "openapiVersion": "3.0.3",
  "operationCount": 42,
  "title": "JD SPI API",
  "version": "1"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider. Send it in the Authorization header as Bearer <token>.

Body

multipart/form-data

file

file

required

OpenAPI 3.x schema file (JSON).

name

string

required

Schema name.

Example:

"kyc-provider"

version

string

required

Schema version.

Example:

"v1.0.0"

Response

Indicates that the resource was successfully created and the operation was completed as expected.

byteSize

integer<int64>

required

Example:

4096

contentHash

string

required

Example:

"sha256:9f2c8b1a4d7e0f3c6b5a8d2e1f4c7b0a3d6e9f2c5b8a1d4e7f0c3b6a9d2e5f8c"

createdAt

string<date-time>

required

Example:

"2026-01-15T10:30:00Z"

createdBy

string

required

Example:

"user@example.com"

id

string<uuid>

required

Example:

"018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8"

name

string

required

Example:

"jd-spi"

openapiVersion

string

required

Example:

"3.0.3"

operationCount

integer<int64>

required

Example:

42

title

string

required

Example:

"JD SPI API"

version

string

required

Example:

"1"