Skip to content

Feature Request: Add OpenAPI Definition to Commit #90

@marcramser

Description

@marcramser

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions