Skip to content

Conversation

@Polo2
Copy link
Member

@Polo2 Polo2 commented Sep 29, 2025

Reverts #403, re-revert #329

Squashed in a single commit (we don't want 20 revert revert commits)

Old commits list:
  • "oas: default example was wrong""
  • "copy oas 3.1 with oas 3.2 changes""
  • "more about tag kind and parent""
  • "security scheme deprecation""
  • "response description is optional""
  • "response no content means no content""
  • "security schemes can be references now too""
  • "removed trailing slash""
  • "use newer rfc relative ref pointer links""
  • "more about tags, oauth2, and server names""
  • "guide: pagination""
  • "quick punt at streaming""
  • "fix broken link""
  • "improved json streaming guide""
  • "new and improved json streaming guide""
  • "couple more tweaks""
  • "link to new spec""

WIP: add a version selector to switch between version 3.1 and 3.2.
Currently, only current version is displayed (thanks to #405 )

@netlify
Copy link

netlify bot commented Sep 29, 2025

Deploy Preview for bump-content-hub ready!

Name Link
🔨 Latest commit 2599af6
🔍 Latest deploy log https://app.netlify.com/projects/bump-content-hub/deploys/68df9a62e6d0590008d7feef
😎 Deploy Preview https://deploy-preview-406--bump-content-hub.netlify.app
📱 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.

@Polo2 Polo2 changed the title Revert "Revert "OpenAPI v3.2 Specification"" Reintroduce OpenAPI v3.2 Specification"" Sep 29, 2025
@Polo2 Polo2 force-pushed the revert-403-revert-359-guide/oas-3.2 branch from 1ea89f1 to 02f3635 Compare September 29, 2025 15:16
@philsturgeon
Copy link
Contributor

Sorry for all those commit names, I am used to doing Squash Merges so didn't think I'd be littering your inbox. I'll squash on my end next time.

@Polo2
Copy link
Member Author

Polo2 commented Sep 30, 2025

Sorry for all those commit names, I am used to doing Squash Merges so didn't think I'd be littering your inbox. I'll squash on my end next time.

Don't worry Phil it was easy to handle this big squash, and have a fresh base to handle the version select

@Polo2 Polo2 force-pushed the revert-403-revert-359-guide/oas-3.2 branch from 02f3635 to 8a1573b Compare September 30, 2025 11:27
@Polo2 Polo2 changed the title Reintroduce OpenAPI v3.2 Specification"" Reintroduce OpenAPI v3.2 Specification - with version selector Sep 30, 2025
@Polo2 Polo2 force-pushed the revert-403-revert-359-guide/oas-3.2 branch 3 times, most recently from 06ec6c5 to 8adfe5c Compare September 30, 2025 15:17
@Polo2
Copy link
Member Author

Polo2 commented Sep 30, 2025

Cc @jayk-u , as discussed, I started a basic dropdown behavior, to allow navigation between versions only when pages exists.

for example:

this page exits on v3.2 only, the selector can not redirect to v3.1
https://deploy-preview-406--bump-content-hub.netlify.app/guides/openapi/specification/v3.2/advanced/json-streaming/

this page exits in both v3.1 and v3.2, the selector handles redirection
https://deploy-preview-406--bump-content-hub.netlify.app/guides/openapi/specification/v3.2/understanding-structure/basic-structure/

Can you confirm this is how you wanted it?

@Polo2 Polo2 marked this pull request as ready for review September 30, 2025 15:28
@jayk-u
Copy link
Contributor

jayk-u commented Sep 30, 2025

@Polo2 Absolutely, that’s exactly what I needed, thank you!
Can I start working on this PR to add the canonical link where needed?

@Polo2
Copy link
Member Author

Polo2 commented Sep 30, 2025

Can I start working on this PR to add the canonical link where needed?

I don't see any valuable reason to update this "src/_guides/openapi/specification/v3.1" folder to improve the dropdown component, so yes, you're free to add canonical 🛶 🇳🇮 urls to all these files.

As discussed, please favor a single commit for all these changes, since we still have to improve the code (what is it about my CSS?)

@jayk-u
Copy link
Contributor

jayk-u commented Oct 1, 2025

As requested, I added the canonical_url and updated the dates when necessary in a single commit.
The addition of a canonical_url was decided based on the following criteria:

  • if the content was slightly modified or not modified at all, a canonical_url was added
  • if the content was heavily modified, no canonical_url was added
  • all canonical_url entries point to version 3.2 in order to favor its indexing.

Is this how you needed it @Polo2 ?

@Polo2
Copy link
Member Author

Polo2 commented Oct 2, 2025

As requested, I added the canonical_url and updated the dates when necessary in a single commit. The addition of a canonical_url was decided based on the following criteria:

  • if the content was slightly modified or not modified at all, a canonical_url was added
  • if the content was heavily modified, no canonical_url was added
  • all canonical_url entries point to version 3.2 in order to favor its indexing.

Is this how you needed it @Polo2 ?

Yes, exactly!

I've got two small feedbacks with these canonical_urls:

  • I noticed a small bug, HTML tag is duplicated, fixed in dedicated PR SEO: fix canonical_url duplication #410
  • you have specified raw url, for example https://docs.bump.sh/guides/openapi/specification/v3.2/introduction/what-is-openapi/. Which mean we'll have to update all these data if we decide to change help center url ( move back to https://bump.sh for example). It's better if we are several people to have this in mind, right 😅

Beside that, LGTM.

Revert #403, back to #359 with a single commit

Old commits list:
- "oas: default example was wrong""
- "copy oas 3.1 with oas 3.2 changes""
- "more about tag kind and parent""
- "security scheme deprecation""
- "response description is optional""
- "response no content means no content""
- "security schemes can be references now too""
- "removed trailing slash""
- "use newer rfc relative ref pointer links""
- "more about tags, oauth2, and server names""
- "guide: pagination""
- "quick punt at streaming""
- "fix broken link""
- "improved json streaming guide""
- "new and improved json streaming guide""
- "couple more tweaks""
- "link to new spec""
@Polo2 Polo2 force-pushed the revert-403-revert-359-guide/oas-3.2 branch from db1efc6 to 924512f Compare October 2, 2025 09:31
@Polo2 Polo2 requested a review from paulRbr October 2, 2025 09:33
Copy link
Member

@paulRbr paulRbr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 thanks for this nice improvement

@Polo2 Polo2 force-pushed the revert-403-revert-359-guide/oas-3.2 branch from 924512f to 152d538 Compare October 2, 2025 13:04
@AurelDbs
Copy link
Contributor

AurelDbs commented Oct 3, 2025

I have made changes to Polo's dropdown CSS.
It behaves in the same way as the branch dropdown in the app.
I just reduced the padding a little so that it wouldn't be too big, given how small the text is.

Capture d’écran 2025-10-03 à 10 08 50 Capture d’écran 2025-10-03 à 10 09 12 Capture d’écran 2025-10-03 à 10 09 23

@AurelDbs AurelDbs force-pushed the revert-403-revert-359-guide/oas-3.2 branch from a8d7ee1 to 930c6fc Compare October 3, 2025 08:43
@AurelDbs AurelDbs force-pushed the revert-403-revert-359-guide/oas-3.2 branch 2 times, most recently from 02f7c36 to 8cedac8 Compare October 3, 2025 09:12
- add canonical urls when needed to 3.1 pages
- update dates on 3.2 pages when relevant
@Polo2 Polo2 force-pushed the revert-403-revert-359-guide/oas-3.2 branch from 8cedac8 to c465c65 Compare October 3, 2025 09:39
This is a tricky one, may I ask some support please :)

Behavior of this component:

when current version is v3.1, detect if there is a similar page
(ie wiht similar url) for other version v3.2

if yes, this is a link to this page
if no, no link and strikethrough

for example:

this page exits on v3.2 only, the selector can not redirect to v3.1
guides/openapi/specification/v3.2/advanced/json-streaming/

this page exits in both v3.1 and v3.2, the selector handles redirection
guides/openapi/specification/v3.2/understanding-structure/basic-structure/

Improve version selector dropdown UX

- Add animated caret rotation (points down when closed, up when open)
- Add checkmark icon for currently selected version
- Improve dropdown positioning and styling with design system variables
- Update toggle controller to manage dropdown state on container element
- Refactor dropdown styles to use consistent spacing and design tokens
@Polo2 Polo2 force-pushed the revert-403-revert-359-guide/oas-3.2 branch from c465c65 to 2599af6 Compare October 3, 2025 09:41
@Polo2 Polo2 merged commit 82919d8 into main Oct 3, 2025
5 checks passed
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.

6 participants