Skip to content

Commit d343189

Browse files
committed
Remove pagination and transport & transfer filters
These were not implemented so do not belong in this spec. If we implement them later, we can reintroduce them at that time.
1 parent 655b1f2 commit d343189

File tree

1 file changed

+16
-25
lines changed

1 file changed

+16
-25
lines changed

routing/DELEGATED_CONTENT_ROUTING_HTTP.md

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -71,36 +71,25 @@ Specifications for some transfer protocols are provided in the "Transfer Protoco
7171
- `404`: must be returned if no matching records are found
7272
- `422`: request does not conform to schema or semantic constraints
7373
- Response Body
74-
75-
```json
76-
{
77-
"Providers": [
78-
{
79-
"Protocol": "<protocol_name>",
80-
"Schema": "<schema>",
81-
...
82-
}
83-
]
84-
}
85-
```
86-
87-
- Default limit: 100 providers
88-
- Optional query parameters
89-
- `transfer` only return providers who support the passed transfer protocols, expressed as a comma-separated list of transfer protocol names such as `transfer=bitswap,filecoin-graphsync-v1`
90-
- `transport` for provider records with multiaddrs, only return records with multiaddrs explicitly supporting the passed transport protocols, encoded as decimal multicodec codes such as `transport=460,478` (`/quic` and `/tls/ws` respectively)
91-
- Implements pagination according to the Pagination section
74+
```json
75+
{
76+
"Providers": [
77+
{
78+
"Protocol": "<protocol_name>",
79+
"Schema": "<schema>",
80+
...
81+
}
82+
]
83+
}
84+
```
85+
86+
- Response limit: 100 providers
9287

9388
Each object in the `Providers` list is a *read provider record*.
9489

9590
## Pagination
9691

97-
APIs that return collections of results should support pagination as follows:
98-
99-
- If there are more results, then a `NextPageToken` field should include an opaque string value, otherwise it should be undefined
100-
- The value of `NextPageToken` can be specified as the value of a `pageToken` query parameter to fetch the next page
101-
- Character set is restricted to the regular expression `[a-zA-Z0-9-_.~]+`, since this is intended to be used in URLs
102-
- The client continues this process until `NextPageToken` is undefined or doesn't care to continue
103-
- A `pageLimit` query parameter specifies the maximum size of a single page
92+
This API does not support pagination, but optional pagination can be added in a backwards-compatible spec update.
10493

10594
### Implementation Notes
10695

@@ -140,6 +129,7 @@ This section contains a non-exhaustive list of known transfer protocols (by name
140129

141130
Multicodec name: `transport-bitswap`
142131
Schema: `bitswap`
132+
Specification: [ipfs/specs/BITSWAP.md](https://github.com/ipfs/specs/blob/main/BITSWAP.md)
143133

144134
#### Bitswap Read Provider Records
145135

@@ -162,6 +152,7 @@ The server should respect a passed `transport` query parameter by filtering agai
162152

163153
Multicodec name: `transport-graphsync-filecoinv1`
164154
Schema: `graphsync-filecoinv1`
155+
Specification: [ipfs/go-graphsync/blob/main/docs/architecture.md](https://github.com/ipfs/go-graphsync/blob/main/docs/architecture.md)
165156

166157
#### Filecoin Graphsync Read Provider Records
167158

0 commit comments

Comments
 (0)