Post organisations schemas publish - Versori User Documentation

POST

/

organisations

/

{organisationId}

/

schemas

/

{id}

/

publish

cURL

curl --request POST \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish \
  --header 'Authorization: <api-key>'

import requests

url = "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "<string>",
  "type": "<string>",
  "version": "<string>",
  "sourceUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "extensions": {}
}

Authorizations

Authorization

string

header

required

Path Parameters

organisationId

string

required

OrganisationID is the ID of the organisation that the schema belongs to.

id

string

required

ID is the schema identifier

Response

PublishSchemaResponse is the response containing the Schema of a published schema.

id

string

required

type

string

required

Type denotes the type of schema the corresponding App is backed by. Currently the only supported value is "openapi", but other types such as "soap", "graphql" and "grpc" are on the roadmap.

version

string

required

Version denotes the version of the schema specification. This property is contextual based on the schema type, for example openapi schemas will contain the OpenAPI specification version (currently only 3.0.x is supported), but grpc APIs could be "proto2" or "proto3".

sourceUrl

string

required

URL is the private address for accessing the schema. This is not guaranteed to be publicly accessible and could be a non-HTTP protocol (i.e. gs:// or s3://)

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

deletedAt

string<date-time>

⌘I

cURL

curl --request POST \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish \
  --header 'Authorization: <api-key>'

import requests

url = "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/publish")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "<string>",
  "type": "<string>",
  "version": "<string>",
  "sourceUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "extensions": {}
}