openapi.yamlに関してのlinterを設定 #25
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
yossydev
commented
Nov 24, 2022
| OperationObject: | ||
| - '#PathItem[get,put,post,delete,options,head,patch,trace]' | ||
| rules: | ||
| oas3-valid-media-example: off |
There was a problem hiding this comment.
stoplightのバグで、
OpenAPIが定義しているexampleオブジェクトについて知らないので、idをスキーマidとして解釈している
というものがあり、色々試しましたが解消ができなかったのでlintをoffにしています。
対象 Issue
.github/workflows/spectral.yaml
Outdated
| @@ -0,0 +1,15 @@ | |||
| name: OpenAPI validation | |||
|
|
|||
There was a problem hiding this comment.
spectral.yamlってファイル名だと何やってるかよくわからないので、check_openapi_format.yamlとかもうちょい直感的にわかる名前にしてほしいかもな
There was a problem hiding this comment.
f713f9b こちらにて、check_openapi_format.yamlに修正しました🙇♂️
muraikenta
reviewed
Nov 25, 2022
| - uses: actions/checkout@v2 | ||
|
|
||
| - name: Lint OpenAPI | ||
| run: npx @stoplight/spectral-cli lint openapi.yaml |
There was a problem hiding this comment.
これをローカルでもnpm run lint で走らせられるようにpackage.json変更しといてもらっていいかな？
There was a problem hiding this comment.
ここもnpm run lint で書き換えてもらえると
added 3 commits
November 25, 2022 15:20
…o feature/opneapi-linter
Merged
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.
やったこと
npx @stoplight/spectral-cli lint openapi.yamlを使って、openapiのrules通りになるように修正。(一応vscodeの拡張機能エディター上でもlintの確認ができます https://marketplace.visualstudio.com/items?itemName=stoplight.spectral)
SpectralでOpenAPI Specをlintしたい！ を参考に、CIの設定。
やってないこと
npm run build:packagesは差分が多くなりそうだったので後に行います。確認したいこと
OpenApiのルール内容
info部分
servers部分
tags部分