skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
tryghost/ghost0 installs

Add Admin API Endpoint

Add a new endpoint or endpoints to Ghost's Admin API at `ghost/api/admin/**`.

How do I install this agent skill?

npx skills add https://github.com/tryghost/ghost --skill add-admin-api-endpoint
view source ↗

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    This skill provides educational documentation and instructions for developers to add Admin API endpoints to the Ghost CMS. It focuses on implementing security best practices such as mandatory permission handling and input validation using Ghost's internal frameworks. No malicious patterns or security risks were detected.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

  • Runlayerwarn

    4/4 files flagged

What does this agent skill do?

Create Admin API Endpoint

Instructions

  1. If creating an endpoint for an entirely new resource, create a new endpoint file in ghost/core/server/api/endpoints/. Otherwise, locate the existing endpoint file in the same directory.
  2. The endpoint file should create a controller object using the JSDoc type from (@tryghost/api-framework).Controller, including at minimum a docName and a single endpoint definition, i.e. browse.
  3. Add routes for each endpoint to ghost/core/server/web/api/endpoints/admin/routes.js.
  4. Add basic e2e-api tests for the endpoint in ghost/test/e2e-api/admin to ensure the new endpoints function as expected.
  5. Run the tests and iterate until they pass: cd ghost && pnpm test:single test/e2e-api/admin/{test-file-name}.

Reference

For a detailed reference on Ghost's API framework and how to create API controllers, see reference.md.

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/tryghost/ghost/add-admin-api-endpoint">View Add Admin API Endpoint on skillZs</a>