JSONPath -- XPath for JSON
draft-goessner-dispatch-jsonpath-00

Document Type Active Internet-Draft (individual)
Last updated 2020-07-13
Stream (None)
Intended RFC status (None)
Formats plain text html xml pdf htmlized (tools) htmlized bibtex
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)
Network Working Group                                         S. Gössner
Internet-Draft                                   Fachhochschule Dortmund
Intended status: Standards Track                         C. Bormann, Ed.
Expires: 13 January 2021                          Universität Bremen TZI
                                                            12 July 2020

                       JSONPath -- XPath for JSON
                  draft-goessner-dispatch-jsonpath-00

Abstract

   insert abstract here

Contributing

   This document picks up the popular JSONPath specification dated
   2007-02-21 and provides a more normative definition for it.  It is
   intended as a submission to the IETF DISPATCH WG, in order to find
   the right way to complete standardization of this specification.  In
   its current state, it is a strawman document showing what needs to be
   covered.

   Comments and issues can be directed at the github repository _insert
   repo here_ as well as (for the time when the more permanent home is
   being decided) at the dispatch@ietf.org mailing list.

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 13 January 2021.

Copyright Notice

   Copyright (c) 2020 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

Gössner & Bormann        Expires 13 January 2021                [Page 1]
Internet-Draft                  JSONPath                       July 2020

   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  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   3
     1.2.  Inspired by XPath . . . . . . . . . . . . . . . . . . . .   3
     1.3.  Overview of JSONPath Expressions  . . . . . . . . . . . .   4
   2.  JSONPath Examples . . . . . . . . . . . . . . . . . . . . . .   7
   3.  Detailed definition . . . . . . . . . . . . . . . . . . . . .   9
   4.  Discussion  . . . . . . . . . . . . . . . . . . . . . . . . .  10
   5.  IANA considerations . . . . . . . . . . . . . . . . . . . . .  10
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  10
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .  10
     6.2.  Informative References  . . . . . . . . . . . . . . . . .  11
   Appendix A.  Early JSONPath implementations . . . . . . . . . . .  11
     A.1.  Implementation  . . . . . . . . . . . . . . . . . . . . .  11
     A.2.  Usage . . . . . . . . . . . . . . . . . . . . . . . . . .  12
     A.3.  Parameters  . . . . . . . . . . . . . . . . . . . . . . .  12
     A.4.  Return value  . . . . . . . . . . . . . . . . . . . . . .  12
     A.5.  JavaScript Example  . . . . . . . . . . . . . . . . . . .  12
     A.6.  PHP example . . . . . . . . . . . . . . . . . . . . . . .  12
     A.7.  Results . . . . . . . . . . . . . . . . . . . . . . . . .  13
   Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . .  13
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  13

1.  Introduction

   This document picks up the popular JSONPath specification dated
   2007-02-21 [JSONPath-orig] and provides a more normative definition
   for it.  It is intended as a submission to the IETF DISPATCH WG, in
   order to find the right way to complete standardization of this
   specification.  In its current state, it is a strawman document
   showing what needs to be covered.

Gössner & Bormann        Expires 13 January 2021                [Page 2]
Internet-Draft                  JSONPath                       July 2020

1.1.  Terminology

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
   "OPTIONAL" in this document are to be interpreted as described in
   BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
Show full document text