Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • caosdb/src/caosdb-proto
1 result
Show changes
Commits on Source (8)
......@@ -3,7 +3,7 @@
# BUILD DOCS
* >=cmake-3.14
* >=cmake-3.13
* >=protoc-3.12
* =[protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc@)-1.4.1
* >=python-3.7
......
ALL:
@echo "THIS IS ONLY FOR DEVELOPMENT. DON'T USE IT"
formatting:
clang-format -i $$(find proto/ -type f -iname "*.proto")
......@@ -32,6 +32,6 @@ Results are in `build/doc_out/index.html`.
### Dependencies
* cmake >= v3.14
* cmake >= v3.13
* protoc >= v3.12
* all the pypi packages from `doc/requirements.txt`.
......@@ -121,7 +121,8 @@ enum MessageCode {
// TODO(tf) Could not move file to it's target folder.
MESSAGE_CODE_CANNOT_MOVE_FILE_TO_TARGET_PATH = 31;
// TODO(tf) Cannot parse value to datetime format (yyyy-mm-dd'T'hh:mm:ss[.fffffffff][TimeZone]).
// TODO(tf) Cannot parse value to datetime format
// (yyyy-mm-dd'T'hh:mm:ss[.fffffffff][TimeZone]).
MESSAGE_CODE_CANNOT_PARSE_DATETIME_VALUE = 32;
// TODO(tf) Cannot parse value to double.
......@@ -130,7 +131,8 @@ enum MessageCode {
// TODO(tf) Cannot parse value to integer.
MESSAGE_CODE_CANNOT_PARSE_INT_VALUE = 34;
// TODO(tf) Cannot parse value to boolean (either 'true' or 'false', ignoring case).
// TODO(tf) Cannot parse value to boolean (either 'true' or 'false', ignoring
// case).
MESSAGE_CODE_CANNOT_PARSE_BOOL_VALUE = 35;
// TODO(tf) Could not connect to MySQL server.
......@@ -139,7 +141,8 @@ enum MessageCode {
// TODO(tf) Please check if your MySQL has all required procedures installed.
MESSAGE_CODE_MYSQL_PROCEDURE_EXCEPTION = 37;
// TODO(tf) This error occurred while parsing the xml. Probably it has a wrong encoding.
// TODO(tf) This error occurred while parsing the xml. Probably it has a wrong
// encoding.
MESSAGE_CODE_REQUEST_HAS_WRONG_ENCODING = 38;
// TODO(tf) Request body didn't contain the expected Elements.
......@@ -154,10 +157,12 @@ enum MessageCode {
// TODO(tf) Could not move file to tmp folder.
MESSAGE_CODE_CANNOT_MOVE_FILE_TO_TMP = 42;
// TODO(tf) Insufficient read permission for this file. Please make it readable.
// TODO(tf) Insufficient read permission for this file. Please make it
// readable.
MESSAGE_CODE_CANNOT_READ_FILE = 43;
// TODO(tf) Insufficient read permission for this file's thumbnail. Please make it readable.
// TODO(tf) Insufficient read permission for this file's thumbnail. Please
// make it readable.
MESSAGE_CODE_CANNOT_READ_THUMBNAIL = 44;
// TODO(tf) No file representation submitted.
......@@ -172,7 +177,8 @@ enum MessageCode {
// TODO(tf) DESCRIPTION?
MESSAGE_CODE_UNKNOWN_JOB = 48;
// TODO(tf) Name is already in use. Choose a different name or reuse an existing entity.
// TODO(tf) Name is already in use. Choose a different name or reuse an
// existing entity.
MESSAGE_CODE_NAME_IS_NOT_UNIQUE = 49;
// TODO(tf) This entity cannot be identified uniquely due to name dublicates
......@@ -184,19 +190,22 @@ enum MessageCode {
// TODO(tf) This entity is empty.
MESSAGE_CODE_ENTITY_IS_EMPTY = 52;
// TODO(tf) An unknown error occured during the transaction and it was rolled back.
// TODO(tf) An unknown error occured during the transaction and it was rolled
// back.
MESSAGE_CODE_TRANSACTION_ROLL_BACK = 53;
// TODO(tf) The file upload failed for an unknown reason.
MESSAGE_CODE_FILE_UPLOAD_FAILED = 54;
// TODO(tf) Unknown unit. Values with this unit cannot be converted to other units when used in search queries.
// TODO(tf) Unknown unit. Values with this unit cannot be converted to other
// units when used in search queries.
MESSAGE_CODE_UNKNOWN_UNIT = 55;
// TODO(tf) You are not allowed to do this.
MESSAGE_CODE_AUTHORIZATION_ERROR = 56;
// TODO(tf) Reference not qualified. The value of this Reference Property is to be a child of its data type.
// TODO(tf) Reference not qualified. The value of this Reference Property is
// to be a child of its data type.
MESSAGE_CODE_REFERENCE_IS_NOT_ALLOWED_BY_DATATYPE = 57;
// TODO(tf) Cannot parse EntityACL.
......@@ -208,25 +217,32 @@ enum MessageCode {
// TODO(tf) This data type cannot be identified due to name duplicates.
MESSAGE_CODE_DATA_TYPE_NAME_DUPLICATES = 60;
// TODO(tf) This entity cannot be identified as it didn't come with a name or id.
// TODO(tf) This entity cannot be identified as it didn't come with a name or
// id.
MESSAGE_CODE_ENTITY_HAS_NO_NAME_OR_ID = 61;
// TODO(tf) Affiliation is not defined for this child-parent constellation.
MESSAGE_CODE_AFFILIATION_ERROR = 62;
// TODO(tf) An error occured during the parsing of this query. Maybe you use a wrong syntax?
// TODO(tf) An error occured during the parsing of this query. Maybe you use a
// wrong syntax?
MESSAGE_CODE_QUERY_PARSING_ERROR = 63;
// TODO(tf) A property which has 'name' as its parent must have a TEXT data type.
// TODO(tf) A property which has 'name' as its parent must have a TEXT data
// type.
MESSAGE_CODE_NAME_PROPERTIES_MUST_BE_TEXT = 64;
// TODO(tf) This entity had parent duplicates. That is meaningless and only one parent had been inserted.
// TODO(tf) This entity had parent duplicates. That is meaningless and only
// one parent had been inserted.
MESSAGE_CODE_PARENT_DUPLICATES_WARNING = 65;
// TODO(tf) This entity had parent duplicates. Parent duplicates are meaningless and would be ignored (and inserted only once). But these parents had diverging inheritance instructions which cannot be processed.
// TODO(tf) This entity had parent duplicates. Parent duplicates are
// meaningless and would be ignored (and inserted only once). But these
// parents had diverging inheritance instructions which cannot be processed.
MESSAGE_CODE_PARENT_DUPLICATES_ERROR = 66;
// TODO(tf) One or more entities are not qualified. None of them have been inserted/updated/deleted.
// TODO(tf) One or more entities are not qualified. None of them have been
// inserted/updated/deleted.
MESSAGE_CODE_ATOMICITY_ERROR = 67;
// TODO(tf) There is no such role '" + role + "'.
......@@ -244,7 +260,8 @@ enum MessageCode {
// TODO(tf) This reference cannot be identified due to name duplicates.
MESSAGE_CODE_REFERENCE_NAME_DUPLICATES = 72;
// TODO(tf) The datatype which is to be inherited could not be detected due to divergent datatypes of at least two parents.
// TODO(tf) The datatype which is to be inherited could not be detected due to
// divergent datatypes of at least two parents.
MESSAGE_CODE_DATATYPE_INHERITANCE_AMBIGUOUS = 73;
// TODO(tf) This datatype does not accept collections of values (e.g. Lists).
......@@ -253,7 +270,8 @@ enum MessageCode {
// TODO(tf) This unit cannot be parsed.
MESSAGE_CODE_CANNOT_PARSE_UNIT = 75;
// TODO(tf) This property is an additional property which has no corresponding property among the properties of the parents.
// TODO(tf) This property is an additional property which has no corresponding
// property among the properties of the parents.
MESSAGE_CODE_ADDITIONAL_PROPERTY = 76;
// TODO(tf) This property overrides the datatype.
......@@ -327,7 +345,8 @@ message Entity {
// relation to other entities or the server's state or configuration.
repeated Message infos = 13;
// File meta data. The actual binary data has to uploaded or downloaded using the File message.
// File meta data. The actual binary data has to uploaded or downloaded using
// the File message.
FileDescriptor file_descriptor = 14;
}
......@@ -377,6 +396,12 @@ message Property {
string unit = 6;
// Property datatype
string datatype = 7;
// Errors of this property
repeated Message errors = 8;
// Warnings of this property
repeated Message warnings = 9;
// Info messages of this property
repeated Message infos = 10;
}
// Parent of an entity.
......@@ -387,9 +412,14 @@ message Parent {
string name = 2;
// Description of the parent entity.
string description = 3;
// Errors of this parent
repeated Message errors = 4;
// Warnings of this parent
repeated Message warnings = 5;
// Info messages of this parent
repeated Message infos = 6;
}
// Response to a retrieve request
message RetrieveResponse {
// Payload of the retrieval
......@@ -405,7 +435,8 @@ message RetrieveResponse {
// CaosDB Query
message Query {
// The string representation of the query, e.g. "FIND Person WITH name = Aisha"
// The string representation of the query, e.g. "FIND Person WITH name =
// Aisha"
string query = 1;
}
......@@ -435,7 +466,8 @@ message QueryOrIdRequest {
}
}
// Single response containing either an id, a COUNT query result, a SELECT-table or complete entities.
// Single response containing either an id, a COUNT query result, a SELECT-table
// or complete entities.
message TransactionResponse {
// We wrap these together in order to make this a repeatable field in the
// MultiTransactionResponse.
......@@ -501,7 +533,8 @@ message IdResponse {
// Entity Transaction Service
service EntityTransactionService {
// Issue multiple mixed requests
rpc MultiTransaction(MultiTransactionRequest) returns (MultiTransactionResponse);
rpc MultiTransaction(MultiTransactionRequest)
returns (MultiTransactionResponse);
}
////////////////////////////////////////////////////////////////////////////
......@@ -529,23 +562,26 @@ enum TransmissionStatus {
TRANSMISSION_STATUS_SUCCESS = 1;
// The transmission terminated with errors.
TRANSMISSION_STATUS_ERROR = 2;
// The transmission is incomplete and the client may send/request the next chunk.
// The transmission is incomplete and the client may send/request the next
// chunk.
TRANSMISSION_STATUS_GO_ON = 3;
}
// Register a file upload.
message RegisterFileUploadRequest {
}
message RegisterFileUploadRequest {}
// Response of the file server upon an upload registration request.
message RegisterFileUploadResponse {
// Whether the server accepted or rejected the registration.
RegistrationStatus status = 1;
// The registration id is used to identify chunks and files which belong to the same upload .
// The registration id is used to identify chunks and files which belong to
// the same upload .
string registration_id = 2;
// The server's maximum chunk size. Submitting bigger chunks has undefined behavior.
// The server's maximum chunk size. Submitting bigger chunks has undefined
// behavior.
int64 max_chunk_size = 4;
// The server's maximum file size. Submitting bigger files has undefined behavior.
// The server's maximum file size. Submitting bigger files has undefined
// behavior.
int64 max_file_size = 5;
}
......@@ -563,7 +599,8 @@ message RegisterFileDownloadRequest {
// Identifies a file which is to be downloaded.
message FileIdentifier {
// Wraps several identifiers in order to have them as a repeatable field in other messages.
// Wraps several identifiers in order to have them as a repeatable field in
// other messages.
oneof wrapped_identifier {
// An entity id.
string entity_id = 1;
......@@ -591,7 +628,6 @@ message FileDownloadHeader {
repeated Message infos = 6;
}
// Response to a download registration request.
message RegisterFileDownloadResponse {
// Whether the server accepted or rejected the registration.
......@@ -611,7 +647,6 @@ message FileChunk {
bytes data = 5;
}
// Temporary identifier of a single file during a transmission.
message FileTransmissionId {
// The registration id which has been issued by the target of the trans
......@@ -622,8 +657,8 @@ message FileTransmissionId {
string file_id = 2;
}
// Request for a file upload which has been registered previously. Chunks may be send in any order.
// Request for a file upload which has been registered previously. Chunks may be
// send in any order.
message FileUploadRequest {
// A single file chunk
FileChunk chunk = 1;
......@@ -653,12 +688,14 @@ message FileDownloadResponse {
service FileTransmissionService {
// Register a file upload. This needs to be done prior to the actual upload
// and prior to the transaction request which uses the uploaded files.
rpc RegisterFileUpload(RegisterFileUploadRequest) returns (RegisterFileUploadResponse);
rpc RegisterFileUpload(RegisterFileUploadRequest)
returns (RegisterFileUploadResponse);
// The actual file upload. The upload has to be registered prior to this rpc.
rpc FileUpload(FileUploadRequest) returns (FileUploadResponse);
// Register a file download. This needs to be done prior to the actual download.
rpc RegisterFileDownload(RegisterFileDownloadRequest) returns (RegisterFileDownloadResponse);
// Register a file download. This needs to be done prior to the actual
// download.
rpc RegisterFileDownload(RegisterFileDownloadRequest)
returns (RegisterFileDownloadResponse);
// The actual download. The download has to be registered prior this rpc.
rpc FileDownload(FileDownloadRequest) returns (FileDownloadResponse);
}