@azure-tools/typespec-autorest 0.31.0-dev.8 → 0.31.0-dev.9

package/README.md

@@ -3,148 +3,6 @@
 This is a TypeSpec library that will emit an enriched OpenAPI 2.0 specification that can be consumed by AutoRest.
 The generated OpenAPI spec will have custom `x-ms-` extensions properties and conform to standards required by AutoRest to generate a more accurate SDK.
 
-## Getting started
+## Documentation
 
-1. Include `@azure-tools/typespec-autorest` dependencies in package.json
-
-```json
-{
-  ...
-  "dependencies": {
-    ...
-    "@azure-tools/typespec-autorest": "latest"
-  }
-}
-```
-
-2. Run `npm install` to install the dependency
-3. Import `@azure-tools/typespec-autorest` in your `main.tsp` file
-
-```typespec
-import "@azure-tools/typespec-autorest";
-```
-
-4. Run `tsp compile`. This will result in a `swagger.json` file crated in `./tsp-output/swagger.json`
-
-## Use in autorest
-
-### Manually
-
-Generate the OpenAPI spec as shown above then run autorest cli directly on it.
-
-## Configuration
-
-### Emitter options:
-
-Emitter options can be configured via the `tspconfig.yaml` configuration:
-
-```yaml
-emitters:
-  '@azure-tools/typespec-autorest':
-    <optionName>: <value>
-
-
-# For example
-emitters:
-  '@azure-tools/typespec-autorest':
-    output-file: my-custom-swagger.json
-```
-
-or via the command line with
-
-```bash
---option "@azure-tools/typespec-autorest.<optionName>=<value>"
-
-# For example
---option "@azure-tools/typespec-autorest.output-file=my-custom-swagger.json"
-```
-
-#### `emitter-output-dir`
-
-Set the emitter output-dir. [See here](https://microsoft.github.io/typespec/introduction/configuration#output-directory-configuration)
-
-#### `output-file`
-
-Configure the name of the swagger output file relative to the `output-dir`.
-
-#### `examples-directory`
-
-Directory where the x-ms-examples are located so the emitter can automatically link.
-
-#### `version`
-
-Select which version should be emitted if the spec support versioning. By default all the version with be emitted in this format `<outputFileName>.<version>.json`
-
-### `new-line`
-
-Set the newline character for emitting files. Can be either:
-
-- `lf`(Default)
-- `crlf`
-
-### `omit-unreachable-types`
-
-Only include types referenced via an operation.
-
-## Decorators
-
-- [@collectionFormat](#collectionformat)
-- [@example](#example)
-- [@useRef](#useref)
-
-### @collectionFormat
-
-Syntax:
-
-```
-@collectionFormat(formatString)
-```
-
-`@collectionFormat` specifies array property type serialization format. Valid format strings are "csv", "multi", "ssv", "tsv", "pipes" though "csv" or "multi" are recommended.
-
-`@collectionFormat` can only be specified on model properties that are arrays.
-
-### @example
-
-Syntax:
-
-```
-@example(pathOrUri, title)
-```
-
-`@example` attaches example files to an operation. Multiple examples can be specified.
-
-`@example` can only be specified on operations.
-
-### @useRef
-
-Syntax:
-
-```
-@useRef(urlString)
-```
-
-`@useRef` is used to replace the TypeSpec model type in emitter output with a pre-existing named OpenAPI schema such as ARM common types.
-
-## How to
-
-### Include `x-ms-skip-url-encoding` in `x-ms-parmaeterized-host` parameter
-
-Every parameter of type `uri` in `@server` will be marked with `x-ms-skip-url-encoding`.
-
-```typespec
-@server("{endpoint}/v2", "Account endpoint", {endpoint: url})
-```
-
-Result in
-
-```json5
-{
-  in: "path",
-  name: "endpoint",
-  required: true,
-  type: "string",
-  format: "uri",
-  "x-ms-skip-url-encoding": true,
-}
-```
+[Autorest Documentation](https://azure.github.io/typespec-azure/docs/emitters/typespec-autorest).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-autorest",
-  "version": "0.31.0-dev.8",
+  "version": "0.31.0-dev.9",
   "author": "Microsoft Corporation",
   "description": "TypeSpec library for emitting openapi from the TypeSpec REST protocol binding",
   "homepage": "https://azure.github.io/typespec-azure",