Skip to content

Commit 70db1ec

Browse files
authored
Cleanup multiapi package generation (along with doc refs). (#41943)
* cleanup multiapi package generation (along with doc refs).
1 parent fb1ac9e commit 70db1ec

File tree

3 files changed

+4
-559
lines changed

3 files changed

+4
-559
lines changed

doc/dev/mgmt/cheatsheet.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,6 @@ python ./scripts/dev_setup.py -p $PACKAGE
3636
python -m packaging_tools.generate_sdk -v -m restapi_path/readme.md
3737
```
3838

39-
Regenerate multi-api client:<br/>
40-
`python ./scripts/multiapi_init_gen.py azure-mgmt-myservice`
41-
42-
Regenerate multi-api of multi-client package:<br/>
43-
`python ./scripts/multiapi_init_gen.py azure-mgmt-myservice#subclientname`
44-
4539
## Update packaging setup.py / MANIFEST / etc.
4640

4741
Locally:<br/>
@@ -50,7 +44,7 @@ Locally:<br/>
5044
Update a given PR (needs GH_TOKEN env variable set):<br/>
5145
`python -m packaging_tools.update_pr -v -p 3979`
5246

53-
Edit `sdk_packaging.toml` if necesseray and restart the tool.
47+
Edit `sdk_packaging.toml` if necessary and restart the tool.
5448

5549
Available options:
5650

@@ -61,7 +55,7 @@ Available options:
6155
| package_nspkg | str | namespace package name | azure-mgmt-nspkg |
6256
| package_pprint_name | str | The nice name to show on PyPI | MyService Management |
6357
| package_doc_id | str | the moniker on docs.microsoft.com (could be empty) | my-service |
64-
| is_stable | bool | Should have discriminer as stable | false |
58+
| is_stable | bool | Should have discriminator as stable | false |
6559
| is_arm | bool | needs a dependency on msrestazure | true |
6660

6761
## ChangeLog

doc/dev/package_version/package_version_rule.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,10 @@ If Python SDK contains preview api-version (like "2020-01-01-preview"), its vers
1212
(1) For single-api package(for example: [confidentialledger](https://github.com/azure-sdk/azure-sdk-for-python/blob/a56c4b44911e173a89cb051aefc588e189e42654/sdk/confidentialledger/azure-mgmt-confidentialledger/azure/mgmt/confidentialledger/_configuration.py#L39)),
1313
as long as it contains preview api-version, the package version should be preview
1414

15-
(2) For multi-api package(for example: [network](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/network/azure-mgmt-network)),
16-
there will be `DEFAULT_API_VERSION`(for example: [`DEFAULT_API_VERSION` of network](https://github.com/Azure/azure-sdk-for-python/blob/0b3fb9ef0bee54f23beb7a4913faaaef5be90d9b/sdk/network/azure-mgmt-network/azure/mgmt/network/_network_management_client.py#L57)).
15+
(2) For multi-api package(for example: [network](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/network/azure-mgmt-network)),
16+
there will be `DEFAULT_API_VERSION`(for example: [`DEFAULT_API_VERSION` of network](https://github.com/Azure/azure-sdk-for-python/blob/0b3fb9ef0bee54f23beb7a4913faaaef5be90d9b/sdk/network/azure-mgmt-network/azure/mgmt/network/_network_management_client.py#L57)).
1717
As long as it is preview, then the package version is preview.
1818

19-
(note1: For more info about multi-api package, please refer to [multiapi.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/multiapi.md))
20-
2119
(note2: preview package version contains `b`, for example: `1.0.0b1`)
2220

2321
# How to calculate next package version
@@ -40,4 +38,3 @@ According to the up rules, we could summarize all the possibilities in the follo
4038
![img.png](version_summary.png)
4139

4240
(`-` means that this item doesn't influence result)
43-

0 commit comments

Comments
 (0)