Skip to content
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

[IoT - Device Provisioning] DataPlane API Review #15621

Merged
merged 21 commits into from
Oct 5, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add readme files
  • Loading branch information
leigharubin authored Sep 16, 2021
commit 516ea304a7564d8f53a5c6f57d85af892fb3f0b7
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## C#

These settings apply only when `--csharp` is specified on the command line.
Please also specify `--csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>`.

``` yaml $(csharp)
csharp:
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
namespace: Microsoft.Devices
output-folder: $(csharp-sdks-folder)/deviceprovisioningservices/management/Microsoft.Devices/Generated
clear-output-folder: true
```
19 changes: 19 additions & 0 deletions specification/deviceprovisioningservices/data-plane/readme.go.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Go

These settings apply only when `--go` is specified on the command line.

``` yaml $(go)
go:
license-header: MICROSOFT_MIT_NO_VERSION
clear-output-folder: true
```

### Tag: package-2021-10-01 and go

These settings apply only when `--tag=package-2019-12-01 --go` is specified on the command line.
Please also specify `--go-sdks-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag) == 'package-2021-10-01' && $(go)
namespace: Microsoft.Devices
output-folder: $(go-sdks-folder)/deviceprovisioningservices/Generated
```
13 changes: 13 additions & 0 deletions specification/deviceprovisioningservices/data-plane/readme.java.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Java

These settings apply only when `--java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.

``` yaml $(java)
azure-arm: true
fluent: true
namespace: Microsoft.Devices
license-header: MICROSOFT_MIT_NO_CODEGEN
payload-flattening-threshold: 1
output-folder: $(azure-libraries-for-java-folder)/deviceprovisioningservices
```
80 changes: 80 additions & 0 deletions specification/deviceprovisioningservices/data-plane/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Device Provisioning Service

> see https://aka.ms/autorest

This is the AutoRest configuration file for Device Provisioning Service.

---

## Getting Started

To build the SDK for Device Provisioning Service, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:

> `autorest`

To see additional help and options, run:

> `autorest --help`

---

## Configuration

### Basic Information

These are the global settings for the IotHub API.

``` yaml
openapi-type: arm
tag: package-2021-10-01
```


### Tag: package-2021-10-01

These settings apply only when `--tag=package-2021-10-01` is specified on the command line.

```yaml $(tag) == 'package-2021-10-01'
input-file:
- Microsoft.Devices/stable/2021-10-01/service.json
```
---

# Code Generation

## Swagger to SDK

This section describes what SDK should be generated by the automatic system.
This is not used by Autorest itself.

``` yaml $(swagger-to-sdk)
swagger-to-sdk:
- repo: azure-sdk-for-net
- repo: azure-sdk-for-java
- repo: azure-sdk-for-go
- repo: azure-sdk-for-js
- repo: azure-sdk-for-node
after_scripts:
- bundle install && rake arm:regen_all_profiles['azure_mgmt_iot_hub']
- repo: azure-resource-manager-schemas
```

## C#

See configuration in [readme.csharp.md](./readme.csharp.md)

## Python

See configuration in [readme.python.md](./readme.python.md)

## Go

See configuration in [readme.go.md](./readme.go.md)

## Java

See configuration in [readme.java.md](./readme.go.md)

## Node.js

See configuration in [readme.nodejs.md](./readme.nodejs.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Node.js

These settings apply only when `--nodejs` is specified on the command line.
Please also specify `--node-sdks-folder=<path to root folder of your azure-sdk-for-node clone>`.

``` yaml $(nodejs)
nodejs:
azure-arm: true
package-name: deviceprovisioningservices
output-folder: $(node-sdks-folder)/lib/services/deviceprovisioningservies
payload-flattening-threshold: 1
generate-license-txt: true
generate-package-json: true
generate-readme-md: false
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Python

These settings apply only when `--python` is specified on the command line.
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.

``` yaml $(python)
python:
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
payload-flattening-threshold: 2
namespace: Microsoft.Devices
package-name: deviceprovisioningservices
package-version: 2021-10-01
clear-output-folder: true
```

``` yaml $(python)
python:
no-namespace-folders: true
output-folder: $(python-sdks-folder)/azure-mgmt/deviceprovisioningservices
```