Skip to content
Snippets Groups Projects
Commit 538c8134 authored by Yan Grange's avatar Yan Grange :wave:
Browse files

Merge branch 'update_doc_link' into 'master'

Update API documentation link

See merge request !6
parents 7c8234fe 1c376470
Branches master
No related tags found
1 merge request!6Update API documentation link
......@@ -7,7 +7,7 @@ If you use (part of) this software please attribute the use to ASTRON as indicat
Current released version 2.0 (master) is to be used with the new LTA stager (stageit), it is not backwards compatible with the old LTA stager. Older versions of this script (i.e., 1.7 and older) have become obsolete.
* User documentation for stageit can be found at: https://support.astron.nl/confluence/display/SDCP/User+documentation
* User documentation for stageit can be found at: https://sdc.astron.nl/stageit/static/documentation/docs/user-guide/advanced/api
* Release 2.0 can be found at: https://git.astron.nl/astron-sdc/lofar_stager_api/-/releases/2.0
## Version 2.0 (current) usage notes
......@@ -22,3 +22,13 @@ Usage notes:
- remove the old username and password from the `.stagingrc` file
- The script is Python2 compatible, there is a Dockerfile available for Python2 testing in `./tests/docker`
- The requests library is a required dependency. If you care about Python2 compatability, you can use at most version 2.22.0 of requests. Otherwise, you can install any version (note: you can also `pip install -r 'requirements.txt'`, which will install version 2.22.0)
### Deprecated functions: Due to changes in the backend, some functions have been deprecated. Those can be called, but this will result in a warning and raise a `NotImplementedError`. The following tables shows the functions together with the rationale to deprecate them:
|function | reason |
| ------------- | ------------- |
| get_stuck_requests(min_retries, days_without_activity) | `stuck` status does not exist anymore |
| reschedule_on_status() | failed jobs reschedule automatically for a few times before failing, manual reschedule still possible|
| get_storage_info() | this is not really user functionality and has been superseded by views for the operators |
| reschedule_on_hold() | `on hold` status does not exist anymore |
| print_on_hold() | `on hold` status does not exist anymore |
| reschedule_aborted() | `aborted` status does not exist anymore |
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment