feat(ref): add VHAL HTTP API documentation #21
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
keirthana
pushed a commit
to keirthana/anbox-cloud-docs
that referenced
this pull request
Jan 17, 2024
Update the doc cheat sheet
adglkh
reviewed
Jan 17, 2024
ref/anbox-https-api.md
Outdated
| "metadata": { | ||
| "value": { | ||
| "area_id": 49, # Requested area. | ||
| "bytes": [], # Raw bytes value as an 8-bit unsigned integer array. |
There was a problem hiding this comment.
Same question I left on the MP, do we need to keep the field when its value is empty? Same for int32_values/int64_values and others.
There was a problem hiding this comment.
I will rework serialization in a follow-up MP.
For now, I prefer to have the documentation reflect what's actually in the code: if we omit the fields in the future, I will update the documentation and remove them (or explain that they may be omitted).
keirthana
requested changes
Jan 23, 2024
ajanon
force-pushed
the
vhal_http_api
branch
2 times, most recently
from
668d3db to
187b8ad
Compare
adglkh
approved these changes
Feb 2, 2024
ref/anbox-https-api.md
Outdated
| "metadata": { | ||
| "value": { | ||
| "area_id": 49, # Requested area. | ||
| "bytes": [], # Raw bytes value as an 8-bit unsigned integer array. |
ajanon
force-pushed
the
vhal_http_api
branch
from
187b8ad to
fc8524c
Compare
This adds VHAL endpoint documentation to the HTTP API docs based on the current version of the VHAL implementation.
ajanon
force-pushed
the
vhal_http_api
branch
from
fc8524c to
cd6d765
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds VHAL endpoint documentation to the HTTP API docs based on the current version of the VHAL implementation.