Skip to content

Conditionally apply info template #1137

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

Merged
merged 1 commit into from
May 1, 2025
Merged

Conversation

sserrata
Copy link
Member

@sserrata sserrata commented May 1, 2025

Description

A regression bug was introduced in #1122 that resulted in build errors in cases where info pages were not used as categoryLinkSource.

Error: /access/api/insights/palo-alto-networks-3-0-apis/ is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.

This PR adds conditions back to ensure the info template is only applied when either:

  • categoryLinkSource is set to "info" or
  • A user defined infoTemplate is provided

Motivation and Context

The info template should only be applied in the cases mentioned above, otherwise fall back to just rendering the info page using the standard view template.

How Has This Been Tested?

See deploy preview

Screenshots (if appropriate)

See deploy preview

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

@sserrata sserrata added the bug Something isn't working label May 1, 2025
@sserrata sserrata self-assigned this May 1, 2025
Copy link

github-actions bot commented May 1, 2025

Size Change: 0 B

Total Size: 2.13 MB

ℹ️ View Unchanged
Filename Size
demo/.docusaurus/codeTranslations.json 2 B
demo/.docusaurus/docusaurus.config.mjs 14.3 kB
demo/.docusaurus/globalData.json 54.1 kB
demo/.docusaurus/i18n.json 267 B
demo/.docusaurus/registry.js 78.5 kB
demo/.docusaurus/routes.js 74.2 kB
demo/.docusaurus/routesChunkNames.json 30.6 kB
demo/.docusaurus/site-metadata.json 1.35 kB
demo/build/assets/css/styles.********.css 146 kB
demo/build/assets/js/main.********.js 706 kB
demo/build/assets/js/runtime~main.********.js 19.8 kB
demo/build/index.html 91.1 kB
demo/build/petstore/add-pet/index.html 28.1 kB
demo/build/petstore/create-user/index.html 22.2 kB
demo/build/petstore/create-users-with-array-input/index.html 22.3 kB
demo/build/petstore/create-users-with-list-input/index.html 22.3 kB
demo/build/petstore/delete-order/index.html 22.3 kB
demo/build/petstore/delete-pet/index.html 22.3 kB
demo/build/petstore/delete-user/index.html 22.6 kB
demo/build/petstore/find-pets-by-status/index.html 23 kB
demo/build/petstore/find-pets-by-tags/index.html 23.7 kB
demo/build/petstore/get-inventory/index.html 21.6 kB
demo/build/petstore/get-order-by-id/index.html 22.5 kB
demo/build/petstore/get-pet-by-id/index.html 23.1 kB
demo/build/petstore/get-user-by-name/index.html 22.6 kB
demo/build/petstore/login-user/index.html 23.2 kB
demo/build/petstore/logout-user/index.html 21.9 kB
demo/build/petstore/new-pet/index.html 22.5 kB
demo/build/petstore/pet/index.html 20.8 kB
demo/build/petstore/place-order/index.html 21.8 kB
demo/build/petstore/schemas/apiresponse/index.html 23.6 kB
demo/build/petstore/schemas/cat/index.html 37.4 kB
demo/build/petstore/schemas/category/index.html 24.6 kB
demo/build/petstore/schemas/dog/index.html 37.8 kB
demo/build/petstore/schemas/honeybee/index.html 37.9 kB
demo/build/petstore/schemas/id/index.html 21.7 kB
demo/build/petstore/schemas/order/index.html 25.7 kB
demo/build/petstore/schemas/pet/index.html 37.4 kB
demo/build/petstore/schemas/tag/index.html 23 kB
demo/build/petstore/schemas/user/index.html 45.5 kB
demo/build/petstore/store/index.html 20 kB
demo/build/petstore/subscribe-to-the-store-events/index.html 28.6 kB
demo/build/petstore/swagger-petstore-yaml/index.html 28.7 kB
demo/build/petstore/update-pet-with-form/index.html 22.5 kB
demo/build/petstore/update-pet/index.html 22.9 kB
demo/build/petstore/update-user/index.html 22.5 kB
demo/build/petstore/upload-file/index.html 22.3 kB
demo/build/petstore/user/index.html 20.5 kB

compressed-size-action

Copy link

github-actions bot commented May 1, 2025

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

https://docusaurus-openapi-36b86--pr1137-kgiwd7wg.web.app

(expires Sat, 31 May 2025 20:26:09 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: bf293780ee827f578864d92193b8c2866acd459f

@sserrata sserrata merged commit 7a4666c into main May 1, 2025
9 checks passed
@sserrata sserrata deleted the conditional-info-template branch May 1, 2025 20:27
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