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

Migrate schema page to Schema component and refactor layout #1001

Merged
merged 14 commits into from
Oct 28, 2024
Merged

Conversation

sserrata
Copy link
Member

@sserrata sserrata commented Oct 21, 2024

Description

Migrates to new Schema theme component for rendering schemas in schema pages and refactors layout as described in #996. Also allows use of createSchemaPageMD when defining markdown generators.

Motivation and Context

Ensures consistency in how schemas are represented across API and schema pages.

How Has This Been Tested?

See deploy preview

@sserrata sserrata added enhancement New feature or request v4.0.0 v4.0.0 labels Oct 21, 2024
@sserrata sserrata self-assigned this Oct 21, 2024
Copy link

github-actions bot commented Oct 21, 2024

Size Change: +67 kB (+3.4%)

Total Size: 2.04 MB

Filename Size Change
demo/build/assets/css/styles.********.css 133 kB +30 B (+0.02%)
demo/build/petstore/schemas/apiresponse/index.html 24.1 kB +2.62 kB (+12.21%) ⚠️
demo/build/petstore/schemas/cat/index.html 38.9 kB +8.68 kB (+28.75%) 🚨
demo/build/petstore/schemas/category/index.html 25.2 kB +3.17 kB (+14.37%) ⚠️
demo/build/petstore/schemas/dog/index.html 39.3 kB +9.67 kB (+32.6%) 🚨
demo/build/petstore/schemas/honeybee/index.html 39.4 kB +9.67 kB (+32.57%) 🚨
demo/build/petstore/schemas/id/index.html 22.1 kB +1.31 kB (+6.31%) 🔍
demo/build/petstore/schemas/order/index.html 26.4 kB +3.91 kB (+17.37%) ⚠️
demo/build/petstore/schemas/pet/index.html 38.8 kB +10.9 kB (+39.03%) 🚨
demo/build/petstore/schemas/tag/index.html 23.5 kB +2.16 kB (+10.12%) ⚠️
demo/build/petstore/schemas/user/index.html 47.6 kB +14.8 kB (+45.2%) 🚨
ℹ️ View Unchanged
Filename Size
demo/.docusaurus/codeTranslations.json 2 B
demo/.docusaurus/docusaurus.config.mjs 13.7 kB
demo/.docusaurus/globalData.json 38.6 kB
demo/.docusaurus/i18n.json 267 B
demo/.docusaurus/registry.js 56.9 kB
demo/.docusaurus/routes.js 52.6 kB
demo/.docusaurus/routesChunkNames.json 21.8 kB
demo/.docusaurus/site-metadata.json 1.23 kB
demo/build/assets/js/main.********.js 675 kB
demo/build/assets/js/runtime~main.********.js 14.6 kB
demo/build/index.html 94.5 kB
demo/build/petstore/add-pet/index.html 23.2 kB
demo/build/petstore/create-user/index.html 22.6 kB
demo/build/petstore/create-users-with-array-input/index.html 22.6 kB
demo/build/petstore/create-users-with-list-input/index.html 22.6 kB
demo/build/petstore/delete-order/index.html 22.6 kB
demo/build/petstore/delete-pet/index.html 22.7 kB
demo/build/petstore/delete-user/index.html 23 kB
demo/build/petstore/find-pets-by-status/index.html 23.4 kB
demo/build/petstore/find-pets-by-tags/index.html 24.1 kB
demo/build/petstore/get-inventory/index.html 21.9 kB
demo/build/petstore/get-order-by-id/index.html 22.9 kB
demo/build/petstore/get-pet-by-id/index.html 23.5 kB
demo/build/petstore/get-user-by-name/index.html 23 kB
demo/build/petstore/login-user/index.html 23.6 kB
demo/build/petstore/logout-user/index.html 22.3 kB
demo/build/petstore/new-pet/index.html 22.9 kB
demo/build/petstore/pet/index.html 24.6 kB
demo/build/petstore/place-order/index.html 22.1 kB
demo/build/petstore/store/index.html 22.5 kB
demo/build/petstore/subscribe-to-the-store-events/index.html 29.2 kB
demo/build/petstore/swagger-petstore-yaml/index.html 29.6 kB
demo/build/petstore/update-pet-with-form/index.html 22.9 kB
demo/build/petstore/update-pet/index.html 23.3 kB
demo/build/petstore/update-user/index.html 22.9 kB
demo/build/petstore/upload-file/index.html 22.7 kB
demo/build/petstore/user/index.html 23.5 kB

compressed-size-action

Copy link

github-actions bot commented Oct 21, 2024

Visit the preview URL for this PR (updated for commit bcf220f):

https://docusaurus-openapi-36b86--pr1001-hs3r0ou8.web.app

(expires Wed, 27 Nov 2024 14:21:28 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: bf293780ee827f578864d92193b8c2866acd459f

@sserrata sserrata closed this Oct 22, 2024
@sserrata sserrata reopened this Oct 22, 2024
@ahelmy
Copy link
Contributor

ahelmy commented Oct 24, 2024

hi @sserrata,
When you are planning to merge this PR?

@sserrata
Copy link
Member Author

Hi @ahelmy, got sidetracked but was stuck on how to handle the differences in col sizes between api, schema and regular docs.

@sserrata sserrata merged commit 320fc1c into main Oct 28, 2024
13 checks passed
@sserrata sserrata deleted the schema-pages branch October 28, 2024 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v4.0.0 v4.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants