Versões comparadas

Chave

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

...

x-totvs em diferentes partes do OpenAPI

  • x-totvs dentro da "info"

    :

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

    Bloco de código
    languagejs
    titleExemplo
    collapsetrue
    (...)
    
    
    "info": {
    
    		"description": "API para informações de Unidade de Medida para Unidade de Medida TOTVS",
    
    		"version": "2.000",
    
    		"title": "UnitOfMeasure",
    
    		"contact": {
    
    			"name": "T-Talk",
    
    			"url": "api.totvs.com.br",
    
    			"email": "[email protected]"
    
    		},
    
    		"x-totvs": {
    
    			"messageDocumentation": {
    
    				"name": "UnitOfMeasure",
    
    				"description": "Cadastro de Unidade de Medida",
    
    				"segment": "Serviços"
    
    			},
    
    			"productInformation": [
    
    				{
    
    					"product": "Protheus",
    
    					"contact": "[email protected]",
    
    					"description": "Cadastro de Unidade de Medida",
    
    					"adapter": "QIES030.prw"
    
    				},
    
    				{
    
    					"product": "Logix",
    
    					"contact": "[email protected]",
    
    					"description": "Cadastro de Unidade de Medida",
    
    					"adapter": ""
    
    				}
    
    			]
    
    		}
    
    	}
    (...)
    

    A propriedade "messageDocumentation" do "x-totvs" traz informações sobre a própria API.

...

  • x-totvs dentro dos verbos dos "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.

...