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

docs: Added gateway API http end-point info #89

Merged
merged 7 commits into from
Nov 4, 2024
Merged

Conversation

jot2re
Copy link
Contributor

@jot2re jot2re commented Oct 30, 2024

Added detailed information about the HTTP endpoints on the gateway.

This closes #1314 as there are not really any direct gRPC end-points. Other requests are instead handled by a connector.

@jot2re jot2re added the documentation Improvements or additions to documentation label Oct 30, 2024
Copy link

@titouantanguy titouantanguy left a comment

Choose a reason for hiding this comment

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

Very nice to have !
I guess it lacks everything that's not HTTP request, but maybe it's due for another PR? (or maybe it's slightly less urgent, as that's not directly exposed to end users)

Mostly minor typos except for reencryption where I believe there are a couple mistakes ?

Also, should it say what's the default port of the http server (and where to change it ?)

docs/references/gateway_api.md Show resolved Hide resolved
docs/references/gateway_api.md Outdated Show resolved Hide resolved
docs/references/gateway_api.md Show resolved Hide resolved
docs/references/gateway_api.md Outdated Show resolved Hide resolved
docs/references/gateway_api.md Outdated Show resolved Hide resolved
docs/references/gateway_api.md Outdated Show resolved Hide resolved
docs/references/gateway_api.md Outdated Show resolved Hide resolved
docs/references/gateway_api.md Outdated Show resolved Hide resolved
docs/references/gateway_api.md Outdated Show resolved Hide resolved
docs/references/gateway_api.md Outdated Show resolved Hide resolved
@jot2re jot2re requested a review from titouantanguy October 31, 2024 17:40
@jot2re
Copy link
Contributor Author

jot2re commented Oct 31, 2024

@titouantanguy there is only one other access point, which is decryption. It stems from the fhevm (connector on their side) which I have a hard time to follow. I add a separate issue for this here

@jot2re jot2re merged commit f4e6add into main Nov 4, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants