Skip to content
This repository has been archived by the owner on Jan 20, 2023. It is now read-only.

Define generic api between front-end and mid/back #4

Open
grtjn opened this issue Oct 10, 2019 · 1 comment
Open

Define generic api between front-end and mid/back #4

grtjn opened this issue Oct 10, 2019 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@grtjn
Copy link
Contributor

grtjn commented Oct 10, 2019

We need to add OpenAPI spec for data fetched from backend to be used in the graph component. Maybe just spelling out the visjs format is enough, or maybe wrapped to allow adding some extra info. We should also spell out what requests can be sent from front-end, preferable as generic as possible as well. The format should not care about origin of the graph data, nor about what logic to use to collect the data. The backend (or middle-tier probably) should just know..

@grtjn grtjn added the enhancement New feature or request label Oct 10, 2019
@grtjn grtjn added this to the code-refactoring milestone Oct 10, 2019
@grtjn
Copy link
Contributor Author

grtjn commented Oct 11, 2019

It would be nice if the api would be embedded into the existing api somehow. One could imagine there is a /api/crud/{type}/{docid}/graph, and a /api/search/{type}/graph endpoint. The first would take the iri derived from docid as starting point, the latter would use a search to come up with the initial iris. Both could take extra params for expanding after initial call.

Note: prefer POST over GET. POST body is protected by https, and can hold more info.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant