Skip to content

Commit

Permalink
Merge pull request hyperledger#1136 from anikitinDSR/change_ref_to_rules
Browse files Browse the repository at this point in the history
[Change reference in docs] Change reference for "roles and permission…
  • Loading branch information
ashcherbakov authored Jan 21, 2019
2 parents 90d9e36 + bc7ee69 commit 5af241c
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ If you made changes in both indy-plenum and indy-node, you need to do the follow
- Relationship between Entities and Transactions: [relationship diagram](docs/relationship-diagram.png)
- Supported transactions and their format: [transactions](docs/transactions.md)
- Supported requests (write, read) and their format: [requests](docs/requests.md)
- [Network roles and permissions](https://docs.google.com/spreadsheets/d/1TWXF7NtBjSOaUIBeIH77SyZnawfo91cJ_ns4TR-wsq4/edit#gid=0)
- [Network roles and permissions](https://github.com/hyperledger/indy-node/blob/master/docs/auth_rules.md)
- [Indy file folder structure guideline](docs/indy-file-structure-guideline.md)
- [Helper Scripts](docs/helper-scripts.md)
- [Pool Upgrade](docs/pool-upgrade.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/requests-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ then have a look at [transactions](transactions.md).

[indy-sdk](https://github.com/hyperledger/indy-sdk) expects the format as specified below.

See [roles and permissions](https://docs.google.com/spreadsheets/d/1TWXF7NtBjSOaUIBeIH77SyZnawfo91cJ_ns4TR-wsq4/edit#gid=0) on the roles and who can create each type of transactions.
See [roles and permissions](https://github.com/hyperledger/indy-node/blob/master/docs/auth_rules.md) on the roles and who can create each type of transactions.


## Base Client-to-Node and Node-to-Node serialization
Expand Down Expand Up @@ -404,7 +404,7 @@ The format of each request-specific data for each type of request.

### NYM
Creates a new NYM record for a specific user, trust anchor, steward or trustee.
Note that only trustees and stewards can create new trust anchors and trustee can be created only by other trusties (see [roles](https://docs.google.com/spreadsheets/d/1TWXF7NtBjSOaUIBeIH77SyZnawfo91cJ_ns4TR-wsq4/edit#gid=0)).
Note that only trustees and stewards can create new trust anchors and trustee can be created only by other trusties (see [roles](https://github.com/hyperledger/indy-node/blob/master/docs/auth_rules.md)).

The request can be used for
creation of new DIDs, setting and rotation of verification key, setting and changing of roles.
Expand All @@ -425,7 +425,7 @@ creation of new DIDs, setting and rotation of verification key, setting and chan
- 2 (STEWARD)
- 101 (TRUST_ANCHOR)

A TRUSTEE can change any Nym's role to None, this stopping it from making any writes (see [roles](https://docs.google.com/spreadsheets/d/1TWXF7NtBjSOaUIBeIH77SyZnawfo91cJ_ns4TR-wsq4/edit#gid=0)).
A TRUSTEE can change any Nym's role to None, this stopping it from making any writes (see [roles](https://github.com/hyperledger/indy-node/blob/master/docs/auth_rules.md)).

- `verkey` (base58-encoded string; optional):

Expand Down
6 changes: 3 additions & 3 deletions docs/requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ then have a look at [transactions](transactions.md).

[indy-sdk](https://github.com/hyperledger/indy-sdk) expects the format as specified below.

See [roles and permissions](https://docs.google.com/spreadsheets/d/1TWXF7NtBjSOaUIBeIH77SyZnawfo91cJ_ns4TR-wsq4/edit#gid=0) on the roles and who can create each type of transactions.
See [roles and permissions](https://github.com/hyperledger/indy-node/blob/master/docs/auth_rules.md) on the roles and who can create each type of transactions.

## Common Request Structure

Expand Down Expand Up @@ -337,7 +337,7 @@ The format of each request-specific data for each type of request.

### NYM
Creates a new NYM record for a specific user, trust anchor, steward or trustee.
Note that only trustees and stewards can create new trust anchors and trustee can be created only by other trusties (see [roles](https://docs.google.com/spreadsheets/d/1TWXF7NtBjSOaUIBeIH77SyZnawfo91cJ_ns4TR-wsq4/edit#gid=0)).
Note that only trustees and stewards can create new trust anchors and trustee can be created only by other trusties (see [roles](https://github.com/hyperledger/indy-node/blob/master/docs/auth_rules.md)).

The request can be used for
creation of new DIDs, setting and rotation of verification key, setting and changing of roles.
Expand All @@ -358,7 +358,7 @@ creation of new DIDs, setting and rotation of verification key, setting and chan
- "2" (STEWARD)
- "101" (TRUST_ANCHOR)

A TRUSTEE can change any Nym's role to None, this stopping it from making any writes (see [roles](https://docs.google.com/spreadsheets/d/1TWXF7NtBjSOaUIBeIH77SyZnawfo91cJ_ns4TR-wsq4/edit#gid=0)).
A TRUSTEE can change any Nym's role to None, this stopping it from making any writes (see [roles](https://github.com/hyperledger/indy-node/blob/master/docs/auth_rules.md)).

- `verkey` (base58-encoded string, possibly starting with "~"; optional):

Expand Down
6 changes: 3 additions & 3 deletions docs/transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ where key is a sequence number of the transaction and value is the serialized tr
- All transactions are serialized to MsgPack format
- All transactions (both transaction log and merkle tree hash stores) are stored in a LevelDB
- One can use the `read_ledger` script to get transactions for a specified ledger in a readable format (JSON)
- See [roles and permissions](https://docs.google.com/spreadsheets/d/1TWXF7NtBjSOaUIBeIH77SyZnawfo91cJ_ns4TR-wsq4/edit#gid=0) for a list of roles and they type of transactions they can create.
- See [roles and permissions](https://github.com/hyperledger/indy-node/blob/master/docs/auth_rules.md) for a list of roles and they type of transactions they can create.

Below you can find the format and description of all supported transactions.

Expand Down Expand Up @@ -170,7 +170,7 @@ Please note that all these metadata fields may be absent for genesis transaction

#### NYM
Creates a new NYM record for a specific user, trust anchor, steward or trustee.
Note that only trustees and stewards can create new trust anchors and a trustee can be created only by other trustees (see [roles](https://docs.google.com/spreadsheets/d/1TWXF7NtBjSOaUIBeIH77SyZnawfo91cJ_ns4TR-wsq4/edit#gid=0)).
Note that only trustees and stewards can create new trust anchors and a trustee can be created only by other trustees (see [roles](https://github.com/hyperledger/indy-node/blob/master/docs/auth_rules.md)).

The transaction can be used for
creation of new DIDs, setting and rotation of verification key, setting and changing of roles.
Expand All @@ -191,7 +191,7 @@ creation of new DIDs, setting and rotation of verification key, setting and chan
- 2 (STEWARD)
- 101 (TRUST_ANCHOR)

A TRUSTEE can change any Nym's role to None, thus stopping it from making any further writes (see [roles](https://docs.google.com/spreadsheets/d/1TWXF7NtBjSOaUIBeIH77SyZnawfo91cJ_ns4TR-wsq4/edit#gid=0)).
A TRUSTEE can change any Nym's role to None, thus stopping it from making any further writes (see [roles](https://github.com/hyperledger/indy-node/blob/master/docs/auth_rules.md)).

- `verkey` (base58-encoded string, possibly starting with "~"; optional):

Expand Down

0 comments on commit 5af241c

Please sign in to comment.