endpoint-validator

Validate REST API endpoints against OpenAPI schemas and parameter definitions.

569|85|Updated Jun 7, 2019

Search Tags:#openapi #validation #compliance #code-review #rest-api

Ready to run

npx skills add https://github.com/mikopbx/Core --skill endpoint-validator

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: endpoint-validator
Source: https://github.com/mikopbx/Core/tree/main/.claude/skills/endpoint-validator
Command: npx skills add https://github.com/mikopbx/Core --skill endpoint-validator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Validates MikoPBX REST API endpoints for OpenAPI compliance and parameter consistency before merge or deployment.

Core Features & Use Cases

Validates DataStructure.php against OpenAPI
Validates SaveRecordAction patterns and schema
Generates compliance reports with actionable recommendations

Quick Start

Identify DataStructure.php and SaveRecordAction.php for a resource, run validation, and review results.

Frequently Asked Questions about endpoint-validator

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

FAQPage Schema

How do I validate REST API endpoints against OpenAPI schemas?▼

Validate REST API endpoints by running compliance checks against your OpenAPI schema definitions. The endpoint-validator checks DataStructure.php and SaveRecordAction.php files for schema alignment, parameter consistency, and 7-phase processing compliance, generating actionable compliance reports before merge.

What does OpenAPI compliance validation check in REST API implementations?▼

OpenAPI compliance validation ensures your REST API endpoints match their OpenAPI specifications. It verifies parameter definitions, method-aware defaults, strict data validation, and documentation alignment across your implementation files to catch discrepancies before deployment.

Can I use endpoint validation during code review?▼

Yes, endpoint validation is designed for code reviews and pre-merge validation. Run it on DataStructure.php and SaveRecordAction.php patterns to enforce OpenAPI compliance and parameter consistency before merging REST API resource changes.

How do I check if my REST API implementation matches its OpenAPI definition?▼

Identify your resource's DataStructure.php and SaveRecordAction.php files, run validation against your OpenAPI schema, and review the compliance report. The validator checks method defaults, data validation strictness, and parameter definitions for documentation alignment.

What happens if my REST API endpoints don't comply with OpenAPI?▼

Non-compliant endpoints generate a compliance report with actionable recommendations. Issues typically involve misaligned parameters, schema violations, or processing pattern deviations that the validator identifies in DataStructure.php and SaveRecordAction.php before deployment.

Do I need OpenAPI definitions to validate REST API endpoints?▼

Yes, OpenAPI schema definitions are required. Endpoint validation compares your implementation files against OpenAPI specifications to ensure parameter consistency, method-aware defaults, and strict data validation compliance for REST API resources.