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

Proper GET links documentation #4

Merged
merged 1 commit into from
Jun 16, 2016
Merged

Proper GET links documentation #4

merged 1 commit into from
Jun 16, 2016

Conversation

ArthurHoaro
Copy link
Member

No description provided.

"api"
],
"private": true,
"created": "2016-06-15T19:23:14+0200",
Copy link
Member

@nodiscc nodiscc Jun 15, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm in favor of UNIX timestamps instead which do not assume the requesting machine has such or such localized date format, and are also easier to compare/work with (they are just integers).

Copy link

@mro mro Jun 15, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

plz only ISO8601 acc W3C for timestamps almost as in the example, but with timezone colon: 2016-06-15T19:23:14+02:00. UTC if you prefer. Compare trivial. Nothing else plz.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does description need a (optional) mimetype nowadays (plaintext vs. markdown)? Atom/content does it this way.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is "todo"?

Copy link
Member

@virtualtam virtualtam Jun 16, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding timestamps, I've seen funny things over some APIs, where you need to multiply or divide the value of the returned Unix epoch to avoid time-travelling either to the Dark Ages™ or to the end of all known multiverses...

ISO8601 is indeed recommended for date/time representation:

@nodiscc decent programming languages propose libraries for proper date/time parsing, that developers will use when they really care about timezones and Daylight Saving Time :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does description need a (optional) mimetype nowadays (plaintext vs. markdown)?

Markdown content is also plaintext. Instead of adding an additional field, a service returning settings, included enabled plugins is probably better. It would let clients interpret any plugin if they want to.

what is "todo"?

I had to do this object definition. 😛

@nodiscc
Copy link
Member

nodiscc commented Jun 16, 2016

Indeed unix timestamps also have their own quirks. Thanks for pointing me to ISO8601, let's go with this.

?do=api is ok for me (it's consistent, clean URL support can come later) and #3 has been closed.

@ArthurHoaro
Copy link
Member Author

Thanks for the review. I'm merging this since there is no blocking comment about it. We can come back on this in another issue/PR if we need to.

@ArthurHoaro ArthurHoaro merged commit 48c4571 into master Jun 16, 2016
@ArthurHoaro ArthurHoaro deleted the get-links-docs branch June 16, 2016 17:08
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

Successfully merging this pull request may close these issues.

4 participants