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

MachineLearningServices - Skus should have possible values defined in enum and x-ms-enum #13546

Open
ArcturusZhang opened this issue Mar 22, 2021 · 4 comments
Labels
ADO Issue is documented on MSFT ADO for internal tracking feature-request This issue requires a new behavior in the product in order be resolved. Machine Learning ML-Workspace Management AreaPath Service Attention This issue is responsible by Azure service team.

Comments

@ArcturusZhang
Copy link
Member

ArcturusZhang commented Mar 22, 2021

In the definition of the Sku model (for instance here), we need an enum type for both of the name and tier to show the possible values. For instance like this:

    "Sku": {
      "description": "Sku of the resource",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the sku",
          "type": "string",
          "enum": {
            "Basic"
          },
          "x-ms-enum": {
            "name": "SkuTypes",
            "values": [
              {"name": "Basic", "description": "Blabla"}
            ]
          }
        },
        "tier": {
          "description": "Tier of the sku like Basic or Enterprise",
          "type": "string",
          "enum": {
            "Basic"
          },
          "x-ms-enum": {
            "name": "SkuTypes",
            "values": [
              {"name": "Basic", "description": "Blabla"}
            ]
          }
        }
      }
    },

With this enum defined in the swagger, we could make the swagger self-explainable without reading the document thoroughly, also we could get the customers aware of the breaking changes more actively like the "deprecation of the Enterprise Sku".

@ghost ghost added the needs-triage This is a new issue that needs to be triaged to the appropriate team. label Mar 22, 2021
@ArcturusZhang ArcturusZhang added Machine Learning Service Attention This issue is responsible by Azure service team. labels Mar 22, 2021
@ghost ghost removed the needs-triage This is a new issue that needs to be triaged to the appropriate team. label Mar 22, 2021
@ghost
Copy link

ghost commented Mar 22, 2021

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @azureml-github.

Issue Details

In the definition of the Sku model (for instance here), we need an enum type for both of the name and tier to show the possible values. For instance like this:

    "Sku": {
      "description": "Sku of the resource",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the sku",
          "type": "string",
          "enum": {
            "Basic"
          },
          "x-ms-enum": {
            "name": "SkuTypes",
            "values": [
              {"name": "Basic", "description": "Blabla"}
            ]
          }
        },
        "tier": {
          "description": "Tier of the sku like Basic or Enterprise",
          "type": "string",
          "enum": {
            "Basic"
          },
          "x-ms-enum": {
            "name": "SkuTypes",
            "values": [
              {"name": "Basic", "description": "Blabla"}
            ]
          }
        }
      }
    },
Author: ArcturusZhang
Assignees: ruowan
Labels:

Machine Learning, Service Attention, needs-triage

Milestone: -

@v-strudm-msft v-strudm-msft added feature-request This issue requires a new behavior in the product in order be resolved. ML-Compute AreaPath labels Mar 23, 2021
@ghost
Copy link

ghost commented Mar 23, 2021

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @brendalee.

Issue Details

In the definition of the Sku model (for instance here), we need an enum type for both of the name and tier to show the possible values. For instance like this:

    "Sku": {
      "description": "Sku of the resource",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the sku",
          "type": "string",
          "enum": {
            "Basic"
          },
          "x-ms-enum": {
            "name": "SkuTypes",
            "values": [
              {"name": "Basic", "description": "Blabla"}
            ]
          }
        },
        "tier": {
          "description": "Tier of the sku like Basic or Enterprise",
          "type": "string",
          "enum": {
            "Basic"
          },
          "x-ms-enum": {
            "name": "SkuTypes",
            "values": [
              {"name": "Basic", "description": "Blabla"}
            ]
          }
        }
      }
    },

With this enum defined in the swagger, we could make the swagger self-explainable without reading the document thoroughly, also we could get the customers aware of the breaking changes more actively like the "deprecation of the Enterprise Sku".

Author: ArcturusZhang
Assignees: -
Labels:

ML-Compute, Machine Learning, Service Attention, feature-request

Milestone: -

@v-strudm-msft v-strudm-msft added the ADO Issue is documented on MSFT ADO for internal tracking label May 11, 2021
@v-strudm-msft v-strudm-msft added ML-Workspace Management AreaPath and removed ML-Compute AreaPath labels May 12, 2021
@ghost
Copy link

ghost commented May 12, 2021

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @rastala.

Issue Details

In the definition of the Sku model (for instance here), we need an enum type for both of the name and tier to show the possible values. For instance like this:

    "Sku": {
      "description": "Sku of the resource",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the sku",
          "type": "string",
          "enum": {
            "Basic"
          },
          "x-ms-enum": {
            "name": "SkuTypes",
            "values": [
              {"name": "Basic", "description": "Blabla"}
            ]
          }
        },
        "tier": {
          "description": "Tier of the sku like Basic or Enterprise",
          "type": "string",
          "enum": {
            "Basic"
          },
          "x-ms-enum": {
            "name": "SkuTypes",
            "values": [
              {"name": "Basic", "description": "Blabla"}
            ]
          }
        }
      }
    },

With this enum defined in the swagger, we could make the swagger self-explainable without reading the document thoroughly, also we could get the customers aware of the breaking changes more actively like the "deprecation of the Enterprise Sku".

Author: ArcturusZhang
Assignees: -
Labels:

ADO, ML-Workspace Management, Machine Learning, Service Attention, feature-request

Milestone: -

@tombuildsstuff
Copy link
Contributor

Any update on this one @rastala?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ADO Issue is documented on MSFT ADO for internal tracking feature-request This issue requires a new behavior in the product in order be resolved. Machine Learning ML-Workspace Management AreaPath Service Attention This issue is responsible by Azure service team.
Projects
None yet
Development

No branches or pull requests

5 participants