Document versioned OpenRosa manifest

Open Beginner friendly
#2,256 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Find the API documentation that lists the existing OpenRosa manifest URLs and read its surrounding endpoint structure. Add the versioned /v1/projects/{projectId}/forms/{xmlFormId}/versions/{version}/manifest URL, then verify the documentation build or link checks pass and that all three manifest URLs are listed.

Written by the indexing model from the issue text.

Description

backend documentation

Currently, we document the following OpenRosa URLs in our API docs:

  • /v1/projects/{projectId}/forms/{xmlFormId}/manifest
  • /v1/test/{token}/projects/{projectId}/forms/{xmlFormId}/draft/manifest

However, we don't document the versioned URL:

  • /v1/projects/{projectId}/forms/{xmlFormId}/versions/{version}/manifest

Starting with #2251, we plan to return versioned URLs in the OpenRosa formList.

This issue is to document the versioned URL.

Dominant language
JavaScript
Stars
227
Forks
237
Avg merge
3d 7h
Merged PRs (30d)
17

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.

More from getodk/central

All issues in getodk/central

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.