Register a Definition

PUT 
/registry-svc/definition

Registers a new definition, associating an definition address with a slug acquired from the bearer token.

Request

application/json

Body

required

Register Service Definition Request

definition

object

apiSpecs

object[]

API Specs such as OpenAPI definitions etc.

Array [

metadata

object

Additional metadata about the API (e.g., author, license, etc.)

property name* string

protocolType string

Protocol type (e.g., OpenAPI, Swagger, etc.)

url string

URL to the OpenAPI file or other API definition

version string

Version of the API specification (e.g., 3.0.0)

]

clients

object[]

Programming language clients such as on npm or GitHub.

Array [

language stringrequired

Possible values: [JavaScript, Python, Java, C#, C++, Ruby, Go, Swift, PHP, TypeScript, Kotlin, Scala, Perl, Rust, Haskell, Clojure, Elixir, Objective-C, F#]

url stringrequired

The URL of the client.

]

hostPort integer

HostPort is a clutch until automatic port assignment works. It will go a way as it doesn't make any sense in a Definition.

id stringrequired

image

object

required

name stringrequired

Name is the container image name/URL to use for the container

port integerrequired

Port is the port number that the container will listen on internally

Responses

201

Created

application/json

Schema

Schema

object

Example (from schema)

{}

400

Invalid JSON

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Loading...