GithubHelp home page GithubHelp logo

josesaribeiro / odata-openapi Goto Github PK

View Code? Open in Web Editor NEW

This project forked from oasis-tcs/odata-openapi

0.0 0.0 0.0 6.48 MB

OASIS OData TC: Tools for producing API descriptions for OData services that adhere to the OpenAPI Specification

Home Page: https://oasis-tcs.github.io/odata-openapi/

License: Other

JavaScript 28.04% XSLT 70.24% Shell 0.80% Batchfile 0.92%

odata-openapi's Introduction

README

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-openapi ) 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.

Description

The purpose of this repository is to support development of tools for producing OpenAPI descriptions for OData services.

Planned work items include:

  • XSLT transformation from OData CSDL XML to OpenAPI JSON
  • example XML files
  • example openapi.json files
  • example files for the live odata.org services

Contributions

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.

Licensing

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.

Further Description of this Repository

The OData TC has published the OData to OpenAPI Mapping Version 1.0, a recommendation on how to create OpenAPI descriptions for OData services. This project is a proof-of-concept implementation of that mapping using XSLT.

The examples folder contains OpenAPI/Swagger 2.0 and OpenAPI 3.0.0 descriptions that have been created from the XML $metadata documents of live and example OData services with the V4-CSDL-to-OpenAPI.xsl transformation in the tools folder.

The entity-relationship diagrams visualizing the resource models of each service are generated on-the-fly with yUML.

OpenAPI descriptions for live example OData services at www.odata.org

OpenAPI descriptions for OData services that reference each other (cross-service references)

Contact

Please send questions or comments about OASIS TC GitHub repositories to Robin Cover and Chet Ensign. 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.

odata-openapi's People

Contributors

ralfhandl avatar robincover avatar fbunsmann avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.