Skip to content

Commit

Permalink
Remove subchapter on Versioning (#225)
Browse files Browse the repository at this point in the history
* remove subchapter on versioning from the https binding

* fix table of content
  • Loading branch information
sebbader-sap authored Feb 15, 2024
1 parent d2798fe commit 19a7e8f
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions catalog/catalog.binding.https.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ This specification defines a RESTful API over HTTPS for the [Catalog Protocol](.
* [2.1 The `catalog/request` Endpoint (Provider-side)](#21-the-catalogrequest-endpoint--provider-side-)
* [2.2 The `catalog/datasets/:id` Endpoint (Provider-side)](#22-the-catalogdatasetsid-endpoint--provider-side-)
* [3 Technical Considerations](#3-technical-considerations)
* [3.1 Versioning](#31-versioning)
* [3.2 Pagination](#32-pagination)
* [3.3 Compression](#33-compression)
* [3.1 Pagination](#31-pagination)
* [3.2 Compression](#32-compression)
* [4 The Well-Known Proof Metadata Endpoint](#4-the-well-known-proof-metadata-endpoint)

## 1 Introduction
Expand Down Expand Up @@ -89,11 +88,7 @@ If the request is successful, the [Catalog Service](../model/terminology.md#cata

## 3 Technical Considerations

### 3.1 Versioning

- Versioning will be done via URLs. TBD.

### 3.2 Pagination
### 3.1 Pagination

A [Catalog Service](../model/terminology.md#catalog-service) may paginate the results of a [Catalog Request Message](./catalog.protocol.md#21-catalog-request-message). Pagination data must be specified using [Web Linking](https://datatracker.ietf.org/doc/html/rfc5988) and the HTTP `Link` header. The `Link` header will contain URLs for navigating to previous and subsequent results. Only the `next` and `previous` link relation types must be supported.
Note that the content and structure of the link query parameters is not defined by the current specification.
Expand Down Expand Up @@ -133,10 +128,11 @@ Link: <https://provider.com/catalog?continuationToken=bn9556075bn44de8ab4bfc9014
}
```

### 3.3 Compression
### 3.2 Compression

[Catalog Services](../model/terminology.md#catalog-service) MAY compress responses to a [Catalog Request](./catalog.protocol.md#21-catalog-request-message) by setting the `Content-Encoding` header to `gzip` as described in the [HTTP 1.1 Specification](https://www.rfc-editor.org/rfc/rfc9110.html#name-gzip-coding).


## 4 The Well-Known Proof Metadata Endpoint

When an implementation supports protected [Datasets](../model/terminology.md#dataset), it may offer a proof metadata endpoint clients can use to determine proof requirements. If the implementation offers a proof data endpoint, it must use the `dspace-trust` [Well-Known Uniform Resource Identifier](https://www.rfc-editor.org/rfc/rfc8615.html) at the top of the path hierarchy:
Expand Down

0 comments on commit 19a7e8f

Please sign in to comment.