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

Docs swagger links path fixes #1633

Merged
merged 2 commits into from
Feb 6, 2025
Merged

Conversation

lanasta
Copy link
Contributor

@lanasta lanasta commented Feb 5, 2025

Proposed changes

The previous fix for #1619 did not work. I updated the Swagger link structure to omit the swagger.html portion and to go up another level in the folder structure.

e.g. From https://hyperledger.github.io/firefly/latest/reference/swagger/swagger.html#/Default%20Namespace/postGenerateContractInterface to https://hyperledger.github.io/firefly/latest/reference/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.

Signed-off-by: Anastasia Lalamentik <[email protected]>
@lanasta lanasta requested a review from a team as a code owner February 5, 2025 19:02
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.

looks good

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.95%. Comparing base (bda6c34) to head (26f1c20).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1633      +/-   ##
==========================================
+ Coverage   99.92%   99.95%   +0.03%     
==========================================
  Files         337      337              
  Lines       29504    29504              
==========================================
+ Hits        29483    29492       +9     
+ Misses         15        8       -7     
+ Partials        6        4       -2     

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

@EnriqueL8 EnriqueL8 merged commit 645ac0a into hyperledger:main Feb 6, 2025
17 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.

bug: Broken Swagger links in documentation
2 participants