Skip to content
This repository has been archived by the owner on Dec 11, 2020. It is now read-only.

Commit

Permalink
An updated ToC for the Json format. This is the result of splitting t…
Browse files Browse the repository at this point in the history
…he format into two docs. Each doc explicitly targets one of the two json formats.
  • Loading branch information
arloMicrosoft committed Jan 18, 2012
1 parent 2cb4fab commit e886d73
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 8 deletions.
17 changes: 9 additions & 8 deletions OData Json Format.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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 ##

Expand All @@ -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 ##

Expand Down
64 changes: 64 additions & 0 deletions OData Json With Metadata Format.markdown
Original file line number Diff line number Diff line change
@@ -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?

0 comments on commit e886d73

Please sign in to comment.