Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better document the use of the schema segment #4280

Merged
merged 2 commits into from
Sep 19, 2023
Merged

Better document the use of the schema segment #4280

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c905171
Better document the use of the schema segment
Sep 19, 2023
0f0dc3c
Address feedback
Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions docs/src/main/paradox/docs/delta/api/resources-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Please visit @ref:[Authentication & authorization](authentication.md) section to

@@@ note { .warning title="Remote contexts" }

From Delta v1.5, remote contexts are only resolved during creates and updates.
That means that when those get updated, the resources importing them must be also updated to take them into account the new version.
Remote contexts are only resolved during creates and updates.
That means that when those get updated, the resources importing them must be also updated to take them into account in a new version.

@@@

Expand Down Expand Up @@ -68,6 +68,12 @@ The json payload:
- If the `@id` value is not found on the payload, an @id will be generated as follows: `base:{UUID}`. The `base` is the
`prefix` defined on the resource's project (`{project_label}`).

The `{schema_id}` segment allows to define an existing SHACL schema to validate the resource with:

- If `_` is provided, no SHACL validation will be performed
- If another value is provided, Nexus will attempt to resolve the schema then validate the expanded JSON-LD value generated
from the provided payload.

**Example**

Request
Expand All @@ -88,7 +94,9 @@ to specify one. The @id will be specified in the last segment of the endpoint UR
PUT /v1/resources/{org_label}/{project_label}/{schema_id}/{resource_id}
{...}
```


The `{schema_id}` has the same behaviour as @ref:[the creation using post operation](#create-using-post).

Note that if the payload contains an @id different from the `{resource_id}`, the request will fail.

**Example**
Expand Down Expand Up @@ -116,6 +124,11 @@ PUT /v1/resources/{org_label}/{project_label}/{schema_id}/{resource_id}?rev={pre
```
... where `{previous_rev}` is the last known revision number for the resource.

The `{schema_id}` segment allows to define an existing SHACL schema to validate the resource with:

- If `_` is provided, no SHACL validation will be performed with the latest version of its current schema
- If another value is provided, it has to match the identifier of the current schema as changing the schema of a
resource is not currently supported. A different revision or tag of this schema can be provided though.

**Example**

Expand Down Expand Up @@ -252,6 +265,11 @@ where ...

`{rev}` and `{tag}` fields cannot be simultaneously present.

The `{schema_id}` segment allows to pass the resource schema:

- If `_` is provided, the value is ignored
- If another value is provided, it must match the identifier of the resource schema.

**Example**

Request
Expand Down