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

chore(docs): fix packagename ref in openapi doc generation #3624

Conversation

jenniferlianne
Copy link

Primary Change: The openapi doc generation script had a reference to the @hyperledger package prefix hardcoded.

This meant that packages that were updated to @hyperledger-cacti still had an ampersand in their path, resulting in
them not being included in the generated documentation.

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

Primary Change: The openapi doc generation script had a
reference to the @hyperledger package prefix hardcoded.

This meant that packages that were updated to
@hyperledger-cacti still had an ampersand in their path,
resulting in them not being included in the generated
documentation.

Signed-off-by: Jennifer Bell <[email protected]>
Copy link
Contributor

@petermetz petermetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jenniferlianne Thank you very much! LGTM!

@petermetz petermetz merged commit 5e3d9d7 into hyperledger-cacti:main Nov 12, 2024
134 of 137 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.

3 participants