HTTP API: Schema endpoint #736
Open
Conversation
This file contains hidden or 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
|
Deploy Preview Available Via |
19 tasks
Simran-B
requested changes
Jul 3, 2025
| - Schema | ||
| ``` | ||
|
|
||
| **Examples** |
There was a problem hiding this comment.
Please see existing content how to use ```curl blocks for generated examples. You basically need to write an arangosh script that generates some minimal data and then use special functions for outputting request to be displayed in the docs.
There was a problem hiding this comment.
I added curl blocks for all 4 endpoints, but how can I verify the commands would be compiled correctly? And, should I add more examples? Or, are the examples too specific?
* reworked graphml documentation * fix merge related errors * Apply suggestions from code review Co-authored-by: Simran <[email protected]> * review * minor changes * review --------- Co-authored-by: Simran <[email protected]>
#737) * Fix API call recording OpenAPI description and release notes * Apply to 3.13 * Upper-case requestType in responses
* Update for UI changes * Add Canvas Actions * Fix links * fix typo --------- Co-authored-by: Paula Mihu <[email protected]>
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.
Description
Add a docs-hugo for new schema endpoints:
/schema,/schema/graph/{graph-name},/schema/view/{view-name},/schema/collection/{collection-name}.Includes query parameters (
sampleNum,exampleNum) and examples of http requests and responses.Upstream PRs