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: project-wide change of OAS vendor extensions cactus -> cacti #2873

Merged
merged 1 commit into from
Nov 15, 2023

Conversation

petermetz
Copy link
Contributor

  1. Did a complete find & replace of the old vendor extensions and the
    new ones. In theory this is a change that the compiler guarantees for us
    to verify completely, but even with that said, I'll leave the CI on so
    that we can double check to be sure.
    This is also a BREAKING CHANGE because if someone had installed the older
    packages and they imported endpoint definitions from the OAS spec based
    on the vendor extensions then their could would stop compiling. Therefore
    this change must be done before we issue the 2.0.0 release.
  2. Also added a bug-fix to tools/custom-checks/check-open-api-json-specs.ts
    because it wasn't just validating HTTP verbs within "paths" but also
    any property that was in there such as "summary" or "description" but
    of course those are string properties so they won't pass the validation
    we impose on HTTP verb definitions for the endpoints.

Fixes #2872

Signed-off-by: Peter Somogyvari peter.somogyvari@accenture.com

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.

Copy link
Contributor

@outSH outSH left a comment

Choose a reason for hiding this comment

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

LGTM

1. Did a complete find & replace of the old vendor extensions and the
new ones. In theory this is a change that the compiler guarantees for us
to verify completely, but even with that said, I'll leave the CI on so
that we can double check to be sure.
This is also a BREAKING CHANGE because if someone had installed the older
packages and they imported endpoint definitions from the OAS spec based
on the vendor extensions then their could would stop compiling. Therefore
this change must be done before we issue the 2.0.0 release.
2. Also added a bug-fix to tools/custom-checks/check-open-api-json-specs.ts
because it wasn't just validating HTTP verbs within "paths" but also
any property that was in there such as "summary" or "description" but
of course those are string properties so they won't pass the validation
we impose on HTTP verb definitions for the endpoints.

Fixes hyperledger-cacti#2872

Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
@petermetz petermetz merged commit 31ac3f1 into hyperledger-cacti:main Nov 15, 2023
@petermetz petermetz deleted the petermetz/issue2872 branch November 15, 2023 22:26
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.

fix(connector-ethereum): add missing openapi.json paths vendor extensions
4 participants