add-namespace

Generate an ApiDOM namespace package with scaffolding, tests, and build configs.

100|25|Updated Mar 24, 2020
One-click install
npx skills add https://github.com/swagger-api/apidom --skill add-namespace
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-namespace
Source: https://github.com/swagger-api/apidom/tree/main/.claude/skills/add-namespace
Command: npx skills add https://github.com/swagger-api/apidom --skill add-namespace

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates creating a complete ApiDOM namespace package for a new API specification version, ensuring consistency with existing namespaces and reducing manual setup time.

Core Features & Use Cases

  • Scaffold a full namespace package (apidom-ns-{spec}-{version}) with source, tests, and build configs.
  • Integrate with parent namespaces when extending an existing spec, reusing visitors and element patterns.
  • Generate and wire up core files and tests following ApiDOM conventions for a production-ready package.

Quick Start

Create a new namespace package for your spec and version, then run the repository build and test workflow to validate integration.

Frequently Asked Questions about add-namespace

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

FAQPage Schema
How do I scaffold an ApiDOM namespace package for a new OpenAPI specification version?

To scaffold an ApiDOM namespace package for a new OpenAPI specification version, this Skill automates the creation of source, tests, and build configurations. It generates the necessary files and references following ApiDOM conventions to ensure production-ready integration.

Can I extend an existing ApiDOM namespace when adding a new specification version?

Yes, you can extend an existing ApiDOM namespace when adding a new specification version. The Skill integrates with parent namespaces, reusing visitors and element patterns while validating field compatibility with the parent version to ensure seamless extension.

What is the best way to automate ApiDOM namespace creation across a monorepo?

The best way to automate ApiDOM namespace creation across a monorepo is using this Skill to consolidate scaffolding, element definitions, visitor definitions, and build configurations. It enforces repository conventions and generates all necessary files for a consistent namespace package.

Does generating a namespace package automatically wire up ApiDOM tests and build configs?

Yes, generating a namespace package automatically wires up ApiDOM tests and build configurations. The Skill generates core files and tests following ApiDOM conventions, ensuring the new namespace package is fully integrated and ready for repository build and test workflows.

Why do I need to validate field compatibility when extending a parent ApiDOM namespace?

You need to validate field compatibility when extending a parent ApiDOM namespace to ensure the new specification version integrates correctly. The Skill enforces repository conventions and validates these fields, preventing structural inconsistencies between the new and parent namespaces.