Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Response headers must appear in the documentation of the sync protocol #40

Open
labkode opened this issue Sep 20, 2015 · 4 comments
Open

Comments

@labkode
Copy link
Member

labkode commented Sep 20, 2015

@moscicki @dragotin

In the spec of the sync protocol we have to show the response headers in the examples, as they are a core part of the protocol.

An example: If you don't reply with the ETag on a download then the client will complain: https://github.com/owncloud/client/blob/7fc7925d17df58e6dfb9eb1383f0895d5fadce58/src/libsync/propagatedownload.cpp#L150

@dragotin
Copy link

Well, the ETag response header is mentioned in the file download section. The example there is very brief indeed, do you think that should be changed?

Apart from that, I think the ETag is explained properly, or not?

@labkode
Copy link
Member Author

labkode commented Sep 23, 2015

@dragotin Yes, Klass, sorry for the noise. It is well explained in the file download section.

I have other question about the spec, the documentation just tell you the format for the calls/operations that the sync client does, but there is no information about the order of the operations.

I think it is important to document the sequence of events.

For example, to setting up a working connection:

  1. Issue a status.php
  2. Ask for capabilities. TBD
  3. Ask for quota. TBD
  4. Ask for modification of top level. TBD
  5. Connection validation call . TBD

I am not sure about the sequence of the TBD yet, but I am sure that if status.php fails, then you cannot continue.

What do you think ?

@dragotin
Copy link

@labkode absolutely, you're right. That needs to be defined as well, if there are constraints about the sequence. I will note that down as a TODO.

@labkode
Copy link
Member Author

labkode commented Sep 23, 2015

@dragotin Thanks, if I get some time I'll do it myself

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants