Goal
Retrieve live Swagger/OpenAPI JSON from NocoBase for endpoint discovery and request construction.
Workflow
-
Ensure API authentication is ready by following nocobase-api-call skill rules.
-
Confirm namespace explicitly (no default in this skill).
-
Ask the agent to use nocobase-api-call to fetch /swagger:get for the confirmed namespace.
-
Do not directly call another skill's script path from this skill.
-
Return raw JSON or pipe to jq for path/operation extraction.
-
If response indicates 404 Not Found , prompt user to check and enable API Docs plugin, then retry.
Dependency Gate
-
Required dependency skill: nocobase-api-call .
-
If nocobase-api-call is not available, do not continue with fallback script-path calls.
-
Prompt user to install required skills first (for example: npx skills add nocobase/skills ), then resume.
404 Handling Note
-
404 Not Found from /swagger:get usually means API Docs plugin is not enabled.
-
Prompt user to enable API Docs in admin plugins before continuing.
Resources
-
scripts/get-swagger.sh
-
Fetch Swagger JSON by calling nocobase-api-call
-
../nocobase-api-call/
-
Shared base skill for authentication and HTTP requests
Usage
Fetch Swagger in collection manager namespace
Fetch Swagger for namespace plugins%2Fdata-source-main.
Inspect paths from returned JSON
Inspect the returned JSON paths with jq expression .paths | keys.