openapi-spec-reviewer

Validate OpenAPI v3.x specifications against HMCTS policy and security standards.

3|4|Updated Apr 4, 2026
One-click install
npx skills add https://github.com/hmcts/agentic-plugins-marketplace --skill openapi-spec-reviewer-hmcts
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openapi-spec-reviewer
Source: https://github.com/hmcts/agentic-plugins-marketplace/tree/main/plugins/agents/hmcts-apim-sdlc-orchestrator/skills/openapi-spec-reviewer
Command: npx skills add https://github.com/hmcts/agentic-plugins-marketplace --skill openapi-spec-reviewer-hmcts

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures OpenAPI specifications adhere to HMCTS data-sharing policy, infrastructure SLA, API standards, and security standards, enabling robust and compliant API development.

Core Features & Use Cases

  • Policy Compliance: Ensures adherence to data-sharing policy, GDPR, and infrastructure SLA.
  • Standard Conformance: Validates against HMCTS API standards, including metadata completeness and versioning.
  • Security: Checks for security vulnerabilities, such as OAuth 2.0 flows and secure data handling.
  • Use Case: When preparing to publish an OpenAPI spec, use this Skill to validate compliance before release.

Quick Start

Review the OpenAPI spec by running the command /openapi-spec-reviewer and provide the spec file as input.

Frequently Asked Questions about openapi-spec-reviewer

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

FAQPage Schema
How do I validate an OpenAPI spec for GDPR and data-sharing compliance?

To audit OpenAPI v3.x specifications, run the command against your spec file to validate HMCTS API standards, infrastructure SLA, and security policies. This ensures compliance before publishing your API.

What does an OpenAPI v3.x policy compliance audit check for?

An OpenAPI security audit validates OAuth 2.0 flows, secure data handling, and metadata completeness. It applies HMCTS security and data-sharing policies to enforce compliance across your API specifications.

Do I need internal knowledge documents for OpenAPI spec validation?

Yes, validating OpenAPI v3.x specifications requires internal knowledge documents to apply policy constraints. These documents provide the HMCTS standards and infrastructure SLA rules needed for the compliance audit.

Why does my OpenAPI spec fail HMCTS API standards validation?

Your OpenAPI spec fails HMCTS validation if it lacks metadata completeness, proper versioning, or secure OAuth 2.0 flows. The audit enforces these infrastructure SLA and security policies strictly.

Can I use this to check OpenAPI security vulnerabilities like OAuth 2.0 flows?

Yes, you can check OpenAPI security vulnerabilities by auditing OAuth 2.0 flows and secure data handling. The validation applies HMCTS security standards to identify and enforce compliance before release.