search

standardnotes / docs

[Moved to https://github.com/standardnotes/app/tree/main/packages/docs] Documentation for Standard Notes users and developers | https://docs.standardnotes.com
https://docs.standardnotes.com
GNU Affero General Public License v3.0
7 stars 23 forks source link

Clarify which fields are optional and which fields are not #48

Open poscat0x04 opened 2 years ago

poscat0x04 commented 2 years ago

Hi, I'm trying to implement a standard notes sync server and would like to know which fields are optional and which fields are not. The documentation only said that the api field "must not be null" but there are no such comments for other fields. I doubt that they are all required cause surely a deleted item does not need to have a content field. It would be nice if the documentation could clear things up.

JaspalSuri commented 2 years ago

Hi @poscat0x04, thank you for the suggestion. Are you referring to this page in the documentation?

[Internal task link for the dev team.]

poscat0x04 commented 2 years ago

No, I'm talking about https://docs.standardnotes.com/specification/auth and https://docs.standardnotes.com/specification/sync

JaspalSuri commented 2 years ago

Thank you for clarifying! I've updated our internal task's description accordingly. 🙂

karolsojko commented 2 years ago

Hi @poscat0x04 as mentioned in this comment: https://github.com/standardnotes/docs/issues/1#issuecomment-589978343 the documentation in the links you've mentioned is outdated. We plan to refactor this in the near future, unfortunately as mentioned in the latest email we have our hands full with some exciting new changes coming in :) I'll keep this issue open so that we can address it in future.