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

give example for datetime #54

Closed
crotwell opened this issue Oct 1, 2020 · 2 comments
Closed

give example for datetime #54

crotwell opened this issue Oct 1, 2020 · 2 comments
Labels
documentation pr review needed Fixed in PR, needs review and merge

Comments

@crotwell
Copy link
Collaborator

crotwell commented Oct 1, 2020

Datetime description is confusing:

Integer values used to represent the year, day, hours, minutes. Decimals represent seconds, a boolean represents the timezone.

What is a boolean timezone? This also doesn't say how the integers are to be combined. Very confusing.

Should also say instead that it is ISO 8601 string, give a link to the ISO spec or perhaps the W3C xschema spec. I think at some point it was preferred to be one of a limited versions of the ISO spec, so perhaps limit to a few like: YYYY-MM-DDThh:mm:ss.SSSSSSZ, YYYY-MM-DDThh:mm:ssZ, YYYY-MM-DDThh:mm:ss.SSSZ, YYYY-MM-DDZ,

Add a sentence that using times in UTC is preferred, and that the Z timezone identifier should be appended to as processing systems often interpret times without timezones as local time. Appending the Z helps eliminate a common source of error.

It should have an example.

@crotwell
Copy link
Collaborator Author

crotwell commented Oct 2, 2020

Related, all example times in the docs should include the Z to designate UTC. For example, Network endDate example should be: endDate="2018-01-27T00:00:00Z"

@crotwell
Copy link
Collaborator Author

fixed in PR #77

@crotwell crotwell added the pr review needed Fixed in PR, needs review and merge label Jul 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation pr review needed Fixed in PR, needs review and merge
Projects
None yet
Development

No branches or pull requests

1 participant