Skip to content

Comments

refactor(theme): migrate OpenAPI types from plugin to theme#1291

Closed
sserrata wants to merge 1 commit intomainfrom
refactor/migrate-types-to-theme
Closed

refactor(theme): migrate OpenAPI types from plugin to theme#1291
sserrata wants to merge 1 commit intomainfrom
refactor/migrate-types-to-theme

Conversation

@sserrata
Copy link
Member

Move OpenAPI type definitions (ServerObject, ParameterObject, RequestBodyObject, MediaTypeObject, SecuritySchemeObject, etc.) from the plugin to the theme's types.d.ts file. This reduces coupling between packages and addresses tech debt from when the plugin generated inline markdown.

Changes:

  • Add OpenAPI types to theme's src/types.d.ts
  • Update theme imports to use local types instead of plugin imports
  • Keep ApiItem as import type from plugin (contract between packages)
  • Keep runtime function imports (sampleFromSchema, etc.) from plugin lib/

Move OpenAPI type definitions (ServerObject, ParameterObject, RequestBodyObject,
MediaTypeObject, SecuritySchemeObject, etc.) from the plugin to the theme's
types.d.ts file. This reduces coupling between packages and addresses tech debt
from when the plugin generated inline markdown.

Changes:
- Add OpenAPI types to theme's src/types.d.ts
- Update theme imports to use local types instead of plugin imports
- Keep ApiItem as import type from plugin (contract between packages)
- Keep runtime function imports (sampleFromSchema, etc.) from plugin lib/
@sserrata sserrata self-assigned this Jan 27, 2026
@sserrata sserrata added the bug Something isn't working label Jan 27, 2026
@github-actions
Copy link

Size Change: 0 B

Total Size: 2.17 MB

ℹ️ View Unchanged
Filename Size
demo/.docusaurus/codeTranslations.json 2 B
demo/.docusaurus/docusaurus.config.mjs 14.7 kB
demo/.docusaurus/globalData.json 60.7 kB
demo/.docusaurus/i18n.json 372 B
demo/.docusaurus/registry.js 87.9 kB
demo/.docusaurus/routes.js 83.1 kB
demo/.docusaurus/routesChunkNames.json 34.4 kB
demo/.docusaurus/site-metadata.json 1.51 kB
demo/build/assets/css/styles.********.css 163 kB
demo/build/assets/js/main.********.js 644 kB
demo/build/assets/js/runtime~main.********.js 21 kB
demo/build/index.html 96.8 kB
demo/build/petstore/add-pet/index.html 29.3 kB
demo/build/petstore/create-user/index.html 24 kB
demo/build/petstore/create-users-with-array-input/index.html 24.1 kB
demo/build/petstore/create-users-with-list-input/index.html 24.1 kB
demo/build/petstore/delete-order/index.html 23.8 kB
demo/build/petstore/delete-pet/index.html 24.1 kB
demo/build/petstore/delete-user/index.html 24.3 kB
demo/build/petstore/find-pets-by-status/index.html 24.8 kB
demo/build/petstore/find-pets-by-tags/index.html 25.4 kB
demo/build/petstore/get-inventory/index.html 23.1 kB
demo/build/petstore/get-order-by-id/index.html 24.1 kB
demo/build/petstore/get-pet-by-id/index.html 24.9 kB
demo/build/petstore/get-user-by-name/index.html 24.4 kB
demo/build/petstore/login-user/index.html 24.9 kB
demo/build/petstore/logout-user/index.html 23.7 kB
demo/build/petstore/new-pet/index.html 24.3 kB
demo/build/petstore/pet/index.html 22.5 kB
demo/build/petstore/place-order/index.html 23.3 kB
demo/build/petstore/schemas/apiresponse/index.html 24.6 kB
demo/build/petstore/schemas/cat/index.html 38.8 kB
demo/build/petstore/schemas/category/index.html 25.7 kB
demo/build/petstore/schemas/dog/index.html 39 kB
demo/build/petstore/schemas/honeybee/index.html 39.1 kB
demo/build/petstore/schemas/id/index.html 22.7 kB
demo/build/petstore/schemas/order/index.html 26.8 kB
demo/build/petstore/schemas/pet/index.html 38.6 kB
demo/build/petstore/schemas/tag/index.html 24.1 kB
demo/build/petstore/schemas/user/index.html 46.4 kB
demo/build/petstore/store/index.html 21.5 kB
demo/build/petstore/subscribe-to-the-store-events/index.html 30.2 kB
demo/build/petstore/swagger-petstore-yaml/index.html 30.2 kB
demo/build/petstore/update-pet-with-form/index.html 24.3 kB
demo/build/petstore/update-pet/index.html 24.7 kB
demo/build/petstore/update-user/index.html 24.3 kB
demo/build/petstore/upload-file/index.html 24.1 kB
demo/build/petstore/user/index.html 22.2 kB

compressed-size-action

@github-actions
Copy link

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

https://docusaurus-openapi-36b86--pr1291-zh1pxhud.web.app

(expires Thu, 26 Feb 2026 16:14:57 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: bf293780ee827f578864d92193b8c2866acd459f

@sserrata sserrata closed this Jan 27, 2026
@sserrata sserrata deleted the refactor/migrate-types-to-theme branch January 27, 2026 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant