Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation as per release 2.2 #5

Merged
merged 3 commits into from
Feb 10, 2025
Merged

Update documentation as per release 2.2 #5

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9810a64
Update document as per release
ravindrapalaskar17 Feb 6, 2025
2c6376f
Update document as per release
ravindrapalaskar17 Feb 6, 2025
eed70d0
Update review comment
ravindrapalaskar17 Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions documentation/API-linting-Implementation-Guideline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ This file consolidates all rules:

## GitHub Actions Integration (Gherkin)

1. Add **[.gherkin-lintrc](https://github.com/camaraproject/Commonalities/blob/main/artifacts/linting_rules/.gherkin-lintrc)** (rules) file to -> root location of repository
1. Add **[.gherkin-lintrc](/artifacts/linting_rules/.gherkin-lintrc)** (rules) file to -> root location of repository

2. Add <b>[megalinter.yml](https://github.com/camaraproject/Commonalities/blob/main/artifacts/linting_rules/.github/workflows/megalinter.yml)</b> to GitHub action workflows in `.github/workflows` folder
2. Add <b>[megalinter.yml](/artifacts/linting_rules/.github/workflows/megalinter.yml)</b> to GitHub action workflows in `.github/workflows` folder
which includes the configuration of Megalinter and Spectral for GitHub actions.

### Manually running linting workflow
Expand Down Expand Up @@ -100,4 +100,3 @@ To integrate Gherkin linting into the Megalinter setup, follow these steps:

*Replace **'test.feature'** with the path to your Test defination feature file.*


4 changes: 2 additions & 2 deletions documentation/Linting-rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Rules applying to OpenAPI v2.0, v3.0, and most likely v3.1 - details are describ
|------------------------------------|--------------------------------------------------------------------------------------|-------------|------------|-------------------|-----------------|
| contact-properties | contact object is full of the most useful properties: `name`, `url`, and `email` | No | No | Warning | Warning |
| duplicated-entry-in-enum | Each value of an `enum` must be different from one another | Yes | Yes | Warning | Warning |
| info-contact | Info object should contain `contact` object | Yes | Yes | Warning | Warning |
| info-contact | Info object should contain `contact` object | No | No | Warning | Warning |
| info-description | Info object should contain `description` object | Yes | Yes | Warning | Warning |
| info-license | Info object should contain `license` object | Yes | Yes | Warning | Warning |
| license-url | link to the full text of licence | Yes | Yes | Warning | Warning |
Expand Down Expand Up @@ -156,7 +156,7 @@ Info object must include the following information: API Version in the format: X
_Spectral rule_: [camara-info−version-format](/artifacts/linting_rules/.spectral.yml)

*Severity*: `warn` <br>
❕ Note: Currently the format like `version: 0.10.0-wip` is used in the API development branch
❕ Note: Currently the format like may include "wip", "x.y.z-alpha.n" or "x.y;z-rc;n" while the API is not yer publicly released.



Expand Down