Need automated Open API syntax validation on submitting PR to master
@ravi-prakash-v is already working on this.
Since Oct 30, 2023.
Assessment
This issue has not been assessed yet.
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
- Dominant language
- No language data
- Stars
- 454
- Forks
- 127
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from beckn/protocol-specifications
-
Migrate default branch from `master` to `main`May be free again @ravi-prakash-v claimed this 372 days ago, and no pull request is open. Openworking group meeting
beckn/protocol-specifications#491 · 1 assignee ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
beckn/protocol-specifications#472 · 3 comments ·
-
Restructure spec repos to allow more interactive learning of the specMay be free again @rajaneeshk90 claimed this 716 days ago, and no pull request is open. Openprotocol-specifications
beckn/protocol-specifications#455 · 1 assignee ·
-
Design specifications for Open Data platformMay be free again @rajaneeshk90 claimed this 716 days ago, and no pull request is open. Openprotocol-specifications
beckn/protocol-specifications#454 · 1 assignee ·
-
Protocol-Specification Version 1.2 releaseMay be free again @rajaneeshk90 claimed this 716 days ago, and no pull request is open. Openprotocol-specifications
beckn/protocol-specifications#451 · 2 comments · 1 assignee ·