RESTCONF Extensions to Support List Pagination
draft-wwlh-netconf-list-pagination-rc-01
|
Document |
Type |
|
Active Internet-Draft (individual)
|
|
Authors |
|
Kent Watsen
,
Qin Wu
,
Olof Hagsand
,
Hongwei Li
|
|
Last updated |
|
2020-11-02
|
|
Stream |
|
(None)
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
plain text
xml
pdf
htmlized (tools)
htmlized
bibtex
|
|
Yang Validation |
|
☯
3 errors, 1 warnings.
draft-wwlh-netconf-list-pagination-rc-01.txt:
xym 0.4.10:
Extracting 'ietf-restconf-list-pagination@2020-11-02.yang'
Removed 0 empty lines
ietf-restconf-list-pagination@2015-01-30.yang:
pyang 2.4.0: pyang --verbose --ietf -p {libs} {model}:
# module search path: a/www/ietf-ftp/yang/rfcmod/:/a/www/ietf-ftp/yang/draftmod/:/a/www/ietf-ftp/yang/ianamod/:/a/www/ietf-ftp/yang/catalogmod/:.:/var/lib/wwwrun/yang/modules:/a/www/ietf-datatracker/7.24.0/env/share/yang/modules
# read ietf-restconf-list-pagination@2015-01-30.yang (CL)
# read /a/www/ietf-ftp/yang/rfcmod/ietf-restconf.yang
# read /a/www/ietf-datatracker/7.24.0/env/share/yang/modules/ietf/ietf-restconf.yang
ietf-restconf-list-pagination@2015-01-30.yang:2: warning: the escape sequence "\
" is unsafe in double quoted strings - pass the flag --lax-quote-checks to avoid this warning
ietf-restconf-list-pagination@2015-01-30.yang:3: error: bad value "urn:ietf:params:xml:ns:yang:ietf-restconf-list-paginati\
on" (should be uri)
yanglint SO 1.6.7: yanglint --verbose -p {tmplib} -p {rfclib} -p {draftlib} -p {ianalib} -p {cataloglib} {model} -i:
err : Encountered invalid character sequence "\
on"".
err : Module "ietf-restconf-list-pagination" parsing failed.
|
|
Additional Resources |
|
|
Stream |
Stream state |
|
(No stream defined) |
|
Consensus Boilerplate |
|
Unknown
|
|
RFC Editor Note |
|
(None)
|
IESG |
IESG state |
|
I-D Exists
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
(None)
|
NETCONF Working Group K. Watsen
Internet-Draft Watsen Network
Intended status: Standards Track Q. Wu
Expires: May 6, 2021 Huawei
O. Hagsand
Netgate
H. Li
HPE
November 2, 2020
RESTCONF Extensions to Support List Pagination
draft-wwlh-netconf-list-pagination-rc-01
Abstract
In some circumstance, a server may contain many instances of a
particular YANG list or leaf-list. Retrieval of the entire list or
leaf-list at once can be extremely inefficient.
Pagination mechanisms are needed to allow a client to iterate through
a large list, in a manner that is most efficient for the application.
This document Updates RFC 8040 to declare "list" and "leaf-list" as
resource targets for the RESTCONF operations such as GET, POST
operations.
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 May 6, 2021.
Watsen, et al. Expires May 6, 2021 [Page 1]
Internet-Draft RESTCONF Pagination Support November 2020
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
(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 . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. RESTCONF Extensions . . . . . . . . . . . . . . . . . . . . . 4
2.1. RESTCONF Media Type . . . . . . . . . . . . . . . . . . . 4
2.2. New Resource Target . . . . . . . . . . . . . . . . . . . 4
3. YANG Module for List Pagination . . . . . . . . . . . . . . . 4
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
4.1. The "IETF XML" Registry . . . . . . . . . . . . . . . . . 6
4.2. The "YANG Module Names" Registry . . . . . . . . . . . . 6
4.3. The "Media Types" Registry . . . . . . . . . . . . . . . 6
4.3.1. Media Type "application/yang-collection+xml" . . . . 6
4.3.2. Media Type "application/yang-data+xml-list" . . . . . 8
5. Security Considerations . . . . . . . . . . . . . . . . . . . 9
5.1. The "ietf-restconf-list-pagination" YANG Module . . . . . 9
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 9
6.1. Normative References . . . . . . . . . . . . . . . . . . 9
6.2. Informative References . . . . . . . . . . . . . . . . . 10
Appendix A. Example YANG Module . . . . . . . . . . . . . . . . 12
Appendix B. Example Data . . . . . . . . . . . . . . . . . . . . 12
Appendix C. Example Queries . . . . . . . . . . . . . . . . . . 12
C.1. No Query Parameter . . . . . . . . . . . . . . . . . . . 12
C.1.1. XML . . . . . . . . . . . . . . . . . . . . . . . . . 12
C.1.2. JSON . . . . . . . . . . . . . . . . . . . . . . . . 13
C.2. Just the "count" Parameter . . . . . . . . . . . . . . . 13
C.3. Just the "skip" Parameter . . . . . . . . . . . . . . . . 14
C.4. Just the "direction" Parameter . . . . . . . . . . . . . 15
C.5. Just the "sort" Parameter . . . . . . . . . . . . . . . . 16
C.6. Combination of "where" + "count" . . . . . . . . . . . . 17
C.7. Combination of "where" + "skip" + "count" . . . . . . . . 18
C.8. Combination of "where" + "sort" + "skip","count" . . . . 19
Show full document text