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

docs(ContractDefinitions): Added description how to use private Properties in asset selectors #1707

Merged
merged 1 commit into from
Dec 6, 2024
Merged

docs(ContractDefinitions): Added description how to use private Properties in asset selectors #1707

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions docs/usage/management-api-walkthrough/03_contractdefinitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,22 @@ part of the `edc:QuerySpec` objects that also allow pagination:
- `POST /v3/policydefinitions/request`
- `POST /v3/contractdefinitions/request`

## Using Private Properties as Asset Selectors
When using a private property as an asset selector, the property defined in the left operator must be prefixed as follows: `"privateProperties.'https://w3id.org/edc/v0.0.1/ns/myCommonProperty'"`.

```json
{
"assetsSelector":
{
"@type": "Criterion",
"operandLeft": "privateProperties.'https://w3id.org/edc/v0.0.1/ns/myCommonProperty'",
"operator": "=",
"operandRight": "sharedValue"
}
}
```


## Side-Effects

The [Domain Model](../README) shows the basic connection between the core concepts of
Expand All @@ -100,6 +116,7 @@ After contract definition, an EDC will automatically allow data access if a requ
Contract Definitions thus must be created with great care. It is essential to align the backend-credentials with the
Access and Contract Policies to manage access consistently from the Dataspace to the backend data.


## Notice

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
Expand Down
Loading