API: add location create endpoint #368
Merged
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
jrwdunham
approved these changes
Jun 5, 2018
|
@sevein should merging this PR also involve adding to https://wiki.archivematica.org/Storage_Service_API? (This touches on the issue 369 which PR 370 aims to solve, but that's not ready so it's not entirely relevant yet.) |
2 tasks
Add new `POST /api/v2/location/` endpoint to enable creation of Location
instances given a known space and pipeline. The following is an example on how
it could be used:
Find a pipeline:
```shell
curl -s \
-H "Authorization: ApiKey test:test" \
-H "Content-Type: application/json" \
"http://127.0.0.1:62081/api/v2/pipeline/" | \
jq -r ".objects | .[0] | .resource_uri"
```
/api/v2/pipeline/90707555-244f-47af-8271-66496a6a965b/
Find a space:
```shell
curl -s \
-H "Authorization: ApiKey test:test" \
-H "Content-Type: application/json" \
"http://127.0.0.1:62081/api/v2/space/" | \
jq -r ".objects | .[0] | .resource_uri"
```
/api/v2/space/141593ff-2a27-44a1-9de1-917573fa0f4a/
Create new location:
```shell
curl -s -d '{
"pipeline": ["/api/v2/pipeline/90707555-244f-47af-8271-66496a6a965b/"],
"purpose": "TS",
"relative_path": "automated-workflow/foo/bar",
"description": "automated workflow",
"space": "/api/v2/space/141593ff-2a27-44a1-9de1-917573fa0f4a/"
}' \
-X POST \
-H "Authorization: ApiKey test:test" \
-H "Content-Type: application/json" \
"http://127.0.0.1:62081/api/v2/location/" | \
jq -r ".resource_uri"
```
/api/v2/location/693f8fa4-744a-4c8f-9e1f-275d422e3bad/
Inspect location:
```shell
curl -s \
-H "Authorization: ApiKey test:test" \
-H "Content-Type: application/json" \
"http://127.0.0.1:62081/api/v2/location/693f8fa4-744a-4c8f-9e1f-275d422e3bad/" | jq
```
```json
{
"description": "automated workflow",
"enabled": true,
"path": "/automated-workflow/foo/bar",
"pipeline": [
"/api/v2/pipeline/90707555-244f-47af-8271-66496a6a965b/"
],
"purpose": "TS",
"quota": null,
"relative_path": "automated-workflow/foo/bar",
"resource_uri": "/api/v2/location/693f8fa4-744a-4c8f-9e1f-275d422e3bad/",
"space": "/api/v2/space/141593ff-2a27-44a1-9de1-917573fa0f4a/",
"used": "0",
"uuid": "693f8fa4-744a-4c8f-9e1f-275d422e3bad"
}
```
This closes #367.
qubot
force-pushed
the
dev/issue-367-api-location-create
branch
from
3737682 to
9f813d7
Compare
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.
Add new
POST /api/v2/location/endpoint to enable creation of Locationinstances given a known space and pipeline. The following is an example on how
it could be used:
Find a pipeline:
curl -s \ -H "Authorization: ApiKey test:test" \ -H "Content-Type: application/json" \ "http://127.0.0.1:62081/api/v2/pipeline/" | \ jq -r ".objects | .[0] | .resource_uri"Find a space:
curl -s \ -H "Authorization: ApiKey test:test" \ -H "Content-Type: application/json" \ "http://127.0.0.1:62081/api/v2/space/" | \ jq -r ".objects | .[0] | .resource_uri"Create new location:
Inspect location:
curl -s \ -H "Authorization: ApiKey test:test" \ -H "Content-Type: application/json" \ "http://127.0.0.1:62081/api/v2/location/693f8fa4-744a-4c8f-9e1f-275d422e3bad/" | jq{ "description": "automated workflow", "enabled": true, "path": "/automated-workflow/foo/bar", "pipeline": [ "/api/v2/pipeline/90707555-244f-47af-8271-66496a6a965b/" ], "purpose": "TS", "quota": null, "relative_path": "automated-workflow/foo/bar", "resource_uri": "/api/v2/location/693f8fa4-744a-4c8f-9e1f-275d422e3bad/", "space": "/api/v2/space/141593ff-2a27-44a1-9de1-917573fa0f4a/", "used": "0", "uuid": "693f8fa4-744a-4c8f-9e1f-275d422e3bad" }This is connected to #367.