Skip to content

feat: generate API reference docs from OpenAPI spec #1526

Open
fabiovincenzi wants to merge 18 commits into
finos:mainfrom
fabiovincenzi:swagger-docs-1510
Open

feat: generate API reference docs from OpenAPI spec #1526
fabiovincenzi wants to merge 18 commits into
finos:mainfrom
fabiovincenzi:swagger-docs-1510

Conversation

@fabiovincenzi
Copy link
Copy Markdown
Contributor

@fabiovincenzi fabiovincenzi commented May 8, 2026

This PR is based on #1501

  • Adds scripts/doc-swagger.js that parses dist/swagger.json into MDX pages, following the same pattern as the existing scripts/doc-schema.js
  • Generates one page per API tag (Auth, Config, Health, Home, Push, Repositories, Users) plus an index page
  • Adds "API Reference" section to the website sidebar

Closes #1510

@fabiovincenzi fabiovincenzi requested a review from a team as a code owner May 8, 2026 09:46
@netlify
Copy link
Copy Markdown

netlify Bot commented May 8, 2026

Deploy Preview for endearing-brigadeiros-63f9d0 ready!

Name Link
🔨 Latest commit 62d9756
🔍 Latest deploy log https://app.netlify.com/projects/endearing-brigadeiros-63f9d0/deploys/6a1dae7709f7650008e43c71
😎 Deploy Preview https://deploy-preview-1526.git-proxy.preview.finos.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment thread scripts/doc-swagger.js Fixed
Comment thread scripts/doc-swagger.js Fixed
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 1, 2026

Codecov Report

❌ Patch coverage is 86.61461% with 240 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.84%. Comparing base (ffd6937) to head (62d9756).

Files with missing lines Patch % Lines
src/service/generatedRoutes.ts 87.10% 139 Missing ⚠️
src/service/controllers/AuthController.ts 76.43% 42 Missing and 3 partials ⚠️
src/service/controllers/PushController.ts 90.85% 15 Missing and 1 partial ⚠️
src/service/authentication.ts 77.35% 10 Missing and 2 partials ⚠️
src/service/index.ts 60.86% 9 Missing ⚠️
src/service/controllers/RepoController.ts 95.78% 7 Missing and 1 partial ⚠️
src/service/controllers/HomeController.ts 53.84% 6 Missing ⚠️
src/service/proxyStore.ts 70.00% 3 Missing ⚠️
src/app.ts 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1526      +/-   ##
==========================================
- Coverage   90.65%   89.84%   -0.81%     
==========================================
  Files          69       71       +2     
  Lines        5690     6743    +1053     
  Branches      985      997      +12     
==========================================
+ Hits         5158     6058     +900     
- Misses        514      664     +150     
- Partials       18       21       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Render generated swagger.json for API documentation

4 participants