-
Notifications
You must be signed in to change notification settings - Fork 116
chore: add new JSDoc endpoint check rule #5677
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Following you can find the validation changes against the target branch for the APIs. No changes detected. You can validate these APIs yourself by using the |
d6b8ca7 to
84997d3
Compare
84997d3 to
b3e4e66
Compare
|
@pquentin given this makes changes to the docs (added spaces), does this need backporting to 9.2, 9.1 and 8.19? |
pquentin
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! LGTM.
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.1 9.1
# Navigate to the new working tree
cd .worktrees/backport-9.1
# Create a new branch
git switch --create backport-5677-to-9.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 061b56d67dd7a22590afaff094d289e7be4025de
# Push it to GitHub
git push --set-upstream origin backport-5677-to-9.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.1Then, create a pull request where the |
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.2 9.2
# Navigate to the new working tree
cd .worktrees/backport-9.2
# Create a new branch
git switch --create backport-5677-to-9.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 061b56d67dd7a22590afaff094d289e7be4025de
# Push it to GitHub
git push --set-upstream origin backport-5677-to-9.2
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.2Then, create a pull request where the |
* chore: add new JSDoc endpoint check rule * chore: `npm run lint --prefix specification -- --fix` * doc: fix missing ` in validator/README/md * chore: prettier * chore: disable currently failing markdown lint errors in JSDocs (cherry picked from commit 061b56d)
* chore: add new JSDoc endpoint check rule * chore: `npm run lint --prefix specification -- --fix` * doc: fix missing ` in validator/README/md * chore: prettier * chore: disable currently failing markdown lint errors in JSDocs (cherry picked from commit 061b56d)
* chore: add new JSDoc endpoint check rule (#5677) * chore: add new JSDoc endpoint check rule * chore: `npm run lint --prefix specification -- --fix` * doc: fix missing ` in validator/README/md * chore: prettier * chore: disable currently failing markdown lint errors in JSDocs (cherry picked from commit 061b56d) * Delete validator/test/no-all-string-literal-unions.test.js * Delete validator/test/no-duplicate-type-names.test.js * Delete specification/indices/delete_sample_configuration/IndicesDeleteSampleConfigurationRequest.ts * fix: remove added files * Update package-lock.json Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> --------- Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
* chore: add new JSDoc endpoint check rule (#5677) * chore: add new JSDoc endpoint check rule * chore: `npm run lint --prefix specification -- --fix` * doc: fix missing ` in validator/README/md * chore: prettier * chore: disable currently failing markdown lint errors in JSDocs (cherry picked from commit 061b56d) * Update package-lock.json Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> --------- Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
I would advise viewing this PR per-commit, as commit 2 is pretty large!
Commits:
a. Includes a fixer
npm run lint --prefix specification -- --fixto fix existing JSDocs that violate the rules outlined in JSDoc endpoint comments should be explicitly split in summary and description #2757Example output:
Outstanding Questions