fix: correct docs path for references #601
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
augustoccesar
force-pushed
the
fix/generated-docs-with-openapi-install
branch
2 times, most recently
from
4b8c467
to
11aaa64
Compare
|
Thanks! Rerunning CI |
arlyon
approved these changes
Sep 3, 2024
The Stripe documentation now is hosted on https://docs.stripe.com/api. The old https://stripe.com/docs/api still works but gets redirected to the new one. The issue is with how we use to generate documentation link on url_finder.rs. On that file, we look for the load the docs and find the window.__INITIAL_STATE__, which contains relative links to the resources. We are using those relative links as if they were relative from https://stripe.com, but now they are relative from https://docs.stripe.com which causes the links to not be correctly built. This is the issue that is causing the verify-codegen CI job to fail. By updating it to the right path, it should stop generating incorrect path to the docs.
augustoccesar
force-pushed
the
fix/generated-docs-with-openapi-install
branch
from
11aaa64
to
539836d
Compare
|
I think failing ci is a memory issue. Hopefully will be a thing of the past with the next branch. Since all others pass I will merge. |
|
🎉 This PR is included in version 0.39.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The Stripe documentation now is hosted on
https://docs.stripe.com/api. The oldhttps://stripe.com/docs/apistill works but gets redirected to the new one.The issue is with how we use to generate documentation link on
url_finder.rs. On that file, we look for the load the docs and find thewindow.__INITIAL_STATE__, which contains relative links to the resources.We are using those relative links as if they were relative from
https://stripe.com, but now they are relative fromhttps://docs.stripe.comwhich causes the links to not be correctly built.This is the issue that is causing the
verify-codegenCI job to fail.By updating it to the right path, it should stop generating incorrect path to the docs.
Checklist
cargo make fmt