Include tag description on API instances, simplify generation script (#76)

Co-authored-by: Hanting ZHANG <[email protected]>

Author: nkzou

.generator/src/generator/cli.py

@@ -113,13 +113,14 @@ def cli(specs, output):
             fp.write(mod_model_j2.render(apis=apis, models=models))
 
         all_operations = []
+        tags_by_name = {tag["name"]: tag for tag in spec["tags"]}
 
         for name, operations in apis.items():
             filename = "api_" + formatter.snake_case(name) + ".rs"
             api_path = resources_dir / "api" / filename
             api_path.parent.mkdir(parents=True, exist_ok=True)
             with api_path.open("w") as fp:
-                fp.write(api_j2.render(name=name, operations=operations))
+                fp.write(api_j2.render(name=name, operations=operations, description=tags_by_name[name]["description"]))
             all_operations.append((name, operations))
 
         mod_path = resources_dir / "api" / "mod.rs"

.generator/src/generator/templates/api.j2

@@ -81,6 +81,7 @@ pub enum {{operation.operationId}}Error {
 }
 {% endfor %}
 
+{{ description|block_comment }}
 #[derive(Debug, Clone)]
 pub struct {{ structName }} {
     config: datadog::Configuration,

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ repos:
   - id: generate
     name: Generate
     language: system
-    entry: bash -c "./generate.sh && ./generate-examples.sh"
+    entry: bash -c "./generate.sh"
     files: '^(\.generator/.*|\.pre-commit-config\.yaml|Makefile|\tests/scenarios/features/.*)'
     pass_filenames: false
     verbose: true

generate-examples.sh

@@ -23,7 +23,12 @@ pre_commit_wrapper () {
   echo "command 'pre-commit run --all-files --hook-stage=manual ${1}' success"
 }
 
+cargo install genemichaels --quiet
 rm -rf src/*
+rm -rf examples/*
 pre_commit_wrapper generator
-pre_commit_wrapper format
+pre_commit_wrapper examples
 pre_commit_wrapper lint
+genemichaels --log silent examples/*.rs
+cargo fmt
+cargo fmt # don't think too hard about this... cargo fmt idempotency edge case

generate.sh

@@ -14,6 +14,15 @@ pub enum ValidateError {
     UnknownValue(serde_json::Value),
 }
 
+/// All requests to Datadog’s API must be authenticated.
+/// Requests that write data require reporting access and require an `API key`.
+/// Requests that read data require full access and also require an `application key`.
+///
+/// **Note:** All Datadog API clients are configured by default to consume Datadog US site APIs.
+/// If you are on the Datadog EU site, set the environment variable `DATADOG_HOST` to
+/// `<https://api.datadoghq.eu`> or override this value directly when creating your client.
+///
+/// [Manage your account’s API and application keys](<https://app.datadoghq.com/organization-settings/>) in Datadog, and see the [API and Application Keys page](<https://docs.datadoghq.com/account_management/api-app-keys/>) in the documentation.
 #[derive(Debug, Clone)]
 pub struct AuthenticationAPI {
     config: datadog::Configuration,

src/datadogV1/api/api_authentication.rs

@@ -196,6 +196,8 @@ pub enum UpdateAWSAccountError {
     UnknownValue(serde_json::Value),
 }
 
+/// Configure your Datadog-AWS integration directly through the Datadog API.
+/// For more information, see the [AWS integration page](<https://docs.datadoghq.com/integrations/amazon_web_services>).
 #[derive(Debug, Clone)]
 pub struct AWSIntegrationAPI {
     config: datadog::Configuration,

src/datadogV1/api/api_aws_integration.rs

@@ -79,6 +79,8 @@ pub enum ListAWSLogsServicesError {
     UnknownValue(serde_json::Value),
 }
 
+/// Configure your Datadog-AWS-Logs integration directly through Datadog API.
+/// For more information, see the [AWS integration page](<https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection>).
 #[derive(Debug, Clone)]
 pub struct AWSLogsIntegrationAPI {
     config: datadog::Configuration,

src/datadogV1/api/api_aws_logs_integration.rs

@@ -60,6 +60,8 @@ pub enum UpdateAzureIntegrationError {
     UnknownValue(serde_json::Value),
 }
 
+/// Configure your Datadog-Azure integration directly through the Datadog API.
+/// For more information, see the [Datadog-Azure integration page](<https://docs.datadoghq.com/integrations/azure>).
 #[derive(Debug, Clone)]
 pub struct AzureIntegrationAPI {
     config: datadog::Configuration,

src/datadogV1/api/api_azure_integration.rs

@@ -60,6 +60,9 @@ pub enum UpdateDashboardListError {
     UnknownValue(serde_json::Value),
 }
 
+/// Interact with your dashboard lists through the API to
+/// organize, find, and share all of your dashboards with your team and
+/// organization.
 #[derive(Debug, Clone)]
 pub struct DashboardListsAPI {
     config: datadog::Configuration,