electerious / Ackee

Self-hosted, Node.js based analytics tool for those who care about privacy.
https://ackee.electerious.com
MIT License
4.2k stars 351 forks source link

[Feature][Docs] details about Ackee endpoints (~10 min to make it) #295

Closed c0ncentus closed 2 years ago

c0ncentus commented 2 years ago

🐣 Is your feature request related to a problem? Please describe. Explicit docs on endpoint and method and what object is sended/ recieved

💡 Describe the solution you'd like https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeEndpoint.html

or simply like : method: GET endpoint : baseUrl/Domains body: return: {id: string}[]

and others things if require ...

📋 Additional context Existing database and api. So I want merge ackee api on my current API but I ask only for you to make a minimal doc on endpoints. I can look to your code (already do) but I'm not sure what really happen.

I think it is really valuable.

electerious commented 2 years ago

Ackee uses GraphQL and therefore has only one endpoint (which is /api). You can find everything about it in the API docs: https://docs.ackee.electerious.com/#/docs/API

Let me know when you have questions about specific queries or mutations. On 5. Oct 2021, 11:16 +0300, c0ncentus @.***>, wrote:

🐣 Is your feature request related to a problem? Please describe. Explicit docs on endpoint and method and what object is sended/ recieved 💡 Describe the solution you'd like https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeEndpoint.html or simply like : method: GET endpoint : baseUrl/Domains body: return: {id: string}[] and others things if require ... 📋 Additional context Existing database and api. So I want merge ackee api on my current API but I ask only for you to make a minimal doc on endpoints. I can look to your code (already do) but I'm not sure what really happen. I think it is really valuable. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.