Skip to content

Conversation

knakatasf
Copy link

@knakatasf knakatasf commented Jul 3, 2025

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.

TODO: Clarify that GET /_api/schema only returns information about collections that are used in Views and graphs.

Upstream PRs

  • 3.10:
  • 3.11:
  • 3.12:
  • 3.13:

Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-736--docs-hugo.netlify.app

@cla-bot cla-bot bot added the cla-signed label Jul 3, 2025
@Simran-B Simran-B changed the title Http api schema endpoint HTTP API: Schema endpoint Jul 3, 2025
@Simran-B Simran-B added this to the 3.12.6 milestone Jul 8, 2025
nerpaula and others added 4 commits July 9, 2025 00:55
* 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants