From da4b03be040afd78abc29452b45a47109169f895 Mon Sep 17 00:00:00 2001 From: Daniel <d.hornung@indiscale.com> Date: Tue, 9 Nov 2021 12:21:53 +0100 Subject: [PATCH] MAINT: Typos and wording fixed. --- CHANGELOG.md | 8 ++++---- proto/caosdb/entity/v1/main.proto | 14 +++++++------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dfc9976..65932ce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,7 +25,7 @@ transactions for insertion, updates, retrieval and deletion of entities and the upload and download of binary files. Entities can be retrieved by id or by query. Several entities can be processed -a single transaction and the transaction types (insertion, update, deletion, +in a single transaction and the transaction types (insertion, update, deletion, retrieval) can be mixed in a single transaction. Notable current limitations of the API: @@ -33,14 +33,14 @@ Notable current limitations of the API: * The error handling is still not perfect. Properties cannot have messages right now and only a few error messages are defined in the API. * The version message can only represent the version id of an entity. The - History cannot be retrieved. + history cannot be retrieved. * The entity's access control lists cannot be changed or retrieved. * The entity state cannot be changed or retrieved. * A lot of flags (e.g. inheritance among other things) which are implemented - in the REST-API of CaosDB are not supported. + in the REST API of CaosDB are not supported. The current release is designed in a way that these limitation can be be -overcome in future releases of the API without braking backwards compatibility. +overcome in future releases of the API without breaking backwards compatibility. #### Info API (v1) diff --git a/proto/caosdb/entity/v1/main.proto b/proto/caosdb/entity/v1/main.proto index c04ca35..8930e4e 100644 --- a/proto/caosdb/entity/v1/main.proto +++ b/proto/caosdb/entity/v1/main.proto @@ -155,10 +155,10 @@ enum MessageCode { // On update: Entity, Property or Parent has no ID and the server is // configured to require a valid ID for all entities which are to be updated - // and their properties and parents as well. + // and for their properties and parents as well. MESSAGE_CODE_ENTITY_HAS_NO_ID = 7; - // Entity is required by other entities which are not to be deleted. + // On delete: Entity is required by other entities which are not to be deleted. MESSAGE_CODE_REQUIRED_BY_PERSISTENT_ENTITY = 8; // Property has no datatype. @@ -215,8 +215,8 @@ enum MessageCode { // Cannot parse value as integer value. MESSAGE_CODE_CANNOT_PARSE_INT_VALUE = 26; - // Cannot parse value as boolean value (either 'true' or 'false', ignoring - // case). + // Cannot parse value as boolean value (either 'true' or 'false', case + // insensitive). MESSAGE_CODE_CANNOT_PARSE_BOOL_VALUE = 27; // File could not be found. @@ -258,7 +258,7 @@ enum MessageCode { // Affiliation is not defined for this child-parent constellation. MESSAGE_CODE_AFFILIATION_ERROR = 40; - // An error occured during the parsing of this query. Maybe you use a wrong + // An error occured during the parsing of this query. Maybe you were using a wrong // syntax? MESSAGE_CODE_QUERY_PARSING_ERROR = 41; @@ -323,8 +323,8 @@ enum MessageCode { MESSAGE_CODE_INTEGER_VALUE_OUT_OF_RANGE = 58; // This entity caused an unexpected integrity violation. This is a strong - // indicator for a server bug. Please report. - MESSAGE_CODE_INTEGRITY_VIOLOATION = 59; + // indicator for a server bug. Please report. + MESSAGE_CODE_INTEGRITY_VIOLATION = 59; } // Messages are used by server's or client's to transport *transient* -- GitLab