nextcloud / nextcloud/documentation

Drop format URI parameter

Open
#12,815 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

The ?format= is pretty bad IMO, since it does not adhere to HTTP standards while the Accept header is exactly made for this purpose. I'm not even sure we should explain here that such a query parameter ever existed.

Originally posted by @provokateurin in https://github.com/nextcloud/documentation/pull/12549#discussion_r1975688589

Should we drop this section about the ?format= then completely, mark it as deprecated or just let it be as it is right now?

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

The issue does not name a file or test. Locate the documentation section that explains the ?format= URI parameter, then review the linked discussion before deciding whether the section should be removed, marked deprecated, or retained. Done means the chosen treatment is reflected consistently in that section.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.