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

Enhance protocol documentation #85

Merged
merged 2 commits into from Dec 24, 2021
Merged

Enhance protocol documentation #85

merged 2 commits into from Dec 24, 2021

Conversation

wchau
Copy link
Collaborator

@wchau wchau commented Nov 24, 2021

Added edge case details with non-negative and 0 max results, and existence of page token.
Fixed JSON formatting.
Identified int types.

https://github.com/delta-io/delta-sharing/blob/c44815eb6b1984e59216e9b7e88b3eeb1b7631db/PROTOCOL.md

PROTOCOL.md Show resolved Hide resolved
@wchau wchau requested a review from zsxwing November 29, 2021 20:23
@zhuansunxt
Copy link
Collaborator

I think the change overall looks pretty good. Two suggestions:

  1. Can we split the change to two PRs, one for error code and one for documentation improvement?
  2. Do you think it's better to add a dedicated response code section compared to having it for every API method?

@wchau
Copy link
Collaborator Author

wchau commented Dec 9, 2021

  1. Can we split the change to two PRs, one for error code and one for documentation improvement?

Done. See #98

  1. Do you think it's better to add a dedicated response code section compared to having it for every API method?

I am creating a poor man's version of DB's official API docs which follows the same format to try to be somewhat consistent. eg: https://docs.databricks.com/dev-tools/api/latest/account.html#operation/get-credential-configs

Copy link
Collaborator

@linzhou-db linzhou-db left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM, do we also want to cover the status code in the http response?
NVM, see #98

…Results, and nextPageToken details

Added response codes. Fixed formatting. Identified int types.

Change error_code to errorCode

ID

Details

ID

Drop details

Summary

200
Fix colons

Some formatting issues

.

.

.

.
@wchau wchau merged commit 0685f7f into delta-io:main Dec 24, 2021
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

Successfully merging this pull request may close these issues.

None yet

4 participants