openedx / openedx/api-doc-tools

Make swagger.yaml auto-build

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7
Forks
17
PR merge metrics
No merged PRs in 30d

Description

This should be part of #4, and included as part of the RTFD push.

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 reading issue #4, which this work is meant to be part of, and inspect how the RTFD push is currently handled. Trace where swagger.yaml is generated or published; done means the file is built automatically as part of that RTFD push.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
build-system, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.