JavaScript Object Notation (JSON) Path
draft-ietf-jsonpath-base-00

Document Type Active Internet-Draft (jsonpath WG)
Authors Glyn Normington  , Edward Surov  , Marko Mikulicic  , Stefan Gössner 
Last updated 2021-03-07
Replaces draft-normington-jsonpath
Stream Internet Engineering Task Force (IETF)
Intended RFC status (None)
Formats plain text pdf htmlized (tools) htmlized bibtex
Stream WG state WG Document
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
JSONPath WG                                           G. Normington, Ed.
Internet-Draft                                              VMware, Inc.
Intended status: Standards Track                           E. Surov, Ed.
Expires: 8 September 2021                        TheSoul Publishing Ltd.
                                                       M. Mikulicic, Ed.
                                                        InfluxData, Inc.
                                                              S. Gössner
                                                 Fachhochschule Dortmund
                                                            7 March 2021

                 JavaScript Object Notation (JSON) Path
                      draft-ietf-jsonpath-base-00

Abstract

   JSONPath defines a string syntax for identifying values within a
   JavaScript Object Notation (JSON) document.

Contributing

   This document picks up the popular JSONPath specification dated
   2007-02-21 and provides a normative definition for it.  In its
   current state, it is a strawman document showing what needs to be
   covered.

   Comments and issues may be directed to this document's github
   repository (https://github.com/ietf-wg-jsonpath/draft-ietf-jsonpath-
   jsonpath).

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 8 September 2021.

Normington, et al.      Expires 8 September 2021                [Page 1]
Internet-Draft                  JSONPath                      March 2021

Copyright Notice

   Copyright (c) 2021 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
     1.2.  Inspired by XPath . . . . . . . . . . . . . . . . . . . .   4
     1.3.  Overview of JSONPath Expressions  . . . . . . . . . . . .   5
   2.  JSONPath Examples . . . . . . . . . . . . . . . . . . . . . .   8
   3.  JSONPath Syntax and Semantics . . . . . . . . . . . . . . . .  11
     3.1.  Overview  . . . . . . . . . . . . . . . . . . . . . . . .  11
     3.2.  Terminology . . . . . . . . . . . . . . . . . . . . . . .  11
     3.3.  Implementation  . . . . . . . . . . . . . . . . . . . . .  11
     3.4.  Syntax  . . . . . . . . . . . . . . . . . . . . . . . . .  12
     3.5.  Semantics . . . . . . . . . . . . . . . . . . . . . . . .  12
     3.6.  Selectors . . . . . . . . . . . . . . . . . . . . . . . .  13
       3.6.1.  Dot Child Selector  . . . . . . . . . . . . . . . . .  13
       3.6.2.  Union Selector  . . . . . . . . . . . . . . . . . . .  14
         3.6.2.1.  Syntax  . . . . . . . . . . . . . . . . . . . . .  14
         3.6.2.2.  Semantics . . . . . . . . . . . . . . . . . . . .  14
         3.6.2.3.  Child . . . . . . . . . . . . . . . . . . . . . .  14
         3.6.2.4.  Array Selector  . . . . . . . . . . . . . . . . .  16
   4.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  20
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .  20
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  20
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .  20
     6.2.  Informative References  . . . . . . . . . . . . . . . . .  20
   Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . .  21
   Contributors  . . . . . . . . . . . . . . . . . . . . . . . . . .  21
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  22

Normington, et al.      Expires 8 September 2021                [Page 2]
Internet-Draft                  JSONPath                      March 2021

1.  Introduction

   This document picks up the popular JSONPath specification dated
Show full document text