JSON Format starter template

oasis-tcs · Jul 20, 2023 · ce1ee90 · ce1ee90
1 parent b0942e9
commit ce1ee90
Show file tree

Hide file tree

Showing 8 changed files with 1,182 additions and 0 deletions.
diff --git a/docs/odata-json-format/odata-json-format.html b/docs/odata-json-format/odata-json-format.html
diff --git a/docs/odata-json-format/odata-json-format.md b/docs/odata-json-format/odata-json-format.md
diff --git a/docs/odata-json-format/styles/markdown-styles-v1.7.3b.css b/docs/odata-json-format/styles/markdown-styles-v1.7.3b.css
@@ -0,0 +1,91 @@
+/* OASIS specification styles for HTML generated from Markdown or similar sources */
+/* usually used after basic w3.css */
+/* Paul Knight 2018-09-27 */
+/* pk 2018-10-01 - v1.2 reduced section header and title (h*) font sizes */
+/* pk 2018-10-02 - v1.3 added right margin; allowed text wrapping in code blocks and scrolling for overflowing text */
+/* pk 2018-10-19 - v1.4 added display:inline to avoid page-wide background coloring */
+/* pk 2018-10-25 - v1.5 added use of <h6> as citation tag for References section or elsewhere */
+/* pk 2018-10-26 - v1.5.1 (experimental) and v1.6 added use of <hr /> as a page break when generating PDF from the HTML */
+/* pk 2018-11-14 - v1.6.1 - lighter gray background color for code blocks */
+/* pk 2019-02-18 - v1.7 - Use Liberation Sans and Liberation Mono fonts if possible */
+/* pk 2019-02-18 - v1.7.1 (experimental) changed px to pt (and reduced numbers) for fonts and tables; added bigtitle style */
+/* pk 2019-05-23 - v1.7.2 (based on 1.7.1) changed monospace "code" font to Courier New */
+/* pk 2019-08-01 - v1.7.3 substitute PostScript name for fonts (LiberationSans for "Liberation Sans" and CourierNew for "Courier New") to address a flaw in "wkhtmltopdf" which rendered all text as bold. Changed "bigtitle" to "h1big"*/
+/* dk 2020-10-21 - v1.7.3a (unofficial for jadn, based on 1.7.3) update block quotes and code blocks */
+/* Heiko Theißen 2023-06-02 - v1.7.3b (unofficial for odata-data-aggregation-ext, based on v1.7.3a) include local font names "Liberation Sans" and "Courier New" */
+
+body {
+ margin-left: 3pc;
+ margin-right: 3pc;
+ font-family: LiberationSans, "Liberation Sans", Arial, Helvetica, sans-serif;
+ font-size:12pt;
+ line-height:1.2;
+ }
+
+html{overflow-x:auto}
+
+ /* styles for section headings - levels 1-5 (maybe include heading1, etc. later) */
+h1{font-size:18pt}h2{font-size:14pt}h3{font-size:13pt}h4{font-size:12pt}h5{font-size:11pt}
+h1big{font-size: 24pt}
+h1,h2,h3,h4,h5,h1big{font-family: LiberationSans, "Liberation Sans", Arial, Helvetica, sans-serif;font-weight: bold;margin:8pt 0;color: #446CAA}
+ /* style for h6, for use as Reference tag */
+h6{font-size:12pt; line-height:1.0}
+h6{font-family: LiberationSans, "Liberation Sans", Arial, Helvetica, sans-serif;font-weight: bold;margin:0pt;}
+ /* not needed - can just use brackets in the label itself */
+ /* h6::before {content: "["} */
+ /* h6::after {content: "]"} */
+
+ /* style for hr to insert a page break before each ruled line (generated in markdown by 3 or more hyphens alone on a line) */
+hr{page-break-before: always;}
+
+
+/* Table styles - bordered with option for striped */
+table {
+ border-collapse: collapse;
+}
+
+table {
+ border-collapse:collapse;
+ border-spacing:0;
+ width:100%;
+ display:table;
+ font-size:12pt;
+ margin-top: 6pt;
+ }
+
+table, th, td {
+ border: 1pt solid black;
+ padding:6pt 6pt;
+ text-align:left;
+ vertical-align:top;
+}
+th {
+ color:#ffffff;
+ background-color: #446CAA;
+ }
+ /* "table-striped" tag is not generated by pandoc - add manually in HTML if wanted */
+.table-striped tbody tr:nth-child(even){background-color:#d6f3ff}
+
+/* style for code blocks */
+pre {
+ background-color:#f0f0f0;
+ padding: 6px;
+}
+
+code,kbd,samp{
+ font-family:CourierNew, "Courier New", monospace;
+ white-space: pre-wrap;
+ font-size: 10pt;
+}
+
+/* offset block quote */
+blockquote {
+ background-color:#f0f0f0;
+ padding-left: 10px;
+ border-left: solid lightgray 6px;
+}
+
+/* space bullets a bit */
+li {
+ margin: 3px 0;
+}
diff --git a/docs/odata-json-format/styles/odata.css b/docs/odata-json-format/styles/odata.css
@@ -0,0 +1,188 @@
+a:target {
+ background-color: yellow;
+}
+
+a[href^="#OData"],
+a[href^="#RFC"],
+a[href^="#SQL"] {
+ font-weight: bold;
+}
+
+a[href^="#OData"]::before,
+a[href^="#RFC"]::before,
+a[href^="#SQL"]::before {
+ content: "[";
+ font-weight: bold;
+}
+
+a[href^="#OData"]::after,
+a[href^="#RFC"]::after,
+a[href^="#SQL"]::after {
+ content: "]";
+ font-weight: bold;
+}
+
+.toc li {
+ list-style-type: none;
+}
+
+.example,
+.example table {
+ font-size: smaller;
+}
+
+.example p,
+.example li {
+ font-style: italic;
+}
+
+table {
+ width: auto;
+}
+
+.example table,
+.example th,
+.example td {
+ padding: 2pt 6pt;
+ white-space: nowrap;
+}
+
+.example td[rowspan] {
+ text-align: right;
+ vertical-align: middle;
+ border-style: dotted;
+}
+
+.example th[colspan] {
+ text-align: center;
+}
+
+.example-data {
+ position: relative;
+}
+
+.example-data div {
+ position: absolute;
+}
+
+.example-data p {
+ font-style: unset !important;
+}
+
+.example-data svg {
+ position: absolute;
+ left: 0;
+ right: 0;
+ top: 0;
+ bottom: 0;
+}
+
+.cross tbody tr:first-of-type,
+.cross tbody tr:nth-of-type(2),
+.cross td:first-of-type,
+.cross td:nth-of-type(2) {
+ font-weight: bold;
+ color: white;
+ background-color: #446CAA
+}
+
+.cross tbody tr:first-of-type td:first-of-type,
+.cross tbody tr:nth-of-type(2) td:first-of-type,
+.cross tbody tr:first-of-type td:nth-of-type(2),
+.cross tbody tr:nth-of-type(2) td:nth-of-type(2) {
+ border: none;
+ background-color: white;
+}
+
+.example-data th:first-of-type:not(:last-of-type),
+.legend tbody tr:first-of-type {
+ background-color: green;
+}
+
+.nav th:nth-of-type(2),
+.nav-2 th:nth-of-type(3),
+.nav-2 th:nth-of-type(4),
+.nav-2 th:nth-of-type(5),
+.legend tbody tr:last-of-type {
+ background-color: rgb(255, 128, 0);
+}
+
+.legend td {
+ font-weight: bold;
+ color: white;
+}
+
+.example-data svg>path {
+ fill: none;
+ stroke: black;
+ stroke-width: 2;
+}
+
+p code,
+li code,
+h1 code,
+h2 code,
+h3 code,
+h4 code,
+h5 code,
+h6 code {
+ font-family: MJXZERO, MJXTEX-T;
+ font-size: 1em;
+ line-height: 0;
+}
+
+.example p code,
+.example li code {
+ font-style: initial;
+}
+
+.example pre {
+ margin-left: 40px;
+}
+
+h1 code,
+h2 code,
+h3 code,
+h4 code,
+h5 code,
+h6 code {
+ font-size: unset;
+}
+
+mjx-container {
+ font-size: unset !important;
+}
+
+mjx-container[display=true] {
+ text-align: left !important;
+ margin-left: 40px !important;
+}
+
+/* The following rule enables typewriter single quotes in maths, like $\hbox{\tt{'$Q$'}}$ */
+mjx-c.mjx-c2019::before {
+ content: "\27" !important;
+ padding-right: 0.525em !important;
+ font-family: MJXZERO, MJXTEX-T;
+}
+
+code .er {
+ color: unset !important;
+ font-weight: unset !important;
+}
+
+hr:first-of-type {
+ page-break-before: avoid;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+ page-break-after: avoid;
+}
+
+h2[id="22-example-data"] {
+ page-break-before: always;
+}
diff --git a/odata-json-format/0 frontmatter.md b/odata-json-format/0 frontmatter.md
@@ -0,0 +1,89 @@
+
+![OASIS Logo](https://docs.oasis-open.org/templates/OASISLogo-v3.0.png)
+
+-------
+
+# $$$pagetitle$$$
+
+## $$$subtitle$$$
+
+## $$$pubdate$$$
+
+&nbsp;
+
+#### This stage:
+https://docs.oasis-open.org/odata/odata-json-format/v4.02/csd01/odata-json-format-v4.02-csd01.md (Authoritative) \
+https://docs.oasis-open.org/odata/odata-json-format/v4.02/csd01/odata-json-format-v4.02-csd01.html \
+https://docs.oasis-open.org/odata/odata-json-format/v4.02/csd01/odata-json-format-v4.02-csd01.pdf
+
+#### Previous stage:
+N/A
+
+#### Latest stage:
+https://docs.oasis-open.org/odata/odata-json-format/v4.02/odata-json-format-v4.02.md (Authoritative) \
+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.pdf
+
+#### Technical Committee:
+[OASIS Open Data Protocol (OData) TC](https://www.oasis-open.org/committees/odata/)
+
+#### Chairs:
+
+Ralf Handl (ralf.handl@sap.com), [SAP SE](http://www.sap.com/) \
+Michael Pizzo (mikep@microsoft.com), [Microsoft](http://www.microsoft.com/)
+
+#### Editors:
+
+Ralf Handl (ralf.handl@sap.com), [SAP SE](http://www.sap.com/) \
+Michael Pizzo (mikep@microsoft.com), [Microsoft](http://www.microsoft.com/) \
+Heiko Theißen (heiko.theissen@sap.com), [SAP SE](http://www.sap.com/)
+
+#### <a name="RelatedWork">Related work:</a>
+This specification replaces or supersedes:
+* OData JSON Format Version 4.01. Edited by Michael Pizzo, Ralf Handl, and Mark Biamonte. OASIS Standard. Latest stage: https://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html.
+* OData JSON Format Version 4.0. Edited by Ralf Handl, Michael Pizzo, and Mark Biamonte. OASIS Standard. Latest stage: http://docs.oasis-open.org/odata/odata-json-format/v4.0/odata-json-format-v4.0.html.
+
+This specification is related to:
+* _OData Version 4.02_. Edited by Michael Pizzo, Ralf Handl, and Heiko Theißen. A multi-part Work Product that includes:
+ * _OData Version 4.02 Part 1: Protocol_. Latest stage. https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html
+ * _OData Version 4.02 Part 2: URL Conventions_. Latest stage. https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part2-url-conventions.html
+ * _ABNF components: OData ABNF Construction Rules Version 4.02 and OData ABNF Test Cases_. https://docs.oasis-open.org/odata/odata/v4.02/csd01/abnf/
+* _OData Vocabularies Version 4.0_. Edited by Michael Pizzo, Ralf Handl, and Ram Jeyaraman. Latest stage: https://docs.oasis-open.org/odata/odata-vocabularies/v4.0/odata-vocabularies-v4.0.html
+* _OData Common Schema Definition Language (CSDL) JSON Representation Version 4.02_. Edited by Michael Pizzo, Ralf Handl, and Heiko Theißen. Latest stage: https://docs.oasis-open.org/odata/odata-csdl-json/v4.02/odata-csdl-json-v4.02.html
+* _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.
+
+#### 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.
+
+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 "[Send A Comment](https://www.oasis-open.org/committees/comments/index.php?wg_abbrev=odata)" button on the TC's web page at https://www.oasis-open.org/committees/odata/.
+
+This specification is provided under the [RF on RAND Terms Mode](https://www.oasis-open.org/policies-guidelines/ipr/#RF-on-RAND-Mode) of the [OASIS IPR Policy](https://www.oasis-open.org/policies-guidelines/ipr/), the mode chosen when the Technical Committee was established. For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC's web page (https://www.oasis-open.org/committees/odata/ipr.php).
+
+Note that any machine-readable content ([Computer Language Definitions](https://www.oasis-open.org/policies-guidelines/tc-process-2017-05-26/#wpComponentsCompLang)) declared Normative for this Work Product is provided in separate plain text files. In the event of a discrepancy between any such plain text file and display content in the Work Product's prose narrative document(s), the content in the separate plain text file prevails.
+
+#### Key words:
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [[RFC2119](#rfc2119)] and [[RFC8174](#rfc8174)] when, and only when, they appear in all capitals, as shown here.
+
+#### Citation format:
+When referencing this specification the following citation format should be used:
+
+**[OData-JSON-Format-v4.02]**
+
+_$$$pagetitle$$$_.
+Edited by Ralf Handl, Michael Pizzo, and Heiko Theißen. $$$pubdate$$$. OASIS $$$subtitle$$$.
+https://docs.oasis-open.org/odata/odata-json-format/v4.02/csd01/$$$filename$$$.html.
+Latest stage: https://docs.oasis-open.org/odata/odata-json-format/v4.02/odata-json-format-v4.02.html.
+
+#### Notices
+Copyright $$$copyright$$$. All Rights Reserved.
+
+Distributed under the terms of the OASIS [IPR Policy](https://www.oasis-open.org/policies-guidelines/ipr/).
+
+The name "OASIS" is a trademark of [OASIS](https://www.oasis-open.org/), the owner and developer of this specification, and should be used only to refer to the organization and its official outputs.
+
+For complete copyright information please see the full Notices section in an Appendix [below](#Notices).
+
+-------