Mailing-List: contact dev-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@couchdb.apache.org
Date: Tue, 3 Dec 2013 19:39:37 +0000 (UTC)
From: "Nathan Vander Wilt (JIRA)" <jira@apache.org>
To: dev@couchdb.apache.org
Message-ID: <JIRA.12682470.1386099539275.64620.1386099577253@arcas>
In-Reply-To: <JIRA.12682470.1386099539275@arcas>
References: <JIRA.12682470.1386099539275@arcas>
Subject: [jira] [Created] (COUCHDB-1952) How exactly are underscore-prefixed
 fields reserved?
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit

Nathan Vander Wilt created COUCHDB-1952:
-------------------------------------------

             Summary: How exactly are underscore-prefixed fields reserved?
                 Key: COUCHDB-1952
                 URL: https://issues.apache.org/jira/browse/COUCHDB-1952
             Project: CouchDB
          Issue Type: Bug
          Components: Documentation
            Reporter: Nathan Vander Wilt


The wiki stated "Note that any top-level fields within a JSON document containing a name that starts with a _ prefix are reserved for use by CouchDB itself." http://wiki.apache.org/couchdb/HTTP_Document_API#Special_Fields

In the new documentation the closest equivalent I can find is the hand-wavy "As a general rule, URL components and JSON fields starting with the _ (underscore) character represent a special component or entity within the server or returned object." http://docs.couchdb.org/en/latest/api/index.html?highlight=underscore

I'd like to see the official documentation clarified:
- are underscore fields still reserved? (I'm assuming so.)
- are they reserved only at the top level? (I'm hoping so.)


--
This message was sent by Atlassian JIRA
(v6.1#6144)