-
Notifications
You must be signed in to change notification settings - Fork 125
Open
Labels
C4GT CommunityProtocol DraftDraft specification submitted for protocol standard considerationDraft specification submitted for protocol standard considerationenhancementNew feature or requestNew feature or request
Description
Name: Protocol Specifications
Title: "Need automated Open API syntax validation on submitting PR to master"
Labels: C4GT Community
Description
Problem:
Sometimes when pull requests are merged, syntactical errors in the Open API document get committed on master.
Feature Request
An automated script that runs when creating a PR to the spec. It should validate transaction.yaml, meta.yaml, and registry.yaml against Open API 3.0 specification.
Goals
- An automated script that runs when creating a PR to the spec. It should validate transaction.yaml, meta.yaml, and registry.yaml against Open API 3.0 specification.
Expected Outcome
- Specs on master branch should not have any errors
Acceptance Criteria
- Checks run on a PR with syntax errors in OpenAPI spec should fail
- Checks run on a PR with no syntax errors in OpenAPI spec should pass
Implementation Details
Mockups / Wireframes
Project
Beckn
Organization Name:
Beckn Open Collective
Domain
Others
Tech Skills Needed:
Open API 3.0
Github actions
Node JS
Mentor(s)
Ravi Prakash
Complexity
Medium
Category
CI/CD
Sub Category
Backend, Research
Metadata
Metadata
Assignees
Labels
C4GT CommunityProtocol DraftDraft specification submitted for protocol standard considerationDraft specification submitted for protocol standard considerationenhancementNew feature or requestNew feature or request