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

refactor: rename OpenAPI extension x-hyperledger-cactus #3010

Conversation

aldousalvarez
Copy link
Contributor

@aldousalvarez aldousalvarez commented Feb 1, 2024

Commit to be reviewed


refactor: rename OpenAPI extension x-hyperledger-cactus

Primary Changes
----------------
1. Updated openapi.yaml in connector-corda to match
   the project rename x-hyperledger-cacti

Fixes #2689

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.

@jagpreetsinghsasan
Copy link
Contributor

@aldousalvarez please fix the PR and the commit message to the standard one I have mentioned several times.

@aldousalvarez aldousalvarez force-pushed the aldousalvarez/issue2689 branch 3 times, most recently from d555936 to b63c154 Compare February 2, 2024 08:56
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.

@aldousalvarez #2689 is about renaming them in the .json files. This PR is renaming it in the .yaml one which is generated from the .json one.

Once you rename it in the .json files the .yaml file should update automatically.

Primary Changes
----------------
1. Updated openapi.yaml in connector-corda to match
   the project rename x-hyperledger-cacti

Fixes hyperledger-cacti#2689

Signed-off-by: aldousalvarez <[email protected]>
@aldousalvarez aldousalvarez force-pushed the aldousalvarez/issue2689 branch from b63c154 to f14a056 Compare March 19, 2024 08:02
@aldousalvarez
Copy link
Contributor Author

@petermetz the .json file is already updated with the correct one which is x-hyperledger-cacti, when I tried to clean and configure it does not update automatically so I just updated the .yaml manually

@aldousalvarez aldousalvarez requested a review from petermetz March 19, 2024 08:05
@petermetz
Copy link
Contributor

@aldousalvarez

the .json file is already updated with the correct one

In that case #2689 was already completed, no need for this PR.

when I tried to clean and configure it does not update automatically so I just updated the .yaml manually

Let's uncover the reason why it's not getting updated. Could you please investigate why is that?
Once the code generation bug is fixed the yaml in this PR will automatically get updated and we don't need to worry about the diff in here (changing the yaml file manually)

@petermetz petermetz closed this Mar 28, 2024
@aldousalvarez
Copy link
Contributor Author

@petermetz okay will dol investigate on this one and will let you know as soon as possible if I have found what is causing this issue and how to fix this as well

@aldousalvarez
Copy link
Contributor Author

Hello @petermetz should I create a new PR or will you reopen this PR and its Issue because I have changes in cactus-plugin-ledger-connector-polkadot that needs to rename the openapi extension to x-hyperledger-cacti

And also regarding the removal of the openapi.yaml in cactus-plugin-ledger-connector-corda should I create also a separate PR and issue or should I just include it here and just explain why we are removing it

@petermetz
Copy link
Contributor

petermetz commented Apr 5, 2024

Hello @petermetz should I create a new PR or will you reopen this PR and its Issue because I have changes in cactus-plugin-ledger-connector-polkadot that needs to rename the openapi extension to x-hyperledger-cacti

@aldousalvarez You could re-open this one just please make sure to explain the context to it, e.g. the details of the conversation you and I had on Wednesday.

And also regarding the removal of the openapi.yaml in cactus-plugin-ledger-connector-corda should I create also a separate PR and issue or should I just include it here and just explain why we are removing it

Separate issue + separate PR please. Detailed explanation of all the conversations we had and what was uncovered in your investigation, etc.

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.

refactor: rename OpenAPI extension x-hyperledger-cactus
4 participants