Azure / Azure/aks-desktop

ossf security best practice: Add reference documentation describing external interface The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project

Open
#672 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
102
Forks
25
Avg merge
1d 4h
Merged PRs (30d)
22

Description

- [ ] Add open API v3 schema for backend routes
- [ ] Documentation for backend should be available on the website (there is a plugin for docusaurus for open API schemas)

Estimate: 1 week.

Contributor guide

Open the contributing guide

Research direction

Start by locating the backend routes and the website's documentation configuration, then review the Docusaurus plugin for OpenAPI schemas. The work is done when an OpenAPI v3 schema describes the backend inputs and outputs and the resulting backend documentation is available on the website.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, backend, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.