Skip to content

Feature Request: Add OpenAPI Definition to Commit #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcramser opened this issue May 22, 2025 · 0 comments
Open

Feature Request: Add OpenAPI Definition to Commit #90

marcramser opened this issue May 22, 2025 · 0 comments

Comments

@marcramser
Copy link

To improve integration and automation possibilities, it would be great if Commit could generate a standardized OpenAPI (Swagger) definition, ideally exposed as /openapi.json.

Benefits:

  • Enables SDK generation across multiple languages, making it easier to consume the API programmatically.
  • Allows automatic request validation to catch errors earlier.
  • Supports CI/CD integration for automated testing and deployment workflows.
  • Facilitates integration with API gateways and external tools that expect OpenAPI specs.
  • Helps integrate Frappe APIs with systems outside the Frappe ecosystem, where OpenAPI is the de facto standard.

Rationale:
While the current approach with documentation and Bruno files is helpful for manual testing and internal use, providing an OpenAPI specification would open the door to a wider ecosystem of automation and tooling, increasing interoperability and developer productivity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant