OpenFn / OpenFn/adaptors

ODK: Support a metadata flag

Open
#658 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

DevX
Dominant language
JavaScript
Stars
24
Forks
41
Avg merge
3d 13h
Merged PRs (30d)
12

Description

This issue is a design for a "metadata only" flag for the ODK adaptor. I suggest we don't implement it until we get a report that it's needed.

When fetching forms or submissions it might be useful to only include metadata in the request (ie, submitted date, created date).

To provide a uniform API across the adaptor, I suggest we do it as an option in the final argument, like this:

getForms(projectId), getSubmissions(projectId, formId, { metaOnly: true })

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names the ODK adaptor and its getForms/getSubmissions API calls, but provides no file or test path. First locate those entry points and check whether a concrete metadata-only requirement has been reported; no implementation is considered done until that need is confirmed and the uniform option design is agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.