POST
/
organisations
/
{organisationId}
/
schemas
/
{id}
/
publish

Authorizations

Authorization
string
headerrequired

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

200 - application/json
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
required
updatedAt
string
required
deletedAt
string