skills.rest
webiny
webinyOFFICIAL
Explore all skills by this author →
Website𝕏@WebinyCMSGitHub

webiny-api-cms-catalog

Catalogs 137 Headless CMS abstractions including entry, model, and group use cases and event handlers.

8.0k|673|Updated Jan 9, 2018
Search Tags:#api#headless cms#event handlers#Use Cases#typeScript#webiny#content entries
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-cms-catalog
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: webiny-api-cms-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/cms
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-cms-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers extending Webiny's Headless CMS on the API side struggle to discover which of the 137 available abstractions (use cases, event handlers, types) fits their task and where to import it from. This Skill provides a searchable catalog mapping each abstraction to its import path and source file.

Core Features & Use Cases

  • Abstraction Discovery: Browse 137 cataloged abstractions covering content entries, models, and groups, each with its exact import statement and source file location.
  • Lifecycle Event Handlers: Find before/after event handlers for entry create, update, delete, publish, unpublish, move, and revision operations, plus model and group lifecycle hooks.
  • Use Case References: Locate use cases such as CreateEntryUseCase, ListEntriesUseCase, GetPublishedRevisionByEntryIdUseCase, and DeleteModelUseCase for programmatic CMS operations.
  • Use Case: When you need to run custom logic after a content entry is published, look up EntryAfterPublishEventHandler, read its source file for the exact interface, and implement it following the referenced event handler pattern.

Quick Start

Ask the AI to find the Webiny CMS abstraction for hooking into entry lifecycle events and show its import path and source file.

Frequently Asked Questions about webiny-api-cms-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I hook into Webiny CMS entry lifecycle events?▼

Use the entry event handler abstractions such as EntryAfterCreateEventHandler or EntryBeforePublishEventHandler from webiny/api/cms/entry. Each handler corresponds to a specific lifecycle point, and you implement it following the webiny-event-handler-pattern skill.

How do I create a content entry programmatically in Webiny?▼

Use CreateEntryUseCase imported from webiny/api/cms/entry, defined in @webiny/api-headless-cms features. Related use cases cover updating, deleting, publishing, and listing entries with filtering and pagination.

What abstractions exist for Webiny CMS content models and groups?▼

The catalog lists model use cases like CreateModelUseCase, CreateModelFromUseCase, and DeleteModelUseCase, plus group use cases like CreateGroupUseCase and ListGroupsUseCase. Lifecycle event handlers exist for both models and groups.

Does Webiny CMS support OpenSearch customization?▼

Yes, the catalog includes OpenSearch abstractions such as CmsEntryOpenSearchQueryModifier, CmsEntryOpenSearchFilter, and CmsEntryOpenSearchFullTextSearch from the @webiny/api-headless-cms-ddb-es package for customizing search behavior.

Why must I read the source file before using an abstraction?▼

The catalog only provides names, import paths, and source locations, not full type signatures. Reading the referenced TypeScript source file gives you the exact interface, generics, and method signatures needed for a correct implementation.

Related Skills

Explore More Software Engineering Skills→
webinywebiny
8.0k

backend-developer

Implement backend API features using Webiny architecture and GraphQL schemas.

Official
Advanced
webinywebiny
8.0k

admin-developer

Guide developers in building Webiny admin features with headless and presentation layers.

Official
Advanced
23blocks-OS23blocks-OS
744

AI Maestro Documentation Search

Search project documentation for function signatures and API details before coding.

Official
Advanced
EllevatedAIEllevatedAI

qa

Simulate real user interactions to manually test web, API, and bot interfaces.

Official
Advanced