nextcloud / nextcloud/deck

Instructions unclear: REST API Documentation

Open
#1,153 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop docs feature: api good first issue
Dominant language
JavaScript
Stars
1.4k
Forks
354
Avg merge
1d 10h
Merged PRs (30d)
43

Description

While making API-calls one can't easily see what format is needed for e.g. dates (like in due-date in cards)
But there are also more things that are unclear, here a (hope so) full list:

  • Date format in entities (JSON) (new SimpleDateFormat("yyyy-MM-dd'T'hh:mm:ssZ"))
  • Date format in Header (If-Modified-Since) (new SimpleDateFormat("E, dd MMM yyyy hh:mm:ss z", Locale.US))
  • All endpoints: reqired fields in entities (JSON), e.g. user must be set when updating a card
  • Examples of requests (JSON) (full, no null fields like due-date 😝 )
  • Optional: Link to https://github.com/nextcloud/Android-SingleSignOn

For anyone working on a third-party-app this would be very helpful.

Thanks!


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Contributor guide

Open the contributing guide

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

Start by locating the REST API documentation and its endpoint descriptions. Use the issue's checklist to document entity and header date formats, required JSON fields, complete request examples without null fields, and optionally the Android-SingleSignOn link. Done means the requested guidance is covered across all endpoints.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.