Files
mintlify__docs/.mintlify/workflows/update-api-reference.md

848 B

name, on, context, automerge
name on context automerge
Update API reference
push
repo branch
mintlify/server main
repo branch
mintlify/mint main
repo
mintlify/docs
false

Review the diff from the last merged PR in the triggering repository for changes to API endpoints, parameters, response shapes, or error codes.

Update the corresponding API specifications or pages in the docs to reflect the changes. Include updated parameter descriptions, type information, and examples where affected.

Success criteria: All API specifications and pages are up to date with the changes in the product repository.

Important

  • If a parameter or endpoint was removed, mark it as deprecated rather than deleting it unless the code explicitly removes it with no deprecation period.
  • If no API changes were introduced, do nothing.