Azure / Azure/azure-rest-api-specs

ContainerInstance.json - ContainersGroups_Get has model validation errors

Open
#2,226 1 comment 0 reactions 0 assignees View on GitHub
Container Instances Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

Model validation issues from ContainerInstance - ContainersGroups_Get operation: https://github.com/Azure/azure-rest-api-specs/blob/master/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/containerInstance.json

1. Required property missing "type" for "ipAddress" [here](https://github.com/Azure/azure-rest-api-specs/blob/76a23e2c89db93576344e9c677bf1cccf98af559/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/examples/ContainerGroupsGet.json#L51), spec indicates it's required [here](https://github.com/Azure/azure-rest-api-specs/blob/76a23e2c89db93576344e9c677bf1cccf98af559/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/containerInstance.json#L703)

2. Required property missing due to casing mismatch between spec and example - please double check with one is correct and update accordingly: required property in spec "memoryInGB" [here](https://github.com/Azure/azure-rest-api-specs/blob/76a23e2c89db93576344e9c677bf1cccf98af559/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/containerInstance.json#L4700) , example [here](https://github.com/Azure/azure-rest-api-specs/blob/76a23e2c89db93576344e9c677bf1cccf98af559/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/examples/ContainerGroupsGet.json#L31) casing of GB is different.

3. resourceGroup in example but not in spec, example [here](https://github.com/Azure/azure-rest-api-specs/blob/76a23e2c89db93576344e9c677bf1cccf98af559/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/examples/ContainerGroupsGet.json#L76), spec [definition](https://github.com/Azure/azure-rest-api-specs/blob/76a23e2c89db93576344e9c677bf1cccf98af559/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/containerInstance.json#L568) for "ContainerGroup" does not contain resourceGroup property

4. containerGroupName missing from required parameters in [example](https://github.com/Azure/azure-rest-api-specs/blob/76a23e2c89db93576344e9c677bf1cccf98af559/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/examples/ContainerGroupsGet.json#L2), though it's included as a "path" parameter in [spec](https://github.com/Azure/azure-rest-api-specs/blob/76a23e2c89db93576344e9c677bf1cccf98af559/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/containerInstance.json#L170)

Contributor guide

Open the contributing guide

Research direction

Read specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/containerInstance.json alongside examples/ContainerGroupsGet.json, focusing on the linked definitions and operation parameters. Run the repository's model validation for this operation, then reconcile the four reported discrepancies so the example and specification validate consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, openapi
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.