Skip to content

Teste/documentacao #908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nathanramorim wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Teste/documentacao #908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
635c76f
Add files via upload
nathanramorim Jun 1, 2021
722a5ee
Add files via upload
nathanramorim Jun 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
329 changes: 329 additions & 0 deletions jsonschema/apis/Apac_v1_000.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,329 @@
{
"openapi": "3.0.1",
"servers": [
{
"description": "API de APAC",
"url": "{{host}}/api/hcg/v1",
"variables": {
"serverUrl": {
"default": "localhost"
},
"serverHttpPort": {
"default": "8051"
}
}
}
],
"info": {
"description": "API de APAC",
"version": "1.000",
"title": "APAC",
"contact": {
"name": "T-Talk",
"url": "api.totvs.com.br",
"email": "comiteintegracao@totvs.com.br"
},
"x-totvs": {
"messageDocumentation": {
"name": "Apac",
"description": "APAC",
"segment": "Saúde"
},
"productInformation": [
{
"product": "RM",
"contact": "TribeSau.Squads@totvs.com.br",
"description": "APAC",
"adapter": "",
"helpUrl": ""
}
]
}
},
"paths": {
"/apac": {
"get": {
"tags": [
"apac"
],
"summary": "Listagem de registros",
"description": "Retorna uma lista de registros",
"operationId": "GetAll",
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Este verbo está disponível com todos os parâmetros",
"minimalVersion": "12.1.32"
}
]
},
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
}
],
"responses": {
"200": {
"description": "Registros recuperados com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/schemas/Apac_1_000.json#/definitions/PagedApac"
}
}
}
},
"404": {
"description": "Erro no momento da recuperação dos registros.",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
}
},
"post": {
"tags": [
"apac"
],
"summary": "Insere um registro",
"description": "Insere um registro",
"operationId": "Post",
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Este verbo não esta disponivel",
"minimalVersion": "12.1.32"
}
]
},
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
}
],
"requestBody": {
"description": "Objeto para inserir um registro",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/schemas/Apac_1_000.json#/definitions/Apac"
}
}
}
},
"responses": {
"200": {
"description": "Registro inserido com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/schemas/Apac_1_000.json#/definitions/Apac"
}
}
}
},
"400": {
"description": "Erro no momento da alteração",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
}
}
},
"/apac/{id}": {
"get": {
"tags": [
"apac"
],
"summary": "Recupera um registro",
"description": "Recupera um registro",
"operationId": "GetOne",
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Este verbo está disponível com todos os parâmetros.",
"minimalVersion": "12.1.32"
}
]
},
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Expand"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
},
{
"$ref": "#/components/parameters/id"
}
],
"responses": {
"200": {
"description": "Registro recuperado com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/schemas/Apac_1_000.json#/definitions/Apac"
}
}
}
},
"404": {
"description": "Erro no momento da recuperação do registro.",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
}
},
"put": {
"tags": [
"apac"
],
"summary": "Atualiza um registro",
"description": "Atualiza um registro",
"operationId": "Put",
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Este verbo esta disponivel apenas para o campo MainProcedureCode (procedimento principal).",
"minimalVersion": "12.1.32"
}
]
},
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
},
{
"$ref": "#/components/parameters/id",
"required": "true"
}
],
"requestBody": {
"description": "Objeto para atualizar registro",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/schemas/Apac_1_000.json#/definitions/Apac"
}
}
}
},
"responses": {
"200": {
"description": "Registro atualizado com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/schemas/Apac_1_000.json#/definitions/Apac"
}
}
}
},
"400": {
"description": "Erro no momento da alteração",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
}
},
"delete": {
"tags": [
"apac"
],
"summary": "Exclui um registro",
"x-totvs": {
"productInformation": [
{
"product": "RM",
"available": true,
"note": "Este verbo não está disponível.",
"minimalVersion": "12.1.32"
}
]
},
"description": "Exclui um registro",
"operationId": "Delete",
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
},
{
"$ref": "#/components/parameters/id"
}
],
"responses": {
"200": {
"description": "Registro excluído com sucesso"
},
"400": {
"description": "Erro no momento da exclusão do registro.",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/Apac/V1/1_000/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
}
}
}
},
"components": {
"parameters": {
"id": {
"name": "id",
"in": "path",
"description": "Cod. Coligada, Id. APAC, Sequencial APAC",
"required": true,
"schema": {
"type": "string"
}
}
},
"schemas": {}
}
}
Loading