Skip to content

Bugfix: AccessControl json id changed to aceid to match resource #517

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

Merged

Conversation

kuby
Copy link
Collaborator

@kuby kuby commented Jul 8, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Updated the JSON key for the access control ID field to ensure correct data serialization.

@kuby kuby requested a review from jkralik July 8, 2025 06:29
Copy link

coderabbitai bot commented Jul 8, 2025

Walkthrough

The change updates the JSON tag for the ID field in the AccessControl struct within the ACL schema, renaming the serialized field from "id" to "aceid" in JSON representations. No other logic or structural modifications are present.

Changes

File(s) Change Summary
schema/acl/acl.go Changed JSON tag of AccessControl.ID from "id" to "aceid"

Poem

A hop and a skip, the field’s name did shift,
From "id" to "aceid", a subtle, swift lift.
JSON now speaks with a slightly new sound,
In the warren of code, such treasures are found.
🥕


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fc6360a and 92bdad3.

📒 Files selected for processing (1)
  • schema/acl/acl.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
  • GitHub Check: build-and-publish-image (bridge-device, cmd/bridge-device/Dockerfile) / build-and-publish-with-cfg
  • GitHub Check: build-and-publish-image (test-cloud-server, test/cloud-server/Dockerfile) / build-and-publish-with-cfg
  • GitHub Check: tests (cloud-server-discovery-resource-observable-debug-384, CERT_TOOL_SIGN_ALG=ECDSA-SHA384 CERT... / test
  • GitHub Check: tests (cloud-server-discovery-resource-observable-debug, true, ghcr.io/iotivity/iotivity-lite/clo... / test
  • GitHub Check: tests (cloud-server-debug, true, true, ghcr.io/iotivity/iotivity-lite/cloud-server-debug:vnext, t... / test
  • GitHub Check: tests (cloud-server-debug-sha384, CERT_TOOL_SIGN_ALG=ECDSA-SHA384 CERT_TOOL_ELLIPTIC_CURVE=P384, ... / test
  • GitHub Check: lint
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (go)
🔇 Additional comments (2)
schema/acl/acl.go (2)

50-50: Confirmed “aceid” is correct per OCF ACL2 spec

  • The OCF oic.r.acl2 resource specification defines the ACE identifier property as "aceid" (not "id").
  • This change aligns the JSON tag in AccessControl with the official OCF Security Specification (v2.0.3, section on ACL2 resource).
  • Note: this is a breaking change for any consumers of the JSON API—please update downstream code to use "aceid" when serializing or parsing ACL entries.

50-50: Confirm downstream compatibility for AccessControl JSON field rename

Location: schema/acl/acl.go:50

No internal references to AccessControl JSON (de)serialization were found in this repo, but renaming the JSON tag from "id" to "aceid" is a breaking change. Please ensure:

  • Downstream services and clients are updated to expect aceid instead of id
  • API documentation and OpenAPI specs are updated accordingly
  • Database schemas or migration scripts referencing this field are adjusted
  • Integration tests cover JSON serialization/deserialization of AccessControl
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

sonarqubecloud bot commented Jul 8, 2025

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.09%. Comparing base (fc6360a) to head (92bdad3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #517   +/-   ##
=======================================
  Coverage   74.09%   74.09%           
=======================================
  Files         124      124           
  Lines        8763     8763           
=======================================
  Hits         6493     6493           
  Misses       1680     1680           
  Partials      590      590           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jkralik jkralik merged commit 209ec3c into main Jul 8, 2025
17 checks passed
@jkralik jkralik deleted the Bugfix-AccessControl-id-does-not-match-with-id-in-acl-resource branch July 8, 2025 06:40
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