Include dev API in docs

Open
#421 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
openapi
Domain
api, documentation

Research direction

The issue identifies the public REST API and a Swagger definition but names no files or entry points. Start by locating the API specification and the documentation site's integration points; done means the public API is documented in a form that is easy for custom integrators to use.

Written by the indexing model from the issue text.

Description

cloud/server

if we have swagger definition of the public REST API it should be possible to easily create nice documentation for anyone who would like to use it for custom integrations

Dominant language
Vue
Stars
15
Forks
22
Avg merge
6d 7h
Merged PRs (30d)
10

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.

More from MerginMaps/docs

All issues in MerginMaps/docs

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.