Unverified Commit 17089f20 authored by Vasili Novikov's avatar Vasili Novikov
Browse files

Update Schema documentation

parent 45008339
Showing with 2 additions and 17 deletions
+2 -17
......@@ -65,21 +65,6 @@ All property names MUST consist of `a-zA-Z0-9_` characters only, and start with
All type names MUST consist of `a-zA-Z0-9_` characters only, and start with `a-zA-Z`
(same as column names).
### Changing the schema locally
If you want to make local changes to the schema while developing
new functionality, you can edit the schema directly.
It's located in `/res/autogenerated_database_schema.json`.
Simply re-start the Pod to apply the changes.
### Contributing your schema
The schema is also used in iOS and other projects.
To make it available universally, please submit your schema to the "schema" repository:
[https://gitlab.memri.io/memri/schema](https://gitlab.memri.io/memri/schema).
Changes made to "schema" repository will allow you to generate new definitions
for other projects, and for Pod.
You can copy the newly generated JSON to Pod during development.
You can contribute to the schemas by making a Merge Requests for the "schema" repository.
Please refer to that repo's documentation on how to work with it and do it best.
TODO: the way of working with Schema has changed and is not fully documented yet.
Refer to the [HTTP_API](./HTTP_API.md) to see how you can change the Schema for now.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment