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

webiny-api-opensearch-catalog

Catalogs ten OpenSearch abstractions with import paths and source files for Webiny API development.

8.0k|673|Updated Jan 9, 2018
Search Tags:#api#Search#typeScript#abstractions#webiny#import paths#OpenSearch
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-opensearch-catalog
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: webiny-api-opensearch-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/opensearch
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-opensearch-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers working with Webiny's OpenSearch integration often struggle to locate the correct abstraction, its exact import path, and its source file. This Skill provides a single lookup catalog of all ten OpenSearch abstractions so you can find and import the right interface without searching the codebase.

Core Features & Use Cases

  • Abstraction Lookup: Lists ten OpenSearch abstractions including OpenSearchClient, OpenSearchIndex, OpenSearchField, and query builder operators with exact import statements.
  • Source File Mapping: Maps each abstraction to its source file in @webiny/api-opensearch so you can read the exact interface and types before use.
  • Use Case: When implementing a custom search feature in a Webiny project, use this catalog to find the OpenSearchQueryBuilderOperator abstraction, copy its import statement, and read its source to implement a custom query operator.

Quick Start

Ask the AI to show the import path and source file for the OpenSearchClient abstraction from the Webiny OpenSearch catalog.

Frequently Asked Questions about webiny-api-opensearch-catalog

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

FAQPage Schema
How do I create an OpenSearch client in Webiny?▼

Import createOpenSearchClient from webiny/api/opensearch, which is defined in @webiny/api-opensearch/client.ts. Read the source file first to confirm the exact parameters and return types before calling it.

What OpenSearch abstractions are available in the Webiny API?▼

Ten abstractions are available, including OpenSearchClient, OpenSearchClientFactory, OpenSearchField, OpenSearchIndex, OpenSearchIndexRegistry, and OpenSearchQueryBuilderOperator with its registry. Each has a documented import path and source file.

How do I register a custom OpenSearch query operator in Webiny?▼

Use the OpenSearchQueryBuilderOperator abstraction to define your operator and OpenSearchQueryBuilderOperatorRegistry to register it. Both are imported from webiny/api/opensearch and defined under the OpenSearchQueryBuilderOperator feature folder.

Where are Webiny OpenSearch interfaces defined?▼

Interfaces are defined in the @webiny/api-opensearch package under feature-specific folders such as features/OpenSearchClient and features/OpenSearchIndex. Each abstraction file contains the exact TypeScript types you should read before implementing.

Does this catalog include implementation patterns for OpenSearch features?▼

No, it only lists abstractions with imports and source locations. For implementation patterns, it directs you to the webiny-use-case-pattern or webiny-event-handler-pattern skills.

Related Skills

Explore More Software Engineering Skills→
webinywebiny
8.0k

backend-developer

Implement backend API features using Webiny architecture and GraphQL schemas.

Official
Advanced
moasadimoasadi
5

ddd-usecase-generator

Generate TypeScript use cases and event listeners with tsyringe dependency injection.

Community
Advanced
dev-jellydev-jelly

jelly-elasticsearch-skill

Perform Elasticsearch/OpenSearch query DSL searches, aggregations, and index management.

Community
Advanced
Ouro-labsOuro-labs
14

writing-skills

Create and verify skills using test-driven development documentation.

Official
Intermediate