Registration Data Access Protocol (RDAP) Query Parameters for Result Sorting and Paging
draft-ietf-regext-rdap-sorting-and-paging-19
| Document | Type | Active Internet-Draft (regext WG) | |
|---|---|---|---|
| Authors | Mario Loffredo , Maurizio Martinelli , Scott Hollenbeck | ||
| Last updated | 2020-10-04 | ||
| Replaces | draft-loffredo-regext-rdap-sorting-and-paging | ||
| Stream | IETF | ||
| Intended RFC status | Proposed Standard | ||
| Formats | plain text xml pdf htmlized (tools) htmlized bibtex | ||
| Reviews | |||
| Stream | WG state | Submitted to IESG for Publication | |
| Document shepherd | Tom Harrison | ||
| Shepherd write-up | Show (last changed 2020-04-21) | ||
| IESG | IESG state | IESG Evaluation::AD Followup | |
| Consensus Boilerplate | Yes | ||
| Telechat date |
Has enough positions to pass. |
||
| Responsible AD | Barry Leiba | ||
| Send notices to | Tom Harrison <tomh@apnic.net> | ||
| IANA | IANA review state | Version Changed - Review Needed | |
| IANA expert review state | Expert Reviews OK | ||
Registration Protocols Extensions M. Loffredo
Internet-Draft M. Martinelli
Intended status: Standards Track IIT-CNR/Registro.it
Expires: April 7, 2021 S. Hollenbeck
Verisign Labs
October 4, 2020
Registration Data Access Protocol (RDAP) Query Parameters for Result
Sorting and Paging
draft-ietf-regext-rdap-sorting-and-paging-19
Abstract
The Registration Data Access Protocol (RDAP) does not include core
functionality for clients to provide sorting and paging parameters
for control of large result sets. This omission can lead to
unpredictable server processing of queries and client processing of
responses. This unpredictability can be greatly reduced if clients
can provide servers with their preferences for managing large
responses. This document describes RDAP query extensions that allow
clients to specify their preferences for sorting and paging result
sets.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on April 7, 2021.
Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
Loffredo, et al. Expires April 7, 2021 [Page 1]
Internet-Draft RDAP Sorting and Paging October 2020
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Conventions Used in This Document . . . . . . . . . . . . 4
2. RDAP Query Parameter Specification . . . . . . . . . . . . . 4
2.1. Sorting and Paging Metadata . . . . . . . . . . . . . . . 4
2.1.1. RDAP Conformance . . . . . . . . . . . . . . . . . . 6
2.2. "count" Parameter . . . . . . . . . . . . . . . . . . . . 6
2.3. "sort" Parameter . . . . . . . . . . . . . . . . . . . . 7
2.3.1. Sorting Properties Declaration . . . . . . . . . . . 8
2.3.2. Representing Sorting Links . . . . . . . . . . . . . 14
2.4. "cursor" Parameter . . . . . . . . . . . . . . . . . . . 16
2.4.1. Representing Paging Links . . . . . . . . . . . . . . 16
3. Negative Answers . . . . . . . . . . . . . . . . . . . . . . 17
4. Implementation Considerations . . . . . . . . . . . . . . . . 18
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18
6. Implementation Status . . . . . . . . . . . . . . . . . . . . 19
6.1. IIT-CNR/Registro.it . . . . . . . . . . . . . . . . . . . 19
6.2. APNIC . . . . . . . . . . . . . . . . . . . . . . . . . . 19
7. Security Considerations . . . . . . . . . . . . . . . . . . . 20
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 20
8.1. Normative References . . . . . . . . . . . . . . . . . . 20
8.2. Informative References . . . . . . . . . . . . . . . . . 22
Appendix A. JSONPath operators . . . . . . . . . . . . . . . . . 23
Appendix B. Approaches to Result Pagination . . . . . . . . . . 24
B.1. Specific Issues Raised by RDAP . . . . . . . . . . . . . 26
Appendix C. Additional Implementation Notes . . . . . . . . . . 26
C.1. Sorting . . . . . . . . . . . . . . . . . . . . . . . . . 27
C.2. Counting . . . . . . . . . . . . . . . . . . . . . . . . 27
C.3. Paging . . . . . . . . . . . . . . . . . . . . . . . . . 27
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 28
Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 31
Show full document text