Amazon Product Type Definition Meta-Schema (v1)

El Amazon Product Type Definition Meta-Schema es una extensión del JSON Schema Draft 2019-09 que describe las propiedades y los requisitos para un tipo de producto de Amazon, como LUGGAGE .

📘

Los URI no son direccionables por red

Los URI incluidos son solo identificadores y no direccionables por red.

Esquema URI : https://schemas.amazon.com/sellers-partners/definitions/product-types/meta-schema/v1

Vocabulario URI : https://schemas.amazon.com/sellers-partners/definitions/product-types/meta-schema/v1

Las instancias del Amazon Product Type Definition Meta-Schema pueden utilizar cualquiera de las keywords (palabras clave) y los vocabularios compatibles con JSON Schema Draft 2019-09 . Consulte la especificación de esquema JSON para obtener más detalles.

Además de los vocabularios estándar JSON Schema Draft 2019-09 , las instancias del Amazon Product Type Definition Meta-Schema utilizan keywords (palabras clave) definidas como vocabulario personalizado en el metaesquema. Esta documentación describe el vocabulario personalizado para el https://schemas.amazon.com/selling-partners/definitions/product-types/vocabulary/v1 URI.

Los consumidores de instancias de Amazon Product Type Definition Meta-Schema pueden optar por ignorar el vocabulario personalizado y usar solo los vocabularios estándar JSON Schema Draft 2019-09 . Si lo hace, validará la mayoría de los requisitos de un tipo de producto de Amazon, pero puede generar algunos errores de validación en el momento del envío.

Vocabulario

editable

• Tipo : boolean
• Finalidad : Informativo
• Descripcion : El palabra clave editable indica si un valor de propiedad se puede cambiar o no para un elemento existente. Las propiedades que no son editables aún pueden ser necesarias para un envío válido, pero no pueden cambiar su valor original. indica si un valor de propiedad se puede cambiar o no para un elemento existente. Las propiedades que no son editables aún pueden ser necesarias para un envío válido, pero no pueden cambiar su valor original.

enumNames

• Tipo : array
• Finalidad : Informativo
• Descripcion : El keyword enumNames contiene una array de etiquetas de visualización para una array correspondiente de valores enum. Las etiquetas de visualización en la array enumNames están en el mismo orden que los valores en la array enum.

hidden

• Tipo : boolean
• Finalidad : Informativo
• Descripcion : El keyword hidden sugiere si una propiedad debe ocultarse o no en las interfaces de usuario de Amazon. Ocultar o mostrar estas propiedades queda a discreción de la aplicación que consume el Amazon Product Type Definition Meta-Schema .

maxUniqueItems

• Tipo : integer
• Finalidad : Validación
• Descripción : En conjunto con el palabra clave selectors , la , la El valor de keyword minUniqueItems define el número máximo de elementos únicos en una array. define el número máximo de elementos únicos en una array.

minUniqueItems

• Tipo : integer
• Finalidad : Validación
• Descripción : En conjunto con el palabra clave selectors , la , la El valor de keyword minUniqueItems define el número mínimo de elementos únicos en una array. define el número mínimo de elementos únicos en una array.

maxUtf8ByteLength

• Tipo : integer
• Finalidad : Validación
• Descripcion : El El valor de keyword maxUtf8ByteLength define la longitud máxima de un define la longitud máxima de un valor string medido en bytes UTF-8. medido en bytes UTF-8.

minUtf8ByteLength

• Tipo : integer
• Finalidad : Validación
• Descripcion : El El valor de keyword minUtf8ByteLength define la longitud mínima de un define la longitud mínima de un valor string medido en bytes UTF-8. medido en bytes UTF-8.

selectors

• Tipo : array
• Finalidad : Validación
• Descripcion : El keyword selectors contiene una array de nombres de propiedades que definen la combinación de propiedades que hacen que un objeto sea único. De forma predeterminada, el esquema JSON determina la singularidad de los objetos en una array en función de todas las propiedades del objeto. Cuando contiene una array de nombres de propiedades que definen la combinación de propiedades que hacen que un objeto sea único. De forma predeterminada, el esquema JSON determina la singularidad de los objetos en una array en función de todas las propiedades del objeto. Cuando selectors están definidos, solo las propiedades especificadas se utilizan para determinar la exclusividad.

$lifecycle

• Tipo : object
• Finalidad : Informativo
• Descripcion : El keyword $lifecycle proporciona detalles sobre los cambios de propiedades y restricciones, como las propiedades de reemplazo y las obsolescencias de los valores de enumeración. proporciona detalles sobre los cambios de propiedades y restricciones, como las propiedades de reemplazo y las obsolescencias de los valores de enumeración.

replacedBy

• Tipo : array
• Finalidad : Informativo
• Descripcion : El keyword replacedBy contiene una array de punteros JSON relativos de acuerdo con esta specification . .

replaces

• Tipo : array
• Finalidad : Informativo
• Descripcion : El keyword replaces contiene una array de punteros JSON relativos de acuerdo con esta specification .

enumDeprecated

• Tipo : array
• Finalidad : Informativo
• Descripcion : El keyword enumDeprecated contiene una array de valores de enumeración que están obsoletos y se eliminarán en el futuro. Los usos existentes de estos valores de enumeración en desuso deben reemplazarse con otros valores antes de que se eliminen. contiene una array de valores de enumeración que están obsoletos y se eliminarán en el futuro. Los usos existentes de estos valores de enumeración en desuso deben reemplazarse con otros valores antes de que se eliminen.

enumReplacement

• Tipo : array
• Finalidad : Informativo
• Descripcion : El keyword enumReplacement contiene una array de objetos que representan valores de enumeración obsoletos y sus valores de reemplazo sugeridos. Los usos existentes de estos valores de enumeración en desuso deben reemplazarse con otros valores antes de que se eliminen. contiene una array de objetos que representan valores de enumeración obsoletos y sus valores de reemplazo sugeridos. Los usos existentes de estos valores de enumeración en desuso deben reemplazarse con otros valores antes de que se eliminen.

Ejemplos de implementaciones de validador

JSON Schema es un vocabulario que le permite anotar y validar documentos JSON. Los autores de JSON Schema no ofrecen herramientas específicas para validar documentos con JSON Schema, sino que JSON Schema define cómo las herramientas deben validar documentos con JSON Schema.

Existen varias bibliotecas y aplicaciones pagas y de código abierto que admiten el esquema JSON; consulte Implementaciones del esquema JSON para obtener una lista de implementaciones conocidas.

Las siguientes implementaciones de validador de referencia proporcionan ejemplos de cómo validar vocabulario personalizado para instancias de Amazon Product Type Definition Meta-Schema utilizando bibliotecas de código abierto específicas del idioma. No hay ningún requisito para usar estas bibliotecas específicas o las implementaciones de ejemplo. Amazon no proporciona soporte técnico para bibliotecas de esquemas JSON de terceros y se proporcionan solo como ejemplos.

.NETO

Para aplicaciones C# .NET, la biblioteca de esquemas Newtonsoft Json.NET es compatible con JSON Schema Draft 2019-09 y vocabularios personalizados. El siguiente ejemplo demuestra cómo utilizar la biblioteca Newtonsoft Json.NET Schema para validar cargas útiles con instancias del Amazon Product Type Definition Meta-Schema .

Ejemplo de implementación del validador para .NET

Java

Para aplicaciones Java, la biblioteca networknt/json-schema-validator es compatible con JSON Schema Draft 2019-09 y vocabularios personalizados. El siguiente ejemplo demuestra cómo utilizar la biblioteca networknt/json-schema-validator para validar cargas útiles con instancias del Amazon Product Type Definition Meta-Schema .

Ejemplo de implementación del validador para Java

JavaScript

Para aplicaciones de JavaScript (incluido Node.js), la biblioteca hyperjump-io/json-schema-validator admite JSON Schema Draft 2019-09 y vocabularios personalizados. El siguiente ejemplo demuestra cómo utilizar la biblioteca hyperjump-io/json-schema-validator para validar cargas útiles con instancias del Amazon Product Type Definition Meta-Schema .

Ejemplo de implementación de validador para JavaScript