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

Stream META data needs to be documented #333

Open
hybotix opened this issue Apr 20, 2013 · 2 comments
Open

Stream META data needs to be documented #333

hybotix opened this issue Apr 20, 2013 · 2 comments

Comments

@hybotix
Copy link

hybotix commented Apr 20, 2013

I noticed that Stream META data has not been documented. I've been "dancing" around the Stream META["more"] item for a few days. There is no indication when this item is valid and what each state means at a given occurrence when it is valid. ALL META data should be documented in full.

@berg
Copy link
Member

berg commented Apr 20, 2013

@hybotix
Copy link
Author

hybotix commented Apr 26, 2013

It's more a matter of where the info is shown. It should be shown under
META, Stream, in the API docs where the other META data is described. It
would be much easier to find it than having to search other parts of the
docs for it.

Also, there is a case where more = False and min_id = max_id. Does this
indicate the current end of the stream?

8-Dale

On Sat, Apr 20, 2013 at 3:50 PM, Bryan Berg [email protected]:

It's documented on these pages:

http://developers.app.net/docs/basics/responses/#response-envelope
http://developers.app.net/docs/basics/pagination/#response-metadata
http://developers.app.net/docs/resources/stream-marker/

What more would you like to see?


Reply to this email directly or view it on GitHubhttps://github.com//issues/333#issuecomment-16712766
.

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