Go to file

Nico Kroll a377a8ecbb First commit of a rough draft and the old doc.		2024-04-12 15:09:15 +02:00
src	First commit of a rough draft and the old doc.	2024-04-12 15:09:15 +02:00
LICENSE	Initial commit	2024-04-08 15:10:40 +02:00
README.md	First commit of a rough draft and the old doc.	2024-04-12 15:09:15 +02:00

README.md

API documentation of TyrePro

How it's written?

The documentations follow the OpenAPI 3.0.0 specifications. You can read the yaml-files manually or use any editor like Swagger or similar.

How to get started?

Explore the endpoints of the common.yaml! There you find some general points and the ways of how to create a session.
Explore the other yaml files, check which permissions (sessions) you need and let's go!

Is the API stable?

Time is change. Nothing is stable. Even when it may sound rough, but it's the truth. During development on a specific part, there will be a lot of changes. Someone requests something new (or changed) and there will be changes. We need to update some points to fullfil further requirements in our application - other changes coming.

That is the reason why we put this API documentation in a public git: that you're able to track what changed.

I've more questions!

Don't hesitate to visit our homepage to contact us!