skills.rest
btabaska
btabaskaCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

rule-api-search

Enforce OpenSearch integration consistency for API search components.

1|1|Updated Mar 31, 2026
Search Tags:#api#logging#search#patterns#conventions#builder#opensearch
One-click install
npx skills add https://github.com/btabaska/simpler-grants-documentation-automation --skill rule-api-search
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rule-api-search
Source: https://github.com/btabaska/simpler-grants-documentation-automation/tree/main/.claude/skills/rule-api-search
Command: npx skills add https://github.com/btabaska/simpler-grants-documentation-automation --skill rule-api-search

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Centralizes and enforces OpenSearch usage and coding conventions for API search paths to ensure consistent, secure, and maintainable search functionality.

Core Features & Use Cases

  • Centralized index configuration and prohibiting per-index custom analyzers.
  • Enforced use of the opensearch_query_builder and typed response objects.
  • Guidance for end-to-end search workflows from index creation to query explain and logging.
  • Use Case: When adding a new search endpoint, follow the standardized patterns to ensure reliable and auditable results.

Quick Start

Follow the standardized OpenSearch patterns described to implement a new search endpoint using the query builder and response mapping rules.

Frequently Asked Questions about rule-api-search

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

FAQPage Schema
How do I standardize OpenSearch query construction and response mapping in my API?▼

Standardize OpenSearch API search by enforcing the opensearch_query_builder and typed response objects to centralize configurations, builders, and response transformations for maintainable query construction.

What problem does centralizing OpenSearch index configuration and analyzers solve?▼

Centralizing OpenSearch index configuration solves inconsistency by prohibiting per-index custom analyzers and enforcing DEFAULT_INDEX_ANALYSIS, ensuring secure and maintainable search functionality across your API.

Can I use custom analyzers for individual search endpoints in my OpenSearch integration?▼

No, you cannot use custom analyzers for individual search endpoints. The conventions prohibit per-index custom analyzers to ensure consistent search functionality and centralized index configuration.

What's the best way to implement end-to-end search workflows from index creation to query logging?▼

The best way to implement end-to-end OpenSearch workflows is following standardized patterns for index creation, query construction, explain, and logging to ensure reliable and auditable search results.

Does this approach apply to all search-related code in api/src/search components?▼

Yes, this approach applies across api/src/search components including index configuration, query construction, response transformations, and indexing workflows to enforce OpenSearch integration consistency.

Related Skills

Explore More Software Engineering Skills→
TeamDay-AITeamDay-AI
2

elasticsearch

Query and manage Elasticsearch/OpenSearch clusters via REST API.

Official
Intermediate
notquenotque
415

enterprise-search

Guide relevance tuning and query understanding for Elasticsearch and OpenSearch systems.

Community
Advanced
stacksjsstacksjs
622

stacks-objects

Provide type-safe object utilities for deep merging, mapping, picking, and clearing undefined values in Stacks projects.

Official
Advanced
RepairYourTechRepairYourTech
6

elasticsearch

Design Elasticsearch and OpenSearch index mappings, queries, and indexing patterns.

Community
Advanced