Comments (5)
@pjungermann I would prefer the option where OPENAPI_SPECTRAL can handle sync + async APIs ^^
Ypu could rename the default config file as .spectral.yml
, and put the mixed config in default content
extends:
- spectral:asyncapi
- spectral:oas
Semantically, OPENAPI_SPECTRAL would analyze openapi + asyncapi , but i wouldn't like to create a new descriptor for each new capability
Another solution might be to deprecate OPENAPI descriptor and create a new descriptor API that would contain API_SPECTRAL, but in my opinion that's not mandatory
from megalinter.
@pjungermann great :)
In order to ensure compatibility until the next major release (usually once a year), please do not remove the openapi descriptor, just add deprecated
and create a new api descriptor aside :)
from megalinter.
@pjungermann would it just work if we update default config file shipped with MegaLinter ?
If not, we could also update the doc to tell to override the config file name using variable OPENAPI_SPECTRAL_CONFIG_FILE
Would you like to make a PR ? :)
from megalinter.
@nvuillam updating the config file would be a viable option (+ updating docs).
- reuse same linter and config file
- separate linter
- separate config files (users could override it if they want to use one for both)
- shared config file
- stick to current file name
- use filename as of Spectral's docs
Based on the setup for other linters, I assumed there might be a preference for ASYNCAPI_SPECTRAL
.
I'm willing to provide a PR. Before, I wanted to find out the right solution for this project.
from megalinter.
I like the idea of changing OPENAPI to API as linter grouping π
I will have a look at preparing the necessary changes.
from megalinter.
Related Issues (20)
- Can we use _extends from another repo in same org HOT 20
- `SPELL_VALE_CONFIG_FILE` not working HOT 7
- APPLY_FIX related steps are not executing HOT 7
- βenv VALIDATE_ALL_CODEBASE=false does not work in docker HOT 12
- Megalinter is very slow HOT 11
- Typescript with invalid interface loaded as resolver HOT 4
- ANSIBLE_LINT enablement in Megalinter configurations is not checking the ansible yaml validations. HOT 11
- Issues with TSQLLINT and .NET 8.x HOT 4
- Request new MegaLinter flavor - python and embedded C/C++ HOT 3
- How/where have to set the ssh key to clone roles using /roles/requirements.yml? HOT 2
- Unable to get number of errors with regex_number HOT 15
- Wrong behaviour of PSALM inside docker HOT 14
- PRE / POST commands at descriptor level HOT 3
- How can I disable 'yamllint' linter to disable checking for quotes for Strings HOT 1
- clang-format docs link is incorrect
- some information about installing megalinter in custom Dockerfile HOT 4
- restructuredtext_lint: Cannot analyze code. Pygments package not found. HOT 3
- Upgrade PHP engine from 8.1 to 8.3 HOT 2
- Manage list type parameters with EXTENDS HOT 6
- Activate SARIF output for clj-kondo
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from megalinter.