List Definitions
GET/registry-svc/definitions
Retrieves a list of all definitions or filters them by specific criteria.
Responses
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
definitions
object[]
apiSpecs
object[]
API Specs such as OpenAPI definitions etc.
metadata
object
Additional metadata about the API (e.g., author, license, etc.)
Protocol type (e.g., OpenAPI, Swagger, etc.)
URL to the OpenAPI file or other API definition
Version of the API specification (e.g., 3.0.0)
clients
object[]
Programming language clients such as on npm or GitHub.
Possible values: [JavaScript
, Python
, Java
, C#
, C++
, Ruby
, Go
, Swift
, PHP
, TypeScript
, Kotlin
, Scala
, Perl
, Rust
, Haskell
, Clojure
, Elixir
, Objective-C
, F#
]
The URL of the client.
HostPort is a clutch until automatic port assignment works. It will go a way as it doesn't make any sense in a Definition.
image
object
Name is the container image name/URL to use for the container
Port is the port number that the container will listen on internally
repository
object
Context is the path to the image build context
ContainerFile is the path to the file that contains the container build instructions Relative from the build context. By default, it is assumed to be a Dockerfile.
URL is the URL to the repository
Version of the code to use
{
"definitions": [
{
"apiSpecs": [
{
"metadata": {},
"protocolType": "string",
"url": "string",
"version": "string"
}
],
"clients": [
{
"language": "JavaScript",
"url": "https://example.com/client.js"
}
],
"hostPort": 0,
"id": "string",
"image": {
"name": "nginx:latest",
"port": 8080
},
"repository": {
"buildContext": "path/to/subfolder",
"containerFile": "docker/Dockerfile",
"url": "https://github.com/singulatron/superplatform.git",
"version": "v1.0.0"
}
}
]
}
Invalid filters
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string"
}