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.
Body
application/json
Body
PreviewCatalogServiceApiSpec
One OfRepresents the provider, or source, of an API spec
Show Child Parameters
Response
Response
Response object containing raw API spec string contents
ApiSpecContentsPreview
Represents raw API spec contents in JSON format
Authentication
Body
CreateCatalogService
objectThe machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
Optionally provide a description of the Service.
<= 2048 characters
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"}
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"}}
CatalogServiceSuggestion
objectThe machine name of the Service that uniquely identifies it within the catalog.
Example:user-svc
The display name of the Service.
Example:User Service
Optionally provide a description of the Service.
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"}
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"}}
CatalogService
objectThe service object contains information about a Service Catalog service.
The service ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
Optionally provide a description of the Service.
<= 2048 characters
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"}}
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
CreateCatalogServiceApiSpec
objectThe name of the API
>= 1 characters<= 120 characters
Example:Pet Store
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
One OfRepresents the provider, or source, of an API spec