Skip to content

Commit a4edbde

Browse files
authored
Merge pull request #413 from ravindrapalaskar17/Update-documentation-as-per-release
Update documentation as per release 2.2 (#5)
2 parents f0e742e + 5a60d77 commit a4edbde

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

documentation/API-linting-Implementation-Guideline.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ This file consolidates all rules:
3737

3838
## GitHub Actions Integration (Gherkin)
3939

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

42-
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
42+
2. Add <b>[megalinter.yml](/artifacts/linting_rules/.github/workflows/megalinter.yml)</b> to GitHub action workflows in `.github/workflows` folder
4343
which includes the configuration of Megalinter and Spectral for GitHub actions.
4444

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

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

103-

documentation/Linting-rules.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Rules applying to OpenAPI v2.0, v3.0, and most likely v3.1 - details are describ
3232
|------------------------------------|--------------------------------------------------------------------------------------|-------------|------------|-------------------|-----------------|
3333
| contact-properties | contact object is full of the most useful properties: `name`, `url`, and `email` | No | No | Warning | Warning |
3434
| duplicated-entry-in-enum | Each value of an `enum` must be different from one another | Yes | Yes | Warning | Warning |
35-
| info-contact | Info object should contain `contact` object | Yes | Yes | Warning | Warning |
35+
| info-contact | Info object should contain `contact` object | No | No | Warning | Warning |
3636
| info-description | Info object should contain `description` object | Yes | Yes | Warning | Warning |
3737
| info-license | Info object should contain `license` object | Yes | Yes | Warning | Warning |
3838
| license-url | link to the full text of licence | Yes | Yes | Warning | Warning |
@@ -156,7 +156,7 @@ Info object must include the following information: API Version in the format: X
156156
_Spectral rule_: [camara-info−version-format](/artifacts/linting_rules/.spectral.yml)
157157

158158
*Severity*: `warn` <br>
159-
❕ Note: Currently the format like `version: 0.10.0-wip` is used in the API development branch
159+
❕ Note: The version format may follow "wip", "x.y.z-alpha.n", or "x.y.z-rc.n" for unreleased or pre-release versions.
160160

161161

162162

0 commit comments

Comments
 (0)