get-endpoint-info

Tool name: get-endpoint-info

Get comprehensive information about specific endpoint including parameters, security, and examples

Input schema

namestring, non-empty

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

pathstring, non-emptyrequired

Endpoint path (for example, /users)

methodstring, non-emptyrequired

HTTP method

Enum:"GET""POST""PUT""DELETE""PATCH""OPTIONS""HEAD""TRACE""get""post"

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",
  "path": "string",
  "method": "GET",
  "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.

endpointobjectrequired

Endpoint details derived from the resolved OpenAPI operation. Besides path and method, the object may include parameters, request body, responses, security, examples, and other operation-level fields from the source OpenAPI description.

globalSecurityArray of objectsrequired

Global security requirements defined on the OpenAPI document.

securitySchemesobjectrequired

Security schemes map from the OpenAPI components section.

componentsobject

Components that the endpoint references, keyed as the source OpenAPI description keys them. A $ref in endpoint resolves against the root of the result.

Output example

{}