Swaggerhub

SwaggerHub is an API design, documentation, collaboration, and governance platform for OpenAPI-based APIs.

Type: Tool
Category: Communication
Version: 1.0.0
Provider: InTouch AI
License: MIT

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

communicationsearch

Swaggerhub

SwaggerHub is an API design, documentation, collaboration, and governance platform for OpenAPI-based APIs.

Base URL: https://api.swaggerhub.com
Auth: header:Authorization (pass your key via the apiKey input)

Operations

searchapis — GET /apis — Search APIs
getownerapis — GET /apis/{owner} — Get a list of APIs of the specified owner
getapiversions — GET /apis/{owner}/{api} — Get a list of API versions
getapidefaultversion — GET /apis/{owner}/{api}/settings/default — Get the default version of an API
getdefinition — GET /apis/{owner}/{api}/{version} — Get the OpenAPI definition of the specified API version
getapicommentsv2 — GET /apis/{owner}/{api}/{version}/comments — Get comments for the specified API version

Inputs

apiKey — your swaggerhub API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops

Example

operation: searchapis
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: searchapis, getownerapis, getapiversions, getapidefaultversion, getdefinition, getapicommentsv2
`api`	string	no	—	Path parameter api (required by some operations).
`owner`	string	no	—	Path parameter owner (required by some operations).
`version`	string	no	—	Path parameter version (required by some operations).
`query`	string	no	—	Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request.