owncloud / owncloud/libre-graph-api

Drive name really required?

Open
#162 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
4
Forks
3
Avg merge
23h 14m
Merged PRs (30d)
1

Description

The spec defines the name of a drive as required, see
https://github.com/owncloud/libre-graph-api/blob/18cc51ae24b30aa25c141cb4bf48d342f99c88fb/api/openapi-spec/v1.0.yaml#L3274C7-L3274C15

In order to patch a drive with

headers: {
  Restore: true
}

the corresponding PATCH request requires the drive name to be provided in the request body, which doesn't make sense for that particular request.

Can we make the name attribute of the drive optional, or does that lead to other issues?

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

Review api/openapi-spec/v1.0.yaml at the drive name definition and the PATCH request described in the issue. Check how the Restore header affects the request, then determine whether making name optional is valid without introducing other API inconsistencies. Done means the specification and related behavior consistently support restoring a drive without requiring name, or document why it must remain required.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.