Skip to main content

​
Changelog and versioning

deepface.dev is shipping the public API as a v1 soft-launch contract.

​
Versioning rules

  • Breaking API changes require an explicit versioning decision before release.
  • Non-breaking additions land in the changelog and OpenAPI spec together.
  • Docs changes that alter endpoint behavior must update the canonical OpenAPI file in the same pull request.

​
Change process

  • Update openapi/deepface.openapi.yaml.
  • Regenerate docs-site/openapi/deepface.openapi.yaml.
  • Run npm run docs:check.
  • Include any customer-facing behavior changes in the pull request summary.