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

API Docs deep links not working #382

Open
janpaepke opened this issue Sep 27, 2024 · 1 comment
Open

API Docs deep links not working #382

janpaepke opened this issue Sep 27, 2024 · 1 comment
Assignees
Labels
API docs Issues with the Mollie docs, ouside the scope of this package.

Comments

@janpaepke
Copy link
Collaborator

janpaepke commented Sep 27, 2024

Throughout the code we made an effort to include deep links to most methods, options and parameters.
Unfortunately with the latest update of the API Docs, linking to specific parameters does not work anymore.

I.e. the link for the method parameter for payment.create is this:
https://docs.mollie.com/reference/v2/payments-api/create-payment?path=method#parameters
which forwards to the new url:
https://docs.mollie.com/reference/create-payment?path=method#parameters

This does point to the correct endpoint, but ignores the search string and anchor.
There does not seem to be any obvious way to point to a specific parameter or response property in the new docs.

Ideally the page would be scrolled to the correct position and the corresponding param/prop highlighted.
Are there any plans for the docs to support something like this?

It does not have to follow the same logic as currently - for example we could switch search param and anchor, or make them both search params. Ideally we could simply run a global search and replace if and when deeplinking is implemented into the API docs.

@janpaepke janpaepke added the API docs Issues with the Mollie docs, ouside the scope of this package. label Sep 27, 2024
@fjbender
Copy link
Contributor

This is a limitation of the underlying platform. We are exploring our options.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API docs Issues with the Mollie docs, ouside the scope of this package.
Projects
None yet
Development

No branches or pull requests

2 participants