Members of the OASIS Open Data Protocol (OData) Technical Committee create and manage technical content in this TC GitHub repository ( https://github.com/oasis-tcs/odata-specs ) as part of the TC's chartered work (i.e., the program of work and deliverables described in its charter).
OASIS TC GitHub repositories, as described in GitHub Repositories for OASIS TC Members' Chartered Work, are governed by the OASIS TC Process, IPR Policy, and other policies, similar to TC Wikis, TC JIRA issues tracking instances, TC SVN/Subversion repositories, etc. While they make use of public GitHub repositories, these TC GitHub repositories are distinct from OASIS Open Repositories, which are used for development of open source licensed content.
The purpose of this repository is to maintain Markdown sources for draft revisions of the OData core and extension specifications.
As stated in this repository's CONTRIBUTING file, contributors to this repository are expected to be Members of the OASIS OData TC, for any substantive change requests. Anyone wishing to contribute to this GitHub project and participate in the TC's technical activity is invited to join as an OASIS TC Member. Public feedback is also accepted, subject to the terms of the OASIS Feedback License.
Please see the LICENSE file for description of the license terms and OASIS policies applicable to the TC's work in this GitHub project. Content in this repository is intended to be part of the OData TC's permanent record of activity, visible and freely available for all to use, subject to applicable OASIS policies, as presented in the repository LICENSE file.
Please send questions or comments about OASIS TC GitHub repositories to Project Administration. For questions about content in this repository, please contact the TC Chair or Co-Chairs as listed on the the OData TC's home page.
Documents are generated from Markdown sources using Node.js modules described here and Pandoc.
- Download and install Node.js, verify via
node -v - Download and install Pandoc, verify via
pandoc -v - Download and install git, verify via
git -v - Optionally download and install GitHub Desktop
- Clone this repository
- In the local repository folder run
npm install, verify vianpm test
Repeat this step if the test fails with an error message like the following after upgrading to a new Chrome version:1 failing 1) OASIS doc build Puppeteer: Error: Could not find Chrome (ver. 116.0.5845.96). This can occur if either 1. you did not perform an installation before running the script (e.g. `npm install`) or 2. your cache path is incorrectly configured (which is: C:\Users\D024504\.cache\puppeteer). For (2), check out our guide on configuring puppeteer at https://pptr.dev/guides/configuration.
-
npm startstarts a local web server to serve the HTML pages at http://localhost:8080- The HTML pages are rebuilt and the browser is auto-refreshed whenever one of the source files changes
-
npm run buildbuilds HTML and Markdown files for publication on https://oasis-tcs.github.io/odata-specs/- Do this before pushing to GitHub to avoid build errors
-
npm run pdfconverts the HTML files to PDF- This is only necessary for publication to the OASIS Library
| Title | Stage | Files | Published at |
|---|---|---|---|
| OData Extension for Data Aggregation Version 4.0 | Committee Specification 03 | Specification Vocabulary ABNF | OASIS |
| OData Version 4.02. Part 1: Protocol | Committee Specification Draft 01 | Specification ABNF | OASIS |
| OData Version 4.02. Part 2: URL Conventions | Committee Specification Draft 01 | Specification ABNF | OASIS |
| OData JSON Format Version 4.02 | Committee Specification Draft 01 | Specification | OASIS |
| OData Common Schema Definition Language (CSDL) JSON Representation Version 4.02 | Committee Specification Draft 01 | Specification Schemas | OASIS |
| OData Common Schema Definition Language (CSDL) XML Representation Version 4.02 | Committee Specification Draft 01 | Specification Schemas | OASIS |