Meta-Schema de definição de tipo de produto da Amazon (v1)

O meta-esquema ("Meta-Schema") de definição de tipo de produto da Amazon é uma extensão do JSON Schema Draft 2019-09 que descreve as propriedades e os requisitos de um tipo de produto da Amazon, como LUGGAGE.

URI do esquema: https://schemas.amazon.com/selling-partners/definitions/product-types/meta-schema/v1

URI do vocabulário: https://schemas.amazon.com/selling-partners/definitions/product-types/vocabulary/v1

As instâncias do Meta-Schema de definição de tipo de produto da Amazon podem utilizar qualquer uma das palavras-chave e vocabulários suportados pelo JSON Schema Draft 2019-09. Consulte https://json-schema.org/specification.html para obter mais detalhes.

Além dos vocabulários padrão do JSON Schema Draft 2019-09, as instâncias do Meta-Schema de definição de tipo de produto da Amazon utilizam palavras-chave definidas como vocabulário personalizado no Meta-Schema. Esta documentação descreve o vocabulário personalizado para o URI https://schemas.amazon.com/selling-partners/definitions/product-types/vocabulary/v1.

Os consumidores de instâncias do Meta-Schema de definição de tipo de produto da Amazon podem optar por ignorar o vocabulário personalizado e usar apenas os vocabulários padrão do JSON Schema Draft 2019-09. Isso validará a maioria dos requisitos de um tipo de produto da Amazon, mas pode resultar em alguns erros de validação no envio.

Vocabulário

`editable`

Tipo: boolean
Objetivo: Informativo
Descrição: A palavra-chave editable indica se um valor de propriedade pode ou não ser alterado para um item existente. As propriedades que não são editáveis ainda podem ser necessárias para um envio válido, mas não podem ser alteradas em relação ao valor original.

`enumNames`

Tipo: array
Objetivo: Informativo
Descrição: a palavra-chave enumNames contém um vetor (array) de rótulos de exibição para um vetor correspondente de valores do tipo enum. Os rótulos de exibição no vetor enumNames estão na mesma ordem que os valores no vetor enum.

`hidden`

Tipo: boolean
Objetivo: Informativo
Descrição: a palavra-chave hidden sugere se uma propriedade deve ou não ser ocultada nas interfaces de usuário da Amazon. Ocultar ou exibir essas propriedades fica a critério do aplicativo que consome o Meta-Schema de definição de tipo de produto da Amazon.

`maxUniqueItems`

Tipo: integer
Objetivo: Validação
Descrição: em conjunto com a palavra-chave selectors, o valor da palavra-chave maxUniqueItems define o número máximo de itens exclusivos em um vetor.

`minUniqueItems`

Tipo: integer
Objetivo: Validação
Descrição: em conjunto com a palavra-chave selectors, o valor da palavra-chave minUniqueItems define o número mínimo de itens exclusivos em um vetor.

`maxUtf8ByteLength`

Tipo: integer
Objetivo: Validação
Descrição: o valor da palavra-chave maxUtf8ByteLength define o comprimento máximo de um valor de uma string medido em bytes UTF-8.

`minUtf8ByteLength`

Type: integer
Purpose: Validation
Description: o valor da palavra-chave minUtf8ByteLength define o comprimento mínimo de um valor de uma string medido em bytes UTF-8.

`selectors`

Tipo: array
Objetivo: Validação
Descrição: a palavra-chave selectors contém um vetor de nomes de propriedades que definem a combinação de propriedades que tornam um objeto exclusivo. Por padrão, o JSON Schema determina a exclusividade dos objetos em um vetor com base em todas as propriedades do objeto. Quando os selectors são definidos, apenas as propriedades especificadas são usadas para determinar a exclusividade.

Exemplos de Implementações do Validador

JSON Schema é um vocabulário que permite anotar e validar documentos JSON. Os autores do JSON Schema não fornecem ferramentas específicas para validar documentos com JSON Schema, em vez disso, JSON Schema define como as ferramentas devem validar documentos com JSON Schema.

Existem vários aplicativos e bibliotecas pagos e de código aberto que suportam JSON Schema, consulte https://json-schema.org/implementations.html para obter uma lista de implementações conhecidas.

As implementações do validador de referência a seguir fornecem exemplos de como validar o vocabulário personalizado para instâncias do Meta-Schema de definição de tipo de produto da Amazon usando bibliotecas de código aberto específicas da linguagem. Não há necessidade de usar essas bibliotecas específicas ou as implementações de exemplo. A Amazon não fornece suporte técnico para bibliotecas de esquema JSON de terceiros, elas são fornecidas apenas como exemplos.

.NET

Para aplicativos C# .NET, a biblioteca Newtonsoft Json.NET Schema é compatível com JSON Schema Draft 2019-09 e vocabulários personalizados. O exemplo a seguir demonstra como utilizar a biblioteca Newtonsoft Json.NET Schema para validar cargas com instâncias do Meta-Schema de definição de tipo de produto da Amazon.

Exemplo de implementação do validador para .NET

Java

Para aplicativos Java, a biblioteca networknt/json-schema-validator é compatível com JSON Schema Draft 2019-09 e vocabulários personalizados. O exemplo a seguir demonstra como utilizar a biblioteca networknt/json-schema-validator para validar cargas com instâncias do Meta-Schema de definição de tipo de produto da Amazon.

Exemplo de implementação do validador para Java

JavaScript

Para aplicativos JavaScript (incluindo Node.js), a biblioteca hyperjump-io/json-schema-validator é compatível com JSON Schema Draft 2019-09 e vocabulários personalizados. O exemplo a seguir demonstra como utilizar a biblioteca hyperjump-io/json-schema-validator para validar cargas com instâncias do Meta-Schema de definição de tipo de produto da Amazon.

Exemplo de implementação do validador para JavaScript