Skip to content

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

Open
@ArcturusZhang

Description

@ArcturusZhang

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".

Metadata

Metadata

Assignees

No one assigned

    Labels

    ADOIssue is documented on MSFT ADO for internal trackingML-Workspace ManagementAreaPathMachine LearningService AttentionWorkflow: This issue is responsible by Azure service team.feature-requestThis issue requires a new behavior in the product in order be resolved.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions