Both sides previous revisionPrevious revisionNext revision | Previous revision |
wiki:rest-api-specs [2016/10/28 18:02] – ↷ Page name changed from wiki:api-perl to wiki:rest-api-specs neyron | wiki:rest-api-specs [2016/11/06 23:16] (current) – neyron |
---|
Details OAR 2 Perl rest-api | ===== OAR 2 Perl REST API ===== |
==== Jobs ==== | ==== Jobs ==== |
| |
* GET ''^/jobs/(\d+)(/details)*(\.yaml|\.json|\.html)*$'' | * GET ''^/jobs/(\d+)(/details)*(\.yaml|\.json|\.html)*$'' |
* GET ''^/jobs/(\d+)/(resources|nodes)(\.yaml|\.json|\.html)*$'' | * GET ''^/jobs/(\d+)/(resources|nodes)(\.yaml|\.json|\.html)*$'' |
* GET ''^/jobs/(\d+)/extratime(\.yaml|\.json|\.html)?$'' | |
* POST ''^/jobs/(\d+)/extratime(\.yaml|\.json|\.html)?$'' | |
* POSTDATA | |
* delay_next_jobs = YES | NO | |
* duration = seconds | |
* POST ''^/jobs/(array/|)(\d+)/(checkpoints|deletions|holds|rholds|resumptions|resubmissions)+/new(\.yaml|\.json|\.html)*$'' | * POST ''^/jobs/(array/|)(\d+)/(checkpoints|deletions|holds|rholds|resumptions|resubmissions)+/new(\.yaml|\.json|\.html)*$'' |
* POST ''^/jobs/(\d+)(\.yaml|\.json|\.html)*$'' | * POST ''^/jobs/(\d+)(\.yaml|\.json|\.html)*$'' |
| |
* GET ''^/colmet/job/(\d+)$'' | * GET ''^/colmet/job/(\d+)$'' |
| |
| ===== Howto write a REST API ===== |
| * http://blog.mwaysolutions.com/2014/06/05/10-best-practices-for-better-restful-api/ |
| * https://github.com/WhiteHouse/api-standards |
| * http://blog.octo.com/en/design-a-rest-api/ |
| * http://www.restapitutorial.com/resources.html |
| * https://blog.philipphauer.de/restful-api-design-best-practices/ |
| * https://stormpath.com/blog/fundamentals-rest-api-design |
| * http://gaboesquivel.com/blog/2015/best-practices-for-designing-web-apis/ |
| * https://geemus.gitbooks.io/http-api-design/content/en/index.html |