Estructurar datos utilizando propiedades y additionalProperties

Las properties y additionalProperties bajo una directiva de esquema de OpenAPI se muestran como propiedades de objeto formal y como una propiedad de diccionario. Si se declara bajo una propiedad o un tipo de additionalProperties, el análisis de OpenAPI ignora uno o el otro. El proceso de registro no arroja un error.

Los properties denominados OpenAPI son propiedades en Apex con el mismo nombre y tipo de datos de propiedad.

Los additionalProperties de OpenAPI se agrupan como la propiedad Apex con propiedades de nombre y tipo Mapa<Cadena, Tipo>, donde Tipo es el tipo de additionalProperties declarado. El tipo de propiedad Mapa es un conjunto de pares clave-valor.

additionalProperties de OpenAPI siempre se declaran como una propiedad de mapa de objeto de Apex, incluso si se pudiera declarar como un tipo de Mapa de Apex independiente. El resultado es propiedades de objeto denominado gestionado de forma coherente definidas junto con additionalProperties.

properties y additionalProperties de OpenAPI se pueden declarar bajo un esquema de parámetro de OpenAPI o un esquema en la sección de definiciones. El analizador de OpenAPI ignora properties o additionalProperties si se declara como un tipo de propiedad de objeto. Un tipo de propiedad de objeto solo debe definir properties o additionalProperties nombrados, pero no ambos. Para solucionar, coloque la definición de propiedad de objeto como un esquema denominado bajo definiciones y hacer referencia a él por nombre.

El analizador de OpenAPI diferencia entre declaraciones literales o esquemas sin tipo. Las declaraciones como additionalProperties: true, additionalProperties: false o additionalProperties: {} se interpretan como no escritas. Las additionalProperties sin escribir se ignoran. No hay una solución para definir additionalProperties que puedan ser de cualquier tipo.

El flujo no permite el acceso o la manipulación de tipos de objeto de Apex con propiedades Mapa, pero mantiene de forma transparente el contenido cuando se asigna a variables del mismo tipo de objeto de Apex. Para manipular la estructura de datos de mapa en flujo, llame una acción invocable de Apex que puede acceder a la estructura de datos se mapa. Para un ejemplo con asignaciones de Servicio externo en acción, consulte Ejemplo 9 en Esquema de OpenAPI 2.0 de Servicios externos.

En cualquier registro de servicio externo que cree en la versión 7 y posteriores del sistema, puede definir una propiedad con un nombre que comience por un número. Cuando se accede a esa propiedad en código Flow o Apex, el proceso de codificación ajusta el nombre de la propiedad.

{
  "UserAvatarUrls": {
	"type": "object",
	"properties": {
  	  "24x24": {
    	    "type": "string",
    	    "description": "The URL of the user's 24x24 pixel avatar.",
    	    "format": "uri"
  	},
  	  "32x32": {
    	    "type": "string",
    	    "description": "The URL of the user's 32x32 pixel avatar.",
    	    "format": "uri"
  	},
  	  "16x16": {
    	    "type": "string",
    	    "description": "The URL of the user's 16x16 pixel avatar.",
    	    "format": "uri"
  	},
  	  "48x48": {
    	    "type": "string",
    	    "description": "The URL of the user's 48x48 pixel avatar.",
    	    "format": "uri"
  	}
    }
  }
}