API linting implementation guideline (#1) #110
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Create .spectral.yml * Create camara-language-avoid-telco.js * Create camara-reserved-words.js * Create camara-security-no-secrets-in-path-or-query-parameters.js * Create megalinter.yml * Create API-linting-Implementation-Guideline.md * update API linting document files with new links of files * Update API-linting-Implementation-Guideline.md * Create javalint.xml * Create .yamllint.yaml * reserved word 'enum' and 'default' are removed from reserved word array * Remove reserved words from arrays: openAPIKeywords and reservedWords" * Enable recommended option true/false for each rule. * Update log of telco rule * Update log of reserved word rule * Update log of camara-security-no-secrets-in-path-or-query-parameters.js * update custom function rule name * update rule name as per camara standards
ravindrapalaskar17
requested review from
shilpa-padgaonkar,
rartych,
patrice-conil,
RubenBG7 and
jordonezlucena
as code owners
This was referenced Dec 12, 2023
Closed
|
I had to make two changes to The problem with the "not enough spaces before comment" error was in I don't know why there was a perceived problem with the newline character in the YAML, but I didn't think it was an issue so disabled that check. |
eric-murray
reviewed
Dec 12, 2023
artifacts/linting_rules/lint_function/camara-security-no-secrets-in-path-or-query-parameters.js
Outdated
Show resolved
Hide resolved
jlurien
reviewed
Dec 19, 2023
| function: truthy | ||
| recommended: true # Set to true/false to enable/disable this rule | ||
|
|
||
| camara-discriminator-use: |
There was a problem hiding this comment.
Not all usages of oneOf/anyOf are related to polymorphism, e.g. https://github.com/camaraproject/QualityOnDemand/blob/main/code/API_definitions/qod-api.yaml#L963
| then: | ||
| function: pattern | ||
| functionOptions: | ||
| match: "^\/([a-z0-9]+(-[a-z0-9]+)*)?(\/[a-z0-9]+(-[a-z0-9]+)*|\/{.+})*$" # doesn't allow /asasd{asdas}sadas pattern or not closed braces |
There was a problem hiding this comment.
Why not using built-in type: kebab
There was a problem hiding this comment.
Tested and updated PR with spectral core function kebab
rkandoi
reviewed
Jan 8, 2024
PedroDiez
reviewed
Feb 1, 2024
PedroDiez
reviewed
Feb 1, 2024
* Update camara-language-avoid-telco.js Header comment added * Update camara-reserved-words.js Header comment added * Update camara-security-no-secrets-in-path-or-query-parameters.js Header comment added * Update .spectral.yml Comment header added * Update .yamllint.yaml Header comment added * Delete artifacts/linting_rules/javalint.xml By default Java is not used in API specification repositories * Update megalinter.yml Header comment extended * Update .yamllint.yaml Changes in default configuration of yamllint * Update .spectral.yml oas3-operation-security-defined rule was disabled as it do not fully support OpenIdConnect flow * Update megalinter.yml Megalinter configuration change, disable not needed linters * Update megalinter.yml Disable running spectral outside of Megalinter * Create spectral_oas_lint.yml workflow configuration to manually run CAMARA OAS rules * Update spectral_oas_lint.yml Simplification * Update .spectral.yml New functions added/modified (more granularity for descriptions) * Update .spectral.yml typo * Update API-linting-Implementation-Guideline.md Modification and reshuffling of the how-to file * Update spectral_oas_lint.yml * Update .spectral.yml Changed camara-discriminator-use severity to: hint * Update .spectral.yml oas3-server-variables commented out * Update megalinter.yml Actions checkout@v4 upload-artifact@v4
rartych
requested review from
jlurien,
PedroDiez,
rkandoi and
shilpa-padgaonkar
PedroDiez
reviewed
Feb 2, 2024
rartych
previously approved these changes
Feb 6, 2024
eric-murray
reviewed
Feb 6, 2024
PedroDiez
approved these changes
Feb 7, 2024
Custom regex including filter added for Spectral
new-lines: disable
rartych
approved these changes
Feb 8, 2024
RubenBG7
approved these changes
Feb 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
This PR introduces a step-by-step process to integrate Spectral linting into the CAMARA Repository.
The integration is essential for validating the API specification design in accordance with CAMARA's API specification guidelines.
The changes encompass both source code modifications and documentation enhancements to ensure a seamless integration of Spectral linting.
Which issue(s) this PR fixes:
Fixes #15