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

bug: Broken Swagger links in documentation #1619

Open
lanasta opened this issue Jan 27, 2025 · 0 comments · May be fixed by #1620
Open

bug: Broken Swagger links in documentation #1619

lanasta opened this issue Jan 27, 2025 · 0 comments · May be fixed by #1620
Labels
bug Something isn't working

Comments

@lanasta
Copy link
Contributor

lanasta commented Jan 27, 2025

What happened?

Referenced on this page: https://hyperledger.github.io/firefly/latest/reference/firefly_interface_format/#automated-generation-of-firefly-interfaces

Clicking on this link leads to a 404
"API documentation for the contract interface generation endpoint"

There may be other broken links. Some versioning needs to be included in the documentation links.

What did you expect to happen?

I expected to be guided to the Swagger page showing the contract interface generation endpoint

How can we reproduce it (as minimally and precisely as possible)?

Go to https://hyperledger.github.io/firefly/latest/reference/firefly_interface_format/#automated-generation-of-firefly-interfaces
and click on "API documentation for the contract interface generation endpoint", you should see a 404 page

Anything else we need to know?

No response

OS version

# On Linux:
$ cat /etc/os-release
# paste output here
$ uname -a
# paste output here

# On Windows:
C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture
# paste output here
@lanasta lanasta added the bug Something isn't working label Jan 27, 2025
@lanasta lanasta changed the title bug: FireFly broken links in documentation -- add versioning bug: FireFly broken Swagger links in documentation Jan 27, 2025
@lanasta lanasta changed the title bug: FireFly broken Swagger links in documentation bug: Broken Swagger links in documentation Jan 27, 2025
@lanasta lanasta linked a pull request Jan 27, 2025 that will close this issue
10 tasks
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 a pull request may close this issue.

1 participant