hub icon indicating copy to clipboard operation
hub copied to clipboard

http-gateway: add api/v1/things endpoint

Open Danielius1922 opened this issue 10 months ago • 3 comments

Summary by CodeRabbit

  • New Features

    • Introduced functionality to retrieve resource links for devices via the new /things endpoint.
  • Tests

    • Added tests for the new /things endpoint, ensuring proper retrieval and formatting of device resources.
  • Refactor

    • Improved JSON unmarshalling in HTTP gateway tests for enhanced error handling.
  • Documentation

    • Updated usage of constants and parameters in virtual device creation to support conditional resource addition based on the device description availability.

Danielius1922 avatar Apr 25 '24 16:04 Danielius1922

Walkthrough

The recent updates to the http-gateway service encompass improvements in handling requests and responses, introducing new functionalities, and enhancing error management. Notable changes include refining function behaviors, updating signatures, and integrating new features like managing resources with specific content. These modifications aim to enhance the service's capabilities and streamline its operations.

Changes

File(s) Change Summary
http-gateway/service/getResource.go, http-gateway/service/getDevice.go Refactored functions for better error handling and response parsing, updated signatures.
http-gateway/service/getThings.go Introduced new types and functions for managing thing descriptions and security configurations.
http-gateway/service/requestHandler.go Added a new field to RequestHandler, updated NewRequestHandler function, and included a new handler for things.
http-gateway/service/service.go Updated the NewRequestHandler function call with an additional argument.
http-gateway/service/updateResource.go Refactored updateResource function to handle query parameters and errors differently.
http-gateway/service/getDeviceResourceLinks.go, http-gateway/service/deleteDevice.go Added a boolean argument to the toSimpleResponse function calls.
http-gateway/service/getResource_test.go Added a new test function to fetch a resource with only content.
http-gateway/test/http.go Introduced a method to set query parameters in RequestBuilder.
http-gateway/uri/uri.go Added new constants and updated paths for devices and things.
Makefile Updated variables and added new targets for setting up and running a bridge device simulator in Docker containers.

🐇 In code's vast and winding maze, Refactors bring new dawn's rays. Functions tuned with care and might, To make our gateway's future bright. Constants, paths, and things anew, In Docker’s world, simulations grew. Hopping forward, changes blend, In harmony, our code ascends. 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

coderabbitai[bot] avatar Apr 25 '24 16:04 coderabbitai[bot]

@coderabbitai review

Danielius1922 avatar May 03 '24 07:05 Danielius1922