Registration Data Access Protocol (RDAP) Partial Response
draft-ietf-regext-rdap-partial-response-03
Registration Protocols Extensions M. Loffredo
Internet-Draft M. Martinelli
Intended status: Standards Track IIT-CNR/Registro.it
Expires: January 31, 2020 July 30, 2019
Registration Data Access Protocol (RDAP) Partial Response
draft-ietf-regext-rdap-partial-response-03
Abstract
The Registration Data Access Protocol (RDAP) does not include
capabilities to request partial responses. In fact, according to the
user authorization, the server can only return full responses.
Partial responses capability, especially in the case of search
queries, could bring benefits to both clients and servers. This
document describes an RDAP query extension that allows clients to
specify their preference for obtaining a partial response.
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 January 31, 2020.
Copyright Notice
Copyright (c) 2019 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
(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
Loffredo & Martinelli Expires January 31, 2020 [Page 1]
Internet-Draft RDAP Partial Response July 2019
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 . . . . . . . . . . . . 3
2. Approaches to Partial Response Implementation . . . . . . . . 3
3. RDAP Path Segment Specification . . . . . . . . . . . . . . . 5
3.1. Subsetting Metadata . . . . . . . . . . . . . . . . . . . 5
3.1.1. Representing Subsetting Links . . . . . . . . . . . . 6
4. Dealing with Relationships . . . . . . . . . . . . . . . . . 7
5. Basic Field Sets . . . . . . . . . . . . . . . . . . . . . . 7
6. Negative Answers . . . . . . . . . . . . . . . . . . . . . . 8
7. RDAP Conformance . . . . . . . . . . . . . . . . . . . . . . 8
8. Implementation Status . . . . . . . . . . . . . . . . . . . . 8
8.1. IIT-CNR/Registro.it . . . . . . . . . . . . . . . . . . . 9
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
10. Security Considerations . . . . . . . . . . . . . . . . . . . 9
11. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 10
12. References . . . . . . . . . . . . . . . . . . . . . . . . . 10
12.1. Normative References . . . . . . . . . . . . . . . . . . 10
12.2. Informative References . . . . . . . . . . . . . . . . . 11
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 12
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 12
1. Introduction
The use of partial response in RESTful API ([REST]) design is very
common. The rationale is quite simple: instead of returning objects
in API responses with all data fields, only a subset is returned.
The benefit is obvious: less data transferred over the network means
less bandwidth usage, faster server response, less CPU time spent
both on the server and the client, as well as less memory usage on
the client.
Several leading APIs providers (e.g. LinkedIn [LINKEDIN], Facebook
[FACEBOOK], Google [GOOGLE]) implement the partial response feature
by providing an optional query parameter by which users require the
fields they wish to receive. Partial response is also considered a
leading principle by many best practices guidelines in REST APIs
implementation ([REST-API1], [REST-API2]) in order to improve
performance, save on bandwidth and possibly accelerate the overall
interaction. In other contexts, for example in digital libraries and
bibliographic catalogues, servers can provide responses according to
Show full document text