Return-Path: X-Original-To: apmail-couchdb-dev-archive@www.apache.org Delivered-To: apmail-couchdb-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4DC9510F6F for ; Tue, 3 Dec 2013 19:47:37 +0000 (UTC) Received: (qmail 48678 invoked by uid 500); 3 Dec 2013 19:47:36 -0000 Delivered-To: apmail-couchdb-dev-archive@couchdb.apache.org Received: (qmail 48630 invoked by uid 500); 3 Dec 2013 19:47:36 -0000 Mailing-List: contact dev-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list dev@couchdb.apache.org Received: (qmail 48569 invoked by uid 99); 3 Dec 2013 19:47:36 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 03 Dec 2013 19:47:36 +0000 Date: Tue, 3 Dec 2013 19:47:36 +0000 (UTC) From: "Alexander Shorin (JIRA)" To: dev@couchdb.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (COUCHDB-1952) How exactly are underscore-prefixed fields reserved? MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/COUCHDB-1952?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13838091#comment-13838091 ] Alexander Shorin commented on COUCHDB-1952: ------------------------------------------- Both yes. You'll get self explain error response if you try to violate these rules. > 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)