Skip to content

Latest commit

 

History

History
110 lines (72 loc) · 2.52 KB

readme.md

File metadata and controls

110 lines (72 loc) · 2.52 KB
Raw

quantum

see https://aka.ms/autorest

This is the AutoRest configuration file for quantum.

Getting Started

To build the SDKs for My API, simply install AutoRest via npm (npm install -g autorest) and then run:

autorest readme.md

To see additional help and options, run:

autorest --help

For other options on installation see Installing AutoRest on the AutoRest github page.

Configuration

Basic Information

These are the global settings for the quantum.

openapi-type: arm
openapi-subtype: rpaas
tag: package-2023-11-13-preview
modelerfour:
  flatten-models: false

Tag: package-2019-11-04-preview

These settings apply only when --tag=package-2019-11-04-preview is specified on the command line.

input-file:
  - Microsoft.Quantum/preview/2019-11-04-preview/quantum.json

Tag: package-2022-01-10-preview

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

input-file:
  - Microsoft.Quantum/preview/2022-01-10-preview/quantum.json

Tag: package-2023-11-13-preview

These settings apply only when --tag=package-2023-11-13-preview is specified on the command line.

input-file:
  - Microsoft.Quantum/preview/2023-11-13-preview/quantum.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.

swagger-to-sdk:
  - repo: azure-sdk-for-python
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-js
  - repo: azure-powershell

Go

See configuration in readme.go.md

Python

See configuration in readme.python.md

TypeScript

See configuration in readme.typescript.md

CSharp

See configuration in readme.csharp.md

Suppression

directive:
  - suppress: EnumInsteadOfBoolean
    where: $.definitions.operation.properties.isDataAction
    from: quantum.json
    reason: 'This property is really a boolean, there are no plans to have more than two values in the future.'
  - suppress: AvoidNestedProperties
    where: $.definitions.ProviderDescription.properties.properties
    from: quantum.json
    reason: We don't have end customers making direct API calls and this is a breaking change for our existing clients.