Preview API Spec

Previews the contents of an API spec as JSON or YAML string.
Specify Accept: application/json to retrieve the contents as JSON string.
Specify Accept: application/yaml to retrieve the contents as YAML string.
Defaults to JSON string format.

post

Body

application/json

PreviewCatalogServiceApiSpec

* Additional properties are NOT allowed.
providerOne Of
required

Represents the provider, or source, of an API spec

UrlApiSpecProviderobject
Show Child Parameters

Response

Response object containing raw API spec string contents

ApiSpecContentsPreview

ApiSpecContentsPreviewstring

Represents raw API spec contents in JSON format

post/api-specs/preview

Body

{ "provider": { "type": "url", "config": { "url": "https://my-company.com/api-specs/openapi.yaml" } } }
 

CreateCatalogService

object
* Additional properties are NOT allowed.
namestringrequired

The machine name of the Service that uniquely identifies it within the catalog.

Match pattern:^[0-9a-z.-]+$

>= 1 characters<= 120 characters

Example:user-svc

display_namestringrequired

The display name of the Service.

>= 1 characters<= 120 characters

Example:User Service

descriptionstring

Optionally provide a description of the Service.

<= 2048 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

custom_fieldsobject

Map of customizable, catalog-defined fields providing information about a service.

Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}

Example

CatalogServiceSuggestion

object
* Additional properties are NOT allowed.
namestringrequired

The machine name of the Service that uniquely identifies it within the catalog.

Example:user-svc

display_namestringrequired

The display name of the Service.

Example:User Service

descriptionstring

Optionally provide a description of the Service.

labelsobject

Labels to facilitate grouping and tagged search.
Resolved keys must be of length 1-63 characters, and cannot start with ‘‘kong’’, ‘‘konnect’’, ‘‘mesh’’, ‘‘kic’’, or ‘’_‘’.’
Label key and value supports JQ expression syntax on discovered entity’s integration_record property.

Example:{"env":"test"}

metadataobject

Map of customizable, catalog-defined fields providing information about a service.

Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}

Example

CatalogService

object

The service object contains information about a Service Catalog service.

idstring(uuid)requiredread-only

The service ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The machine name of the Service that uniquely identifies it within the catalog.

Match pattern:^[0-9a-z.-]+$

>= 1 characters<= 120 characters

Example:user-svc

display_namestringrequired

The display name of the Service.

>= 1 characters<= 120 characters

Example:User Service

descriptionstringrequired

Optionally provide a description of the Service.

<= 2048 characters

custom_fieldsobjectrequired

Map of customizable, catalog-defined fields providing information about a service.

Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}

labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

CreateCatalogServiceApiSpec

object
* Additional properties are NOT allowed.
namestringrequired

The name of the API

>= 1 characters<= 120 characters

Example:Pet Store

descriptionstringrequired

The description of the API

<= 2048 characters

Example:A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification

providerOne Of
required

Represents the provider, or source, of an API spec

UrlApiSpecProviderobject
Show Child Parameters
Example