beckn / protocol-specifications

Core protocol specification for peer-to-peer consumer-provider interaction

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Need a pre-commit hook for Open API syntax validation for Beckn core specification

rajaneeshk90 opened this issue · comments

Issue:
Occasionally, when modifications are made to the Beckn core specification, unnoticed syntactical errors may arise, necessitating manual identification and correction.

Proposed Resolution:
Implement a Git pre-commit script to execute on the user's local machine when committing changes to the Beckn specification. This script should conduct validation checks on transaction.yaml, meta.yaml, and registry.yaml against the OpenAPI 3.0 specification.

Anticipated Result:
The implementation of this script should prevent the introduction of any syntactical errors into the core specification with each new commit.

Acceptance Criteria:

Commits containing syntax errors in the OpenAPI spec should result in failure.
Commits free of syntax errors in the OpenAPI spec should pass the validation process.