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

Distinguish modules and endpoints #100

Open
dariok opened this issue Feb 22, 2018 · 0 comments
Open

Distinguish modules and endpoints #100

dariok opened this issue Feb 22, 2018 · 0 comments
Labels
needs testing Test changes in realistic conditions (possibly prepare CI tests) project specifics REST
Milestone

Comments

@dariok
Copy link
Owner

dariok commented Feb 22, 2018

Everything that is regularly and/or programatically queried (be it from the outside or by the app itself) should be implemented by ways of a RESTful endpoint (stored in edoc/rest).
This endpoint should get its data either directly from the DB or by making use of a module (stored in edoc/modules).

The representations are to be assembled by the REST script while the logic to do so may either be stored in the REST script (if it is static and global) or be provided by a module (usually by project.xqm if it can be project specific). In many cases, a standard representation hard coded into the REST script will be the fallback to a project specific script.

@dariok dariok changed the title Module, XQL konsolidieren Distinguish modules and endpoints Feb 18, 2019
@dariok dariok added this to the v2.0 milestone Feb 18, 2019
@dariok dariok added the needs testing Test changes in realistic conditions (possibly prepare CI tests) label Apr 18, 2019
@dariok dariok modified the milestones: v2.0, 1.5 May 24, 2019
dariok added a commit that referenced this issue Oct 28, 2019
@dariok dariok linked a pull request Dec 15, 2022 that will close this issue
@dariok dariok removed a link to a pull request Dec 18, 2022
@dariok dariok modified the milestones: v 2.0, v3 Dec 18, 2022
@dariok dariok modified the milestones: Release v4, REST v2 Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs testing Test changes in realistic conditions (possibly prepare CI tests) project specifics REST
Projects
None yet
Development

No branches or pull requests

1 participant