-
Notifications
You must be signed in to change notification settings - Fork 140
Open
Labels
area/docsIssues related to documentation, plugin examples, blueprints, and guidesIssues related to documentation, plugin examples, blueprints, and guidesenhancementNew feature or requestNew feature or request
Description
Describe what's missing in our docs
As discussed @aj-emerich, let's:
- adjust the README https://github.com/kestra-io/client-sdk/tree/main to redirect to https://kestra.io/docs/api-reference/kestra-sdk instead of duplicating the information
- refine https://kestra.io/docs/api-reference/kestra-sdk to 1 page per language
- change to Release 1.0 as the first stable release
- 1 page per language covering:
- how to install that SDK - the README is mostly correct https://github.com/kestra-io/client-sdk/tree/main
- pip install kestrapy
- npm install @kestra-io/kestra-sdk
- go get [github.com/kestra-io/client-sdk/go-sdk@latest](http://github.com/kestra-io/client-sdk/go-sdk@latest)
- how to authenticate i.e. instantiate the client with the
Configuration()object- 1 sub-section per authentication method (username + password, another section for API token authentication in EE/Cloud)
- how to create or update a flow if it already exists
- how to execute a flow
- how to follow the execution i.e. wait for results (server-sent event = SSE) → Yann should send an example to AJ as this is a custom endpoint not covered by the autogenerated SDK
wait=truewill poll for the status every X seconds etc; in contrast, the follow endpoint uses SSE to stream logs/progress in real-time → **get** /api/v1/{tenant}/executions/{executionId}/followand **get** /api/v1/{tenant}/logs/{executionId}/follow
- then how to list all flows from the tutorial namespace with filters
- how to install that SDK - the README is mostly correct https://github.com/kestra-io/client-sdk/tree/main
Metadata
Metadata
Assignees
Labels
area/docsIssues related to documentation, plugin examples, blueprints, and guidesIssues related to documentation, plugin examples, blueprints, and guidesenhancementNew feature or requestNew feature or request