chore(deps):SP-4138 add error_message and error_code fields to Depend…

[agustingroh]

…ency batch response

Summary by CodeRabbit

• New Features

  • Dependency responses now include error codes and messages for granular error reporting when processing fails, covering scenarios such as invalid package URLs, missing components, and version mismatches.

• Documentation

  • Updated API documentation with examples showing error handling in dependency responses.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: eb56442b-120b-4f4b-a504-f7b289eaf042

📥 Commits

Reviewing files that changed from the base of the PR and between fdda934 and d28a8a6.

⛔ Files ignored due to path filters (1)

• api/dependenciesv2/scanoss-dependencies.pb.go is excluded by !**/*.pb.go

📒 Files selected for processing (4)

• CHANGELOG.md
• protobuf/scanoss/api/dependencies/v2/README.md
• protobuf/scanoss/api/dependencies/v2/scanoss-dependencies.proto
• protobuf/scanoss/api/dependencies/v2/scanoss-dependencies.swagger.json

---

📝 Walkthrough

Walkthrough

This pull request adds error handling capabilities to the Dependencies API by introducing two new optional fields (error_message and error_code) to dependency objects. Changes span protobuf schema definitions, Swagger documentation, README updates, and CHANGELOG entries to consistently reflect this enhancement across all specification files.

Changes

Cohort / File(s)	Summary
Version Documentation CHANGELOG.md	Adds release entry [0.32.0] documenting the addition of error_message and error_code fields to Dependencies within DependencyResponse.
API Schema Definition protobuf/scanoss/api/dependencies/v2/scanoss-dependencies.proto	Adds two new optional fields to the Dependencies message: error_message (string) and error_code (common.v2.ErrorCode) for per-dependency error reporting.
OpenAPI Specification protobuf/scanoss/api/dependencies/v2/scanoss-dependencies.swagger.json	Updates DependencyResponseDependencies schema with error_message and error_code properties; introduces new v2ErrorCode enum (INVALID_PURL, COMPONENT_NOT_FOUND, NO_INFO, INVALID_SEMVER, VERSION_NOT_FOUND); adds description field to DependencyResponse.
API Documentation protobuf/scanoss/api/dependencies/v2/README.md	Updates GetDependencies section with new error fields; adds dedicated "Response Examples" section with explicit "Error in dependency" example showing error field usage.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

• eeisegn
• isasmendiagus

Poem

🐰 New error fields hop into the schema,
Dancing through proto, swagger, and more,
Per-dependency messages declare their fate,
No more silent failures at the door! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: adding error_message and error_code fields to the Dependency response, which aligns with all the file modifications in the changeset.
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
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/SP-4138-add-status-in-batch-dependency-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

• X
• Mastodon
• Reddit
• LinkedIn

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