Skip to content

chore(hfh):SP-4186 inclde licenses in hfh response#67

Merged
agustingroh merged 1 commit intomainfrom
chore/SP-4186-include-licenses-in-hfh-response
Mar 26, 2026
Merged

chore(hfh):SP-4186 inclde licenses in hfh response#67
agustingroh merged 1 commit intomainfrom
chore/SP-4186-include-licenses-in-hfh-response

Conversation

@agustingroh
Copy link
Copy Markdown
Contributor

@agustingroh agustingroh commented Mar 26, 2026

Summary by CodeRabbit

  • New Features

    • Component scan responses now include comprehensive license information for each detected version, providing license name, SPDX identifier, approval status, and documentation URL to support improved license compliance tracking.
  • Documentation

    • Updated API documentation and release notes with new license metadata structure in response examples.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 26, 2026

📝 Walkthrough

Walkthrough

This change extends the API schema across multiple files to introduce license metadata support. A new License nested message type is added to the protobuf definitions with fields for name, SPDX identifier, approval status, and URL. A licenses field is then added to the HFHResponse.Version message to carry license data in API responses. Documentation and schema definitions are updated accordingly for a version 0.33.0 release.

Changes

Cohort / File(s) Summary
License Schema Definitions
protobuf/scanoss/api/scanning/v2/scanoss-scanning.proto, protobuf/scanoss/api/scanning/v2/scanoss-scanning.swagger.json
Introduces HFHResponse.Version.License nested message with name, spdx_id, is_spdx_approved, and url fields; adds repeated licenses field to HFHResponse.Version; updates Swagger definitions with corresponding HFHResponseVersionLicense schema.
Documentation Updates
CHANGELOG.md, protobuf/scanoss/api/scanning/v2/README.md
Adds 0.33.0 release entry documenting new license structures; updates example API response in README to include licenses arrays for version entries.
Formatting
protobuf/scanoss/api/common/v2/scanoss-common.proto
Adds blank line after VERSION_NOT_FOUND = 4; enum value.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 License fields now take their place,
In schemas neat with structured grace,
SPDX IDs in arrays gleam,
A metadata dream, pristine and clean,
Version 0.33 hops this way!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title contains a typo ('inclde' instead of 'include') and is partially related to the main change but lacks clarity about adding license data structures to HFH responses. Fix the typo 'inclde' to 'include' to improve clarity and correctness of the pull request title.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/SP-4186-include-licenses-in-hfh-response

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@agustingroh agustingroh force-pushed the chore/SP-4186-include-licenses-in-hfh-response branch from 0dfc0c7 to b422c33 Compare March 26, 2026 11:38
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CHANGELOG.md`:
- Line 13: Update the changelog line to hyphenate the compound adjective by
replacing "High precision Folder Hashing" with "High-precision Folder Hashing"
in the entry describing the added `licenses` repeated field on
`HFHResponse.Version`, so the text reads "...include license information in
High-precision Folder Hashing scan responses".
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 65a0f576-ab79-4a5a-bbe1-44ee69dd3160

📥 Commits

Reviewing files that changed from the base of the PR and between 009b215 and b422c33.

⛔ Files ignored due to path filters (1)
  • api/scanningv2/scanoss-scanning.pb.go is excluded by !**/*.pb.go
📒 Files selected for processing (5)
  • CHANGELOG.md
  • protobuf/scanoss/api/common/v2/scanoss-common.proto
  • protobuf/scanoss/api/scanning/v2/README.md
  • protobuf/scanoss/api/scanning/v2/scanoss-scanning.proto
  • protobuf/scanoss/api/scanning/v2/scanoss-scanning.swagger.json

@agustingroh agustingroh merged commit 18879cc into main Mar 26, 2026
4 checks passed
@agustingroh agustingroh deleted the chore/SP-4186-include-licenses-in-hfh-response branch March 26, 2026 11:51
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.

2 participants