Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: Session Lock read response documentation update #10095

Closed
johncowen opened this issue Apr 23, 2021 · 0 comments · Fixed by #10651
Closed

docs: Session Lock read response documentation update #10095

johncowen opened this issue Apr 23, 2021 · 0 comments · Fixed by #10651
Assignees
@freddygv
Labels
type/docs Documentation needs to be created/updated/clarified

Comments

@johncowen
Copy link
Contributor

The documentation for the read response for Session Locks uses the old pre-1.7 shape:

https://www.consul.io/api-docs/session#sample-response-2

This was changed in 1.7:

// pre1.7
"Checks": ["serfHealth", ...]

//post-1.7
"NodeChecks": ["serfHealth", ...],
"ServiceChecks": null

Creating/updating sessions accepts both new style and old style payloads for back compat reasons, but guessing we should add something to the documentation around that also.
@johncowen johncowen added the type/docs Documentation needs to be created/updated/clarified label Apr 23, 2021
@johncowen johncowen mentioned this issue May 13, 2021
Merged
blake added a commit that referenced this issue Jul 20, 2021
@blake
docs: Update responses for /v1/session/ endpoints post 1.7
a446503 
Update output for /v1/session/ endpoints to match output post Consul
1.7.0.

Documents new `NodeChecks` and `ServiceChecks` parameters which were
added in that release.

Resolves #7341, resolves #10095
@blake blake mentioned this issue Jul 20, 2021
Merged
blake added a commit that referenced this issue Jul 21, 2021
@blake
docs: Update responses for /v1/session/ endpoints post 1.7
e515c9d 
Update output for /v1/session/ endpoints to match output post Consul
1.7.0.

Documents new `NodeChecks` and `ServiceChecks` parameters which were
added in that release.

Resolves #7341, resolves #10095
hc-github-team-consul-core pushed a commit that referenced this issue Jul 21, 2021
@blake @hc-github-team-consul-core
docs: Update responses for /v1/session/ endpoints post 1.7
5376692 
Update output for /v1/session/ endpoints to match output post Consul
1.7.0.

Documents new `NodeChecks` and `ServiceChecks` parameters which were
added in that release.

Resolves #7341, resolves #10095
hc-github-team-consul-core pushed a commit that referenced this issue Jul 21, 2021
@blake @hc-github-team-consul-core
docs: Update responses for /v1/session/ endpoints post 1.7
c792f37 
Update output for /v1/session/ endpoints to match output post Consul
1.7.0.

Documents new `NodeChecks` and `ServiceChecks` parameters which were
added in that release.

Resolves #7341, resolves #10095
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@freddygv freddygv

Labels
type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Update responses for /v1/session/ endpoints post 1.7 hashicorp/consul
2 participants
@johncowen @freddygv