From e886d734f73f8ff6df479785fe4a70d7d3f7719c Mon Sep 17 00:00:00 2001 From: Arlo Belshee Date: Wed, 18 Jan 2012 12:04:31 -0800 Subject: [PATCH] An updated ToC for the Json format. This is the result of splitting the format into two docs. Each doc explicitly targets one of the two json formats. --- OData Json Format.markdown | 17 ++++--- OData Json With Metadata Format.markdown | 64 ++++++++++++++++++++++++ 2 files changed, 73 insertions(+), 8 deletions(-) create mode 100644 OData Json With Metadata Format.markdown diff --git a/OData Json Format.markdown b/OData Json Format.markdown index a0a6616..dfdb7f9 100644 --- a/OData Json Format.markdown +++ b/OData Json Format.markdown @@ -18,7 +18,6 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S # Common Payload Format # - This section includes all the stuff that is common between request and response payloads. Mostly, this means the representations of EDM values. -- Also, it contains only the stuff that is common between historical and efficient formats. ## Entities ## @@ -41,19 +40,21 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S # Request Specifics # -- All the stuff that only applies to request payloads. Is there any? Only that which is common between efficient and historical formats. +- All the stuff that only applies to request payloads. -# Response Specifics # +## HTTP Headers ## -- All the stuff that only applies to response payloads. Only that which is common between efficient and historical formats. +- proper accept header to request this format. +- other stuff? -# Efficient Format Specifics # +# Response Specifics # -- Repeat whatever sections from above change in the efficient format, and talk about what this format adds. +- All the stuff that only applies to response payloads. -# Historical Format Specifics # +## HTTP Headers ## -- Repeat whatever sections from above change in the historical format, and talk about what this format adds. +- proper content type for this format. +- other stuff? ## Next Links ## diff --git a/OData Json With Metadata Format.markdown b/OData Json With Metadata Format.markdown new file mode 100644 index 0000000..55f37da --- /dev/null +++ b/OData Json With Metadata Format.markdown @@ -0,0 +1,64 @@ +# OData Json With Meatadata Format # + +# Overview # + +- Description of document; refer to core doc. +- Design goals +- Efficient format vs historical (needs better name) format + +# 2. Notational Conventions # + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [[RFC2119](http://tools.ietf.org/html/rfc2119 "Key words for use in RFCs to Indicate Requirement Levels")]. + +## 2.1 ??? ## + +- Normative reference to the OData core document +- Any other notational conventions? + +# Common Payload Format # + +- This section includes all the stuff that is common between request and response payloads. Mostly, this means the representations of EDM values. + +## Entities ## + +### Properties ### + +### Navigation Properties ### + +### Metadata ### + +## Primitive Values ## + +- All of the types, by category (numeric, string, spatial, temporal, special) +- Specific statement of representation in payload. + +## Complex Types ## + +### Properties ### + +### Metadata ### + +# Request Specifics # + +- All the stuff that only applies to request payloads. + +## HTTP Headers ## + +- proper accept header to request this format. +- other stuff? + +# Response Specifics # + +- All the stuff that only applies to response payloads. + +## HTTP Headers ## + +- proper content type for this format. +- other stuff? + +## Next Links ## + +## Response-Level Properties ## + +- Inline count +- Others?