Skip to content

Commit 1defdd3

Browse files
committed
gateway: car params and Content-Location
1 parent b94f597 commit 1defdd3

File tree

2 files changed

+21
-12
lines changed

2 files changed

+21
-12
lines changed

src/http-gateways/path-gateway.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -254,23 +254,23 @@ A Gateway SHOULD include the
254254

255255
### `dag-scope` (request query parameter)
256256

257-
Only used on CAR requests, same as :ref[dag-scope] from :cite[trustless-gateway].
257+
Optional, can be used to limit the scope of verifiable DAG requests such as CAR, same as :ref[dag-scope] from :cite[trustless-gateway].
258258

259259
### `entity-bytes` (request query parameter)
260260

261-
Only used on CAR requests, same as :ref[entity-bytes] from :cite[trustless-gateway].
261+
Optional, can be used to limit the scope of verifiable DAG requests such as CAR, same as :ref[entity-bytes] from :cite[trustless-gateway].
262262

263263
### `car-version` (request query parameter)
264264

265-
Only used on CAR requests, same as :ref[car-version] from :cite[trustless-gateway].
265+
Optional, specific to CAR requests, same as :ref[car-version] from :cite[trustless-gateway].
266266

267267
### `car-order` (request query parameter)
268268

269-
Only used on CAR requests, same as :ref[car-order] from :cite[trustless-gateway].
269+
Optional, specific to CAR requests, same as :ref[car-order] from :cite[trustless-gateway].
270270

271271
### `car-dups` (request query parameter)
272272

273-
Only used on CAR requests, same as :ref[car-dups] from :cite[trustless-gateway].
273+
Optional, specific to CAR requests, same as :ref[car-dups] from :cite[trustless-gateway].
274274

275275
# HTTP Response
276276

src/http-gateways/trustless-gateway.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -196,18 +196,27 @@ returned:
196196

197197
### :dfn[`car-version`] (request query parameter)
198198

199-
Only used on CAR requests, it is the same as [CAR version](#car-version) content
200-
type parameter. In case both are present, the value in the HTTP Header has priority.
199+
Optional, only used on CAR requests.
200+
201+
Serves same purpose as [CAR `version` content type parameter](#car-version-content-type-parameter).
202+
203+
In case both are present in the request, the value from the [`Accept`](#accept-request-header) HTTP Header has priority and a matching [`Content-Location`](#content-location-response-header) SHOULD be returned with the response.
201204

202205
### :dfn[`car-order`] (request query parameter)
203206

204-
Only used on CAR requests, it is the same as [CAR `order`](#car-order-content-type-parameter)
205-
content type parameter. In case both are present, the value in the HTTP Header has priority.
207+
Optional, only used on CAR requests.
208+
209+
Serves same purpose as [CAR `order` content type parameter](#car-order-content-type-parameter).
210+
211+
In case both are present in the request, the value from the [`Accept`](#accept-request-header) HTTP Header has priority and a matching [`Content-Location`](#content-location-response-header) SHOULD be returned with the response.
206212

207213
### :dfn[`car-dups`] (request query parameter)
208214

209-
Only used on CAR requests, it is the same as [CAR `dups`](#car-dups-content-type-parameter)
210-
content type parameter. In case both are present, the value in the HTTP Header has priority.
215+
Optional, only used on CAR requests.
216+
217+
Serves same purpose as [CAR `dups` content type parameter](#car-dups-content-type-parameter).
218+
219+
In case both are present in the request, the value from the [`Accept`](#accept-request-header) HTTP Header has priority and a matching [`Content-Location`](#content-location-response-header) SHOULD be returned with the response.
211220

212221
# HTTP Response
213222

@@ -249,7 +258,7 @@ A CAR stream for the requested
249258
content type (with optional `order` and `dups` params), path and optional
250259
`dag-scope` and `entity-bytes` URL parameters.
251260

252-
## CAR version (content type parameter)
261+
## CAR `version` (content type parameter)
253262

254263
Value returned in
255264
[`CarV1Header.version`](https://ipld.io/specs/transport/car/carv1/#header)

0 commit comments

Comments
 (0)