Skip to content

Commit

Permalink
update w3-admin.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gobengo committed Jan 17, 2024
1 parent 47bf3c4 commit 900d054
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions w3-admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Admin Protocol

![status:wip](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square)
![status:reliable](https://img.shields.io/badge/status-reliable-green.svg?style=flat-square)

## Editors

Expand All @@ -10,7 +10,7 @@

- [Travis Vachon](https://github.com/travis), [Protocol Labs](https://protocol.ai/)

# Abstract
## Abstract

Storage providers in the w3 family of protocols need to be able to get information about the customers, subscriptions and "consumers" (i.e., spaces)
they work with. The capabilities described in this document all act on the "service" resource (i.e., `did:web:web3.storage`) and can be delegated
Expand Down Expand Up @@ -71,6 +71,11 @@ export const get = capability({
})
```

#### Implementations

* @web3-storage/capabilities: [capability in consumer.js](https://github.com/web3-storage/w3up/blob/231cf1f863f4e9a96c92d9ef5001617ba928028d/packages/capabilities/src/consumer.js#L29C1-L29C1)

Check failure on line 76 in w3-admin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-admin.md:76:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
* @web3-storage/upload-api: [invocation handler in (https://github.com/web3-storage/w3up/blob/231cf1f863f4e9a96c92d9ef5001617ba928028d/packages/upload-api/src/consumer/get.js)

Check failure on line 77 in w3-admin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-admin.md:77:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

Check failure on line 77 in w3-admin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Bare URL used [Context: "https://github.com/web3-storag..."]

w3-admin.md:77:53 MD034/no-bare-urls Bare URL used [Context: "https://github.com/web3-storag..."]

### `customer/get`

Get information about a customer.
Expand Down Expand Up @@ -111,6 +116,11 @@ export const get = capability({
})
```

#### Implementations

* @web3-storage/capabilities: [capability in customer.js](https://github.com/web3-storage/w3up/blob/231cf1f863f4e9a96c92d9ef5001617ba928028d/packages/capabilities/src/customer.js#L12)

Check failure on line 121 in w3-admin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-admin.md:121:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
* @web3-storage/upload-api: [invocation handler in customer/get.js](https://github.com/web3-storage/w3up/blob/231cf1f863f4e9a96c92d9ef5001617ba928028d/packages/upload-api/src/customer/get.js)

Check failure on line 122 in w3-admin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-admin.md:122:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

### `subscription/get`

Get information about a subscription.
Expand Down Expand Up @@ -151,6 +161,11 @@ export const get = capability({
})
```

#### Implementations

* @web3-storage/capabilities: [capability in admin.js](https://github.com/web3-storage/w3up/blob/main/packages/capabilities/src/admin.js)

Check failure on line 166 in w3-admin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-admin.md:166:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
* @web3-storage/upload-api: [invocation handler in subscription/get.js](hthttps://github.com/web3-storage/w3up/blob/231cf1f863f4e9a96c92d9ef5001617ba928028d/packages/upload-api/src/subscription/get.js)

Check failure on line 167 in w3-admin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-admin.md:167:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

Check failure on line 167 in w3-admin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Bare URL used [Context: "https://github.com/web3-storag..."]

w3-admin.md:167:75 MD034/no-bare-urls Bare URL used [Context: "https://github.com/web3-storag..."]

### `admin/upload/inspect`

Get information about a content CID. This does not return the actual data identified by the CID, just metadata our
Expand All @@ -171,6 +186,11 @@ with the date it was uploaded.
}
```

#### Implementations

* @web3-storage/capabilities: [capability in admin.js](https://github.com/web3-storage/w3up/blob/main/packages/capabilities/src/admin.js)

Check failure on line 191 in w3-admin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-admin.md:191:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
* @web3-storage/upload-api: [invocation handler in admin/upload/inspect.js](https://github.com/web3-storage/w3up/blob/231cf1f863f4e9a96c92d9ef5001617ba928028d/packages/upload-api/src/admin/upload/inspect.js)

Check failure on line 192 in w3-admin.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Unordered list style [Expected: dash; Actual: asterisk]

w3-admin.md:192:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

### `admin/store/inspect`

Get information about a shard (i.e., a CAR that contains part of an upload) CID. This
Expand All @@ -191,3 +211,8 @@ which it was stored.
stores: Array<{space: SpaceDID, insertedAt: Date}>
}
```

#### Implementations

* @web3-storage/capabilities: [capability in admin.js](https://github.com/web3-storage/w3up/blob/main/packages/capabilities/src/admin.js)
* @web3-storage/upload-api: [invocation handler in admin/store/inspect.js](https://github.com/web3-storage/w3up/blob/231cf1f863f4e9a96c92d9ef5001617ba928028d/packages/upload-api/src/admin/store/inspect.js)

0 comments on commit 900d054

Please sign in to comment.