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

Broken Swagger links in documentation #1620

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

lanasta
Copy link
Contributor

@lanasta lanasta commented Jan 27, 2025

Proposed changes

Updated the Swagger link structure to omit the swagger.html portion and to switch away from using the relative path

e.g. From https://hyperledger.github.io/firefly/latest/reference/swagger/swagger.html#/Default%20Namespace/postGenerateContractInterface to https://hyperledger.github.io/firefly/latest/swagger/#/Default%20Namespace/postGenerateContractInterface

Fixes #1619


Types of changes

  • Bug fix
  • New feature added
  • Documentation Update

Please make sure to follow these points

  • I have read the contributing guidelines.
  • I have performed a self-review of my own code or work.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generates no new warnings.
  • My Pull Request title is in format < issue name > eg Added links in the documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • My changes have sufficient code coverage (unit, integration, e2e tests).

Screenshots (If Applicable)


Other Information

Any message for the reviewer or kick off the discussion by explaining why you considered this particular solution, any alternatives etc.

EnriqueL8 and others added 10 commits December 19, 2024 10:49
Signed-off-by: Enrique Lacal <[email protected]>
Signed-off-by: Enrique Lacal <[email protected]>
actions/upload-artifact and actions/download-artifact have
been deprecated and need updated.

https://github.blog/changelog/2024-04-16-deprecation-notice-v3-of-the-artifact-actions/

Signed-off-by: Ry Jones <[email protected]>
Signed-off-by: Enrique Lacal <[email protected]>
Per the LFDT requirements adding an OpenSSF scorecard workflow

Signed-off-by: Enrique Lacal <[email protected]>
@lanasta lanasta requested a review from a team as a code owner January 27, 2025 16:48
Signed-off-by: Anastasia Lalamentik <[email protected]>
Copy link

codecov bot commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.95%. Comparing base (d1c61be) to head (3d25437).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1620   +/-   ##
=======================================
  Coverage   99.95%   99.95%           
=======================================
  Files         337      337           
  Lines       29504    29504           
=======================================
  Hits        29492    29492           
  Misses          8        8           
  Partials        4        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@EnriqueL8 EnriqueL8 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 spotting this and fixing them!

Have pulled it down and ran the doc-site locally, all looks good

@EnriqueL8
Copy link
Contributor

Needs Dockerfile fix from #1617 before merging

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.

bug: Broken Swagger links in documentation
3 participants