Skip to content

Conversation

@pierskarsenbarg
Copy link
Member

There have been a couple of questions about the path parameter in automation API. Here's the most recent on the subject of disabling default providers

Proposed changes

  • Updated blog post on disabling default providers to point to docs page
  • Updated docs page on resource providers to include code for automation API

Unreleased product version (optional)

Related issues (optional)

* Updated blog post on disabling default providers to point to docs page
* Updated docs page on resource providers to include code for automation
  API
@claude
Copy link
Contributor

claude bot commented Nov 7, 2025

Documentation Review

Thank you for adding this helpful content about using the path parameter in Automation API! This addresses a common question and improves the documentation. However, I've identified several issues that need to be addressed before this can be merged.

Issues Found

1. Syntax errors in code examples

File: content/docs/iac/concepts/resources/providers.md

  • Line 606 (JavaScript): Missing object syntax for the third parameter. Should be { path: true } not just true

    await stack.setConfig("pulumi:disable-default-providers[0]", { value: "*" }, { path: true });
    
  • Line 613 (TypeScript): Invalid syntax - mixing named parameter with object literal

    await stack.setConfig("pulumi:disable-default-providers[0]", { value: "*" }, { path: true });
    
  • Line 634 (Go): Double period typo - stack.. should be stack.

    stack.SetConfig(ctx, "pulumi:disable-default-providers[0]", auto.ConfigValue{Value: "*"}, true)
    
  • Line 641 (Java): Missing 's' at the beginning - tack should be stack

    stack.setConfig("pulumi:disable-default-providers[0]", new ConfigValue("*"), true);
    

2. Inconsistent parameter syntax across languages

Looking at the existing Automation API examples in content/docs/iac/automation-api/getting-started-automation-api.md, there's an inconsistency in how the JavaScript/TypeScript setConfig method handles the third parameter. The Python example uses a positional boolean (True), C# and Go use named parameters (path: true), but JavaScript/TypeScript examples in the existing docs don't show a third parameter.

Please verify the correct syntax for each language by checking the Automation API SDK source code or documentation:

  • JavaScript/TypeScript: Verify if the third parameter should be { path: true } or just true
  • All languages: Ensure the syntax matches the actual SDK implementation

3. Missing newline at end of file

File: content/docs/iac/concepts/resources/providers.md, Line 645

The file must end with a newline character per repository standards (AGENTS.md).

4. Content suggestion for blog post update

File: content/blog/disable-default-providers/index.md, Line 317

The sentence could be more concise and direct:

To add the `disable-default-providers` configuration setting using the Pulumi CLI or the Automation API SDK, see the [Resource providers](/docs/iac/concepts/resources/providers/#disabling-default-providers) page.

Changes:

  • "please visit" → "see" (more concise)
  • Split reference to methods earlier in the sentence for better flow

Summary

The content addition is valuable and addresses a documentation gap. Once the syntax errors are corrected and verified against the actual SDK implementations, this will be a helpful addition to the docs.

Action items:

  1. Fix all syntax errors identified above
  2. Verify the correct setConfig/SetConfig signature for each language SDK
  3. Add newline at end of providers.md
  4. Consider the blog post wording suggestion

Please mention me (@claude) if you'd like me to review the updated changes or help verify the correct API syntax.

@pulumi-bot
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants