Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
26 changes: 24 additions & 2 deletions documentation/ci-fix.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,31 @@ Most guides here require for you to have `npm` installed, which you can get by i

## Spell check

Please add your words to `./custom-words.txt` if you think you have the correct spell.
If you receive a spelling failure either fix the spelling to match or if there are words that need to be suppressed for your service then add the word to the override list in [cspell.json](https://github.com/Azure/azure-rest-api-specs/blob/main/cSpell.json). Either
add to your existing section or create a new section for your specific spec or service family if the work is more generally used in losts of files under your service.
```
"overrides": [
... example of specific file override
{
"filename": "**/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json",
"words": [
"saskey"
]
}
... example of specific service family override
{
"filename": "**/specification/cognitiveservices/**/*.json",
"words": [
"flac",
"mpga"
]
}
```
Words are case-insensitive so use lower case for the word list.

If you need more information on see [cspell configuration](https://cspell.org/configuration/).

If your problem is some existing error name that is not a word and need to suppress the error in that file (and don't want to add to custom-words.txt), you can add it to `./cSpell.txt`.
*Note*: We are trying to move away from one shared dictionary file so try and avoid editing custom-words.txt in the root as it will likely go away in the future.

## Prettier check

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ options:
package-dir: "azure-ai-contentsafety"
package-version: "1.0.0"
package-name: "{package-dir}"
package-pprint-name: "\"Azure AI Content Safety\""
"@azure-tools/typespec-csharp":
package-dir: "Azure.AI.ContentSafety"
namespace: "{package-dir}"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ options:
generate-tests: false
custom-types-subpackage: "implementation.models"
custom-types: "FunctionCallPreset"
customization-class: customization/src/main/java/MyCustomization.java
"@azure-tools/typespec-ts":
package-dir: "openai"
generateMetadata: false
Expand Down
36 changes: 10 additions & 26 deletions specification/edgemarketplace/resource-manager/readme.python.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,16 @@ 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: azure.mgmt.edgemarketplace
package-name: azure-mgmt-edgemarketplace
package-version: 2023-08-01
clear-output-folder: true
title: EdgeMarketPlaceMgmtClient
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
namespace: azure.mgmt.edgemarketplace
package-name: azure-mgmt-edgemarketplace
package-version: 1.0.0b1
clear-output-folder: true
```

### Python multi-api

Generate all API versions currently shipped for this package

```yaml $(python) && $(multiapi)
batch:
- tag: package-2023-08-01
``` yaml $(python)
no-namespace-folders: true
output-folder: $(python-sdks-folder)/edgemarketplace/azure-mgmt-edgemarketplace/azure/mgmt/edgemarketplace
```

### Tag: package-2023-08-01 and python

These settings apply only when `--tag=package-2023-08-01 --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 $(tag) == 'package-2023-08-01' && $(python)
python:
namespace: azure.mgmt.edgemarketplace.v2023_04_01_preview
output-folder: $(python-sdks-folder)/edgemarketplace/azure-mgmt-edgemarketplace/azure/mgmt/edgemarketplace/v2023_08_01
```