Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

funnyhcat-dotcom/api-json-merge-patch-doctor

Open more actions menu

Repository files navigation

api-json-merge-patch-doctor

A zero-dependency CLI that audits JSON Merge Patch documentation.

It checks RFC 7396 media type, PATCH endpoint behavior, null deletion, omitted-field semantics, array replacement, before/patch/after examples, validation, ETag/If-Match concurrency, idempotency, errors, JSON Patch distinction, patchable field allowlists, authorization/mass-assignment safety, audit logs, and SDK usage.

Quick start

npx api-json-merge-patch-doctor docs/patch.md

Checks

  • application/merge-patch+json / RFC 7396
  • PATCH endpoint behavior
  • null removes fields
  • omitted fields stay unchanged
  • arrays are replaced whole
  • before/patch/after examples
  • validation after merge
  • ETag / If-Match concurrency
  • idempotency
  • error examples
  • JSON Merge Patch vs JSON Patch
  • patchable field allowlist
  • authorization and mass assignment safety
  • audit/change logs
  • SDK/client usage

CI

api-json-merge-patch-doctor docs/patch.md --min-score 85

License

MIT

About

Audit JSON Merge Patch docs for RFC 7396 media type, null deletion, omitted fields, array replacement, examples, validation, ETags, errors, and safety.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.