Skip to content

get-endpoints

Tool name: get-endpoints

Get all endpoints for a specific API.

Input schema

namestring, non-empty

API name, or a unique part of it. Omit when filePath is given.

versionstring

API version. When omitted and several versions exist, the highest one is used.

filePathstring

Path to the API description file.

Input example
{
  "name": "string",
  "version": "string",
  "filePath": "string"
}

Output schema

apistringrequired

API title.

versionstringrequired

API version.

filePathstringrequired

API description file path for this result.

otherMatchesArray of objects(ApiDescriptionRef)

Other description files the lookup matched. Present only when several share the requested name.

serversArray of objects(OpenApiServer)required

Servers defined by the published OpenAPI description.

endpointsArray of objects(ApiEndpointSummary)required
Output example
{}