Need automated Open API syntax validation on submitting PR to master

[ravi-prakash-v]

---

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

[Deekshithrathod]

@ravi-prakash-v This seems a fairly easy task, assuming that we can use this library & the GitHub actions can be configured easily as well. I have tried to find the guide for local setup but couldn't find one, can you please point me to it? And also feel free to assign it to me, if no one else is working on it.

[Sarfraz-droid]

we can also use https://github.com/IBM/openapi-validator . as a cli tool to validate open api syntaxes

[Deekshithrathod]

@Sarfraz-droid I will take a look at it.

[Deekshithrathod]

@ravi-prakash-v Just checked the GHA marketplace, there are some readily available OAS validator GitHub actions like this. Will this do? ( If yes, I will raise a PR ) or would you like to build the entire thing from scratch?

[c4gt-community-support]

Hi!
Mandatory Details - The following details essential to submit tickets to C4GT Community Program are missing. Please add them!

• Product Name - Please add a heading called Product Name and mention the name of the product below it.

Without these details, the ticket cannot be listed on the C4GT Community Listing.

Please update the ticket

[ravi-prakash-v]

Hi @Deekshithrathod, that will work. Can you please raise a PR for this?

[Deekshithrathod]

@ravi-prakash-v Sure can do. Feel free to assign this to me.

[Deekshithrathod]

@ravi-prakash-v Raised a PR, do check & let me know if you have any suggestions.

[emmayank]

Hi @ravi-prakash-v , the PR has been raised for the above issue by @Deekshithrathod . Please find it here - #387