summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Schaal <daniel@schaal.email>2016-09-10 13:49:46 +0200
committerDaniel Schaal <daniel@schaal.email>2016-09-10 13:49:46 +0200
commit2c688c13c6ea8cb325d98ace107344fa247bc3fc (patch)
tree271d9ff8037c361b7a82cd77ed7d2f7892cde94d
parent3c751ec9f6b30a3e6fec7117b940a120c9336eaa (diff)
Consistently use isUnread in item json
-rw-r--r--docs/externalapi/External-Api.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/externalapi/External-Api.md b/docs/externalapi/External-Api.md
index cedfdaff6..e652b114b 100644
--- a/docs/externalapi/External-Api.md
+++ b/docs/externalapi/External-Api.md
@@ -222,12 +222,12 @@ with the following request body:
// read and starred
"id": 5,
"isStarred": false,
- "isRead": true,
+ "isUnread": true,
"contentHash": "08ffbcf94bd95a1faa6e9e799cc29054"
}, {
// only read
"id": 6,
- "isRead": true,
+ "isUnread": true,
"contentHash": "09ffbcf94bd95a1faa6e9e799cc29054"
}, {
// only starred
@@ -248,7 +248,7 @@ If no items have been read or starred, simply leave the **items** array empty, e
The response matches the **GET** call, except there can be two different types of item objects:
* **[Full](#full)**: Contains all attributes
-* **[Reduced](#reduced)**: Contains only **id**, **isRead** and **isStarred**
+* **[Reduced](#reduced)**: Contains only **id**, **isUnread** and **isStarred**
The deciding factor whether a full or reduced item object is being returned depends on the contentHash in the request: If the contentHash matches the record in the database a reduced item object is being returned, otherwise a full object is used. Both can occur in the same items array at the same time.
@@ -264,11 +264,11 @@ For instance let's take a look at the following example. You are **POST**ing the
"items": [{
"id": 5,
"isStarred": false,
- "isRead": true,
+ "isUnread": true,
"contentHash": "08ffbcf94bd95a1faa6e9e799cc29054"
}, {
"id": 6,
- "isRead": true,
+ "isUnread": true,
"contentHash": "09ffbcf94bd95a1faa6e9e799cc29054"
}, {
"id": 7,
@@ -285,10 +285,10 @@ and receive the following output in return:
"items": [{
"id": 5,
"isStarred": false,
- "isRead": true
+ "isUnread": true
}, {
"id": 6,
- "isRead": true,
+ "isUnread": true,
"isStarred": false
}]
}
oducts derived from this software without * prior written permission. For written permission, please contact * openssl-core@openssl.org. * * 5. Products derived from this software may not be called "OpenSSL" * nor may "OpenSSL" appear in their names without prior written * permission of the OpenSSL Project. * * 6. Redistributions of any form whatsoever must retain the following * acknowledgment: * "This product includes software developed by the OpenSSL Project * for use in the OpenSSL Toolkit (http://www.openssl.org/)" * * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE. * ==================================================================== * * This product includes cryptographic software written by Eric Young * (eay@cryptsoft.com). This product includes software written by Tim * Hudson (tjh@cryptsoft.com). * */ #ifndef HEADER_SUREWARE_ERR_H # define HEADER_SUREWARE_ERR_H #ifdef __cplusplus extern "C" { #endif /* BEGIN ERROR CODES */ /* * The following lines are auto generated by the script mkerr.pl. Any changes * made after this point may be overwritten when the script is next run. */ static void ERR_load_SUREWARE_strings(void); static void ERR_unload_SUREWARE_strings(void); static void ERR_SUREWARE_error(int function, int reason, char *file, int line); # define SUREWAREerr(f,r) ERR_SUREWARE_error((f),(r),__FILE__,__LINE__) /* Error codes for the SUREWARE functions. */ /* Function codes. */ # define SUREWARE_F_SUREWAREHK_CTRL 100 # define SUREWARE_F_SUREWAREHK_DH_EX_FREE 112 # define SUREWARE_F_SUREWAREHK_DSA_DO_SIGN 101 # define SUREWARE_F_SUREWAREHK_EX_FREE 102 # define SUREWARE_F_SUREWAREHK_FINISH 103 # define SUREWARE_F_SUREWAREHK_INIT 104 # define SUREWARE_F_SUREWAREHK_LOAD_PRIVKEY 105 # define SUREWARE_F_SUREWAREHK_LOAD_PUBKEY 113 # define SUREWARE_F_SUREWAREHK_MODEXP 107 # define SUREWARE_F_SUREWAREHK_RAND_BYTES 108 # define SUREWARE_F_SUREWAREHK_RAND_SEED 109 # define SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC 110 # define SUREWARE_F_SUREWAREHK_RSA_SIGN 111 # define SUREWARE_F_SUREWARE_LOAD_PUBLIC 106 /* Reason codes. */ # define SUREWARE_R_BIO_WAS_FREED 100 # define SUREWARE_R_MISSING_KEY_COMPONENTS 105 # define SUREWARE_R_PADDING_CHECK_FAILED 106 # define SUREWARE_R_REQUEST_FAILED 101 # define SUREWARE_R_REQUEST_FALLBACK 102 # define SUREWARE_R_SIZE_TOO_LARGE_OR_TOO_SMALL 103 # define SUREWARE_R_UNIT_FAILURE 104 # define SUREWARE_R_UNKNOWN_PADDING_TYPE 107 #ifdef __cplusplus } #endif #endif