Skip to content

Commit 071c8e3

Browse files
Improve V2 and V3 documentation page
Refine the format of V4 introduction
1 parent b49facc commit 071c8e3

16 files changed

+48
-16
lines changed

pages/documentation/abnf.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
date: 2014-02-20 08:09:31.000000000 +08:00
55
permalink: /documentation/odata-version-3-0/abnf/
66
---
7-
<h5 class="alert alert-success">Note: OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0. <a href="/documentation/" title="" class="alert-link"><span class="glyphicon glyphicon-chevron-right"></span> Go to OData Version 4.0</a></h5>
7+
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0.
8+
<br><br>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
810
<h1 id="abnfforodata">ABNF for OData</h1>
911
<p>Current Revision: 4/27/2012</p>
1012
<p>The following Augmented BackusNaur Form (ABNF) details the construction rules for OData Uris that target OData services that follow the Uri Conventions specified in this document.<br />

pages/documentation/atom-format-v2.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
date: 2014-02-28 03:35:17.000000000 +08:00
55
permalink: /documentation/odata-version-2-0/atom-format/
66
---
7-
<h5 class="alert alert-success">Note: OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0. <a href="/documentation/" title="" class="alert-link"><span class="glyphicon glyphicon-chevron-right"></span> Go to OData Version 4.0</a></h5>
7+
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0.
8+
<br><br>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
810
<h2>Introduction</h2>
911
<p>OData supports two formats for representing the resources (Collections, Entries, Links, etc) it exposes: the XML-based Atom format and the JSON format. This document describes how OData resources are represented in Atom (plus additional elements defined in AtomPub) and <a href="../json-format">[OData-JSON]</a> describes the JSON representation. The <a href="../operations#RepresentationFormatAndContentTypeNegotiation"> content type negotiation</a> section of the <a href="../operations">[OData-Operations]</a> document describes how clients can use standard HTTP content type negotiation to tell an OData service which format it wants to use.</p>
1012
<h2><a id="Background" name="Background"></a>1. Background</h2>

pages/documentation/atom-format-v3.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
date: 2014-02-20 08:13:13.000000000 +08:00
55
permalink: /documentation/odata-version-3-0/atom-format/
66
---
7-
<h5 class="alert alert-success">Note: OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0. <a href="/documentation/" title="" class="alert-link"><span class="glyphicon glyphicon-chevron-right"></span> Go to OData Version 4.0</a></h5>
7+
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0.
8+
<br><br>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
810
<h1 id="overview">1. Overview</h1>
911
<p>The OData protocol is comprised of a set of specifications for representing and interacting with structured content. This document describes the OData Atom Format returned from an OData Service when requesting the <code>application/atom+xml</code> mime type.</p>
1012
<p>An OData payload may represent:</p>

pages/documentation/batch-processing-v2.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
date: 2014-02-28 03:34:09.000000000 +08:00
55
permalink: /documentation/odata-version-2-0/batch-processing/
66
---
7-
<h5 class="alert alert-success">Note: OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0. <a href="/documentation/" title="" class="alert-link"><span class="glyphicon glyphicon-chevron-right"></span> Go to OData Version 4.0</a></h5>
7+
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0.
8+
<br><br>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
810
<h2>Introduction</h2>
911
<p>The OData protocol exposes a uniform service interface to operate on collections of structured and unstructured data. <a href="../operations">[OData-Operations]</a> enumerates the set of operations supported by the uniform interface and describes a means to send one operation per HTTP request.</p>
1012
<p>This document builds on the <a href="../operations">[OData-Operations]</a> document and describes how an OData implementation can optionally support executing multiple operations sent in a single HTTP request through the use of Batching. This document covers both how Batch operations are represented and processed.</p>

pages/documentation/batch-processing-v3.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
date: 2014-02-20 08:11:24.000000000 +08:00
55
permalink: /documentation/odata-version-3-0/batch-processing/
66
---
7-
<h5 class="alert alert-success">Note: OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0. <a href="/documentation/" title="" class="alert-link"><span class="glyphicon glyphicon-chevron-right"></span> Go to OData Version 4.0</a></h5>
7+
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0.
8+
<br><br>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
810
<h1 id="opendataprotocolodatabatchprocessing"></h1>
911
<h1 id="introduction">1. Introduction</h1>
1012
<p>The OData protocol defines a way to query and manipulate data (described using an EDM model) using a simple set of operations. This document builds on the ‘Interaction Semantics’ section of the core OData specification document and describes how an OData implementation MAY support executing multiple operations sent in a single HTTP request through the use of Batching. This document covers both how Batch operations are represented and processed.</p>

pages/documentation/common-schema-definition-language-csdl.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
date: 2014-02-20 08:01:53.000000000 +08:00
55
permalink: /documentation/odata-version-3-0/common-schema-definition-language-csdl/
66
---
7-
<h5 class="alert alert-success">Note: OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0. <a href="/documentation/" title="" class="alert-link"><span class="glyphicon glyphicon-chevron-right"></span> Go to OData Version 4.0</a></h5>
7+
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0.
8+
<br><br>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
810
<h1 id="introduction">Introduction</h1>
911
<p>OData services are described by an Entity Data Model (EDM). Common Schema Definition Language (CSDL) defines an XML-based representation of the entity model exposed by an OData service. CSDL is based on standards defined in [<code><a href="http://www.w3.org/TR/2006/REC-xml11–20060816/">XML 1.1</a></code>] and [<code><a href="http://www.w3.org/standards/techs/xmlschema#w3c_all">XML Schema</a></code>].</p>
1012
<p>An OData service SHOULD provide a CSDL description of its entity model when a client requests a description of the entity model by sending a <code>GET</code> request to <code>&lt;serviceRoot&gt;/$metadata</code>. <code>$metadata</code> MUST wrap the CSDL document in an EDMX wrapper.</p>

pages/documentation/json-format-v2.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
date: 2014-02-28 03:36:01.000000000 +08:00
55
permalink: /documentation/odata-version-2-0/json-format/
66
---
7-
<h5 class="alert alert-success">Note: OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0. <a href="/documentation/" title="" class="alert-link"><span class="glyphicon glyphicon-chevron-right"></span> Go to OData Version 4.0</a></h5>
7+
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0.
8+
<br><br>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
810
<h2>Introduction</h2>
911
<p>OData supports two formats for representing the resources (Collections, Entries, Links, etc) it exposes: the XML-based AtomPub format and the JSON format. This document describes how OData resources are represented in JSON and <a href="../atom-format">[OData-Atom]</a> describes the AtomPub representation. The <a href="../operations#ContentTypeNegotation">content type negotiation</a> section of the <a href="../operations">[OData-Operations]</a> document describes how clients can use standard HTTP content type negotiation to tell an OData service which format it wants to use.</p>
1012
<h2><a id="Background" name="Background"></a>1. Background</h2>

pages/documentation/json-verbose-format-v3.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
date: 2014-02-20 08:15:04.000000000 +08:00
55
permalink: /documentation/odata-version-3-0/json-verbose-format/
66
---
7-
<h5 class="alert alert-success">Note: OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0. <a href="/documentation/" title="" class="alert-link"><span class="glyphicon glyphicon-chevron-right"></span> Go to OData Version 4.0</a></h5>
7+
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0.
8+
<br><br>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
810
<p>OData is released under the <a href="http://www.microsoft.com/openspecifications/en/us/programs/osp/default.aspx">Open Specification Promise</a> to allow anyone to freely interoperate with OData implementations.<br />
911
Current Revision: 4/27/2012</p>
1012
<h1 id="overview">Overview</h1>

pages/documentation/odata-version-2-0.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
date: 2014-02-28 03:18:29.000000000 +08:00
55
permalink: /documentation/odata-version-2-0/
66
---
7-
<h5 class="alert alert-success">Note: OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0. <a href="/documentation/" title="" class="alert-link"><span class="glyphicon glyphicon-chevron-right"></span> Go to OData Version 4.0</a></h5>
7+
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0.
8+
<br><br>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
810

911
<ul>
1012
<li><a href="/documentation/odata-version-2-0/overview">OData Version 2.0 Overview</a></li>

pages/documentation/odata-version-3-0-core-protocol.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
date: 2014-02-20 07:50:09.000000000 +08:00
55
permalink: /documentation/odata-version-3-0/odata-version-3-0-core-protocol/
66
---
7-
<h5 class="alert alert-success">Note: OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0. <a href="/documentation/" title="" class="alert-link"><span class="glyphicon glyphicon-chevron-right"></span> Go to OData Version 4.0</a></h5>
7+
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0.
8+
<br><br>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
810
<h1 id="overview">1. Overview</h1>
911
<p>The OData Protocol is an application-level protocol for interacting with data via RESTful web services. The protocol supports the description of data models and the editing and querying of data according to those models. It provides facilities for:</p>
1012
<ul>

0 commit comments

Comments
 (0)