skills.rest
tsunami28
tsunami28COMMUNITY
Explore all skills by this author →
Website𝕏@MilosKatinskiGitHub

elaboration-upsert-api-contract

Create OpenAPI 3.x YAML contracts from feature requirements and implementation slices.

Updated Jun 18, 2026
Search Tags:#openapi#rest#software architecture#yaml#endpoint design#api contract
One-click install
npx skills add https://github.com/tsunami28/MindNova --skill elaboration-upsert-api-contract
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: elaboration-upsert-api-contract
Source: https://github.com/tsunami28/MindNova/tree/main/.claude/skills/elaboration-upsert-api-contract
Command: npx skills add https://github.com/tsunami28/MindNova --skill elaboration-upsert-api-contract

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of creating inconsistent API designs by transforming agreed software slices into a machine-readable OpenAPI contract that teams and automation can rely on.

Core Features & Use Cases

  • OpenAPI Contract Creation: Produces OpenAPI 3.x YAML specifications that define REST paths, schemas, authentication, and responses.
  • API Design Governance: Applies repository conventions such as naming rules, error models, status code guidance, and single-domain boundaries.
  • Use Case: When a team starts building a new HTTP endpoint, use this Skill to create the API contract that developers and quality engineers can consume before implementation begins.

Quick Start

Use the elaboration-upsert-api-contract skill to create an OpenAPI specification for the new REST endpoint based on the approved feature slice.

Frequently Asked Questions about elaboration-upsert-api-contract

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

FAQPage Schema
How do I generate an OpenAPI 3.x YAML specification from feature requirements?▼

Creating an OpenAPI 3.x YAML specification requires transforming agreed software feature slices into machine-readable API contracts. This process defines REST paths, schemas, authentication rules, and error response modeling before code generation begins.

What is API contract design and when do I need an OpenAPI specification?▼

API contract design defines REST endpoint boundaries, schemas, and error models in an OpenAPI YAML format. You need this specification before implementation begins so teams and automation can consume consistent API definitions.

How do I enforce repository conventions and error response modeling in REST endpoint design?▼

Enforce repository conventions by applying naming rules, status code guidance, and single-domain boundaries during OpenAPI specification authoring. This yields a governed API contract with consistent schema definitions and error response modeling.

Can I define authentication rules and schema definitions before code generation starts?▼

Yes, you can define authentication rules and schema definitions before code generation begins. The skill outputs an OpenAPI 3.x YAML contract containing these exact boundaries, allowing developers to consume the specification prior to implementation.

Does this approach to API design governance work for single-domain boundaries?▼

Yes, this API design governance approach explicitly supports single-domain boundaries. It applies repository conventions such as naming rules and error models to produce a focused OpenAPI 3.x YAML specification for your specific REST endpoint slice.

Related Skills

Explore More Software Engineering Skills→
chiruu12chiruu12
1

spec-driven-development

Create and review software specifications before implementation begins.

Community
Intermediate
mk-knight23mk-knight23
1

api-tester

Generate and execute pytest suites from OpenAPI specs for REST APIs.

Community
Advanced
hulusi-tunchulusi-tunc
3

naming-convention

Establish naming conventions for design elements, components, and tokens.

Community
Intermediate
theodrosyimertheodrosyimer

api-docs

Generate a browsable API documentation website from an OpenAPI specification.

Community
Advanced