Annotate OrangeHRM REST API endpoints with OpenAPI v3 annotations.
npx skills add https://github.com/orangehrm/orangehrm --skill rest-openapi
Please help me install this Agent Skill. Skill: rest-openapi Source: https://github.com/orangehrm/orangehrm/tree/main/.agents/skills/rest-openapi Command: npx skills add https://github.com/orangehrm/orangehrm --skill rest-openapi
This Skill eliminates the risk of missing or incorrect OpenAPI v3 annotations for OrangeHRM REST endpoints and models, which cause CI build failures and produce inaccurate, unreliable API documentation for consumers.
Use the rest-openapi skill to add correct OpenAPI annotations to your new OrangeHRM REST endpoint and pass the CI lint check.
High-intent search queries and answers about installing and using this skill.
Fix generate-open-api-doc CI failures by correcting malformed zircote/swagger-php annotations on endpoint handlers and Model classes, ensuring required fields, naming conventions, and PHP constants align with routes.yaml to produce valid OpenAPI v3 specs.
Add OpenAPI annotations by applying zircote/swagger-php attributes to your endpoint handler methods, defining Model @OA.Schema blocks, and referencing project-standard shared component refs like RecordNotFound and sortOrder to ensure consistent REST v2 API documentation.
Required shared component references for OrangeHRM REST v2 API include RecordNotFound, ForbiddenResponse, sortOrder, limit, and offset. Using these pre-defined shared refs eliminates duplication and ensures documentation consistency across all endpoints.
swagger-php annotations break the CI lint workflow when they contain missing required fields, use literal values instead of PHP constants, or mismatch the routes.yaml configuration, which collectively cause invalid OpenAPI spec generation and build failures.
You cannot use literal values in swagger-php OpenAPI schema definitions for OrangeHRM. You must reference PHP constants to ensure annotations pass the mandatory generate-open-api-doc CI lint check and maintain accurate API documentation.
Debug OpenAPI annotation errors for bulk delete endpoints by using step-by-step recipes and checklists to verify @OA.Schema blocks, validate shared response refs, and ensure endpoint handler methods match routes.yaml to pass CI lint enforcement.
rundeckAutomate REST API endpoint creation with OpenAPI annotations and versioning.
xloxn69Generate OpenAPI 3.0 YAML/JSON specifications for REST API endpoints.
jdevalkGenerate GitHub Actions workflows for WordPress plugin CI/CD.
zhaono1Generate OpenAPI 3.0/3.x specifications and endpoint documentation from REST APIs.
