Run any Skill in Manus with one click

update-openapi-contract

Stars0

Forks0

UpdatedMarch 2, 2026 at 19:23

Update and validate OpenAPI specs when backend API contracts change. Use when adding/changing endpoints, DTOs, response schemas, or auth requirements in api-go or api-java.

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Run Skill in Manus

Source

namuan

namuan/nx-multi-repo-template

View GitHub Repository View Creator Repositories

Download

Run Skill in Manus

Related occupationsSOC

Based on SOC occupation classification

Software DevelopersComputer and Mathematical Occupations·SOC 15-1252

SKILL.md

readonly

name	update-openapi-contract
description	Update and validate OpenAPI specs when backend API contracts change. Use when adding/changing endpoints, DTOs, response schemas, or auth requirements in api-go or api-java.

Update OpenAPI Contract

Use this skill whenever API request/response behavior changes.

1) Update the correct spec file

Java API changes → docs/openapi/api-java.yaml
Go API changes → docs/openapi/api-go.yaml

2) Keep spec aligned with implementation

Synchronize:

path and method
request body schema and required fields
response status codes and payload schemas
auth requirements (Bearer JWT, device key, etc.)

3) Ensure tests reflect contract updates

Service-level tests for changed behavior.
E2E tests where contract changes affect cross-service or user-visible flows.

4) Validate after changes

At minimum run relevant service/test commands:

pnpm nx run api-java:test or pnpm nx run api-go:test
npm run test:e2e:backend if endpoints are used in integrated flows

5) Keep docs coherent

If endpoint purpose or usage changed significantly, update related docs (README.md, docs/polyglot-architecture.md, or focused runbooks) in the same change.

More from this repository

same repository

add-e2e-test

namuan/nx-multi-repo-template

Add or update Playwright E2E tests for backend APIs or frontend UI in this monorepo. Use when asked for end-to-end verification, cross-service test coverage, or deterministic integration tests.

2026-03-020

add-frontend-feature

namuan/nx-multi-repo-template

Implement or modify frontend features in the React app with correct service boundaries, shared UI usage, and matching tests. Use when asked to add pages, components, API integrations, or state/UI behavior in apps/frontend.

2026-03-020

debug-ci-failure

namuan/nx-multi-repo-template

Diagnose and fix failing CI checks in this Nx polyglot monorepo. Use when asked to investigate GitHub Actions failures, pre-push issues, or failing affected lint/test/build targets.

2026-03-020

add-api-endpoint

namuan/nx-multi-repo-template

Add or update a backend API endpoint in this polyglot monorepo. Use when asked to create REST endpoints, handlers/controllers, request or response DTOs, service logic, routes, OpenAPI updates, and matching tests.

2026-03-020

add-database-migration

namuan/nx-multi-repo-template

Author, validate, and document Postgres schema migrations in this monorepo. Use when asked to add tables/columns/indexes, modify schema, or prepare rollback-safe DB changes.

2026-03-020

name	update-openapi-contract
description	Update and validate OpenAPI specs when backend API contracts change. Use when adding/changing endpoints, DTOs, response schemas, or auth requirements in api-go or api-java.

Update OpenAPI Contract

Use this skill whenever API request/response behavior changes.

1) Update the correct spec file

Java API changes → docs/openapi/api-java.yaml
Go API changes → docs/openapi/api-go.yaml

2) Keep spec aligned with implementation

Synchronize:

path and method
request body schema and required fields
response status codes and payload schemas
auth requirements (Bearer JWT, device key, etc.)

3) Ensure tests reflect contract updates

Service-level tests for changed behavior.
E2E tests where contract changes affect cross-service or user-visible flows.

4) Validate after changes

At minimum run relevant service/test commands:

pnpm nx run api-java:test or pnpm nx run api-go:test
npm run test:e2e:backend if endpoints are used in integrated flows

5) Keep docs coherent

If endpoint purpose or usage changed significantly, update related docs (README.md, docs/polyglot-architecture.md, or focused runbooks) in the same change.