High level API serialization

Summary

Enhanced JSON serialization in the high level API. Most importantly, serialize() now has a plain_json parameter.

Focus

Are the changes backwards compatible?

Test Environment

• Run the tests (still to be written).

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues #245 (closed)
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

assigned to @daniel

marked the checklist item All automated tests pass as completed

left review comments

added 1 commit

• 49382a8f - STYLE: Whitespace only.

Compare with previous version

added 1 commit

• af843d65 - TEST: Added unit test for high level api serialization.

Compare with previous version

marked the checklist item Up-to-date CHANGELOG.md (or not necessary) as completed

added 1 commit

• 70588ba6 - DOCS: More documentation for the high level api serialization.

Compare with previous version

marked the checklist item Up-to-date JSON schema (or not necessary) as completed

marked the checklist item Appropriate user and developer documentation (or not necessary) as completed

left review comments

requested review from @i.nueske

marked the checklist item Annotations in code (Gitlab comments) as completed

marked this merge request as ready

mentioned in merge request caosdb-advanced-user-tools!132 (merged)