nextcloud / nextcloud/deck

Add openapi.json so it can be viewed by OCS-API Viewer app

Open
#8,223 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
JavaScript
Stars
1.4k
Forks
354
Avg merge
1d 10h
Merged PRs (30d)
43

Description

How to use GitHub
  • Please use the 👍 reaction to show that you are affected by the same issue.
  • Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
  • Subscribe to receive notifications on status change and new comments.

Is your feature request related to a problem? Please describe.
When using external automation tools or if you are scripting knowing API endpoints is very important. Currently, there is a quite old API documentation at https://deck.readthedocs.io/en/latest/API/ but e.g. Talk relies on the OCS-API Viewer app for Nextcloud, always displaying the latest API docs. Deck isn't available there.

Describe the solution you'd like
Publish an openapi.json which can be read by the OCS-API Viewer app.

Describe alternatives you've considered
Since I can't find any openapi.json file I can't even use other viewers. Now it's try and error with the old documentation.

Additional context

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 comparing Deck's available API endpoints with the existing API documentation at deck.readthedocs.io and the requirements of the OCS-API Viewer app. Done means an openapi.json is published for Deck and can be consumed by the viewer and other OpenAPI tools.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.