Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

poc(api-docs): swagger ui api docs #10579

Draft
wants to merge 25 commits into
base: master
Choose a base branch
from

Conversation

DominikB2014
Copy link
Contributor

@DominikB2014 DominikB2014 commented Jul 3, 2024

Still a lot of work to do here, but keeping it up in draft for visibility and testing in a PR deployment.

Copy link

vercel bot commented Jul 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 3, 2025 8:34pm
develop-docs ❌ Failed (Inspect) Feb 3, 2025 8:34pm
sentry-docs ❌ Failed (Inspect) Feb 3, 2025 8:34pm

Copy link

codecov bot commented Jul 3, 2024

Bundle Report

Changes will increase total bundle size by 21.55MB (107.57%) ⬆️⚠️, exceeding the configured threshold of 5%.

Bundle name Size Change
sentry-docs-server* 9.91MB 9.91MB (100%) ⬆️⚠️
sentry-docs-edge-server* 254.34kB 254.34kB (100%) ⬆️⚠️
sentry-docs-client* 7.98MB 7.98MB (100%) ⬆️⚠️
sentry-docs-server-cjs 12.02MB 1.65MB (15.91%) ⬆️⚠️
sentry-docs-client-array-push 11.06MB 1.76MB (18.96%) ⬆️⚠️

ℹ️ *Bundle size includes cached data from a previous commit

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/3245-*.js (New) 1.4MB 1.4MB 100.0% 🚀
static/chunks/pages/_app-*.js -3 bytes 866.66kB -0.0%
static/css/*.css 133.88kB 151.85kB 744.87% ⚠️
static/css/*.css -873 bytes 1.02kB -46.21%
static/css/*.css -4.68kB 10.75kB -30.33%
static/css/*.css -2.06kB 1.89kB -52.18%
static/css/*.css (New) 15.12kB 15.12kB 100.0% 🚀
static/css/*.css (New) 8.24kB 8.24kB 100.0% 🚀
static/chunks/949fd6f9-*.js (New) 416.47kB 416.47kB 100.0% 🚀
static/chunks/3088-*.js -393 bytes 390.51kB -0.1%
server/app/_not-*.js 18.62kB 264.38kB 7.58% ⚠️
server/app/[[...path]]/page_client-*.js 18.62kB 264.34kB 7.58% ⚠️
server/app/platform-*.js 3.3kB 234.33kB 1.43%
static/chunks/main-*.js -394 bytes 117.97kB -0.33%
static/chunks/app/[[...path]]/page-*.js -87 bytes 65.32kB -0.13%
static/chunks/app/platform-*.js 10 bytes 12.86kB 0.08%
static/chunks/webpack-*.js 103 bytes 5.53kB 1.9%
app-*.json 216 bytes 4.32kB 5.26% ⚠️
static/jgZZkCft8_X1QeXh92rbe/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/jgZZkCft8_X1QeXh92rbe/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/chunks/5075-*.js (Deleted) -246.53kB 0 bytes -100.0% 🗑️
static/B1QLf7MyfJ30rFEUsGCt7/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/B1QLf7MyfJ30rFEUsGCt7/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Files in static/chunks/app/[[...path]]/page-*.js:

  • ./src/components/api-docs/swagger-ui.css → Total Size: 39 bytes
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
../app/[[...path]]/page.js 1.59MB 2.11MB 310.97% ⚠️
2542.js 18.2kB 1.57MB 1.17%
8147.js (New) 1.04MB 1.04MB 100.0% 🚀
../instrumentation.js 18.2kB 908.41kB 2.04%
5017.js 18.2kB 884.44kB 2.1%
../app/[[...path]]/page.js.nft.json 38 bytes 369.07kB 0.01%
../app/platform-redirect/page.js.nft.json 38 bytes 368.99kB 0.01%
../app/sitemap.xml/route.js.nft.json 38 bytes 366.96kB 0.01%
8270.js 90 bytes 77.76kB 0.12%
9567.js 29 bytes 18.84kB 0.15%
4899.js (Deleted) -1.04MB 0 bytes -100.0% 🗑️

Files in ../app/[[...path]]/page.js:

  • ./src/components/api-docs/swagger-ui.css → Total Size: 1 bytes

  • ./src/components/api-docs/index.tsx → Total Size: 740 bytes

  • ./app/[[...path]]/page.tsx → Total Size: 11.81kB

  • ./src/components/api-docs/apiDocs.tsx → Total Size: 448 bytes

Files in 8270.js:

  • ./src/components/sidebar/sidebarLinks.tsx → Total Size: 3.72kB

Files in 9567.js:

  • ./src/build/shared.ts → Total Size: 378 bytes

  • ./src/build/resolveOpenAPI.ts → Total Size: 4.54kB

  • ./src/build/shared.ts → Total Size: 378 bytes

App Routes Affected:

App Route Size Change Total Size Change (%)
/[[...path]] 1.59MB 2.11MB 310.97% ⚠️

@lizokm lizokm self-requested a review July 8, 2024 19:49
@getsantry
Copy link
Contributor

getsantry bot commented Sep 14, 2024

This pull request has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you add the label WIP, I will leave it alone unless WIP is removed ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@getsantry getsantry bot added Stale and removed Stale labels Sep 14, 2024
@getsantry
Copy link
Contributor

getsantry bot commented Oct 7, 2024

This pull request has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you add the label WIP, I will leave it alone unless WIP is removed ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@getsantry getsantry bot added the Stale label Oct 7, 2024
@DominikB2014
Copy link
Contributor Author

WIP, on hold to complete some product work!

@getsantry getsantry bot removed the Stale label Oct 8, 2024
@getsantry getsantry bot added the Stale label Oct 30, 2024
@getsantry
Copy link
Contributor

getsantry bot commented Oct 30, 2024

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you remove the label Waiting for: Community, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@getsantry getsantry bot removed the Stale label Oct 31, 2024
@getsantry
Copy link
Contributor

getsantry bot commented Nov 27, 2024

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you remove the label Waiting for: Community, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@getsantry getsantry bot added Stale and removed Stale labels Nov 27, 2024
@getsantry
Copy link
Contributor

getsantry bot commented Dec 20, 2024

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you remove the label Waiting for: Community, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@getsantry getsantry bot added Stale and removed Stale labels Dec 20, 2024
@getsantry
Copy link
Contributor

getsantry bot commented Feb 1, 2025

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you remove the label Waiting for: Community, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@getsantry getsantry bot removed the Stale label Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant