search_endpoints
Locate specific API endpoints by searching paths, descriptions, or tags within OpenAPI schemas. Filter by HTTP methods, authentication, deprecation status, or include/exclude tags for precise results.
Instructions
Search endpoints by query in path, description, or tags
Input Schema
Name | Required | Description | Default |
---|---|---|---|
api | Yes | API name or direct URL | |
deprecated | No | Filter by deprecation status | |
has_authentication | No | Filter by authentication requirement | |
methods | No | Filter by HTTP methods (e.g., ['GET', 'POST']) | |
page | No | Page number (1-based) | |
page_size | No | Items per page (max 100) | |
query | Yes | Search query | |
tags_exclude | No | Exclude endpoints with these tags | |
tags_include | No | Include endpoints with these tags |
Input Schema (JSON Schema)
{
"properties": {
"api": {
"description": "API name or direct URL",
"type": "string"
},
"deprecated": {
"description": "Filter by deprecation status",
"type": "boolean"
},
"has_authentication": {
"description": "Filter by authentication requirement",
"type": "boolean"
},
"methods": {
"description": "Filter by HTTP methods (e.g., ['GET', 'POST'])",
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"default": 1,
"description": "Page number (1-based)",
"minimum": 1,
"type": "integer"
},
"page_size": {
"default": 50,
"description": "Items per page (max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"query": {
"description": "Search query",
"type": "string"
},
"tags_exclude": {
"description": "Exclude endpoints with these tags",
"items": {
"type": "string"
},
"type": "array"
},
"tags_include": {
"description": "Include endpoints with these tags",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"api",
"query"
],
"type": "object"
}