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.

Sign up for GitHub

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

Jump to bottom

Fully document the REST-API #3

Open
schloett opened this issue Jun 19, 2015 · 2 comments
Open

Fully document the REST-API #3

schloett opened this issue Jun 19, 2015 · 2 comments
Assignees
@hziak

Comments

@schloett
Copy link

Please document the API in such a way, that an external developer is able to work with it. At the moment, the description is based on an example for request and response. For developers, who are not involved in EEXCESS (and partially even for those), it is almost impossible to figure out the meaning and effect of the particular attributes. Moreover, the range of expected values is unclear for example at the attribute "timeRange".
In addition, it would be nice to have URLs of the servers available.
@hziak
Copy link
Contributor

hziak commented Jun 23, 2015

added comments to the fields and explained possible implications

@hziak hziak closed this as completed Jun 23, 2015
@schloett
Copy link
Author

The documentation does not seem to be sufficient yet. See #10, #32 or EEXCESS/eexcess#11 for example.

@schloett schloett reopened this Nov 18, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hziak hziak

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@schloett @hziak