beckn / beckn/protocol-specifications

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

Open
#403 0 comments 0 reactions 1 assignee Claimed by @rajaneeshk90 View on GitHub
Dominant language
No language data
Stars
453
Forks
126
PR merge metrics
No merged PRs in 30d

Description

**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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.