Skip to content

Commit afe07cc

Browse files
authored
Renamed no-default-version feature to no-default-tag & expanded tag documentation (#711)
1 parent 93c9973 commit afe07cc

File tree

686 files changed

+3138
-2633
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

686 files changed

+3138
-2633
lines changed

services/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- [#675](https://github.com/Azure/azure-sdk-for-rust/pull/675) use Basic Information tag for default version
55
- [#634](https://github.com/Azure/azure-sdk-for-rust/issues/634) limit docs.rs to 5 API tags
66
- [#632](https://github.com/Azure/azure-sdk-for-rust/issues/632) add links & README.md for services
7+
- Renamed `no-default-version` feature to `no-default-tag` & expanded tag documentation
78

89
# 0.1 (2022-01)
910

services/autorust/codegen/src/cargo_toml.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ features = [{}]
6161
default = ["{}", "enable_reqwest"]
6262
enable_reqwest = ["azure_core/enable_reqwest"]
6363
enable_reqwest_rustls = ["azure_core/enable_reqwest_rustls"]
64-
no-default-version = []
64+
no-default-tag = []
6565
"#,
6666
crate_name, crate_name, docs_rs_features, default_feature
6767
)
@@ -88,7 +88,7 @@ pub fn get_default_tag<'a>(tags: &[&'a Tag], default_tag: Option<&str>) -> &'a T
8888
}
8989

9090
const MAX_DOCS_RS_FEATURES: usize = 4;
91-
const NO_DEFAULT_VERSION: &str = "no-default-version";
91+
const NO_DEFAULT_TAG: &str = "no-default-tag";
9292

9393
/// Get a list of features to document at docs.rs in addition the default
9494
fn docs_rs_features(tags: &[&Tag], default_feature: &str) -> Vec<String> {
@@ -104,6 +104,6 @@ fn docs_rs_features(tags: &[&Tag], default_feature: &str) -> Vec<String> {
104104
})
105105
.collect();
106106
features.truncate(MAX_DOCS_RS_FEATURES);
107-
features.insert(0, NO_DEFAULT_VERSION.to_owned());
107+
features.insert(0, NO_DEFAULT_TAG.to_owned());
108108
features
109109
}

services/autorust/codegen/src/lib_rs.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ fn create_body(tags: &[&Tag]) -> Result<TokenStream> {
2828
cfgs.extend(quote! {
2929
#[cfg(feature = #feature_name)]
3030
pub mod #mod_name;
31-
#[cfg(all(feature = #feature_name, not(feature = "no-default-version")))]
31+
#[cfg(all(feature = #feature_name, not(feature = "no-default-tag")))]
3232
pub use #mod_name::{models, operations, operations::Client, operations::ClientBuilder, operations::Error};
3333
});
3434
}
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# {{ crate_name }} crate
22

3-
The is an [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate that is generated from the Azure REST API specifications listed in:
3+
This is a generated [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate from the Azure REST API specifications listed in:
44

55
{{ readme_url }}
66

7-
The default `Tag` is `{{default_tag.name()}}`.
7+
To get started with these generated service crates, see the [examples](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/README.md#examples).
88

9-
The following `Tag`s are available:
9+
The default tag is `{{default_tag.name()}}`.
10+
11+
The following [tags](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/tags.md) are available:
1012
{% for tag in tags %}
1113
- `{{tag.name()}}` has {{self.operation_total(tag)}} operations from {{self.api_version_total(tag)}} API versions: {{self.api_versions(tag)}}. Use crate feature `{{tag.rust_feature_name()}}` to enable. The operations will be in the `{{tag.rust_mod_name()}}` module.
1214
{%- endfor -%}

services/mgmt/activedirectory/Cargo.toml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

services/mgmt/activedirectory/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# azure_mgmt_activedirectory crate
22

3-
The is an [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate that is generated from the Azure REST API specifications listed in:
3+
This is a generated [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate from the Azure REST API specifications listed in:
44

55
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/azureactivedirectory/resource-manager/readme.md
66

7-
The default `Tag` is `package-2020-03`.
7+
To get started with these generated service crates, see the [examples](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/README.md#examples).
88

9-
The following `Tag`s are available:
9+
The default tag is `package-2020-03`.
10+
11+
The following [tags](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/tags.md) are available:
1012

1113
- `package-preview-2017-04` has 6 operations from 1 API versions: `2017-04-01-preview`. Use crate feature `package-preview-2017-04` to enable. The operations will be in the `package_preview_2017_04` module.
1214
- `package-preview-2020-03` has 8 operations from 1 API versions: `2020-03-01-preview`. Use crate feature `package-preview-2020-03` to enable. The operations will be in the `package_preview_2020_03` module.

services/mgmt/activedirectory/src/lib.rs

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

services/mgmt/addons/Cargo.toml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

services/mgmt/addons/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# azure_mgmt_addons crate
22

3-
The is an [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate that is generated from the Azure REST API specifications listed in:
3+
This is a generated [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate from the Azure REST API specifications listed in:
44

55
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/addons/resource-manager/readme.md
66

7-
The default `Tag` is `package-2018-03`.
7+
To get started with these generated service crates, see the [examples](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/README.md#examples).
88

9-
The following `Tag`s are available:
9+
The default tag is `package-2018-03`.
10+
11+
The following [tags](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/tags.md) are available:
1012

1113
- `package-2018-03` has 5 operations from 1 API versions: `2018-03-01`. Use crate feature `package-2018-03` to enable. The operations will be in the `package_2018_03` module.
1214
- `package-2017-05` has 5 operations from 1 API versions: `2017-05-15`. Use crate feature `package-2017-05` to enable. The operations will be in the `package_2017_05` module.

services/mgmt/addons/src/lib.rs

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

services/mgmt/adhybridhealthservice/Cargo.toml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# azure_mgmt_adhybridhealthservice crate
22

3-
The is an [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate that is generated from the Azure REST API specifications listed in:
3+
This is a generated [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate from the Azure REST API specifications listed in:
44

55
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/adhybridhealthservice/resource-manager/readme.md
66

7-
The default `Tag` is `package-2014-01`.
7+
To get started with these generated service crates, see the [examples](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/README.md#examples).
88

9-
The following `Tag`s are available:
9+
The default tag is `package-2014-01`.
10+
11+
The following [tags](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/tags.md) are available:
1012

1113
- `package-2014-01` has 77 operations from 1 API versions: `2014-01-01`. Use crate feature `package-2014-01` to enable. The operations will be in the `package_2014_01` module.

services/mgmt/adhybridhealthservice/src/lib.rs

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

services/mgmt/adp/Cargo.toml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

services/mgmt/adp/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# azure_mgmt_adp crate
22

3-
The is an [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate that is generated from the Azure REST API specifications listed in:
3+
This is a generated [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate from the Azure REST API specifications listed in:
44

55
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/adp/resource-manager/readme.md
66

7-
The default `Tag` is `package-2021-11-01-preview`.
7+
To get started with these generated service crates, see the [examples](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/README.md#examples).
88

9-
The following `Tag`s are available:
9+
The default tag is `package-2021-11-01-preview`.
10+
11+
The following [tags](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/tags.md) are available:
1012

1113
- `package-2020-07-01-preview` has 12 operations from 1 API versions: `2020-07-01-preview`. Use crate feature `package-2020-07-01-preview` to enable. The operations will be in the `package_2020_07_01_preview` module.
1214
- `package-2021-02-01-preview` has 13 operations from 1 API versions: `2021-02-01-preview`. Use crate feature `package-2021-02-01-preview` to enable. The operations will be in the `package_2021_02_01_preview` module.

services/mgmt/adp/src/lib.rs

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

services/mgmt/advisor/Cargo.toml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

services/mgmt/advisor/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# azure_mgmt_advisor crate
22

3-
The is an [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate that is generated from the Azure REST API specifications listed in:
3+
This is a generated [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate from the Azure REST API specifications listed in:
44

55
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/advisor/resource-manager/readme.md
66

7-
The default `Tag` is `package-2020-01`.
7+
To get started with these generated service crates, see the [examples](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/README.md#examples).
88

9-
The following `Tag`s are available:
9+
The default tag is `package-2020-01`.
1010

11+
The following [tags](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/tags.md) are available:
12+
13+
- `package-2022-02-preview` has 2 operations from 1 API versions: `2022-02-01-preview`. Use crate feature `package-2022-02-preview` to enable. The operations will be in the `package_2022_02_preview` module.
1114
- `package-2020-07-preview` has 3 operations from 1 API versions: `2020-07-01-preview`. Use crate feature `package-2020-07-preview` to enable. The operations will be in the `package_2020_07_preview` module.
1215
- `package-2020-01` has 15 operations from 1 API versions: `2020-01-01`. Use crate feature `package-2020-01` to enable. The operations will be in the `package_2020_01` module.
1316
- `package-2017-04` has 15 operations from 1 API versions: `2017-04-19`. Use crate feature `package-2017-04` to enable. The operations will be in the `package_2017_04` module.

services/mgmt/advisor/src/lib.rs

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

services/mgmt/agrifood/Cargo.toml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

services/mgmt/agrifood/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# azure_mgmt_agrifood crate
22

3-
The is an [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate that is generated from the Azure REST API specifications listed in:
3+
This is a generated [Azure SDK for Rust](https://github.com/Azure/azure-sdk-for-rust) crate from the Azure REST API specifications listed in:
44

55
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/agrifood/resource-manager/readme.md
66

7-
The default `Tag` is `package-2020-05-12-preview`.
7+
To get started with these generated service crates, see the [examples](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/README.md#examples).
88

9-
The following `Tag`s are available:
9+
The default tag is `package-2020-05-12-preview`.
10+
11+
The following [tags](https://github.com/Azure/azure-sdk-for-rust/blob/main/services/tags.md) are available:
1012

1113
- `package-2020-05-12-preview` has 15 operations from 1 API versions: `2020-05-12-preview`. Use crate feature `package-2020-05-12-preview` to enable. The operations will be in the `package_2020_05_12_preview` module.

0 commit comments

Comments
 (0)