Bump SDK to 2.1.0-rc.4 #40
Conversation
WalkthroughWalkthroughThis update primarily involves minor version increments and documentation improvements across various API and test files in a Python package generated by Swagger Codegen. Key changes include the deprecation of an endpoint, the addition of punctuation for clarity in documentation, and updating the Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (14)
- README.md (4 hunks)
- docs/AliasApi.md (2 hunks)
- docs/ChecksApi.md (2 hunks)
- docs/TicketsApi.md (3 hunks)
- hoprd_sdk/api/alias_api.py (2 hunks)
- hoprd_sdk/api/checks_api.py (2 hunks)
- hoprd_sdk/api/tickets_api.py (2 hunks)
- hoprd_sdk/api_client.py (1 hunks)
- hoprd_sdk/api_client.py.orig (1 hunks)
- hoprd_sdk/configuration.py (1 hunks)
- setup.py (1 hunks)
- test/test_alias_api.py (1 hunks)
- test/test_checks_api.py (1 hunks)
- test/test_tickets_api.py (1 hunks)
Files skipped from review due to trivial changes (5)
- hoprd_sdk/api/alias_api.py
- hoprd_sdk/api/checks_api.py
- hoprd_sdk/api/tickets_api.py
- hoprd_sdk/api_client.py
- setup.py
Additional Context Used
LanguageTool (31)
README.md (5)
Near line 2: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...created HOPR node and exposing it using a HTTP REST API This Python package is a...
Near line 130: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...oldest message currently present in the nodes message inbox. MessagesApi | [**peek_...
Near line 133: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...st of messages currently present in the nodes message inbox. MessagesApi | [**send_...
Near line 140: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...ers` and `announced peers`. NodeApi | [version](docs/NodeApi....
Near line 190: This phrase is duplicated. You should probably use “API key” only once.
Context: ...thorization ## api_token - Type: API key - API key parameter name: X-Auth-Token - **Loca...docs/AliasApi.md (14)
Near line 9: A punctuation mark might be missing here.
Context: ...s) that have this alias assigned to it. set_alias | **...
Near line 10: You might be missing the article “an” here.
Context: ...alias) | POST /api/v3/aliases | Set alias for a peer with a specific PeerId. # *...
Near line 53: Unpaired symbol: ‘[’ seems to be missing
Context: ...r, str)** ### Authorization api_token, [bearer_token]...
Near line 58: Did you mean “except”?
Context: ... - Content-Type: Not defined - Accept: application/json [Back to top]...
Near line 111: Did you mean “except”?
Context: ... - Content-Type: Not defined - Accept: application/json [Back to top]...
Near line 118: You might be missing the article “an” here.
Context: ... > PeerIdResponse get_alias(alias) Get alias for the PeerId (Hopr address) that have...
Near line 118: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...lias for the PeerId (Hopr address) that have this alias assigned to it. Get alias f...
Near line 120: You might be missing the article “an” here.
Context: ...at have this alias assigned to it. Get alias for the PeerId (Hopr address) that have...
Near line 120: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...lias for the PeerId (Hopr address) that have this alias assigned to it. ### Example...
Near line 165: Did you mean “except”?
Context: ... - Content-Type: Not defined - Accept: application/json [Back to top]...
Near line 172: You might be missing the article “an” here.
Context: ...* > PeerIdResponse set_alias(body) Set alias for a peer with a specific PeerId. Set...
Near line 174: You might be missing the article “an” here.
Context: ...for a peer with a specific PeerId. Set alias for a peer with a specific PeerId. ###...
Near line 206: A punctuation mark might be missing here.
Context: ...----------- | ------------- body | [AliasPeerIdBodyRequest](AliasPeerIdBod...
Near line 206: A punctuation mark might be missing here.
Context: ...yRequest**](AliasPeerIdBodyRequest.md)| Alias name along with the PeerId to be aliase...docs/ChecksApi.md (7)
Near line 11: Possible typo: you repeated a word
Context: ...Check whether the node is started. # healthyz > healthyz() Check whether the node is healthy. ...
Near line 50: Did you mean “except”?
Context: ... - Content-Type: Not defined - Accept: Not defined [Back to top] [[Ba...
Near line 52: Unpaired symbol: ‘[’ seems to be missing
Context: ... Accept: Not defined [Back to top] [[Back to API list]](../README.md#do...
Near line 54: Possible typo: you repeated a word
Context: ...) [Back to README] # readyz > readyz() Check whether the node is ready to a...
Near line 93: Did you mean “except”?
Context: ... - Content-Type: Not defined - Accept: Not defined [Back to top] [[Ba...
Near line 97: Possible typo: you repeated a word
Context: ...) [Back to README] # startedz > startedz() Check whether the node is started. ...
Near line 136: Did you mean “except”?
Context: ... - Content-Type: Not defined - Accept: Not defined [Back to top] [[Ba...docs/TicketsApi.md (5)
Near line 16: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: ...lmost never be used as it can issue a large number of on-chain transactions. The tickets shou...
Near line 51: Unpaired symbol: ‘[’ seems to be missing
Context: ...nse body) ### Authorization api_token, [bearer_token]...
Near line 56: Did you mean “except”?
Context: ... - Content-Type: Not defined - Accept: application/json [Back to top]...
Near line 106: Did you mean “except”?
Context: ... - Content-Type: Not defined - Accept: application/json [Back to top]...
Near line 156: Did you mean “except”?
Context: ... - Content-Type: Not defined - Accept: application/json [Back to top]...
Ruff (6)
test/test_alias_api.py (2)
17-17:
hoprd_sdkimported but unused
19-19:
hoprd_sdk.rest.ApiExceptionimported but unusedtest/test_checks_api.py (2)
17-17:
hoprd_sdkimported but unused
19-19:
hoprd_sdk.rest.ApiExceptionimported but unusedtest/test_tickets_api.py (2)
17-17:
hoprd_sdkimported but unused
19-19:
hoprd_sdk.rest.ApiExceptionimported but unused
GitHub Check Runs (1)
Lint success (9)
test/test_alias_api.py: [failure] 17-17:
[*]hoprd_sdkimported but unused
test/test_alias_api.py: [failure] 19-19:
[*]hoprd_sdk.rest.ApiExceptionimported but unused
test/test_checks_api.py: [failure] 17-17:
[*]hoprd_sdkimported but unused
test/test_checks_api.py: [failure] 19-19:
[*]hoprd_sdk.rest.ApiExceptionimported but unused
test/test_tickets_api.py: [failure] 17-17:
[*]hoprd_sdkimported but unused
test/test_tickets_api.py: [failure] 19-19:
[*]hoprd_sdk.rest.ApiExceptionimported but unused
Additional comments not posted (21)
test/test_checks_api.py (1)
34-34: Update the test case description to match the updated API documentation.Ensure that the test case reflects the new description accurately in the test implementation.
test/test_tickets_api.py (1)
41-41: Update the test case description to reflect the deprecation of the endpoint.Ensure that the test case reflects the new description accurately in the test implementation.
test/test_alias_api.py (1)
34-34: Update the test case description to match the updated API documentation.Ensure that the test case reflects the new description accurately in the test implementation.
docs/ChecksApi.md (4)
7-7: Ensure consistency in API documentation.Verify that the method description aligns with the actual API behavior.
14-14: Ensure consistency in API documentation.Verify that the method description aligns with the actual API behavior.
16-16: Ensure consistency in API documentation.Verify that the method description aligns with the actual API behavior.
30-30: Ensure consistency in API documentation.Verify that the method description aligns with the actual API behavior.
docs/TicketsApi.md (4)
8-8: Update the API documentation to reflect the deprecation of the endpoint.Ensure that the documentation accurately reflects the current API behavior.
63-63: Update the API documentation to reflect the deprecation of the endpoint.Ensure that the documentation accurately reflects the current API behavior.
65-65: Update the API documentation to reflect the deprecation of the endpoint.Ensure that the documentation accurately reflects the current API behavior.
85-85: Update the API documentation to reflect the deprecation of the endpoint.Ensure that the documentation accurately reflects the current API behavior.
docs/AliasApi.md (4)
7-7: Ensure consistency in API documentation.Verify that the method description aligns with the actual API behavior.
15-15: Ensure consistency in API documentation.Verify that the method description aligns with the actual API behavior.
17-17: Ensure consistency in API documentation.Verify that the method description aligns with the actual API behavior.
37-37: Ensure consistency in API documentation.Verify that the method description aligns with the actual API behavior.
hoprd_sdk/configuration.py (1)
253-253: Update the SDK version in the debug report to match the new version.Ensure that the SDK version is correctly updated across all relevant files and documentation.
README.md (4)
7-7: Update the package version to match the new SDK version.
113-113: Ensure the description for thealiasesendpoint ends with a period for consistency.
125-125: Correct the description to end with a period for consistency.
145-145: Update the description to reflect the deprecation of theshow_all_ticketsendpoint.hoprd_sdk/api_client.py.orig (1)
75-75: Update ofuser_agentto 'Swagger-Codegen/2.1.0-rc.4/python' aligns with the PR's objective to reflect the new SDK version.
This Pull request contains the changeset required to be compliant with the Hoprd API version above mentioned
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
show_all_ticketsendpoint.Refactor
2.1.0-rc.3to2.1.0-rc.4.Chores
user_agentand SDK package version in configuration files to the new version.Tests