Giter Site home page Giter Site logo

xero-schemas's Introduction

xero-schemas

Machine generated, machine-readable schemas for the Xero APIs

These schemas are currently being used in the 2.0 branch of xero-php, and are designed as a source of truth for codegens in other languages since Xero's are incomplete and often out of date.

At this point the schemas are 100% generated from the developer documentation, but there is provision for an 'overrides' file to help out where the documentation is not completely correct or indicative of how it actually works (namely the behaviour around TrackingCategories).

APIs supported

The generated OpenAPI/Swagger files in the schemas folder.

Actual Documentation

It would be nice to find something to integrate into the build process to automatically render the generated swagger files out to html - in the mean time, you can head to editor.swagger.io and load any of the schemas above.

Installation and Generation

Installation can be done with a composer install, following that you can execute ./bin/generate and the schemas will be updated.

Issues and PRs

Raising issues is welcome, and feel free to submit PRs, but please don't submit changes that were not made directly from the generator or overrides file as they'll be impossible to track.

OAuth 1.0

Unfortunately, the spec doesn't allow OAuth1, so there's not quite enough in the schemas to make a fully generatable API.

xero-schemas's People

Contributors

calcinai avatar

Watchers

 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.