OData / OData/odataorg.github.io
Documentation on JSON primitive types for OData v2 incorrect
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 73
- Forks
- 106
- PR merge metrics
- No merged PRs in 30d
Description
Either the documentation on primitive types or the implementation of the Northwind services is incorrect.
https://www.odata.org/documentation/odata-version-2-0/json-format/ states that for Edm.Single values are represented as the "Literal form of Edm.Single as used in URIs formatted as a JSON string".
This means, that a value 1.5 would be represented as "1.5f". This differs from the documentation for the atom format. The Northwind services do not follow this rule either, e. g. Discount is a Edm.Single property: https://services.odata.org/V2/Northwind/Northwind.svc/Invoices?$format=json&$select=Discount&$filter=Discount%20ne%200
What is the truth?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the OData v2 JSON primitive-type wording at the linked documentation page with the atom-format documentation and the Northwind Invoices JSON response for Discount. Determine whether the specification or the service behavior is authoritative, then update the affected documentation or implementation once the expected representation is confirmed.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100