Skip to content

Commit f503333

Browse files
authored
docs: update links in documentation (#238)
1 parent 3f08b8f commit f503333

File tree

10 files changed

+27
-28
lines changed

10 files changed

+27
-28
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ We're always looking for more opinions on discussions in the issue tracker. It's
3434
- This repo is [commitizen friendly](https://github.com/commitizen/cz-cli), so you can use the `cz` cli to help create your commits.
3535
- Lint and test before submitting the pull request by running `$ npm test`
3636
- 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 main)
37+
- Make the pull request from a [topic branch](https://alvinalexander.com/git/git-topic-branch-workflow-pattern-pro-git/) (not main)
3838
- 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)
3939

4040
## [Finding contributions to work on](labels/help%20wanted)
@@ -46,12 +46,12 @@ Look at the existing issues for areas of contribution. Searching for issues labe
4646
## More about SmartThings
4747

4848
If you are not familiar with SmartThings, we have
49-
[extensive on-line documentation](https://smartthings.developer.samsung.com/develop/index.html).
49+
[extensive on-line documentation](https://developer.smartthings.com/docs/getting-started/welcome/).
5050

5151
To create and manage your services and devices on SmartThings, create an account in the
52-
[developer workspace](https://devworkspace.developer.samsung.com/).
52+
[developer workspace](https://smartthings.developer.samsung.com/workspace/).
5353

54-
The [SmartThings Community](https://community.smartthings.com/c/developers/) is a good place share and
54+
The [SmartThings Community](https://community.smartthings.com/) is a good place share and
5555
ask questions.
5656

5757
There is also a [SmartThings reddit community](https://www.reddit.com/r/SmartThings/) where you
@@ -61,4 +61,4 @@ can read and share information.
6161

6262
Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
6363

64-
Copyright 2019 SmartThings, Inc.
64+
Copyright 2023 SmartThings, Inc.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ SmartApps are custom applications that execute outside of the SmartThings Platfo
4747

4848
There are two distinct options for hosting your SmartApp: AWS Lambda and Webhook.
4949

50-
- **Webhook** SmartApps are any publicly-accessible web server that will receive a POST request payload.
51-
5250
- **AWS Lambda** SmartApps are hosted in the Amazon Web Services cloud and are invoked by ARN instead of a public-DNS address.
5351

54-
To learn more about SmartApps, including choosing the best hosting solution for your SmartApp, visit the [SmartApp developer documentation](https://developer-preview.smartthings.com/docs/connected-services/smartapp-basics).
52+
- **Webhook** SmartApps are any publicly-accessible web server that will receive a POST request payload.
53+
54+
To learn more about SmartApps, including choosing the best hosting solution for your SmartApp, visit the [SmartApp developer documentation](https://developer.smartthings.com/docs/connected-services/smartapp-basics).
5555

5656
## Installation
5757

@@ -77,7 +77,7 @@ import SmartApp from '@smartthings/smartapp'
7777

7878
The example SmartApp below is the equivalent of a simple Rule (if contact sensor opens/closes, turn lights on/off) which is easily achieved via our Rules API. It is given here as a brief showcase of the SDK, and is not meant to be a good candidate for a SmartApp.
7979

80-
>Before hosting your own Automation, be sure to check out [Rules](https://developer-preview.smartthings.com/docs/automations/rules). When all services and Device features involved in a Rule are local, Rules execute locally on a Hub, allowing you to benefit from greater speed, stability, and security than cloud-reliant solutions.
80+
>Before hosting your own Automation, be sure to check out [Rules](https://developer.smartthings.com/docs/automations/rules). When all services and Device features involved in a Rule are local, Rules execute locally on a Hub, allowing you to benefit from greater speed, stability, and security than cloud-reliant solutions.
8181
8282
### Running as a Web Service
8383

@@ -220,12 +220,12 @@ See the full usage guide on the [project's GitHub repository](https://github.com
220220
---
221221
## More about SmartThings
222222

223-
Check out our complete developer documentation [here](https://developer-preview.smartthings.com/docs/getting-started/welcome/).
223+
Check out our complete developer documentation [here](https://developer.smartthings.com/docs/getting-started/welcome).
224224

225225
To create and manage your services and devices on SmartThings, create an account in the
226-
[developer workspace](https://devworkspace.developer.samsung.com/).
226+
[developer workspace](https://smartthings.developer.samsung.com/workspace/).
227227

228-
The [SmartThings Community](https://community.smartthings.com/c/developers/) is a good place share and
228+
The [SmartThings Community](https://community.smartthings.com/) is a good place share and
229229
ask questions.
230230

231231
There is also a [SmartThings reddit community](https://www.reddit.com/r/SmartThings/) where you
@@ -235,4 +235,4 @@ can read and share information.
235235

236236
Licensed under the [Apache License, Version 2.0](LICENSE)
237237

238-
Copyright 2019 SmartThings, Inc.
238+
Copyright 2023 SmartThings, Inc.

docs/V2_RELEASE_NOTES.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Methods that return lists now return arrays rather that an object with the prope
1111
is done automatically by the API. The 1.X version of the SDK does not support paging at all in these methods, which
1212
can result in missed items, such as when a location has more than 200 devices.
1313

14-
This change was also made for consitency, since not all endpoints used the `items`
14+
This change was also made for consistency, since not all endpoints used the `items`
1515
object, and for convenience. Since the lists are of limited length and unordered,
1616
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
17+
to be retrieved. In the future methods with potentially unbounded numbers of items with inherent order, such as event
1818
history, will include a paging mechanism.
1919

2020
### REST API calls are now handled by a separate package
@@ -26,13 +26,13 @@ therefore don't need to use this SDK.
2626
As a result of the switch to use the [@smartthings/core-sdk](https://www.npmjs.com/package/@smartthings/core-sdk)
2727
for REST API calls, [Axios](https://www.npmjs.com/package/axios) is now used as the HTTP client rather than
2828
[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
29+
[AxiosError](https://github.com/axios/axios/blob/main/index.d.ts#L12-L41) class, so instead of accessing the
3030
status of an error response with `.catch(error => {error.statusCode})` you'd do so with
3131
`.catch(error => {error.response.status})`.
3232

3333
### All methods return a Promise
3434
All methods now return a Promise. Before there were some methods that returned void. There was also inconsistency
35-
in the response of methods that returned no data, with some returning an empty obhect `{}`, others returning an
35+
in the response of methods that returned no data, with some returning an empty object `{}`, others returning an
3636
empty string `"`, and still others returning a status value `{"status": "success"}`. Now all such methods return
3737
a status value.
3838

docs/classes/_smart_app_d_.smartapp.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
# SmartApp
44

55
An instance of the SmartApp class is created to handle lifecycle events for WEBHOOK_SMART_APP, LAMBDA_SMART_APP,
6-
and API_ONLY apps. Options can either be passed in as parameters to the
7-
to the constructor, for example:
6+
and API_ONLY apps. Options can either be passed in as parameters to the constructor, for example:
87
```
98
import {SmartApp} from '@smartthings/smartapp'
109
...
@@ -594,7 +593,7 @@ ___
594593

595594
Defines a configuration page that is displayed during app installation and update.
596595
You can create as many pages as needed to satisfy your configuration needs. See the documentation on
597-
[how to design pages](https://smartthings.developer.samsung.com/docs/how-to/design-pages-smartapp.html)
596+
[how to design pages](https://developer.smartthings.com/docs/connected-services/configuration#page-phase)
598597
for your automation.
599598

600599
**Parameters:**
@@ -621,7 +620,7 @@ ___
621620

622621
**permissions**(`value`: string | string[]): *[SmartApp](_smart_app_d_.smartapp.md)*
623622

624-
Specify the [OAuth2 scopes](https://smartthings.developer.samsung.com/docs/auth-and-permissions.html#OAuth2-scopes)
623+
Specify the [OAuth2 scopes](https://developer.smartthings.com/docs/connected-services/oauth-integrations)
625624
explicitly required by this app. For example `['r:devices:*', and 'x:devices:*']
626625
to be able to read and control all devices in the location. You do not have to
627626
provide this list for devices selected by the user in configuration settings.

docs/classes/smartapp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -571,7 +571,7 @@ Defines a configuration page that is displayed during app installation and updat
571571
You can create as many pages as needed to satisfy your configuration needs. See the
572572
the documentation on how to design pages for your automation.
573573

574-
https://smartthings.developer.samsung.com/docs/how-to/design-pages-smartapp.html
574+
https://developer.smartthings.com/docs/connected-services/configuration#page-phase
575575

576576
**Parameters:**
577577

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SmartApp SDK Reference
22

3-
The [SmartApp](classes/_smart_app_d_.smartapp.md) class handles all SmartApp [lifecycle events](https://developer-preview.smartthings.com/docs/connected-services/lifecycles) and callbacks. It is instantiated and configured with handlers where appropriate and is invoked in response to either web server HTTP requests, or in response to AWS Lambda function calls.
3+
The [SmartApp](classes/_smart_app_d_.smartapp.md) class handles all SmartApp [lifecycle events](https://developer.smartthings.com/docs/connected-services/lifecycles) and callbacks. It is instantiated and configured with handlers where appropriate and is invoked in response to either web server HTTP requests, or in response to AWS Lambda function calls.
44

55
## Instantiation and Initialization
66

docs/modules/_lifecycle_events_d_.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The display mode of the operating system of the client.
5151

5252
**language**: *string*
5353

54-
Language header representing the client's preferred language. The format of the `Accept-Language` header follows what is defined in [RFC 7231, section 5.3.5](https://tools.ietf.org/html/rfc7231#section-5.3.5)
54+
Language header representing the client's preferred language. The format of the `Accept-Language` header follows what is defined in [RFC 7231, section 5.3.5](https://www.rfc-editor.org/rfc/rfc7231#section-5.3.5)
5555

5656
### os
5757

lib/lifecycle-events.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ export namespace AppEvent {
400400
*/
401401
version: string
402402
/**
403-
* Language header representing the clients preferred language. The format of the `Accept-Language` header follows what is defined in [RFC 7231, section 5.3.5](https://tools.ietf.org/html/rfc7231#section-5.3.5)
403+
* Language header representing the client's preferred language. The format of the `Accept-Language` header follows what is defined in [RFC 7231, section 5.3.5](https://www.rfc-editor.org/rfc/rfc7231#section-5.3.5)
404404
*/
405405
language: string
406406
/**

lib/pages/page.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ module.exports = class Page {
2727
/**
2828
* Define sections for user defined settings. Chain as many as needed.
2929
*
30-
* https://smartthings.developer.samsung.com/docs/how-to/design-pages-smartapp.html#Page-Components
30+
* https://developer.smartthings.com/docs/connected-services/configuration/#sections-and-settings
3131
* @param {String} name Name your section for use in i18n localization keys
3232
* @param {SectionCallback} closure { import("./section") } Chainable section instance
3333
* @returns {Page} Page instance

lib/smart-app.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ export class SmartApp {
417417
/**
418418
* Defines a configuration page that is displayed during app installation and update.
419419
* You can create as many pages as needed to satisfy your configuration needs. See the documentation on
420-
* [how to design pages](https://smartthings.developer.samsung.com/docs/how-to/design-pages-smartapp.html)
420+
* [how to design pages](https://developer.smartthings.com/docs/connected-services/configuration#page-phase)
421421
* for your automation.
422422
*/
423423
page(id: string,
@@ -427,7 +427,7 @@ export class SmartApp {
427427
configData?: InstalledAppConfiguration) => HandlerResponse): SmartApp
428428

429429
/**
430-
* Specify the [OAuth2 scopes](https://smartthings.developer.samsung.com/docs/auth-and-permissions.html#OAuth2-scopes)
430+
* Specify the [OAuth2 scopes](https://developer.smartthings.com/docs/connected-services/oauth-integrations)
431431
* explicitly required by this app. For example `['r:devices:*', and 'x:devices:*']
432432
* to be able to read and control all devices in the location. You do not have to
433433
* provide this list for devices selected by the user in configuration settings.

0 commit comments

Comments
 (0)