properties-type-object-no-definition.md

PropertiesTypeObjectNoDefinition

Category

ARM Error

Applies to

ARM OpenAPI(swagger) specs

Related ARM Guideline Code

• RPC-Policy-V1-03

Output Message

Properties with type:object must have definition of a reference model.

Description

Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.

CreatedAt

April 18, 2023

LastModifiedAt

May 16, 2023

How to fix the violation

The "type:object" model is not defined in the payload. Define the reference model of the object or change the "type" to a primitive data type like string, int, etc. The following would be invalid:

...
{
  "definitions": {
    "Resource": {
      "type": "object",
      "properties": {
        "description": "The properties type.",
        "info": {
          "readOnly": true,
          "description": "The info type.",
          "type": "object"
        }
      }
    }
  }
}
...

A valid example of reference model:

...
{
  "definitions": {
    "Resource": {
      "type": "object",
      "properties": {
        "description": "The properties type.",
        "info": {
          "readOnly": true,
          "type": "object",
          "description": "The info type.",
          "details": {
            "readOnly": true,
            "type": "string"
          }
        }
      }
    }
  }
}
...

A valid example of primitve data type:

...
{
  "definitions": {
    "Resource": {
      "type": "object",
      "properties": {
        "description": "The properties type.",
        "info": {
          "readOnly": true,
          "type": "string"
        }
      }
    }
  }
}
...