Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • x-totvs dentro dos verbos dos endpoints 
    Âncora
    xtotvs-paths
    xtotvs-paths

    O exemplo a seguir também é um trecho da API UnitOfMeasure v2.

    Bloco de código
    languagejs
    titleExemplo
    collapsetrue
    (...)
    "paths": {
    		"/UnitOfMeasures": {
    			"get": {
    				"tags": [
    					"UnitOfMeasures"
    				],
    				"summary": "Retorna lista de Unidade de Medida",
    				"x-totvs": {
    					"productInformation": [
    						{
    							"product": "Protheus",
    							"available": true,
    							"note": "Este verbo esta disponivel com todos os parametros",
    							"minimalVersion": "12.1.21"
    						},
    						{
    							"product": "Logix",
    							"available": true,
    							"note": "Este verbo esta disponivel com todos os parametros",
    							"minimalVersion": "12.1.23"
    						}
    					]
    				}
    (...)

    Diferentemente do x-totvs da "info",  a propriedade "messageDocumentation" não está presente nos x-totvs dos "paths".

    Já a propriedade "productInformation" traz informações sobre os produtos TOTVS.

    • product: produto ao qual aquelas informações do "productInformation" se referem;
    • available: campo booleano que indicia de o verbo esta implementado no produto;
    • note: observações sobre o verbo referente ao produto, como regras específicas;
    • minimalVersion: a versão minima na qual o verbo foi implementado no produto.
Aviso

O validador automatizado no GitHub avalia a consistência dos 'products' declarados na info e nos paths. Caso um dado produto tenha implementado algum dos endpoints de uma API, ele deve ser declarado no 'productInformation' daquele endpoint e também na 'info'. Analogamente, um dado produto só pode estar declarado na 'info' se tiver implementado pelo menos um dos endpoints daquela API.


Sinta-se à vontade para navegar por nossas APIs, tanto pelo API Reference quanto pelo nosso repositório do GitHub, e observar como estão configurados seus respectivos x-totvs!

...