Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pagination and filter changes #228

Conversation

jimmarino
Copy link
Contributor

Adds the following:

  • Adjust pagination to be normative and only require "next" and "previous" relations.
  • Change the pagination examples to use a continuation param.
  • Add Result 400 Bad Request.

Note that pagination "normative" cannot be done in the abstract protocol specification as some transports may not support (or want to support) pagination. We also should not make pagination "mandatory" since an implementation may choose not to offer it (which, for most catalogs, even large ones, is likely not necessary given support for compression technologies) or choose to perform it on every type of request. Making it "normative" means when pagination is performed, it is serialized in a certain format.

Note that I did not change the Technical Considerations section. It offers important information about the protocol design (not implementation-specific information) that is valuable to retain.

Closes #194

Copy link
Collaborator

@matgnt matgnt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks you!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't see the diff in this file except the whitespace at the end, which is probably not intended.

@ssteinbuss ssteinbuss merged commit e5b658a into International-Data-Spaces-Association:main Feb 15, 2024
1 check passed
ssteinbuss added a commit that referenced this pull request Feb 15, 2024
* ci: fix typo for file check workflow (#215)

* ci: fix typo

* ci: remove duplicated workflow trigger

* Update context.json (#216)

* replace odrl:offer/odrl:agreement with dspace:offer/dspace:agreement (#221)

* extend explanation on dspace-trust child resources (#222)

* Replace providerId/consumerId with odrl:assigner / odrl:assignee (#213)

* replace providerId/consumerId with odrl:assigner / odrl:assignee

* replace providerId/consumerId in contract.negotiation.protocol

* fix the ToC in contract.negotiation.binding.https

* Update model documents (#229)

* Add pagination and filter changes (#228)

* Add pagination and filter changes

* Change continuation tokens

* Adds auth description to common bindings document (#227)

* Add description

* Remove auth sections

* Remove auth sections from catalog

* Remove subchapter on Versioning (#225)

* remove subchapter on versioning from the https binding

* fix table of content

* Cleanup `EndpointProperty` inconsistencies and specify `authType` (#218)

* Specify auth type property; clarify authorization property and make case consistent; remove incorrect bearer prefix; remove non-normative S3 reference

* Add descriptions

* Remove S3 reference

* Remove S3 reference

* Revert releases folder change

* Emphazising that the spec does not cover the data transfer (#230)

* Highlighting the text by formatting
* Adding further explanation

---------

Co-authored-by: Julia Pampus <72392527+juliapampus@users.noreply.github.com>
Co-authored-by: Maarten Kollenstart <maarten.kollenstart@tno.nl>
Co-authored-by: sebbader-sap <107036549+sebbader-sap@users.noreply.github.com>
Co-authored-by: Jim Marino <jim.marino@gmail.com>
ssteinbuss added a commit that referenced this pull request Feb 16, 2024
* Update model.md

* Splitting to not-normative and normative part
* adding  description on registry

* Fix formatting

* Update model.md

Adding intro text

* Update model/model.md

fixing typo

Co-authored-by: Jim Marino <jim.marino@gmail.com>

* Fix formatting

* Adding link to terminology

* Update model/model.md

Co-authored-by: Julia Pampus <72392527+juliapampus@users.noreply.github.com>

* update branch (#231)

* ci: fix typo for file check workflow (#215)

* ci: fix typo

* ci: remove duplicated workflow trigger

* Update context.json (#216)

* replace odrl:offer/odrl:agreement with dspace:offer/dspace:agreement (#221)

* extend explanation on dspace-trust child resources (#222)

* Replace providerId/consumerId with odrl:assigner / odrl:assignee (#213)

* replace providerId/consumerId with odrl:assigner / odrl:assignee

* replace providerId/consumerId in contract.negotiation.protocol

* fix the ToC in contract.negotiation.binding.https

* Update model documents (#229)

* Add pagination and filter changes (#228)

* Add pagination and filter changes

* Change continuation tokens

* Adds auth description to common bindings document (#227)

* Add description

* Remove auth sections

* Remove auth sections from catalog

* Remove subchapter on Versioning (#225)

* remove subchapter on versioning from the https binding

* fix table of content

* Cleanup `EndpointProperty` inconsistencies and specify `authType` (#218)

* Specify auth type property; clarify authorization property and make case consistent; remove incorrect bearer prefix; remove non-normative S3 reference

* Add descriptions

* Remove S3 reference

* Remove S3 reference

* Revert releases folder change

* Emphazising that the spec does not cover the data transfer (#230)

* Highlighting the text by formatting
* Adding further explanation

---------

Co-authored-by: Julia Pampus <72392527+juliapampus@users.noreply.github.com>
Co-authored-by: Maarten Kollenstart <maarten.kollenstart@tno.nl>
Co-authored-by: sebbader-sap <107036549+sebbader-sap@users.noreply.github.com>
Co-authored-by: Jim Marino <jim.marino@gmail.com>

* Merging definitions of dataspace registry

* Clarifing that the Rulebook content is non-normative and an example

* Update model/model.md

Co-authored-by: Jim Marino <jim.marino@gmail.com>

---------

Co-authored-by: Jim Marino <jim.marino@gmail.com>
Co-authored-by: Julia Pampus <72392527+juliapampus@users.noreply.github.com>
Co-authored-by: Maarten Kollenstart <maarten.kollenstart@tno.nl>
Co-authored-by: sebbader-sap <107036549+sebbader-sap@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Catalog: Pagination and Filter making it hard to reach compatibility in practice
4 participants