Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

kobotoolbox: add generic http helpers #934

Open
aleksa-krolls opened this issue Jan 23, 2025 · 2 comments
Open

kobotoolbox: add generic http helpers #934

aleksa-krolls opened this issue Jan 23, 2025 · 2 comments
Assignees
Labels
adaptor Related to one of the adaptors Medium Complexity level P3 Priority Level

Comments

@aleksa-krolls
Copy link
Member

aleksa-krolls commented Jan 23, 2025

Request

Add support for basic http helpers for these methods:

  1. GET
  2. POST
  3. PUT

Note that we'll revisit the existing functions like getSubmissions(...) later as Joe wants to revisit the signature and develop more of a spec for #603.

API docs

https://kf.kobotoolbox.org/api/v2/assets/
fyi assets in the API language are the same thing as kobo forms

Credentials

See LP openfn demo Kobo Account

Testing Guidance

Make sure the helpers can support these requests:

  1. GET /api/v2/assets/{uid}/deployment/ --> this will return the deployment status of this form(which basically says whether or not this form is deployed already).
  • You can try with this form with uid aNxSba2DYAF3wm8hLyGUxK --> you should find that this form is not yet deployed
  • To get other form examples, run GET /api/v2/assets/ to query a list of kobo forms in this account
  1. POST /api/v2/assets/{uid}/deployment/ --> run this to try to deploy the form
  2. PUT /api/v2/assets/{uid}/deployment/ --> run this to try updating the status to deploy the form
@github-project-automation github-project-automation bot moved this to New Issues in v2 Jan 23, 2025
@aleksa-krolls aleksa-krolls changed the title kobotoolbox: kobotoolbox: add generic http helpers Jan 23, 2025
@aleksa-krolls
Copy link
Member Author

fyi @hunterachieng - synced with @josephjclark on this recently, and we think that actually #603 is not ready to be worked on... so we'll do this instead in the next kobo sprint. Ahead of the meeting Monday, please review this issue and provide estimates

@aleksa-krolls aleksa-krolls added the adaptor Related to one of the adaptors label Jan 23, 2025
@martalovescoffee martalovescoffee added Easy Complexity level P3 Priority Level Medium Complexity level and removed Easy Complexity level labels Jan 27, 2025
@josephjclark
Copy link
Collaborator

@hunterachieng when you get around to this, please add all the http helpers into the http. namespace - like we're doing with OpenMRS!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adaptor Related to one of the adaptors Medium Complexity level P3 Priority Level
Projects
Status: New Issues
Development

No branches or pull requests

4 participants