SkillsAdd

jabrena/plinth

701-technologies-openapi

Use when you need framework-agnostic OpenAPI 3.x guidance — spec structure, metadata and versioning, paths and operations, reusable schemas, security schemes, examples, documentation quality, contract validation (e.g.

First seen Apr 7, 2026

Installation

$ npx skills add jabrena/plinth --skill 701-technologies-openapi
View on skills.sh ↗ GitHub repository ↗

Summary

  • Use when you need framework-agnostic OpenAPI 3.x guidance — spec structure, metadata and versioning, paths and operations, reusable schemas, security schemes, examples, documentation quality, contract validation (e.g.
  • Spectral), breaking-change awareness, and handoffs to codegen — without choosing Spring Boot, Quarkus, or Micronaut.
  • This should trigger for requests such as Review an OpenAPI; Improve an OpenAPI; Improve API contract; Improve API schema design.
  • Part of Plinth Toolkit

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

azure-rbac Shared topics
microsoft/azure-skills 489K installs
hig-technologies Similar name
raintree-technology/hig-doctor

>- Apple HIG guidance for Apple technology integrations: Siri, Apple Pay, HealthKit, HomeKit, A…

457 installs

Also in this package

Other skills from jabrena/plinth · top by installs.

npx skills add jabrena/plinth
110-java-maven-best-practices 6 121-java-object-oriented-design 378 124-java-secure-coding 369 131-java-testing-unit-testing 357 141-java-refactoring-with-modern-features 337 122-java-type-design 318 302-frameworks-spring-boot-rest 317 125-java-concurrency 316 111-java-maven-dependencies 315 321-frameworks-spring-boot-testing-unit-tests 6

Browse all from jabrena/plinth

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 437
License LICENSE
Default branch main
Open issues 22
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Version0.18.0
LicenseApache-2.0
More metadata
author
Juan Antonio Breña Moral
version
0.18.0

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 3,484 B
  • docs SUMMARY.md 519 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 243 installs

SKILL.md

OpenAPI 3.x best practices

Help teams produce maintainable OpenAPI 3.x contracts that stay aligned with HTTP semantics and consumer needs.

What is covered in this Skill?

  • Document structure: openapi, info, servers, tags, and consistent resource grouping
  • Path and operation design: parameters, request bodies, response matrices, operationId, status codes
  • Reusable components (schemas, parameters, responses, security schemes) and examples
  • Validation and CI: spec linting, breaking-change checks, pre-codegen gates
  • Security modeling in the contract (schemes, scopes, global vs operation security)
  • Clear boundaries between contract-first design and runtime implementation concerns

Scope: Contract-first quality only. Focus this skill on OpenAPI design, quality, and governance guidance.

Constraints

Keep recommendations at the OpenAPI layer unless the user explicitly asks for Java framework integration. After editing this repository's XML sources, regenerate skills and verify the build.

  • MANDATORY: Run ./mvnw compile or mvn compile before proposing Java or Maven changes in the same change set
  • FRAMEWORK: Keep guidance contract-centric; do not prescribe framework-specific controller wiring or runtime exposure details
  • FUZZING: Keep fuzzing guidance high-level and contract-focused without linking to external skill identifiers
  • VERIFY: Run ./mvnw clean verify or mvn clean verify before promoting changes
  • EDGE CASE: If the user goal is ambiguous, stop and ask a clarifying question before editing files or running project-wide commands
  • EDGE CASE: If required context, files, credentials, or tools are missing, report the blocker explicitly and ask whether to proceed with setup or fallback guidance
  • EDGE CASE: If requested changes conflict with project constraints or safety boundaries, explain the conflict and ask for user confirmation on the preferred trade-off

When to use this skill

  • Review an OpenAPI
  • Improve an OpenAPI
  • Improve API contract
  • Improve API schema design
  • Validate an OpenAPI spec

Workflow

  1. Read reference and assess project context

Read references/701-technologies-openapi.md and inspect current API/context artifacts before proposing changes.

  1. Gather scope and decide target improvements

Identify requested outcomes, constraints, and the minimum safe set of changes to apply.

  1. Apply technology-aligned changes

Implement or refactor artifacts following the reference patterns and project conventions.

  1. Run verification and report results

Execute appropriate checks and summarize what changed, what was verified, and any follow-up actions.

Reference

For detailed guidance, examples, and constraints, see [references/701-technologies-openapi.md](references/701-technologies-openapi.md).