...
- type: Indica o tipo de dado do campo, mais detalhes consultar o tópico Tipos de dados padrão.
- description: é importante que a descrição esteja bem detalhada, lembre-se que para o analista que está propondo um campo, o objetivo deste campo é sempre muito óbvio, porém próximos analistas do mesmo produto ou até analistas de outros produtos sempre terão dificuldade caso o campo não esteja bem documentado.
- x-totvs: propriedade customizada com a documentação referente ao campo em cada produto Totvs.
Padrão de nomenclatura
Os nomes dos campos na mensagem única devem respeitar as regras a seguir:
...
Bloco de código |
---|
|
"BankCode": {
"description": "Código do banco",
"type": "integer",
"format": "int32"
} |
Long
type: integer
...
Bloco de código |
---|
|
"BankCode": {
"description": "Código do banco",
"type": "integer",
"format": "int64"
} |
Float
type: number
...
Bloco de código |
---|
|
"UnitsPerHour": {
"type": "number",
"format": "float"
} |
Double
...
Bloco de código |
---|
|
"CreditLimit":{
"type":"number",
"format":"double"
} |
Propriedades de validação
...