Giter Club home page Giter Club logo

habitica-api's Introduction

Habitica API OpenAPI specification

I've stopped working on it for now.
Most endpoints are there, some might be missing.
Feel free to report any issues and make requests.
Contributions are also welcome.

habitica-api's People

Contributors

igromanru avatar benniefolyfe avatar

Stargazers

Andrés Felipe Esguerra Restrepo avatar

Watchers

 avatar  avatar

Forkers

benniefolyfe

habitica-api's Issues

Check and fix endpoint descriptins

Some endpoint descriptions aren't accurate or not very good explained.
For example: In all /v3/groups/{groupId} endpoints, the path parameter groupId can be a UUID of a Group or simply party for your current party group.

Make each json object into a schema

Since the official Habitica Api documentation does not contain reusable objects, but basically each request and each response has its own structure, I started writing the OpenAPI in the same way.
Then I tried to use the OpenAPI Generator to generate some client code from the specification.
Generator creates objects with random names out of anonymous json objects.
Therefore it's better to make it properly and make each object into it's own schema.

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.