Automated HTML abstracts

oasis-tcs · Aug 15, 2023 · ed5a7bb · ed5a7bb
1 parent 68bafd2
commit ed5a7bb
Show file tree

Hide file tree

Showing 19 changed files with 50 additions and 8 deletions.
diff --git a/docs/odata-csdl-json/odata-csdl-json.html b/docs/odata-csdl-json/odata-csdl-json.html
@@ -4,6 +4,7 @@
   <meta charset="utf-8" />
   <meta name="generator" content="pandoc" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <meta name="description" content="OData services are described by an Entity Model (EDM). The Common Schema Definition Language (CSDL) defines specific representations of the entity data model exposed by an OData service, using XML, JSON, and other formats. This document (OData CSDL JSON Representation) specifically defines the JSON representation of CSDL." />
   <title>OData Common Schema Definition Language (CSDL) JSON Representation Version 4.02</title>
   <style>
     code{white-space: pre-wrap;}

diff --git a/docs/odata-csdl-xml/odata-csdl-xml.html b/docs/odata-csdl-xml/odata-csdl-xml.html
@@ -4,6 +4,7 @@
   <meta charset="utf-8" />
   <meta name="generator" content="pandoc" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <meta name="description" content="OData services are described by an Entity Model (EDM). The Common Schema Definition Language (CSDL) defines specific representations of the entity data model exposed by an OData service, using XML, JSON, and other formats. This document (OData CSDL XML Representation) specifically defines the XML representation of CSDL." />
   <title>OData Common Schema Definition Language (CSDL) XML Representation Version 4.02</title>
   <style>
     code{white-space: pre-wrap;}
@@ -139,7 +140,7 @@ <h4 id="related-work"><a name="RelatedWork">Related work:</a></h4>
 <li><em>OData JSON Format Version 4.02</em>. Edited by Ralf Handl, Mike Pizzo, and Heiko Theißen. Latest stage: <a href="https://docs.oasis-open.org/odata/odata-json-format/v4.02/odata-json-format-v4.02.html">https://docs.oasis-open.org/odata/odata-json-format/v4.02/odata-json-format-v4.02.html</a></li>
 </ul>
 <h4 id="abstract">Abstract:</h4>
-<p>OData services are described by an Entity Model (EDM). The Common Schema Definition Language (CSDL) defines specific representations of the entity data model exposed by an OData service, using XML, JSON, and other formats. This document (OData CSDL JSON Representation) specifically defines the JSON representation of CSDL.</p>
+<p>OData services are described by an Entity Model (EDM). The Common Schema Definition Language (CSDL) defines specific representations of the entity data model exposed by an OData service, using XML, JSON, and other formats. This document (OData CSDL XML Representation) specifically defines the XML representation of CSDL.</p>
 <h4 id="status">Status:</h4>
 <p>This document was last revised or approved by the OASIS Open Data Protocol (OData) TC on the above date. The level of approval is also listed above. Check the "Latest stage" location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at <a href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata#technical">https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata#technical</a>.</p>
 <p>TC members should send comments on this specification to the TC's email list. Others should send comments to the TC's public comment list, after subscribing to it by following the instructions at the "<a href="https://www.oasis-open.org/committees/comments/index.php?wg_abbrev=odata">Send A Comment</a>" button on the TC's web page at <a href="https://www.oasis-open.org/committees/odata/">https://www.oasis-open.org/committees/odata/</a>.</p>

diff --git a/docs/odata-csdl-xml/odata-csdl-xml.md b/docs/odata-csdl-xml/odata-csdl-xml.md
@@ -56,7 +56,7 @@ This specification is related to:
 * _OData JSON Format Version 4.02_. Edited by Ralf Handl, Mike Pizzo, and Heiko Theißen. Latest stage: https://docs.oasis-open.org/odata/odata-json-format/v4.02/odata-json-format-v4.02.html
 
 #### Abstract:
-OData services are described by an Entity Model (EDM). The Common Schema Definition Language (CSDL) defines specific representations of the entity data model exposed by an OData service, using XML, JSON, and other formats. This document (OData CSDL JSON Representation) specifically defines the JSON representation of CSDL.
+OData services are described by an Entity Model (EDM). The Common Schema Definition Language (CSDL) defines specific representations of the entity data model exposed by an OData service, using XML, JSON, and other formats. This document (OData CSDL XML Representation) specifically defines the XML representation of CSDL.
 
 #### Status:
 This document was last revised or approved by the OASIS Open Data Protocol (OData) TC on the above date. The level of approval is also listed above. Check the "Latest stage" location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata#technical.

diff --git a/docs/odata-data-aggregation-ext/odata-data-aggregation-ext.html b/docs/odata-data-aggregation-ext/odata-data-aggregation-ext.html
@@ -4,6 +4,7 @@
   <meta charset="utf-8" />
   <meta name="generator" content="pandoc" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <meta name="description" content="This specification adds basic grouping and aggregation functionality (e.g. sum, min, and max) to the Open Data Protocol (OData) without changing any of the base principles of OData." />
   <title>OData Extension for Data Aggregation Version 4.0</title>
   <style>
     code{white-space: pre-wrap;}

diff --git a/docs/odata-json-format/odata-json-format.html b/docs/odata-json-format/odata-json-format.html
@@ -4,6 +4,7 @@
   <meta charset="utf-8" />
   <meta name="generator" content="pandoc" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <meta name="description" content="The Open Data Protocol (OData) for representing and interacting with structured content is comprised of a set of specifications. The core specification for the protocol is in OData Version 4.02 Part 1: Protocol. This document extends the core specification by defining representations for OData requests and responses using a JSON format." />
   <title>OData JSON Format Version 4.02</title>
   <style>
     code{white-space: pre-wrap;}

diff --git a/docs/odata-json-format/odata-json-format.md b/docs/odata-json-format/odata-json-format.md
@@ -53,7 +53,11 @@ This specification is related to:
 * _OData Common Schema Definition Language (CSDL) XML Representation Version 4.02_. Edited by Michael Pizzo, Ralf Handl, and Heiko Theißen. Latest stage: https://docs.oasis-open.org/odata/odata-csdl-xml/v4.02/odata-csdl-xml-v4.02.html
 
 #### Abstract:
-The Open Data Protocol (OData) for representing and interacting with structured content is comprised of a set of specifications. The core specification for the protocol is in OData Version 4.02 Part 1: Protocol. This document extends the core specification by defining representations for OData requests and responses using a JSON format.
+The Open Data Protocol (OData) for representing and interacting with structured
+content is comprised of a set of specifications. The core specification for the
+protocol is in OData Version 4.02 Part 1: Protocol.
+This document extends the core specification by defining representations for 
+OData requests and responses using a JSON format.
 
 #### Status:
 This document was last revised or approved by the OASIS Open Data Protocol (OData) TC on the above date. The level of approval is also listed above. Check the "Latest stage" location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata#technical.

diff --git a/docs/odata-protocol/odata-protocol.html b/docs/odata-protocol/odata-protocol.html
@@ -4,6 +4,7 @@
   <meta charset="utf-8" />
   <meta name="generator" content="pandoc" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <meta name="description" content="The Open Data Protocol (OData) enables the creation of REST-based data services, which allow resources, identified using Uniform Resource Locators (URLs) and defined in an Entity Data Model (EDM), to be published and edited by Web clients using simple HTTP messages. This document defines the core semantics and facilities of the protocol." />
   <title>OData Version 4.02. Part 1: Protocol</title>
   <style>
     code{white-space: pre-wrap;}

diff --git a/docs/odata-url-conventions/odata-url-conventions.html b/docs/odata-url-conventions/odata-url-conventions.html
@@ -4,6 +4,7 @@
   <meta charset="utf-8" />
   <meta name="generator" content="pandoc" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <meta name="description" content="The Open Data Protocol (OData) enables the creation of REST-based data services, which allow resources, identified using Uniform Resource Locators (URLs) and defined in an Entity Data Model (EDM), to be published and edited by Web clients using simple HTTP messages. This specification defines a set of recommended (but not required) rules for constructing URLs to identify the data and metadata exposed by an OData service as well as a set of reserved URL query string operators." />
   <title>OData Version 4.02. Part 2: URL Conventions</title>
   <style>
     code{white-space: pre-wrap;}

diff --git a/odata-csdl/0 frontmatter.md b/odata-csdl/0 frontmatter.md
@@ -71,7 +71,7 @@ This specification is related to:
 * _OData JSON Format Version 4.02_. Edited by Ralf Handl, Mike Pizzo, and Heiko Theißen. Latest stage: https://docs.oasis-open.org/odata/odata-json-format/v4.02/odata-json-format-v4.02.html
 
 #### Abstract:
-OData services are described by an Entity Model (EDM). The Common Schema Definition Language (CSDL) defines specific representations of the entity data model exposed by an OData service, using XML, JSON, and other formats. This document (OData CSDL JSON Representation) specifically defines the JSON representation of CSDL.
+$$$description$$$
 
 #### Status:
 This document was last revised or approved by the OASIS Open Data Protocol (OData) TC on the above date. The level of approval is also listed above. Check the "Latest stage" location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata#technical.

diff --git a/odata-csdl/json.yaml b/odata-csdl/json.yaml
@@ -7,3 +7,8 @@ previousStage: n/a
 pubdate: 14 July 2023
 pubdateISO: '2023-07-14'
 copyright: © OASIS Open 2023
+description:
+  OData services are described by an Entity Model (EDM).
+  The Common Schema Definition Language (CSDL) defines specific representations
+  of the entity data model exposed by an OData service, using XML, JSON, and other formats.
+  This document (OData CSDL JSON Representation) specifically defines the JSON representation of CSDL.
diff --git a/odata-csdl/xml.yaml b/odata-csdl/xml.yaml
@@ -7,3 +7,8 @@ previousStage: n/a
 pubdate: 14 July 2023
 pubdateISO: '2023-07-14'
 copyright: © OASIS Open 2023
+description:
+  OData services are described by an Entity Model (EDM).
+  The Common Schema Definition Language (CSDL) defines specific representations
+  of the entity data model exposed by an OData service, using XML, JSON, and other formats.
+  This document (OData CSDL XML Representation) specifically defines the XML representation of CSDL.
diff --git a/odata-data-aggregation-ext/0 frontmatter.md b/odata-data-aggregation-ext/0 frontmatter.md
@@ -62,7 +62,7 @@ This specification is related to:
 * _OData JSON Format Version 4.01_. Edited by Ralf Handl, Mike Pizzo, and Mark Biamonte. Latest stage: https://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html
 
 #### Abstract:
-This specification adds basic grouping and aggregation functionality (e.g. sum, min, and max) to the Open Data Protocol (OData) without changing any of the base principles of OData.
+$$$description$$$
 
 #### Status:
 This document was last revised or approved by the OASIS Open Data Protocol (OData) TC on the above date. The level of approval is also listed above. Check the "Latest stage" location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata#technical.

diff --git a/odata-data-aggregation-ext/meta.yaml b/odata-data-aggregation-ext/meta.yaml
@@ -6,3 +6,6 @@ previousStage: cs02
 pubdate: 05 July 2023
 pubdateISO: '2023-07-05'
 copyright: © OASIS Open 2023
+description:
+  This specification adds basic grouping and aggregation functionality (e.g. sum, min, and max)
+  to the Open Data Protocol (OData) without changing any of the base principles of OData.
diff --git a/odata-json-format/0 frontmatter.md b/odata-json-format/0 frontmatter.md
@@ -53,7 +53,7 @@ This specification is related to:
 * _OData Common Schema Definition Language (CSDL) XML Representation Version 4.02_. Edited by Michael Pizzo, Ralf Handl, and Heiko Theißen. Latest stage: https://docs.oasis-open.org/odata/odata-csdl-xml/v4.02/odata-csdl-xml-v4.02.html
 
 #### Abstract:
-The Open Data Protocol (OData) for representing and interacting with structured content is comprised of a set of specifications. The core specification for the protocol is in OData Version 4.02 Part 1: Protocol. This document extends the core specification by defining representations for OData requests and responses using a JSON format.
+$$$description$$$
 
 #### Status:
 This document was last revised or approved by the OASIS Open Data Protocol (OData) TC on the above date. The level of approval is also listed above. Check the "Latest stage" location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata#technical.

diff --git a/odata-json-format/meta.yaml b/odata-json-format/meta.yaml
@@ -6,3 +6,9 @@ previousStage: n/a
 pubdate: 14 July 2023
 pubdateISO: '2023-07-14'
 copyright: © OASIS Open 2023
+description: |
+  The Open Data Protocol (OData) for representing and interacting with structured
+  content is comprised of a set of specifications. The core specification for the
+  protocol is in OData Version 4.02 Part 1: Protocol.
+  This document extends the core specification by defining representations for 
+  OData requests and responses using a JSON format.
diff --git a/odata-protocol/0 frontmatter.md b/odata-protocol/0 frontmatter.md
@@ -57,7 +57,7 @@ This specification is related to:
 * _OData Extension for Temporal Data Version 4.0_. Edited by Ralf Handl, Hubert Heijkers, Gerald Krause, Michael Pizzo, Heiko Theißen, and Martin Zurmuehl. Latest stage: https://docs.oasis-open.org/odata/odata-temporal-ext/v4.0/odata-temporal-ext-v4.0.html
 
 #### Abstract:
-The Open Data Protocol (OData) enables the creation of REST-based data services, which allow resources, identified using Uniform Resource Locators (URLs) and defined in an Entity Data Model (EDM), to be published and edited by Web clients using simple HTTP messages. This document defines the core semantics and facilities of the protocol.
+$$$description$$$
 
 #### Status:
 This document was last revised or approved by the OASIS Open Data Protocol (OData) TC on the above date. The level of approval is also listed above. Check the "Latest stage" location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata#technical.

diff --git a/odata-protocol/meta.yaml b/odata-protocol/meta.yaml
@@ -6,3 +6,8 @@ previousStage: n/a
 pubdate: 14 July 2023
 pubdateISO: '2023-07-14'
 copyright: © OASIS Open 2023
+description:
+  The Open Data Protocol (OData) enables the creation of REST-based data services,
+  which allow resources, identified using Uniform Resource Locators (URLs) and
+  defined in an Entity Data Model (EDM), to be published and edited by Web clients
+  using simple HTTP messages. This document defines the core semantics and facilities of the protocol.
diff --git a/odata-url-conventions/0 frontmatter.md b/odata-url-conventions/0 frontmatter.md
@@ -57,7 +57,7 @@ This specification is related to:
 * _OData Extension for Temporal Data Version 4.0_. Edited by Ralf Handl, Hubert Heijkers, Gerald Krause, Michael Pizzo, Heiko Theißen, and Martin Zurmuehl. Latest stage: https://docs.oasis-open.org/odata/odata-temporal-ext/v4.0/odata-temporal-ext-v4.0.html
 
 #### Abstract:
-The Open Data Protocol (OData) enables the creation of REST-based data services, which allow resources, identified using Uniform Resource Locators (URLs) and defined in an Entity Data Model (EDM), to be published and edited by Web clients using simple HTTP messages. This specification defines a set of recommended (but not required) rules for constructing URLs to identify the data and metadata exposed by an OData service as well as a set of reserved URL query string operators.
+$$$description$$$
 
 #### Status:
 This document was last revised or approved by the OASIS Open Data Protocol (OData) TC on the above date. The level of approval is also listed above. Check the "Latest stage" location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata#technical.

diff --git a/odata-url-conventions/meta.yaml b/odata-url-conventions/meta.yaml
@@ -6,3 +6,11 @@ previousStage: n/a
 pubdate: 14 July 2023
 pubdateISO: '2023-07-14'
 copyright: © OASIS Open 2023
+description:
+  The Open Data Protocol (OData) enables the creation of REST-based data services,
+  which allow resources, identified using Uniform Resource Locators (URLs) and
+  defined in an Entity Data Model (EDM), to be published and edited by Web clients
+  using simple HTTP messages.
+  This specification defines a set of recommended (but not required) rules for
+  constructing URLs to identify the data and metadata exposed by an OData service
+  as well as a set of reserved URL query string operators.