Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Databricks PowerShell Module documentation related to enableNoPublicIP Property #14381

Closed
msaranga opened this issue Mar 2, 2021 · 3 comments · Fixed by #19591
Closed
Assignees
Labels
Data Bricks Doc - Reference feature-request This issue requires a new behavior in the product in order be resolved.

Comments

@msaranga
Copy link
Contributor

msaranga commented Mar 2, 2021

Can we update documentation of Az Databricks Cmdlet related EnableNoPublicIP description as per Swagger

Proposed implementation details (optional)

Please navigate to Az Databricks workspace creation documentation , search for property "-EnableNoPublicIP" property. This has generic documentation information. Please update document as per Swagger.
Here is the Swagger description
"enableNoPublicIp":
{
"$ref": "#/definitions/WorkspaceCustomBooleanParameter",
"description": "Should the Public IP be Disabled?"
}

@msaranga msaranga added feature-request This issue requires a new behavior in the product in order be resolved. needs-triage This is a new issue that needs to be triaged to the appropriate team. labels Mar 2, 2021
@ghost ghost removed the needs-triage This is a new issue that needs to be triaged to the appropriate team. label Mar 2, 2021
@isra-fel isra-fel self-assigned this Mar 3, 2021
@isra-fel isra-fel added this to the Backlog milestone Mar 3, 2021
@isra-fel
Copy link
Member

isra-fel commented Mar 3, 2021

Thanks @msaranga for reporting!

This issue is because swagger defines a boolen parameter with a nested object, and our code generator chose the description of the inner property instead of the outer one.

    "WorkspaceCustomObjectParameter": {
      "properties": {
        "type": {
          "$ref": "#/definitions/WorkspaceCustomParameterType",
          "description": "The type of variable that this is"
        },
        "value": {
          "type": "object",
          "description": "The value which should be used for this field."     <---------- here
        }
      },
      "required": [
        "value"
      ],
      "description": "The value which should be used for this field."
    },

So as the code was generated, we might need to revisit the logic of autorest.powershell

BTW @msaranga do you happen to know why wasn't the parameter be designed as a simple boolean parameter, for example

"enableNoPublicIp":
{
  "type": "boolean",
  "description": "Should the Public IP be Disabled?"
}

@dingmeng-xue
Copy link
Member

@LucasYao93 , can we fix it in this release?

@LucasYao93
Copy link
Contributor

@LucasYao93 , can we fix it in this release?

Yes, we can.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Data Bricks Doc - Reference feature-request This issue requires a new behavior in the product in order be resolved.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants