Add REST API docs #3376
Merged
Add REST API docs #3376
Conversation
This file contains 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
jfrohnhofen
approved these changes
Oct 24, 2018
docs/rest_api.md
Outdated
| #### Expects | ||
| - Optional GET parameter `isEditable=[BOOLEAN]` | ||
| - If true: list only users for which you can change team memberships | ||
| - If false: list only users for which you can not change team memberships |
There was a problem hiding this comment.
cannot
Suggested change
| - If false: list only users for which you can not change team memberships | |
| - If false: list only users for which you cannot change team memberships |
docs/rest_api.md
Outdated
| #### Expects | ||
| - Optional GET parameter `isEditable=[BOOLEAN]` | ||
| - If true: list only datasets you can edit | ||
| - If false: list only datasets you can not edit |
There was a problem hiding this comment.
Suggested change
| - If false: list only datasets you can not edit | |
| - If false: list only datasets you cannot edit |
docs/rest_api.md
Outdated
|
|
||
| #### Note | ||
|
|
||
| For each attached NML file, one task is created. This request will also return status code 200 if some tasks could not be created. Failed tasks are instead encoded in the JSON response |
There was a problem hiding this comment.
I don't get this. Above it says "Create tasks without attached NML files" but here we talk about NMLs?
| - JSON object with four optional fields: | ||
| - `"user"` `[STRING]` show only tasks on which the user with this id has worked | ||
| - `"project"` `[STRING]` show only tasks of the project with this name | ||
| - `"ids"` `[JSON LIST OF STRINGS]` show only tasks with these ids |
There was a problem hiding this comment.
Inconsistent with LIST[STRING] used above
|
note to self: also reduce indent of second point in task createFromFiles |
jfrohnhofen
added a commit
that referenced
this pull request
Nov 14, 2018
* master: remove -v (verbose) from backend-tests in CI (#3425) Add recommended configuration to TaskTypes (backend only) (#3415) Even if initialData is disabled, insert local stores (#3421) Add REST API docs (#3376) clearer message when annotation couldnt be found while logged out (#3413) prepare release 18.11.0 (#3414) Handle Cross-Datastore Duplicates, introducing scratch datastores (#3394) restrict user visibility (#3389) Add REST API versioning support (second try) (#3408) Enable hybrid tracings by default (#3399)
jfrohnhofen
added a commit
that referenced
this pull request
Nov 14, 2018
* isosurface: expose voxel dimensions as parameter, proper scale, #3313 remove -v (verbose) from backend-tests in CI (#3425) Add recommended configuration to TaskTypes (backend only) (#3415) Even if initialData is disabled, insert local stores (#3421) Add REST API docs (#3376) clearer message when annotation couldnt be found while logged out (#3413) prepare release 18.11.0 (#3414) Handle Cross-Datastore Duplicates, introducing scratch datastores (#3394) restrict user visibility (#3389) Add REST API versioning support (second try) (#3408) Enable hybrid tracings by default (#3399)
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.
Should be merged only after #3385 .
https://docs.webknossos.org/v/doc-rest-api/reference/rest_api
Issues:
[ ] Updated changelog[ ] Updated migration guide if applicable[ ] Needs datastore update after deployment