Document the API and using Gaia without the Admin client
Skarlso opened this issue · 8 comments
There has been need to not use the UI but rather the API directly. We need to document a proper way of using the API without the admin client and document the API as well and it's features.
@Skarlso thanks. We need this for sure!
I also think that the current way of triggering a Gaia pipeline is too complex and not really user friendly (send request to get bearer token, send another request to trigger pipeline).
It would be cool if (optional) Gaia would automatically generate a token (or user provides one) and this could be used to trigger one specific pipeline. What do you think?
@michelvocks Hmm. How would you get to that token? Or would you have to use an authenticated admin for it which gives it to you for later usage? We'd have to safe the triggering token / pipeline, which should be fine. 🤔
Hmm. How would you get to that token? Or would you have to use an authenticated admin for it which gives it to you for later usage?
Exactly. In the pipeline settings you should be able to set/generate a token and attach it to one specific pipeline.
I know this feature from jenkins: https://humanwhocodes.com/blog/2015/10/triggering-jenkins-builds-by-url/
But there it's in my opinion also too complicated. I think there is no reason for providing two tokens.
Cool! That sounds doable!
It would be great if you could provide open API / swagger specs for the API, so we can use existing tooling like swagger-codegen to generate clients for SDK :)
Swagger has been added. I'll update the gaia docs with a static rip off it. Otherwise, the docs are available under:
the deployed base url /swagger/index.html.
Documentation and swagger has been added.
Better late then never, I guess @leberknecht :D