Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teamdigitale/api-oas-checker-action
GitHub Action wrapper for Spectral - a JSON/YAML/OpenAPI/AsyncAPI/etc linter with Italian API Guidelines
https://github.com/teamdigitale/api-oas-checker-action
Last synced: 7 days ago
JSON representation
GitHub Action wrapper for Spectral - a JSON/YAML/OpenAPI/AsyncAPI/etc linter with Italian API Guidelines
- Host: GitHub
- URL: https://github.com/teamdigitale/api-oas-checker-action
- Owner: teamdigitale
- License: apache-2.0
- Fork: true (stoplightio/spectral-action)
- Created: 2020-07-10T12:31:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-18T19:29:46.000Z (about 2 years ago)
- Last Synced: 2024-08-02T06:14:50.858Z (3 months ago)
- Language: TypeScript
- Homepage: https://teamdigitale.github.io/api-oas-checker/
- Size: 1.24 MB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-egov-de - Italian Open API Validation Checker - connect/api/-/blob/main/.spectral.yml) (Tooling for developers / OZG Progress tracking)
README
# Italian API Guidelines linter
This action lints your OAS3+ API specifiction files checking for Italian API Guidelines.
Rules are retrieved from [api-oas-checker](https://teamdigitale.github.io/api-oas-checker/spectral.yml)
Currently, this project is based on the opensource [Spectral](https://github.com/stoplightio/spectral) linter.
## Usage
See [action.yml](action.yml)
```yaml
name: Run Spectral API checker on Pull Requestson:
- pull_requestjobs:
build:
name: Run Spectral
runs-on: ubuntu-latest
steps:
# Check out the repository
- uses: actions/checkout@v2- name: API Guidelines linter - beta
uses: ioggstream/[email protected]
with:
# The pattern describing the file paths to lint with Spectral
file_glob: 'openapi/*.yaml'```
### Inputs
- **file_glob:** Pattern describing the set of files to lint. Defaults to `*.oas.{json,yml,yaml}`. (_Note:_ Pattern syntax is documented in the [fast-glob](https://www.npmjs.com/package/fast-glob) package documentation)
- **spectral_ruleset:** By default it will point to the latest Italian Guidelines spectral.yml. You can reference a tagged version though.
## Configuration
If you need a more fine-grained configuration, consider writing your own action or implement your linting pipeline reusing the components provided here and in [api-oas-checker](https://teamdigitale.github.io/api-oas-checker/spectral.yml)