Editando definições de esquema

Os esquemas fornecem aos desenvolvedores informações sobre a solicitação que eles devem fazer ou a resposta que eles devem esperar receber ao chamar uma operação de API. É possível editar esquemas que foram criados anteriormente em vários lugares em sua definição de API.

É possível definir as seguintes configurações de definição de esquema:

• Nome do esquema: esse nome define uma chave que permite que esse esquema seja referenciado de outro lugar na definição de API; a referência tem o formato a seguir:

  #/definitions/Name

  Para mudar o nome, clique no ícone Origem , mude o valor no campo e, em seguida, clique em Salvar.
• Opcional: Título: O título do esquema
• Tipo: O tipo de dados do esquema; selecione um dos seguintes:
  • • Matriz
    • Booleano
    • Número inteiro
    • número
    • objeto
    • sequência

  Nota: se você mudar o tipo de um esquema existente, quaisquer configurações existentes que não sejam relevantes para o novo tipo ainda serão retidas na origem OpenAPI , mesmo que não sejam mais exibidas na interface com o usuário. Portanto, é necessário evitar a portabilidade de um esquema de um tipo para outro, mas, em vez disso, criar um novo esquema ou modificar a origem OpenAPI diretamente; para abrir o editor de origem, clique no ícone Origem .
• Propriedades: a propriedade do esquema. Para incluir uma propriedade no esquema, clique em Incluir ao lado do título da seção Propriedades , conclua os detalhes e clique em Salvar.
• Configurações de esquema adicionais dependentes do Tipo selecionado de propriedade Para visualizar e editar essas configurações de esquema, clique no Menu Opções próximo à propriedade que deseja visualizar e selecione Detalhes.
  • booleano: sem configurações específicas do tipo.
  • inteiro :
    • Formato: um modificador de tipo de dados opcional. Para obter mais informações, consulte Tipos de dados no OpenAPI Specification
    • Múltiplo de: a divisão de uma instância de número inteiro por este valor deve resultar em um número inteiro.
    • Máximo: uma instância de número inteiro deve ser menor ou igual a este valor.
    • Máximo exclusivo: uma instância de número inteiro deve ser estritamente inferior a este valor.
    • Mínimo: uma instância de número inteiro deve ser maior ou igual a este valor.
    • Mínimo exclusivo: uma instância de número inteiro deve ser estritamente maior do que este valor.
  • número:
    • Formato: um modificador de tipo de dados opcional. Para obter mais informações, consulte Tipos de dados no OpenAPI Specification
    • Múltiplo de: a divisão de uma instância de número por este valor deve resultar em um número inteiro.
    • Máximo: uma instância de número deve ser menor ou igual a este valor.
    • Máxima exclusiva: uma instância de número deve ser estritamente inferior a este valor.
    • Mínimo: uma instância de número deve ser maior ou igual a este valor.
    • Mínimo exclusivo: uma instância de número deve ser estritamente maior do que este valor.
  • objeto:.
    • Máximo de propriedades: o número de propriedades em uma instância de objeto deve ser menor ou igual a este valor.
    • Mínimo de propriedades: o número de propriedades em uma instância de objeto deve ser maior ou igual a este valor.
    • Propriedades necessárias: uma matriz de nomes de propriedade; todo nome de propriedade na matriz deve ser o nome de uma propriedade em uma instância de objeto. Para incluir um nome de propriedade necessário, clique em Incluir ao lado do título da seção Propriedades necessárias, digite o nome, em seguida, clique em Criar.
  • sequência:
    • Formato: um modificador de tipo de dados opcional. Para obter mais informações, consulte Tipos de dados no OpenAPI Specification
    • Padrão: uma expressão regular; uma instância de sequência deve combinar com sucesso a expressão.
    • Máximo de comprimento: o número máximo permitido de caracteres em uma instância de sequência.
    • Mínimo de comprimento: o número mínimo permitido de caracteres em uma instância de sequência.
    • Enumeração: uma matriz de valores de sequência; uma instância de sequência deve corresponder a um dos valores da matriz. Para incluir um valor numérico, clique em Incluir, insira o valor e, em seguida, clique em Criar.
• Configurações gerais; selecione as opções necessárias:
  • Necessário: Uma propriedade associada a este esquema é necessária.
  • Somente leitura: uma propriedade associada a este esquema pode ser retornada em uma resposta, mas não deve ser incluída em uma solicitação. Por exemplo, propriedades cujos valores são identificadores gerados pelo sistema serão definidas como Somente leitura porque os clientes de aplicativos não seriam capazes de configurá-las.
• Valor de Exemplo: um valor de exemplo. O que quer que você insira aqui é exibido no estado em que se encontra no Portal do Desenvolvedor
• Documentação Externa: Um recurso externo para documentação estendida; forneça as seguintes informações:
  • URL (necessário): a URL para a documentação de destino.
  • Descrição: uma descrição opcional da documentação de destino. É possível usar a sintaxeCommonMark para representação de rich text.
• Xml: Metadados que permitem mais definições de modelo XML ajustado; forneça as seguintes informações:
  • Nome: Substitui o nome do elemento ou atributo usado para a propriedade do esquema descrito.
  • Namespace : O endereço URL da definição do namespace.
  • Prefixo: o prefixo a ser usado para o Nome.
  • Atributo: Especifica se a definição de propriedade se traduz em um atributo em vez de um elemento.
  • Wrapped: Para uma definição de matriz, especifica se a matriz é agrupada (por exemplo, <books><book/><book/></books>) ou desagrupada (<book/><book/>).
• Clique em Salvar quando concluído.