Skip to content

Commit

Permalink
Remove mentions to remote storages in docs (#5097)
Browse files Browse the repository at this point in the history
Co-authored-by: Simon Dumas <[email protected]>
  • Loading branch information
imsdu and Simon Dumas authored Aug 13, 2024
1 parent ca55762 commit 3a0152d
Show file tree
Hide file tree
Showing 37 changed files with 92 additions and 427 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
curl -X PUT \
-F "file=@/path/to/myfile.pdf;type=application/pdf" \
-H 'x-nxs-file-metadata: {"name": "My File"}' \
"http://localhost:8080/v1/files/myorg/myproject/myfile?storage=remote&tag=mytag"
"http://localhost:8080/v1/files/myorg/myproject/myfile?storage=s3&tag=mytag"
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
"_rev": 1,
"_self": "http://localhost:8080/v1/files/myorg/myproject/myfile",
"_storage": {
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote",
"@type": "RemoteDiskStorage",
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3",
"@type": "S3Storage",
"_rev": 1
},
"_updatedAt": "2021-05-12T07:30:54.576Z",
Expand Down
13 changes: 0 additions & 13 deletions docs/src/main/paradox/docs/delta/api/assets/files/link-post.json

This file was deleted.

16 changes: 0 additions & 16 deletions docs/src/main/paradox/docs/delta/api/assets/files/link-post.sh

This file was deleted.

11 changes: 0 additions & 11 deletions docs/src/main/paradox/docs/delta/api/assets/files/link-put.json

This file was deleted.

14 changes: 0 additions & 14 deletions docs/src/main/paradox/docs/delta/api/assets/files/link-put.sh

This file was deleted.

39 changes: 0 additions & 39 deletions docs/src/main/paradox/docs/delta/api/assets/files/linked-post.json

This file was deleted.

38 changes: 0 additions & 38 deletions docs/src/main/paradox/docs/delta/api/assets/files/linked-put.json

This file was deleted.

8 changes: 4 additions & 4 deletions docs/src/main/paradox/docs/delta/api/assets/files/listed.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
"_rev": 2,
"_self": "http://localhost:8080/v1/files/myorg/myproject/9ca0d270-35f0-4369-9c17-296fe36fd9a5",
"_storage": {
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote",
"@type": "RemoteDiskStorage",
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3",
"@type": "S3Storage",
"_rev": 1
},
"_updatedAt": "2021-05-12T07:56:48.380Z",
Expand Down Expand Up @@ -84,8 +84,8 @@
"_rev": 2,
"_self": "http://localhost:8080/v1/files/myorg/myproject/mylink",
"_storage": {
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote",
"@type": "RemoteDiskStorage",
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3",
"@type": "S3Storage",
"_rev": 1
},
"_updatedAt": "2021-05-12T08:00:40.790Z",
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/paradox/docs/delta/api/assets/files/sse.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/files.json"],"@type":"FileCreated","_attributes":{"_bytes":1658857,"_digest":{"_value":""},"_filename":"myfile.png","_location":"file:///tmp/test/nexus/myorg/myproject/3/4/c/4/9/1/a/1/myfile.png","_mediaType":"image/png","_origin":"Storage","_uuid":"34c491a1-17ba-4726-bdf2-3b4e1e150750"},"_fileId":"http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5","_instant":"2021-05-12T07:56:42.991Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5","_rev":1,"_storage":{"@id":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","@type":"RemoteDiskStorage","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_rev":1},"_subject":"http://localhost:8080/v1/anonymous"}
data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/files.json"],"@type":"FileCreated","_attributes":{"_bytes":1658857,"_digest":{"_value":""},"_filename":"myfile.png","_location":"file:///tmp/test/nexus/myorg/myproject/3/4/c/4/9/1/a/1/myfile.png","_mediaType":"image/png","_origin":"Storage","_uuid":"34c491a1-17ba-4726-bdf2-3b4e1e150750"},"_fileId":"http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5","_instant":"2021-05-12T07:56:42.991Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5","_rev":1,"_storage":{"@id":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","@type":"S3Storage","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_rev":1},"_subject":"http://localhost:8080/v1/anonymous"}
event:FileCreated
id:9750c010-b2f7-11eb-96af-ed7fe24c2ccf

data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/files.json"],"@type":"FileAttributesUpdated","_bytes":1658857,"_digest":{"_algorithm":"SHA-256","_value":"e88fd2d76dd7c1a144c68e89a38c972251623dacf4c898154aae4c3b03eb4a84"},"_fileId":"http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5","_instant":"2021-05-12T07:56:48.380Z","_mediaType":"image/png","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/9ca0d270-35f0-4369-9c17-296fe36fd9a5","_rev":2,"_subject":"http://localhost:8080/v1/anonymous"}
event:FileAttributesUpdated
id:9a8229e0-b2f7-11eb-96af-ed7fe24c2ccf

data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/files.json"],"@type":"FileCreated","_attributes":{"_bytes":1658857,"_digest":{"_value":""},"_filename":"myfile2.png","_location":"file:///tmp/test/nexus/myorg/myproject/6/6/0/4/9/9/d/9/myfile2.png","_origin":"Storage","_uuid":"660499d9-c522-4f90-beda-2d79e538ffce"},"_fileId":"http://localhost:8080/v1/resources/myorg/myproject/_/mylink","_instant":"2021-05-12T08:00:34.563Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/mylink","_rev":1,"_storage":{"@id":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","@type":"RemoteDiskStorage","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/remote","_rev":1},"_subject":"http://localhost:8080/v1/anonymous"}
data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/files.json"],"@type":"FileCreated","_attributes":{"_bytes":1658857,"_digest":{"_value":""},"_filename":"myfile2.png","_location":"file:///tmp/test/nexus/myorg/myproject/6/6/0/4/9/9/d/9/myfile2.png","_origin":"Storage","_uuid":"660499d9-c522-4f90-beda-2d79e538ffce"},"_fileId":"http://localhost:8080/v1/resources/myorg/myproject/_/mylink","_instant":"2021-05-12T08:00:34.563Z","_project":"http://localhost:8080/v1/projects/myorg/myproject","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/mylink","_rev":1,"_storage":{"@id":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","@type":"S3Storage","_resourceId":"http://localhost:8080/v1/resources/myorg/myproject/_/s3","_rev":1},"_subject":"http://localhost:8080/v1/anonymous"}
event:FileCreated
id:21564eb0-b2f8-11eb-96af-ed7fe24c2ccf

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"@type": "RemoteDiskStorage",
"@type": "S3Storage",
"default": false,
"folder": "test"
"bucket": "test"
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
curl -X PUT \
-H "Content-Type: application/json" \
"http://localhost:8080/v1/storages/myorg/myproject/remote" -d \
"http://localhost:8080/v1/storages/myorg/myproject/s3" -d \
'{
"@type": "RemoteDiskStorage",
"@type": "S3Storage",
"default": false,
"folder": "test"
"bucket": "test"
}'
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,20 @@
"https://bluebrain.github.io/nexus/contexts/storages-metadata.json",
"https://bluebrain.github.io/nexus/contexts/metadata.json"
],
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote",
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3",
"@type": [
"Storage",
"RemoteDiskStorage"
"S3Storage"
],
"_algorithm": "SHA-256",
"_constrainedBy": "https://bluebrain.github.io/nexus/schemas/storages.json",
"_createdAt": "2021-05-11T12:22:19.195Z",
"_createdBy": "http://localhost:8080/v1/anonymous",
"_deprecated": false,
"_incoming": "http://localhost:8080/v1/storages/myorg/myproject/remote/incoming",
"_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/remote/outgoing",
"_incoming": "http://localhost:8080/v1/storages/myorg/myproject/s3/incoming",
"_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/s3/outgoing",
"_project": "http://localhost:8080/v1/projects/myorg/myproject",
"_rev": 1,
"_self": "http://localhost:8080/v1/storages/myorg/myproject/remote",
"_self": "http://localhost:8080/v1/storages/myorg/myproject/s3",
"_updatedAt": "2021-05-11T12:22:19.195Z",
"_updatedBy": "http://localhost:8080/v1/anonymous"
}
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
curl -X DELETE \
"http://localhost:8080/v1/storages/myorg/myproject/remote?rev=3"
"http://localhost:8080/v1/storages/myorg/myproject/s3?rev=3"
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,20 @@
"https://bluebrain.github.io/nexus/contexts/storages-metadata.json",
"https://bluebrain.github.io/nexus/contexts/metadata.json"
],
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote",
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3",
"@type": [
"Storage",
"RemoteDiskStorage"
"S3Storage"
],
"_algorithm": "SHA-256",
"_constrainedBy": "https://bluebrain.github.io/nexus/schemas/storages.json",
"_createdAt": "2021-05-11T12:22:19.195Z",
"_createdBy": "http://localhost:8080/v1/anonymous",
"_deprecated": true,
"_incoming": "http://localhost:8080/v1/storages/myorg/myproject/remote/incoming",
"_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/remote/outgoing",
"_incoming": "http://localhost:8080/v1/storages/myorg/myproject/s3/incoming",
"_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/s3/outgoing",
"_project": "http://localhost:8080/v1/projects/myorg/myproject",
"_rev": 4,
"_self": "http://localhost:8080/v1/storages/myorg/myproject/remote",
"_self": "http://localhost:8080/v1/storages/myorg/myproject/s3",
"_updatedAt": "2021-05-11T12:29:27.821Z",
"_updatedBy": "http://localhost:8080/v1/anonymous"
}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
curl "http://localhost:8080/v1/storages/myorg/myproject/remote/source"
curl "http://localhost:8080/v1/storages/myorg/myproject/s3/source"
Original file line number Diff line number Diff line change
@@ -1 +1 @@
curl "http://localhost:8080/v1/storages/myorg/myproject/remote/statistics"
curl "http://localhost:8080/v1/storages/myorg/myproject/s3/statistics"
Original file line number Diff line number Diff line change
@@ -1 +1 @@
curl "http://localhost:8080/v1/storages/myorg/myproject/remote"
curl "http://localhost:8080/v1/storages/myorg/myproject/s3"
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"@type": "RemoteDiskStorage",
"@type": "S3Storage",
"default": false,
"folder": "test-updated"
"bucket": "test-updated"
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,24 @@
"https://bluebrain.github.io/nexus/contexts/storages.json",
"https://bluebrain.github.io/nexus/contexts/metadata.json"
],
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote",
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3",
"@type": [
"Storage",
"RemoteDiskStorage"
"S3Storage"
],
"default": false,
"folder": "test-updated",
"maxFileSize": 10737418240,
"bucket": "test-updated",
"readPermission": "resources/read",
"writePermission": "files/write",
"_algorithm": "SHA-256",
"_constrainedBy": "https://bluebrain.github.io/nexus/schemas/storages.json",
"_createdAt": "2021-05-11T12:22:19.195Z",
"_createdBy": "http://localhost:8080/v1/anonymous",
"_deprecated": true,
"_incoming": "http://localhost:8080/v1/storages/myorg/myproject/remote/incoming",
"_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/remote/outgoing",
"_incoming": "http://localhost:8080/v1/storages/myorg/myproject/s3/incoming",
"_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/s3/outgoing",
"_project": "http://localhost:8080/v1/projects/myorg/myproject",
"_rev": 4,
"_self": "http://localhost:8080/v1/storages/myorg/myproject/remote",
"_self": "http://localhost:8080/v1/storages/myorg/myproject/s3",
"_updatedAt": "2021-05-11T12:29:27.821Z",
"_updatedBy": "http://localhost:8080/v1/anonymous"
}
11 changes: 5 additions & 6 deletions docs/src/main/paradox/docs/delta/api/assets/storages/listed.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,21 +45,20 @@
"_updatedBy": "http://localhost:8080/v1/anonymous"
},
{
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/remote",
"@id": "http://localhost:8080/v1/resources/myorg/myproject/_/s3",
"@type": [
"Storage",
"RemoteDiskStorage"
"S3Storage"
],
"_algorithm": "SHA-256",
"_constrainedBy": "https://bluebrain.github.io/nexus/schemas/storages.json",
"_createdAt": "2021-05-11T12:22:19.195Z",
"_createdBy": "http://localhost:8080/v1/anonymous",
"_deprecated": true,
"_incoming": "http://localhost:8080/v1/storages/myorg/myproject/remote/incoming",
"_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/remote/outgoing",
"_incoming": "http://localhost:8080/v1/storages/myorg/myproject/s3/incoming",
"_outgoing": "http://localhost:8080/v1/storages/myorg/myproject/s3/outgoing",
"_project": "http://localhost:8080/v1/projects/myorg/myproject",
"_rev": 4,
"_self": "http://localhost:8080/v1/storages/myorg/myproject/remote",
"_self": "http://localhost:8080/v1/storages/myorg/myproject/s3",
"_updatedAt": "2021-05-11T12:29:27.821Z",
"_updatedBy": "http://localhost:8080/v1/anonymous"
}
Expand Down
Loading

0 comments on commit 3a0152d

Please sign in to comment.