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.

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: docs for prism anoncreds method support #183

Merged
merged 4 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions documentation/docs/concepts/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ The process for retrieving a [DID document](#did-document).
### DID subject
The entity is identified by a [DID](#decentralized-identifer-(did)) and described by a [DID documents](#did-document). Anything can be a DID subject: person, group, organization, physical thing, digital thing, etc.

### DID Url
A DID itself is a type of a URL, while `did` is a registered schema type, like `http` and `https`. With Identus, we refer DID URLs to a DID that includes path and query parameters and can resolve a resource via one of the service endpoints in the DID document. For example:
```
did:prism:9f847f8bbb66c112f71d08ab39930d468ccbfe1e0e1d002be53d46c431212c26?resourceService=agent-base-url&resourcePath=schema-registry/schemas/did-url&resourceHash=4074bb1a8e0ea45437ad86763cd7e12de3fe8349ef19113df773b0d65c8a9c46
```

### Distributed Ledger Technology (DLT)
A distributed database or ledger establishes confidence for the participants to rely on the data recorded. Typically these databases use nodes and a consensus protocol to confirm the order of cryptographically signed transactions. Linking the transactions over time creates a historical ledger that is effectively immutable.

Expand Down Expand Up @@ -174,6 +180,12 @@ The Protection API in User-Managed Access ([UMA](#uma)) is a set of endpoints th
### Protocol buffer
Also known as protobuf.

### Prism envelope
A response type for endpoints that implement prism anoncred method
```json
{"resource": <encoded resource as string>, url: <did url at which this resource can be resolved>}
```



## R
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The following enviroment variables can be used to configure Cloud Agent:
| POLLUX_DB_NAME | Database name where Pollux db will store data. | String | pollux |
| POLLUX_DB_USER | Pollux database username for login. | String | postgres |
| POLLUX_DB_PASSWORD | Pollux database password for login. | String | postgres |
| POLLUX_STATUS_LIST_REGISTRY_PUBLIC_URL | Url of status list registroy to verify the revocation of JWT credentials | String | http://localhost:8085 |
| ISSUE_BG_JOB_RECORDS_LIMIT | Maximum number of records issue credentials job will try to process at the same time. | Int | 25 |
| ISSUE_BG_JOB_RECURRENCE_DELAY | Interval at which issue credentials job will try to process records. | String | 2 seconds |
| ISSUE_BG_JOB_PROCESSING_PARALLELISM | Maximum amount of parallel issue credential job processings. | Int | 5 |
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"license": "Apache-2.0",
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"start": "npx docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
Expand Down
Loading