idnits 2.17.1 draft-ietf-geojson-text-seq-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (April 07, 2016) is 2939 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Missing Reference: 'GeoJSON' is mentioned on line 96, but not defined == Unused Reference: 'RFC7159' is defined on line 171, but no explicit reference was found in the text ** Obsolete normative reference: RFC 7159 (Obsoleted by RFC 8259) Summary: 1 error (**), 0 flaws (~~), 3 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 GeoJSON S. Gillies 3 Internet-Draft Mapbox 4 Intended status: Informational April 07, 2016 5 Expires: October 9, 2016 7 GeoJSON Text Sequences 8 draft-ietf-geojson-text-seq-00 10 Abstract 12 A proposed standard for geographic data that can be parsed and 13 produced incrementally 15 Status of This Memo 17 This Internet-Draft is submitted in full conformance with the 18 provisions of BCP 78 and BCP 79. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF). Note that other groups may also distribute 22 working documents as Internet-Drafts. The list of current Internet- 23 Drafts is at http://datatracker.ietf.org/drafts/current/. 25 Internet-Drafts are draft documents valid for a maximum of six months 26 and may be updated, replaced, or obsoleted by other documents at any 27 time. It is inappropriate to use Internet-Drafts as reference 28 material or to cite them other than as "work in progress." 30 This Internet-Draft will expire on October 9, 2016. 32 Copyright Notice 34 Copyright (c) 2016 IETF Trust and the persons identified as the 35 document authors. All rights reserved. 37 This document is subject to BCP 78 and the IETF Trust's Legal 38 Provisions Relating to IETF Documents 39 (http://trustee.ietf.org/license-info) in effect on the date of 40 publication of this document. Please review these documents 41 carefully, as they describe your rights and restrictions with respect 42 to this document. Code Components extracted from this document must 43 include Simplified BSD License text as described in Section 4.e of 44 the Trust Legal Provisions and are provided without warranty as 45 described in the Simplified BSD License. 47 Table of Contents 49 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 50 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2 51 2. GeoJSON Text Sequence Format . . . . . . . . . . . . . . . . 2 52 3. Security Considerations . . . . . . . . . . . . . . . . . . . 3 53 4. Interoperability Considerations . . . . . . . . . . . . . . . 3 54 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 3 55 6. Normative References . . . . . . . . . . . . . . . . . . . . 4 56 Appendix A. Contributors . . . . . . . . . . . . . . . . . . . . 4 57 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 4 59 1. Introduction 61 Large or never-ending sequences of records pose a problem for JSON 62 that is well explained in the motivation for JSON Text Sequences 63 [RFC7464]. GeoJSON [GeoJSON] faces the same kind of problem: 64 geographic datasets often run to the tens of thousands or millions of 65 records. The problem is amplified by the possibility of large arrays 66 of coordinates for each of the records. 68 This document describes a solution to this problem based on JSON Text 69 Sequences. A GeoJSON Text Sequence is a document containing not, 70 e.g., a single GeoJSON Feature Collection, but multiple GeoJSON 71 Feature texts that can be parsed and produced incrementally. 73 The advantage of using ASCII character RS "0x1e" to denote a record 74 is that sequence producers and parsers need not enforce a canonical 75 form for record GeoJSON. Any valid GeoJSON, pretty-printed or 76 compact, can be used in a GeoJSON text sequence. Additionally, 77 GeoJSON text sequences inherit from [RFC7464] rules for consistent 78 processing of sequences with potentially corrupted records. 80 1.1. Requirements Language 82 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 83 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 84 "OPTIONAL" in this document are to be interpreted as described in 85 [RFC2119]. 87 2. GeoJSON Text Sequence Format 89 Defined in prose, following [RFC7464]: a GeoJSON text sequence is any 90 number of GeoJSON texts, each encoded in UTF-8 [RFC3629], each 91 preceded by one ASCII RS character, and each followed by a line feed 92 (LF). 94 The GeoJSON Text Sequence Format conforms to all the rules of 95 [RFC7464] and adds the following constraint: each JSON text MUST 96 contain a single GeoJSON object as defined in [GeoJSON]. 98 Heterogeneous sequences containing a mix of GeoJSON Geometry, 99 Feature, and Feature Collection objects are permitted. How producers 100 and parsers of GeoJSON text sequences should communicate about which 101 GeoJSON types might appear in a sequence is not specified in this 102 document. 104 3. Security Considerations 106 GeoJSON text sequences have no security considerations beyond those 107 of JSON text sequences and the GeoJSON format. 109 4. Interoperability Considerations 111 A variety of parsers designed for newline-delimited sequences of 112 compact JSON text are deployed on the internet today. While there is 113 no canonical form for JSON texts, and pretty-printed and compact 114 forms are equally valid, GeoJSON text sequences containing compact 115 GeoJSON texts with no internal newlines are more interoperable with 116 existing non-standardized parsers. 118 In a distributed system where order and exactly-once delivery of 119 messages are difficult to achieve, GeoJSON text sequences that do not 120 rely on order of texts for extra semantics are more interoperable 121 than those that do. 123 5. IANA Considerations 125 The MIME media type for GeoJSON feature sequences is application/geo 126 +json-seq. 128 Type name: application 130 Subtype name: geo+json-seq 132 Required parameters: n/a 134 Optional parameters: n/a 136 Encoding considerations: binary 138 Security considerations: See section 5 above 140 Interoperability considerations: See section 6 above 141 Published specification: [[This document]] 143 Applications that use this media type: various 145 Additional information: 147 Magic number(s): n/a 149 File extension(s): n/a 151 Macintosh file type code: n/a 153 Object Identifiers: n/a 155 Person to contact for further information: Sean Gillies 156 (sean.gillies@gmail.com) 158 Intended usage: COMMON 160 Restrictions on usage: none 162 6. Normative References 164 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 165 Requirement Levels", BCP 14, RFC 2119, March 1997. 167 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 168 10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November 169 2003, . 171 [RFC7159] Bray, T., "The JavaScript Object Notation (JSON) Data 172 Interchange Format", RFC 7159, March 2014. 174 [RFC7464] Williams, N., "JavaScript Object Notation (JSON) Text 175 Sequences", RFC 7464, DOI 10.17487/RFC7464, February 2015, 176 . 178 Appendix A. Contributors 180 TODO. 182 Author's Address 184 S. Gillies 185 Mapbox 187 Email: sean.gillies@gmail.com 188 URI: http://sgillies.net