Repository navigation
deleteStorageFile: accept tb:// URL; fix README snippets that don't compile #26
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ | |
| [](https://github.com/testingbot/testingbot-java/actions/workflows/test.yml) | ||
| [](https://github.com/testingbot/testingbot-java/actions/workflows/codeql-analysis.yml) | ||
| [](https://www.apache.org/licenses/LICENSE-2.0) | ||
| [](https://www.oracle.com/java/) | ||
| [](https://www.oracle.com/java/) | ||
|
|
||
| TestingBotREST Java | ||
| ==================== | ||
|
|
@@ -36,7 +36,7 @@ Retrieves collection of available browsers | |
|
|
||
|
|
||
| ```java | ||
| ArrayList<TestingbotBrowser> devices = restApi.getBrowsers(); | ||
| ArrayList<TestingbotBrowser> browsers = restApi.getBrowsers(); | ||
| ``` | ||
|
|
||
| ### getDevices | ||
|
|
@@ -45,7 +45,7 @@ Retrieves collection of available devices | |
|
|
||
|
|
||
| ```java | ||
| ArrayList<TestingbotDevice> devices = restApi.getDevices(); | ||
| List<TestingbotDevice> devices = restApi.getDevices(int offset, int count); | ||
| ``` | ||
|
|
||
| ### getAvailableDevices | ||
|
|
@@ -54,7 +54,7 @@ Retrieves collection of available devices | |
|
|
||
|
|
||
| ```java | ||
| ArrayList<TestingbotDevice> devices = restApi.getAvailableDevices(); | ||
| List<TestingbotDevice> devices = restApi.getAvailableDevices(); | ||
| ``` | ||
|
|
||
| ### getDevice | ||
|
|
@@ -150,7 +150,7 @@ Updates information about the current user | |
|
|
||
|
|
||
| ```java | ||
| TestingbotUser user = restApi.updateUserInfo(TestingBotUser); | ||
| boolean success = restApi.updateUserInfo(TestingbotUser user); | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as above: signature-style documentation, consistent with the rest of the README (e.g. updateTest(TestingbotTest test)). The fix is the return type (boolean, not TestingbotUser) and the class-name casing (TestingbotUser). |
||
| ``` | ||
|
|
||
| ### getTunnels | ||
|
|
@@ -406,8 +406,8 @@ Maven | |
| <dependency> | ||
| <groupId>com.testingbot</groupId> | ||
| <artifactId>testingbotrest</artifactId> | ||
| <version>1.0.8</version> | ||
| <version>1.1.0</version> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| </dependencies | ||
| </dependencies> | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Intentional. This README documents each method in signature style, e.g. getDevice(int deviceId), stopTest(String sessionId), getTests(int offset, int count) and getStorageFiles(int offset, int count), and this line now follows that convention. The bug fixed here is that the zero-arg getDevices() it showed does not exist at all. Converting the whole README to runnable snippets is out of scope for this PR.