You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ We're always looking for more opinions on discussions in the issue tracker. It's
34
34
- This repo is [commitizen friendly](https://github.com/commitizen/cz-cli), so you can use the `cz` cli to help create your commits.
35
35
- Lint and test before submitting the pull request by running `$ npm test`
36
36
- Write a convincing description of why we should land your pull request. Answer _why_ it's needed and provide use-cases.
37
-
- Make the pull request from a [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) (not master)
37
+
- Make the pull request from a [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) (not main)
38
38
- You might be asked to do changes to your pull request. There's never a need to open another pull request – [just update the existing one.](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md)
39
39
40
40
## [Finding contributions to work on](labels/help%20wanted)
Copy file name to clipboardExpand all lines: docs/V2_RELEASE_NOTES.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,37 +3,37 @@
3
3
## Summary of major changes
4
4
5
5
Version 2.0.0 is a major new release that is not 100% backwardly compatible with the 1.X version, though for most
6
-
SmartApps the changes required should be minor. Here are the areas where your app may need to be changed
6
+
SmartApps the changes required should be minor. Here are the areas where your app may need to be changed
7
7
to use the V2 SDK:
8
8
9
9
### List methods now return arrays rather than objects with an items property
10
-
Methods that return lists now return arrays rather that an object with the properties `items` and `_links`. Paging
11
-
is done automatically by the API. The 1.X version of the SDK does not support paging at all in these methods, which
10
+
Methods that return lists now return arrays rather that an object with the properties `items` and `_links`. Paging
11
+
is done automatically by the API. The 1.X version of the SDK does not support paging at all in these methods, which
12
12
can result in missed items, such as when a location has more than 200 devices.
13
13
14
14
This change was also made for consitency, since not all endpoints used the `items`
15
15
object, and for convenience. Since the lists are of limited length and unordered,
16
-
paging is of limited practical use. Most applications, such as displaying a sorted display of items require all pages
17
-
to be retrieved. In the future methods with potentially unbounded numbers of items with inherient order, such as event
16
+
paging is of limited practical use. Most applications, such as displaying a sorted display of items require all pages
17
+
to be retrieved. In the future methods with potentially unbounded numbers of items with inherient order, such as event
18
18
history, will include a paging mechanism.
19
19
20
20
### REST API calls are now handled by a separate package
21
-
The [@smartthings/core-sdk](https://www.npmjs.com/package/@smartthings/core-sdk) package is now used
21
+
The [@smartthings/core-sdk](https://www.npmjs.com/package/@smartthings/core-sdk) package is now used
22
22
for all API calls. It can also be used in applications that are not SmartApps or API Access apps and
23
23
therefore don't need to use this SDK.
24
24
25
25
### There's a new HTTP client
26
26
As a result of the switch to use the [@smartthings/core-sdk](https://www.npmjs.com/package/@smartthings/core-sdk)
27
-
for REST API calls, [Axios](https://www.npmjs.com/package/axios) is now used as the HTTP client rather than
28
-
[request-promise-native](https://www.npmjs.com/package/request-promise-native) (which has been deprecated). As a result, the error object has changed. It's now an instance of the
29
-
[AxiosError](https://github.com/axios/axios/blob/master/index.d.ts#L76-L92) class, so instead of accessing the
27
+
for REST API calls, [Axios](https://www.npmjs.com/package/axios) is now used as the HTTP client rather than
28
+
[request-promise-native](https://www.npmjs.com/package/request-promise-native) (which has been deprecated). As a result, the error object has changed. It's now an instance of the
29
+
[AxiosError](https://github.com/axios/axios/blob/main/index.d.ts#L76-L92) class, so instead of accessing the
30
30
status of an error response with `.catch(error => {error.statusCode})` you'd do so with
31
31
`.catch(error => {error.response.status})`.
32
32
33
33
### All methods return a Promise
34
-
All methods now return a Promise. Before there were some methods that returned void. There was also inconsistency
34
+
All methods now return a Promise. Before there were some methods that returned void. There was also inconsistency
35
35
in the response of methods that returned no data, with some returning an empty obhect `{}`, others returning an
36
-
empty string `"`, and still others returning a status value `{"status": "success"}`. Now all such methods return
36
+
empty string `"`, and still others returning a status value `{"status": "success"}`. Now all such methods return
0 commit comments