Skip to content

Commit

Permalink
deploy: 4b66f7d
Browse files Browse the repository at this point in the history
  • Loading branch information
shinyhappydan committed Sep 26, 2023
1 parent 86b4cbc commit 61a8cca
Show file tree
Hide file tree
Showing 100 changed files with 2,416 additions and 111 deletions.
2 changes: 1 addition & 1 deletion paradox.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"name" : "docs",
"version" : "0.0.0+1-64304504+20230913-1250-SNAPSHOT"
"version" : "0.0.0+1-64304504+20230926-1241-SNAPSHOT"
}
3 changes: 1 addition & 2 deletions snapshot/contexts/elasticsearch-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
"View": "https://bluebrain.github.io/nexus/vocabulary/View",
"ElasticSearchView": "https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView",
"AggregateElasticSearchView": "https://bluebrain.github.io/nexus/vocabulary/AggregateElasticSearchView",
"_uuid": "https://bluebrain.github.io/nexus/vocabulary/uuid",
"_indexingRev": "https://bluebrain.github.io/nexus/vocabulary/indexingRev"
"_uuid": "https://bluebrain.github.io/nexus/vocabulary/uuid"
},
"@id": "https://bluebrain.github.io/nexus/contexts/elasticsearch-metadata.json"
}
3 changes: 1 addition & 2 deletions snapshot/contexts/elasticsearch.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@
"viewId": {
"@type": "@id"
},
"_uuid": "https://bluebrain.github.io/nexus/vocabulary/uuid",
"_indexingRev": "https://bluebrain.github.io/nexus/vocabulary/indexingRev"
"_uuid": "https://bluebrain.github.io/nexus/vocabulary/uuid"
},
"https://bluebrain.github.io/nexus/contexts/pipeline.json"
],
Expand Down
9 changes: 9 additions & 0 deletions snapshot/contexts/remote-contexts.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"@context": {
"@vocab": "https://bluebrain.github.io/nexus/vocabulary/",
"remoteContexts": {
"@container": "@set"
}
},
"@id": "https://bluebrain.github.io/nexus/contexts/remote-contexts.json"
}
8 changes: 6 additions & 2 deletions snapshot/docs/delta/api/acls-api.html
Original file line number Diff line number Diff line change
Expand Up @@ -197,12 +197,15 @@
<li><a href="../../../docs/delta/api/permissions-api.html" class="page">Permissions</a></li>
<li><a href="../../../docs/delta/api/realms-api.html" class="page">Realms</a></li>
<li><a href="../../../docs/delta/api/acls-api.html" class="active page">Access Control Lists</a></li>
<li><a href="../../../docs/delta/api/user-permissions-api.html" class="page">User Permissions</a></li>
<li><a href="../../../docs/delta/api/orgs-api.html" class="page">Organizations</a></li>
<li><a href="../../../docs/delta/api/projects-api.html" class="page">Projects</a></li>
<li><a href="../../../docs/delta/api/quotas.html" class="page">Quotas</a></li>
<li><a href="../../../docs/delta/api/schemas-api.html" class="page">Schemas</a></li>
<li><a href="../../../docs/delta/api/resources-api.html" class="page">Resources</a></li>
<li><a href="../../../docs/delta/api/trial.html" class="page">Trial</a></li>
<li><a href="../../../docs/delta/api/multi-fetch.html" class="page">Multi fetch</a></li>
<li><a href="../../../docs/delta/api/id-resolution.html" class="page">Id Resolution</a></li>
<li><a href="../../../docs/delta/api/resolvers-api.html" class="page">Resolvers</a></li>
<li><a href="../../../docs/delta/api/views/index.html" class="page">Views</a>
<ul>
Expand All @@ -222,6 +225,7 @@
<li><a href="../../../docs/delta/api/events-api.html" class="page">Global events</a></li>
<li><a href="../../../docs/delta/api/supervision-api.html" class="page">Supervision</a></li>
</ul></li>
<li><a href="../../../docs/delta/metadata.html" class="page">Nexus Metadata</a></li>
<li><a href="../../../docs/delta/plugins/index.html" class="page">Plugins</a></li>
<li><a href="../../../docs/delta/benchmarks/index.html" class="page">Benchmarks</a>
<ul>
Expand Down Expand Up @@ -1033,13 +1037,13 @@ <h2><a href="#acl-server-sent-events" name="acl-server-sent-events" class="ancho
</span>
</div>
</a>
<a href="../../../docs/delta/api/orgs-api.html" title="Organizations" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="../../../docs/delta/api/user-permissions-api.html" title="User Permissions" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Organizations
User Permissions
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
Expand Down
31 changes: 15 additions & 16 deletions snapshot/docs/delta/api/archives-api.html
Original file line number Diff line number Diff line change
Expand Up @@ -197,12 +197,15 @@
<li><a href="../../../docs/delta/api/permissions-api.html" class="page">Permissions</a></li>
<li><a href="../../../docs/delta/api/realms-api.html" class="page">Realms</a></li>
<li><a href="../../../docs/delta/api/acls-api.html" class="page">Access Control Lists</a></li>
<li><a href="../../../docs/delta/api/user-permissions-api.html" class="page">User Permissions</a></li>
<li><a href="../../../docs/delta/api/orgs-api.html" class="page">Organizations</a></li>
<li><a href="../../../docs/delta/api/projects-api.html" class="page">Projects</a></li>
<li><a href="../../../docs/delta/api/quotas.html" class="page">Quotas</a></li>
<li><a href="../../../docs/delta/api/schemas-api.html" class="page">Schemas</a></li>
<li><a href="../../../docs/delta/api/resources-api.html" class="page">Resources</a></li>
<li><a href="../../../docs/delta/api/trial.html" class="page">Trial</a></li>
<li><a href="../../../docs/delta/api/multi-fetch.html" class="page">Multi fetch</a></li>
<li><a href="../../../docs/delta/api/id-resolution.html" class="page">Id Resolution</a></li>
<li><a href="../../../docs/delta/api/resolvers-api.html" class="page">Resolvers</a></li>
<li><a href="../../../docs/delta/api/views/index.html" class="page">Views</a>
<ul>
Expand All @@ -222,6 +225,7 @@
<li><a href="../../../docs/delta/api/events-api.html" class="page">Global events</a></li>
<li><a href="../../../docs/delta/api/supervision-api.html" class="page">Supervision</a></li>
</ul></li>
<li><a href="../../../docs/delta/metadata.html" class="page">Nexus Metadata</a></li>
<li><a href="../../../docs/delta/plugins/index.html" class="page">Plugins</a></li>
<li><a href="../../../docs/delta/benchmarks/index.html" class="page">Benchmarks</a>
<ul>
Expand Down Expand Up @@ -288,14 +292,13 @@
</div>
<div class="md-content__searchable">
<h1><a href="#archives" name="archives" class="anchor"><span class="anchor-link"></span></a>Archives</h1>
<p>An archive is a collection of resources stored inside an archive file. The archiving format chosen for this purpose is tar (or tarball). Archive resources are rooted in the <code>/v1/archives/{org_label}/{project_label}/</code> collection.</p>
<p>An archive is a collection of resources stored inside an archive file. The archiving format chosen for this purpose is ZIP. Archive resources are rooted in the <code>/v1/archives/{org_label}/{project_label}/</code> collection.</p>
<p>Each archive&hellip; </p>
<ul>
<li>belongs to a <code>project</code> identifier by the label <code>{project_label}</code></li>
<li>inside an <code>organization</code> identifier by the label <code>{org_label}</code></li>
</ul><div class="callout note tip"><div class="callout-title">Authorization notes</div>
<p>When modifying archives, the caller must have <code>archives/write</code> permissions on the current path of the project or the ancestor paths.</p>
<p>When reading archives, the caller must have <code>resources/read</code> permissions on the current path of the project or the ancestor paths.</p>
<p>For both reading and modifying archives, the caller must have <code>resources/read</code> permissions on the current path of the project or the ancestor paths.</p>
<p>Please visit <a href="authentication.html">Authentication &amp; authorization</a> section to learn more about it.</p></div>
<h2><a href="#lifecycle" name="lifecycle" class="anchor"><span class="anchor-link"></span></a>Lifecycle</h2>
<p>Contrarily to the rest of the platform resources, archives are not persisted resources, given their nature. Therefore there are no update, tag or deprecation operations available on archive resources.</p>
Expand Down Expand Up @@ -352,7 +355,7 @@ <h2><a href="#payload" name="payload" class="anchor"><span class="anchor-link"><
<ul>
<li>Only allowed for Resource type</li>
<li>Optional and defaults to compacted</li>
<li>Accepts the following values: source (to get the original payload), compacted, expanded, n-triples, dot</li>
<li>Accepts the following values: source (to get the original payload), annotated-source (to get the original payload with metadata), compacted, expanded, n-triples, dot</li>
<li>Can not be present at the same time as <code>originalSource</code> field.</li>
</ul>
</li>
Expand All @@ -374,10 +377,10 @@ <h2><a href="#create-using-post" name="create-using-post" class="anchor"><span c
<li>If the <code>@id</code> value is found on the payload, this @id will be used.</li>
<li>If the <code>@id</code> value is not found on the payload, an @id will be generated as follows: <code>base:{UUID}</code>. The <code>base</code> is the <code>prefix</code> defined on the resource&rsquo;s project (<code>{project_label}</code>).</li>
</ul>
<p>The response will be an HTTP 303 Location redirect, which will point to the url where to consume the archive (tarball).</p>
<p>The response will be an HTTP 303 Location redirect, which will point to the url where to consume the archive (ZIP).</p>
<p>The following diagram can help to understand the HTTP exchange <img src="assets/archives/post-redirect-get.png" alt="post-redirect-get" title="Post/Redirect/Get archive" /></p>
<p><strong>Example</strong></p>
<p>The following example shows how to create an archive containing 3 files. 2 of them are resources and the other is a file. As a response, the tarball will be offered.</p>
<p>The following example shows how to create an archive containing 3 files. 2 of them are resources and the other is a file. As a response, the ZIP file will be offered.</p>
<dl>
<dt>Request</dt>
<dd>
Expand Down Expand Up @@ -510,24 +513,20 @@ <h2><a href="#create-using-put" name="create-using-put" class="anchor"><span cla
</dl>
<p>Note that if the payload contains an @id different from the <code>{archive_id}</code>, the request will fail.</p>
<h2><a href="#fetch" name="fetch" class="anchor"><span class="anchor-link"></span></a>Fetch</h2>
<p>When fetching an archive, the response format can be chosen through HTTP content negotiation. In order to fetch the archive metadata, the client can use any of the <a href="content-negotiation.html#supported-mime-types">following MIME types</a>. However, in order to fetch the archive content, the HTTP <code>Accept</code> header should be provided:</p>
<ul>
<li><code>*/*</code> or <code>application/x-tar</code> will return a tar archive (or tarball)</li>
<li><code>application/zip</code> will return a zip archive</li>
</ul><div class="callout note warning"><div class="callout-title">Note</div>
<p><a href="https://en.wikipedia.org/wiki/Tar_(computing)" title="The limitations of the tar format">The limitations of the tar format</a> makes the usage of archives difficult (among other things, the maximum file name is limited to 100 characters), so its support will be removed in a future release.</p></div>
<p>When fetching an archive, the response format can be chosen through HTTP content negotiation. In order to fetch the archive metadata, the client can use any of the <a href="content-negotiation.html#supported-mime-types">following MIME types</a>. However, in order to fetch the archive content, the HTTP <code>Accept</code> header should be provided as <code>application/zip</code>.</p>
<p>@@@</p>
<p>When downloading the archive, it is possible to ignore resources that does not exist by appending the query parameter <code>ignoreNotFound=true</code> to the fetch link.</p>
<pre><code>GET /v1/archives/{org_label}/{project_label}/{archive_id}
GET /v1/archives/{org_label}/{project_label}/{archive_id}?ignoreNotFound=true
</code></pre>
<p><strong>Example</strong></p>
<dl>
<dt>Request (tarball)
<dt>Request (ZIP)
</dt>
<dd>
<pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/BlueBrain/nexus/tree/master/docs/src/main/paradox/docs/delta/api/assets/archives/fetch.sh" target="_blank" title="Go to snippet source">source</a><code class="language-sh">curl &quot;http://localhost:8080/v1/archives/myorg/myproject/myarchive&quot; \
-H &quot;Accept: application/x-tar&quot; \
-o output.tar</code></pre></dd>
-H &quot;Accept: application/x-zip&quot; \
-o output.zip</code></pre></dd>
<dt>Request (metadata)
</dt>
<dd>
Expand Down Expand Up @@ -569,7 +568,7 @@ <h2><a href="#fetch" name="fetch" class="anchor"><span class="anchor-link"></spa
&quot;_createdAt&quot;: &quot;2021-05-17T14:54:42.939Z&quot;,
&quot;_createdBy&quot;: &quot;http://localhost:8080/v1/realms/myrealm/users/john&quot;,
&quot;_updatedAt&quot;: &quot;2021-05-17T14:54:42.939Z&quot;,
&quot;_updatedBy&quot;: &quot;http://localhost:8080/v1/realms/myrealm/users/john&quot;
&quot;_updatedBy&quot;: &quot;http://localhost:8080/v1/realms/myrealm/users/john&quot;,
&quot;_expiresInSeconds&quot;: 17530
}</code></pre></dd>
</dl>
Expand Down
4 changes: 2 additions & 2 deletions snapshot/docs/delta/api/assets/archives/fetch.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
curl "http://localhost:8080/v1/archives/myorg/myproject/myarchive" \
-H "Accept: application/x-tar" \
-o output.tar
-H "Accept: application/x-zip" \
-o output.zip
2 changes: 1 addition & 1 deletion snapshot/docs/delta/api/assets/archives/fetched.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@
"_createdAt": "2021-05-17T14:54:42.939Z",
"_createdBy": "http://localhost:8080/v1/realms/myrealm/users/john",
"_updatedAt": "2021-05-17T14:54:42.939Z",
"_updatedBy": "http://localhost:8080/v1/realms/myrealm/users/john"
"_updatedBy": "http://localhost:8080/v1/realms/myrealm/users/john",
"_expiresInSeconds": 17530
}
11 changes: 11 additions & 0 deletions snapshot/docs/delta/api/assets/graph-analytics/ga-search.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,17 @@
"path": "http://schema.org/worksFor"
}
],
"remoteContexts": [
{
"@type": "ProjectRemoteContextRef",
"iri": "https://bbp.epfl.ch/contexts/person",
"resource": {
"id": "https://bbp.epfl.ch/contexts/person",
"project": "myorg/myproj",
"rev": 1
}
}
],
"_createdAt": "2023-08-08T15:49:14.081Z",
"_createdBy": {
"@type": "User",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"@context" : [
"https://bluebrain.github.io/nexus/contexts/metadata.json",
"https://bluebrain.github.io/nexus/contexts/search.json"
],
"_total" : 2,
"_results" : [
{
"@id" : "https://example.com/Alice",
"_constrainedBy" : "https://bluebrain.github.io/nexus/schemas/unconstrained.json",
"_createdAt" : "2023-09-22T13:55:33.493Z",
"_createdBy" : "http://localhost:8080/v1/realms/myrealm/users/bob",
"_deprecated" : false,
"_incoming" : "http://localhost:8080/v1/resources/myorg/myproject/_/https:%2F%2Fexample.com%2FAlice/incoming",
"_outgoing" : "http://localhost:8080/v1/resources/myorg/myproject/_/https:%2F%2Fexample.com%2FAlice/outgoing",
"_project" : "http://localhost:8080/v1/projects/myorg/myproject",
"_rev" : 1,
"_schemaProject" : "http://localhost:8080/v1/projects/myorg/myproject",
"_score" : 0.0,
"_self" : "http://localhost:8080/v1/resources/myorg/myproject/_/https:%2F%2Fexample.com%2FAlice",
"_updatedAt" : "2023-09-22T13:55:33.493Z",
"_updatedBy" : "http://localhost:8080/v1/realms/myrealm/users/bob"
},
{
"@id" : "https://example.com/Alice",
"_constrainedBy" : "https://bluebrain.github.io/nexus/schemas/unconstrained.json",
"_createdAt" : "2023-09-22T13:55:33.459Z",
"_createdBy" : "http://localhost:8080/v1/realms/myrealm/users/bob",
"_deprecated" : false,
"_incoming" : "http://localhost:8080/v1/resources/myorg/secondproject/_/https:%2F%2Fexample.com%2FAlice/incoming",
"_outgoing" : "http://localhost:8080/v1/resources/myorg/secondproject/_/https:%2F%2Fexample.com%2FAlice/outgoing",
"_project" : "http://localhost:8080/v1/projects/myorg/secondproject",
"_rev" : 1,
"_schemaProject" : "http://localhost:8080/v1/projects/myorg/secondproject",
"_score" : 0.0,
"_self" : "http://localhost:8080/v1/resources/myorg/secondproject/_/https:%2F%2Fexample.com%2FAlice",
"_updatedAt" : "2023-09-22T13:55:33.459Z",
"_updatedBy" : "http://localhost:8080/v1/realms/myrealm/users/bob"
}
],
"_maxScore" : 0.0
}
1 change: 1 addition & 0 deletions snapshot/docs/delta/api/assets/id-resolution/request.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
curl "http://localhost:8080/v1/resolve/https%3A%2F%2Fexample.com%2FAlice"
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"@context": {
"@vocab": "https://schema.org/"
},
"@id": "https://example.com/Alice",
"@type": "Person",
"name": "Alice",
"age": 42
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
"acls/read",
"projects/read",
"permissions/read",
"archives/write",
"organizations/create",
"views/query",
"storages/write",
Expand Down
18 changes: 18 additions & 0 deletions snapshot/docs/delta/api/assets/remote-contexts.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"@context": "https://bluebrain.github.io/nexus/contexts/remote-contexts.json",
"remoteContexts": [
{
"@type": "StaticContextRef",
"iri": "https://bluebrain.github.io/nexus/contexts/metadata.json"
},
{
"@type": "ProjectContextRef",
"iri": "https://localhost/nexus/context",
"resource": {
"id": "https://localhost/nexus/context",
"project": "org/proj",
"rev": 5
}
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
curl "http://localhost:8080/v1/resources/org/proj/_/my-resource/remote-contexts"
19 changes: 19 additions & 0 deletions snapshot/docs/delta/api/assets/trial/resources/generate.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
curl -X PUT \
-H "Content-Type: application/json" \
"http://localhost:8080/trial/resources/myorg/myproj/" \
-d \
'{
"schema": "https://bbp.epfl.ch/nexus/schema/morphology"
"resource": {
"@context": [
"https://neuroshapes.org",
"https://bluebrain.github.io/nexus/contexts/metadata.json",
{
"@vocab": "https://bluebrain.github.io/nexus/vocabulary/"
}
],
"@id": "https://bbp.epfl.ch/nexus/data/morphology-001",
"@type": "Morphology",
"name": "Morphology 001"
}
}'
26 changes: 26 additions & 0 deletions snapshot/docs/delta/api/assets/trial/resources/generated.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"result": {
"@context": [
"https://bluebrain.github.io/nexus/contexts/metadata.json",
{
"@vocab": "https://bluebrain.github.io/nexus/vocabulary/"
},
"https://neuroshapes.org"
],
"@id": "https://bbp.epfl.ch/nexus/data/morphology-001",
"@type": "Morphology",
"name": "Morphology 001",
"_constrainedBy": "https://bbp.epfl.ch/nexus/schema/morphology",
"_createdAt": "2023-09-18T12:00:00Z",
"_createdBy": "http://localhost/v1/realms/wonderland/users/alice",
"_deprecated": false,
"_incoming": "http://localhost/v1/resources/myorg/myproj/_/https:%2F%2Fbluebrain.github.io%2Fnexus%2Fvocabulary%2FmyId/incoming",
"_outgoing": "http://localhost/v1/resources/myorg/myproj/_/https:%2F%2Fbluebrain.github.io%2Fnexus%2Fvocabulary%2FmyId/outgoing",
"_project": "http://localhost/v1/projects/myorg/myproj",
"_rev": 1,
"_schemaProject": "http://localhost/v1/projects/myorg/myproj",
"_self": "http://localhost/v1/resources/myorg/myproj/_/https:%2F%2Fbluebrain.github.io%2Fnexus%2Fvocabulary%2FmyId",
"_updatedAt": "2023-09-18T12:00:00Z",
"_updatedBy": "http://localhost/v1/realms/wonderland/users/alice"
}
}
15 changes: 15 additions & 0 deletions snapshot/docs/delta/api/assets/trial/resources/payload.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"schema": "https://bbp.epfl.ch/nexus/schema/morphology"
"resource": {
"@context": [
"https://neuroshapes.org",
"https://bluebrain.github.io/nexus/contexts/metadata.json",
{
"@vocab": "https://bluebrain.github.io/nexus/vocabulary/"
}
],
"@id": "https://bbp.epfl.ch/nexus/data/morphology-001",
"@type": "Morphology",
"name": "Morphology 001"
}
}
4 changes: 2 additions & 2 deletions snapshot/docs/delta/api/assets/version.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"dependencies": {
"blazegraph": "2.1.6-RC",
"postgresql": "15.4",
"elasticsearch": "8.8.1",
"remoteStorage": "1.8.0"
"elasticsearch": "8.10.1",
"remoteStorage": "1.9.0"
},
"plugins": {
"archive": "1.9.0",
Expand Down
Loading

0 comments on commit 61a8cca

Please sign in to comment.