Skip to content

Commit

Permalink
chore: flesh out remaining blockstore fields
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Trottier committed Dec 30, 2019
1 parent c04d1c8 commit 9bec9ac
Show file tree
Hide file tree
Showing 6 changed files with 576 additions and 245 deletions.
12 changes: 7 additions & 5 deletions doc/PROTO.md
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ NameSysAPI provides a generic name resolution API
<a name="pb.Block"></a>

### Block
Block is a single block of ipfs data



| Field | Type | Label | Description |
Expand All @@ -555,9 +555,10 @@ BlockstoreRequest is a message used to control blockstores

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| cids | [string](#string) | repeated | cids holds at least 1 cid, to hold 0 is considered an error |
| reqType | [BSREQTYPE](#pb.BSREQTYPE) | | reqType is used to indicate the particular request being mande |
| reqOpts | [BSREQOPTS](#pb.BSREQOPTS) | | reqOpts is an optional parameter that can be used for fine-tuned request control |
| requestType | [BSREQTYPE](#pb.BSREQTYPE) | | indicates the particular request type being made |
| reqOpts | [BSREQOPTS](#pb.BSREQOPTS) | repeated | optional request settings |
| cids | [string](#string) | repeated | cids of blocks sent by: BS_DELETE, BS_GET, BS_GET_MANY |
| data | [bytes](#bytes) | repeated | the data we are putting sent by: BS_PUT, BS_PUT_MANY |



Expand All @@ -572,7 +573,8 @@ BlockstoreResponse is a response to a BlockstoreqRequest

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| blocks | [Block](#pb.Block) | repeated | |
| requestType | [BSREQTYPE](#pb.BSREQTYPE) | | indicates the particular request type being made |
| blocks | [Block](#pb.Block) | repeated | a copy of blocks from the blockstore sent by: BS_PUT, BS_PUT_MANY, BS_GET, BS_GET_MANY in the case of BS_PUT, and BS_PUT_MANY requests the data field will be empty as this is only populated by get requests |



Expand Down
Loading

0 comments on commit 9bec9ac

Please sign in to comment.