Skip to content

Commit

Permalink
Fix a few typos in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre Cauchois committed Dec 19, 2017
1 parent ca31583 commit f379dce
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion common/core/src/authentication_provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { TransportConfig } from './authorization';
*/
export enum AuthenticationType {
/**
* X509 authentication uses X509 certificate and key pairs.
* X509 Certificate based authentication.
*/
X509,
/**
Expand Down
4 changes: 3 additions & 1 deletion common/core/src/authorization.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,12 @@ export interface X509 {
* Passphrase used to decode the key associated with the X509 certificate.
*/
passphrase?: string;

/**
* @private
*/
certFile?: string;

certFile?: string;
/**
* @private
*/
Expand Down
2 changes: 1 addition & 1 deletion provisioning/device/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This package (**azure-iot-provisioning-device**) provides the device client that
## Install

There are at least 3 different packages involved when writing code to take advantage of the Azure IoT Hub Device Provisioning Service:
- The "client" package that will be used to create a provisioning client. This is this package.
- The "client" package that will be used to create a provisioning client. (This package).
- the "transport" package that will decide which protocol will be used to communicate with the provisioning service. One of **azure-iot-provisioning-device-amqp**, **azure-iot-provisioning-device-mqtt**, or **azure-iot-provisioning-device-http**. Please note that X509 authentication is supported with all protocols but TPM authentication is supported only with AMQP and HTTP.
- The "security client" package that will be used to interface with whatever type of security (x509 or TPM) is used to authenticate the device.

Expand Down
6 changes: 3 additions & 3 deletions provisioning/device/samples/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
"license": "MIT",
"dependencies": {
"azure-iot-provisioning-device": "0.0.1",
"azure-iot-provisioning-device-http": "0.0.1",
"azure-iot-provisioning-device-amqp": "0.0.1",
"azure-iot-provisioning-device-http": "0.0.1",
"azure-iot-provisioning-device-mqtt": "0.0.1",
"azure-iot-security-x509": "0.0.1"
},
"scripts" : {
"scripts": {
"build": "echo nothing to do"
},
"engines": {
Expand All @@ -25,4 +25,4 @@
"url": "https://github.com/Azure/azure-iot-sdk-node/issues"
},
"homepage": "https://github.com/Azure/azure-iot-sdk-node#readme"
}
}
2 changes: 1 addition & 1 deletion provisioning/device/samples/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This file can be found in https://github.com/Azure/azure-iot-sdk-node/tree/master/provisioning/device/samples

This folder contains simple samples showing how to use the various features of the Microsoft Azure IoT Device Provisioning Service from an application running JavaScript or TypeScript code.
This folder contains simple samples showing how to use the various features of the Microsoft Azure IoT Hub Device Provisioning Service from an application running JavaScript or TypeScript code.

## List of samples

Expand Down
2 changes: 0 additions & 2 deletions provisioning/transport/amqp/src/amqp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ export class Amqp extends EventEmitter implements X509ProvisioningTransport {
}
},
registrationRequest: (request, callback) => {
// TODO: this only works for x509
this._amqpStateMachine.transition('connecting', request, (err) => {
if (err) {
callback(err);
Expand All @@ -99,7 +98,6 @@ export class Amqp extends EventEmitter implements X509ProvisioningTransport {
});
},
queryOperationStatus: (request, operationId, callback) => {
// TODO: this only works for x509
this._amqpStateMachine.transition('connecting', request, (err) => {
if (err) {
callback(err);
Expand Down

0 comments on commit f379dce

Please sign in to comment.