feat: operationId should conform to naming convention #124
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
SaltedCaramelCoffee
requested review from
mkistler and
dpopp07
and removed request for
mkistler
Codecov Report
@@ Coverage Diff @@
## master #124 +/- ##
=======================================
Coverage 92.65% 92.65%
=======================================
Files 56 56
Lines 2055 2055
=======================================
Hits 1904 1904
Misses 151 151Continue to review full report at Codecov.
|
dpopp07
requested changes
Jan 29, 2020
src/plugins/validation/2and3/semantic-validators/operation-ids.js
Outdated
Show resolved
Hide resolved
Co-Authored-By: Dustin Popp <dpopp07@gmail.com>
SaltedCaramelCoffee
force-pushed
the
operation-id-name-convention-check
branch
from
d83f555
to
ce648a3
Compare
dpopp07
approved these changes
Jan 29, 2020
|
I approved it but now noticing that Travis builds are failing - make sure you get those sorted before merging! |
dpopp07
pushed a commit
that referenced
this pull request
Jan 29, 2020
# [0.17.0](v0.16.2...v0.17.0) (2020-01-29) ### Features * operationId should conform to naming convention ([#124](#124)) ([79ca9b8](79ca9b8))
|
🎉 This PR is included in version 0.17.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
documentation for operation Id naming convention
We should add support to the validator to check for conformance to these conventions and report any non-conformance as a warning
This PR takes the following approach to check for operationId naming convention:
pfor whichpandp/{param}exist,phas a GET and POST path, andp/{param}has a GET, a DELETE, and a POST or PUT or PATCH.pstarts with "list"pstarts with "create" or "add"p/{param}starts with "get"p/{param}starts with "delete"p/{param}starts with "update"