new-entity-requirements

Drafts OpenSpec change proposals for new Terraform entities from API and docs.

208|148|Updated Oct 27, 2021
One-click install
npx skills add https://github.com/elastic/terraform-provider-elasticstack --skill new-entity-requirements
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: new-entity-requirements
Source: https://github.com/elastic/terraform-provider-elasticstack/tree/main/.agents/skills/new-entity-requirements
Command: npx skills add https://github.com/elastic/terraform-provider-elasticstack --skill new-entity-requirements

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Gathers initial requirements for a new Terraform resource or data source by examining API clients (go-elasticsearch, generated kbapi), Elastic API docs (Elastic docs MCP server and/or web), then interviewing the user for gaps. Produces an OpenSpec proposal (change with proposal, design, tasks, and delta specs)—not a hand-written spec under openspec/specs/ alone. Use when designing a new entity, drafting requirements from an API, or before implementing a new resource/data source.

Core Features & Use Cases

  • Gather API surface information from code and docs to define scope.
  • Interview stakeholders to resolve ambiguities and capture decisions.
  • Produce OpenSpec artifacts (proposal.md, design.md, tasks.md, delta specs) under an organized openspec/changes/<name>/.

Quick Start

Draft the initial OpenSpec proposal for a new Terraform entity by compiling API client requirements, Elastic docs, and stakeholder input.

Frequently Asked Questions about new-entity-requirements

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

FAQPage Schema
How do I gather Terraform entity requirements from Elastic API clients?

Terraform entity requirements are gathered by scanning API clients like go-elasticsearch and kbapi, analyzing Elastic API docs, and interviewing stakeholders to fill gaps. This process drafts an OpenSpec proposal defining the minimal change needed for the new entity.

What is the OpenSpec workflow for proposing a new Terraform resource?

The OpenSpec workflow for a new Terraform resource involves creating a change under openspec/changes, generating artifacts like proposal.md, design.md, tasks.md, and delta specs. It iteratively resolves questions via an interview to ensure decisions are captured as formal requirements.

How do I create an OpenSpec change proposal for an Elastic API data source?

An OpenSpec change proposal for an Elastic API data source is created by compiling API surface information from code and docs to define scope. Stakeholder interviews resolve ambiguities, producing organized artifacts under openspec/changes/<name>/.

When do I need a requirements interview for a new Terraform entity?

A requirements interview for a new Terraform entity is needed when initial API client scanning and Elastic docs review leave gaps or ambiguities. The interview resolves open points, maintains traceability to source documents, and ensures decisions have clear acceptance criteria.

Does this requirements gathering process work with go-elasticsearch and kbapi?

Yes, the requirements gathering process works with go-elasticsearch and kbapi by systematically scanning these API clients to identify the minimal OpenSpec change. It exposes unresolved questions as open points and captures decisions as formal requirements.

What are the limitations of using OpenSpec for Terraform entity requirements?

A limitation of using OpenSpec for Terraform entity requirements is that it produces a change proposal with delta specs, not a hand-written spec under openspec/specs/ alone. Unresolved questions remain as open points until the interview process is fully completed.