|
|
* Features to have:
|
|
|
# Features to have:
|
|
|
|
|
|
1. Effective bulk operations: with http v2, will require httpv2 development for HED, this feature can be postponed
|
|
|
2. Support for versioning: via url paths like https://arc.zero:443/arex/rest/v1.0/info
|
... | ... | @@ -11,37 +11,37 @@ |
|
|
9. support different response formats: html, xml and later json
|
|
|
|
|
|
|
|
|
* Design basics.
|
|
|
# Design basics.
|
|
|
|
|
|
Functionality as resource.
|
|
|
## Functionality as resource.
|
|
|
Access to general functionality of the CE through URL :
|
|
|
<base URL>/cluster
|
|
|
Operations:
|
|
|
- retrieve generic information about cluster (GET command)
|
|
|
|
|
|
Delegation functionality:
|
|
|
## Delegation functionality:
|
|
|
<base URL>/delegation
|
|
|
- Initiate delegation, perform delegation (POST or GET/PUT combination)
|
|
|
|
|
|
Delegation as resource
|
|
|
## Delegation as resource
|
|
|
<base URL>/delegation/<delegation id>
|
|
|
- Update delegation (method?)
|
|
|
|
|
|
Job control functionality:
|
|
|
## Job control functionality:
|
|
|
<base URL>/jobs
|
|
|
- Initiate new job(s) (POST, should PUT into subdir also create new job?)
|
|
|
|
|
|
Job as resource. Each job is represented by URL
|
|
|
## Job as resource. Each job is represented by URL
|
|
|
<base URL>/jobs/<job id>
|
|
|
- Modify job - cancel, pause, resume (POST, similar to new job creation?)
|
|
|
- Clean job (DELETE)
|
|
|
|
|
|
Sub-resources of the job.
|
|
|
Session directory:
|
|
|
## Sub-resources of the job.
|
|
|
### Session directory:
|
|
|
<base URL>/jobs/<job id>/session
|
|
|
- store, modify, retrieve files in session directory (PUT, GET, DELETE, maybe use POST for altering part of the file?)
|
|
|
|
|
|
Information about job:
|
|
|
### Information about job:
|
|
|
<base URL>/jobs/<job id>/info/<information type>
|
|
|
- just follow controldir layout
|
|
|
- read-only.
|
... | ... | @@ -49,38 +49,39 @@ Information about job: |
|
|
Information about all jobs of a cluster (for a job monitor):
|
|
|
TO BE DISCUSSED
|
|
|
|
|
|
* Web browser compatibility - GET with "Accept: text/html" on each resource returns HTML with some useful information.
|
|
|
## Web browser compatibility
|
|
|
GET with "Accept: text/html" on each resource returns HTML with some useful information.
|
|
|
|
|
|
|
|
|
* Definitions of job control operations
|
|
|
# Definitions of job control operations
|
|
|
|
|
|
** Submit job
|
|
|
## Submit job
|
|
|
|
|
|
** Cancel job
|
|
|
## Cancel job
|
|
|
|
|
|
** Pause job
|
|
|
## Pause job
|
|
|
|
|
|
** Resume job
|
|
|
## Resume job
|
|
|
|
|
|
** Restart job
|
|
|
## Restart job
|
|
|
|
|
|
** Delete job
|
|
|
## Delete job
|
|
|
|
|
|
** Access job information
|
|
|
## Access job information
|
|
|
|
|
|
* Definitions of job data access operations
|
|
|
# Definitions of job data access operations
|
|
|
|
|
|
** Store file
|
|
|
## Store file
|
|
|
|
|
|
** Read file
|
|
|
## Read file
|
|
|
|
|
|
** Modify file
|
|
|
## Modify file
|
|
|
|
|
|
* Definition of delegation operation
|
|
|
# Definition of delegation operation
|
|
|
|
|
|
** Create new delegation
|
|
|
## Create new delegation
|
|
|
|
|
|
** Update existng delegation
|
|
|
## Update existng delegation
|
|
|
|
|
|
** Access delegation metadata
|
|
|
## Access delegation metadata
|
|
|
|