Open Garden

Description

This API/Projects provides lots of information about plantations, their needs, and sowing advice.

• Open Garden
  • Description
  • Projects
  • Integration
    • Rate Limiting
    • Content-Range
    • JWT Ticket
    • Bad Request Handling
  • Roadmap
    • Release notes
  • Versioning
  • Contributing

Projects

Project	Description
Core	Contains server, including REST API, Socket Server...
Admin	Backend automatically generated using swagger definition
Hass	Home Assistant add-on	In progress...
App	Web Application	In progress...

Integration

Rate Limiting

This project is protected by throttling.

You can compute your remaining requests via the responses headers.

Header	Description	Example
x-ratelimit-limit	the maximum number of requests	20
x-ratelimit-remaining	remaining requests	18
x-ratelimit-reset	time to reset the counter	30

Content-Range

Header	Description	Example
Content-Range	The Content-Range response HTTP header indicates where in a full body message a partial message belongs. like elements {range-start}-{range-end}/{size}	elements 0-10/1

JWT Ticket

The HTTP Authorization request header is required to authenticate a user on many endpoints.

This header must be provided like :

curl -X 'GET' ...
  -H 'Authorization: Bearer {TOKEN}'

To obtain this {TOKEN} you must call the endpoint /account/login (cf SwaggerUI).

Bad Request Handling

{
  "statusCode": 400,
  "message": [
    {
      "value": "0",
      "property": "example",
      "constraints": {
        "matches": "example must match ^/[a-z0-9_-]/$ regular expression",
        "isLength": "example must be longer than or equal to 3 characters",
        "isString": "example must be a string"
      }
    }
  ],
  "error": "Bad Request"
}

Roadmap

View the OpenGarden Public Roadmap

Release notes

For the versions available, see the tags on this repository.

Versioning

We use SemVer for versioning.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.