- Accounts: Konnector accounts
- Apps: Apps
- Bank: banking related data
- Bills: bills
- Contacts: instance owner contacts
- Files: files documents
- Files_metadatas: Metadatas about files
- Konnectors: Connectors
- Notifications: notifications made by the apps
- Permissions: Permissions of the instance
- Photos Albums: photos albums
- Procedures: Administrative procedures
- Sessions Logins: sessions logins entry
- Settings: Instance settings
- Sharings: documents used for Cozy to Cozy sharings
- Accounts Types: OAuth informations and secrets for apps & konnectors
- Autocategorization: Auto categorization remote doctype
- Exports: Instances exports
- Jobs: Instance jobs
- OAuth Clients: OAuth clients informations of the stack
- OAuth Access Codes: Access codes specific to OAuth flow
- Triggers: Job triggers
- Triggers state: Job triggers states
- Remote requests: logs of requests via the remote doctypes
- Sessions: cozy-stack sessions
- Shared: cozy-stack doctype for sharings
This repository is where the declaration of remote doctypes is done. Read more about remote doctypes in the cozy stack repository.
- Bets Unibet: Bets from Unibet website
Relations between documents are under a relationships
object at the root of the document. Relations are referenced by their names.
Each relation is an object with a data
property containing either null
, one reference or an array of references.
A reference is an object containing at least a _type
with the name of the referenced doctype and an _id
with the id of the referenced document inside its doctype.
{
"_id": "mobydick",
"relationships": {
"authors": {
"data": [{ "_id": "hermanmelville", "_type": "io.cozy.contacts" }]
}
}
}
We distinguish three levels : the data (a list of songs from a playlist), the metadata about the data (the creation date of the playlist itself), the metadata of the cozy document (the creation date of the cozy document describing the playlist).
The third level (metadata of the wrapping document) is described by an object named cozyMetadata
at the root of the document.
The following keys are reserved and have special meanings:
doctypeVersion
: Name or identifier for the version of the schema used by this document (ie:doctypeVersion: 2
for "This document conforms to io.cozy.contacts in its version 2")metadataVersion
: Version of thecozyMetadata
createdAt
: Creation date of the cozy documentcreatedByApp
: Slug of the app or connector which created the documentcreatedByAppVersion
: Version identifier of the appupdatedAt
: Last modification date of the cozy documentupdatedByApps
: List of objects representing the applications (slugs and versions) which modified the cozy document in its life and the last update date for each of those apps (one entry per slug, apps should just update the value)sourceAccount
: When the document was imported from a connector, identifier of the account in io.cozy.accounts
Note: All these attributes are optionnal and taken care by the apps modifying the document. Unless specified otherwise in the documentation of the doctype, all these attributes may not be present or may have a null
value.
{
"_id": "xxxx",
"cozyMetadata": {
"doctypeVersion": 4,
"metadataVersion": 1,
"createdAt": "xxxxx",
"createdByApp": "xxxx",
"createdByAppVersion": "xxxx",
"updatedAt": "xxxxx",
"updatedByApps": [
{
"slug": "xxxxx",
"date": "xxxxx",
"version": 3
}
],
"sourceAccount": "xxxxx"
}
}
Date should be formatted in ISO8601 :
2017-04-22T01:00:00-05:00
✅2017-04-22T01:00:00Z
✅2017-04-22
✅2017-04-22 01:00
❌