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.

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

Revisit and Improve documentation on Refresh and Update endpoints #95

Open
james-rae opened this issue May 31, 2018 · 2 comments
Open
Assignees

Comments

@james-rae
Copy link
Member

In the Service Contract , revist the documentation around refresh and update (and compare against the code).

In particular:

  • update doc claims it has no request body, but this does not appear to be the case. add param and details around the param if required.
  • if refresh is just calling update against a batch of keys, indicate that
@barryytm
Copy link
Collaborator

barryytm commented Jun 4, 2018

After taken a look at the codes. Here are a couple things that I've concluded and please correct me if I am wrong.

  • update does has a request body and even Request Params indicated that, it appeared to be just a small mistake in the docs. service_type is the only mandatory field/param in update that was being used.
  • refresh is not calling update but rather recreating the nodes against the registered keys.

@barryytm
Copy link
Collaborator

barryytm commented Jun 4, 2018

Just to clarify. update also uses any other fields that require updating on a pre-registered entry as mentioned in the service contract but they are not required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants