From 5d41cfe8a84db61193d981a06a340a449419f23d Mon Sep 17 00:00:00 2001 From: andre.guimaraes Date: Fri, 1 Jun 2018 10:19:58 -0300 Subject: [PATCH] Atualiza a documentação --- apidoc.json | 3 ++- src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java | 44 ++++++++++++++++++++++++++++++++++++++++++++ src/main/webapp/api-docs/api_data.js | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--- src/main/webapp/api-docs/api_data.json | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--- src/main/webapp/api-docs/api_project.js | 10 +++++++++- src/main/webapp/api-docs/api_project.json | 10 +++++++++- 6 files changed, 298 insertions(+), 9 deletions(-) diff --git a/apidoc.json b/apidoc.json index 382a562..2ba1821 100644 --- a/apidoc.json +++ b/apidoc.json @@ -3,5 +3,6 @@ "version": "2.0.0", "description": "Documentação da camada de integração ANS X SEI. Essa documentação serve para apoiar aos consumidores da camada de integração, pode ser necessário consultar a documentação oficial do SEI para melhor entendimento do negócio e seus objetos. Mais informações do SEI-Broker veja o artigo wiki.", "title": "Documentação - sei-broker", - "url":"https:///sei-broker/service" + "url":"https:///sei-broker/service", + "order":["Processo","Documento","Bloco","Unidade","Contato","Arquivo"] } \ No newline at end of file diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java index 0da0bbf..49b977c 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java @@ -1299,6 +1299,50 @@ public class ProcessoResource { } } + /** + * @api {get} /processos/:processo/unidades Consultar unidades + * @apiName consultarUnidadesProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta as unidades onde o processo está aberto. + * + * @apiParam (Path Parameters) {String} processo Número do processo. + * + * @apiExample Exemplo de requisição: + * curl -i https:///sei-broker/service/processos/33910002924201874/unidades + * + * @apiSuccess (Sucesso Response Body - 200) {List} unidades Lista da unidades onde o processo está aberto. + * @apiSuccess (Sucesso Response Body - 200) {Unidade} unidades.unidade Objeto Unidade. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.idUnidade Identificador da unidade. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sigla Sigla de unidade. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.descricao Descrição da unidade. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinProtocolo Descrição pendente da área de negócio. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinArquivamento Descrição pendente da área de negócio. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinOuvidoria Descrição pendente da área de negócio. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * [ + * { + * "idUnidade": "110000934", + * "sigla": "COSAP", + * "descricao": "Coordenadoria de Sistemas e Aplicativos", + * "sinProtocolo": "S", + * "sinArquivamento": "N", + * "sinOuvidoria": "N" + * } + * ] + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"código do erro" + * } + */ @GET @Path("/processos/{processo:\\d+}/unidades") @Produces(MediaType.APPLICATION_JSON) diff --git a/src/main/webapp/api-docs/api_data.js b/src/main/webapp/api-docs/api_data.js index 73a9424..705c0ef 100644 --- a/src/main/webapp/api-docs/api_data.js +++ b/src/main/webapp/api-docs/api_data.js @@ -1352,9 +1352,9 @@ define({ "api": [ "type": "", "url": "", "version": "0.0.0", - "filename": "sei-broker/target/sei-broker-2.5.1/api-docs/main.js", - "group": "C__git_sei_broker_target_sei_broker_2_5_1_api_docs_main_js", - "groupTitle": "C__git_sei_broker_target_sei_broker_2_5_1_api_docs_main_js", + "filename": "sei-broker/target/sei-broker-2.6/api-docs/main.js", + "group": "C__git_sei_broker_target_sei_broker_2_6_api_docs_main_js", + "groupTitle": "C__git_sei_broker_target_sei_broker_2_6_api_docs_main_js", "name": "" }, { @@ -6886,6 +6886,120 @@ define({ "api": [ "groupTitle": "Processo" }, { + "type": "get", + "url": "/processos/:processo/unidades", + "title": "Consultar unidades", + "name": "consultarUnidadesProcesso", + "group": "Processo", + "version": "2.0.0", + "permission": [ + { + "name": "RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA" + } + ], + "description": "

Consulta as unidades onde o processo está aberto.

", + "parameter": { + "fields": { + "Path Parameters": [ + { + "group": "Path Parameters", + "type": "String", + "optional": false, + "field": "processo", + "description": "

Número do processo.

" + } + ] + } + }, + "examples": [ + { + "title": "Exemplo de requisição:\t", + "content": "curl -i https:///sei-broker/service/processos/33910002924201874/unidades", + "type": "json" + } + ], + "success": { + "fields": { + "Sucesso Response Body - 200": [ + { + "group": "Sucesso Response Body - 200", + "type": "List", + "optional": false, + "field": "unidades", + "description": "

Lista da unidades onde o processo está aberto.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "Unidade", + "optional": false, + "field": "unidades.unidade", + "description": "

Objeto Unidade.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.idUnidade", + "description": "

Identificador da unidade.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.sigla", + "description": "

Sigla de unidade.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.descricao", + "description": "

Descrição da unidade.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.sinProtocolo", + "description": "

Descrição pendente da área de negócio.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.sinArquivamento", + "description": "

Descrição pendente da área de negócio.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.sinOuvidoria", + "description": "

Descrição pendente da área de negócio.

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n[\n\t{\n \t \"idUnidade\": \"110000934\",\n \t \"sigla\": \"COSAP\",\n \t \"descricao\": \"Coordenadoria de Sistemas e Aplicativos\",\n \t \"sinProtocolo\": \"S\",\n \t \"sinArquivamento\": \"N\",\n \t \"sinOuvidoria\": \"N\"\n\t}\n]", + "type": "json" + } + ] + }, + "error": { + "examples": [ + { + "title": "Error-Response:", + "content": "HTTP/1.1 500 Internal Server Error\n{\n\t\"error\":\"Mensagem de erro.\"\n\t\"code\":\"código do erro\"\n}", + "type": "json" + } + ] + }, + "filename": "sei-broker/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java", + "groupTitle": "Processo" + }, + { "type": "delete", "url": "/:unidade/processos/:processo/anexados/:processoAnexado", "title": "Desanexar processo", diff --git a/src/main/webapp/api-docs/api_data.json b/src/main/webapp/api-docs/api_data.json index 1eb0280..853bdf9 100644 --- a/src/main/webapp/api-docs/api_data.json +++ b/src/main/webapp/api-docs/api_data.json @@ -1352,9 +1352,9 @@ "type": "", "url": "", "version": "0.0.0", - "filename": "sei-broker/target/sei-broker-2.5.1/api-docs/main.js", - "group": "C__git_sei_broker_target_sei_broker_2_5_1_api_docs_main_js", - "groupTitle": "C__git_sei_broker_target_sei_broker_2_5_1_api_docs_main_js", + "filename": "sei-broker/target/sei-broker-2.6/api-docs/main.js", + "group": "C__git_sei_broker_target_sei_broker_2_6_api_docs_main_js", + "groupTitle": "C__git_sei_broker_target_sei_broker_2_6_api_docs_main_js", "name": "" }, { @@ -6886,6 +6886,120 @@ "groupTitle": "Processo" }, { + "type": "get", + "url": "/processos/:processo/unidades", + "title": "Consultar unidades", + "name": "consultarUnidadesProcesso", + "group": "Processo", + "version": "2.0.0", + "permission": [ + { + "name": "RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA" + } + ], + "description": "

Consulta as unidades onde o processo está aberto.

", + "parameter": { + "fields": { + "Path Parameters": [ + { + "group": "Path Parameters", + "type": "String", + "optional": false, + "field": "processo", + "description": "

Número do processo.

" + } + ] + } + }, + "examples": [ + { + "title": "Exemplo de requisição:\t", + "content": "curl -i https:///sei-broker/service/processos/33910002924201874/unidades", + "type": "json" + } + ], + "success": { + "fields": { + "Sucesso Response Body - 200": [ + { + "group": "Sucesso Response Body - 200", + "type": "List", + "optional": false, + "field": "unidades", + "description": "

Lista da unidades onde o processo está aberto.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "Unidade", + "optional": false, + "field": "unidades.unidade", + "description": "

Objeto Unidade.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.idUnidade", + "description": "

Identificador da unidade.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.sigla", + "description": "

Sigla de unidade.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.descricao", + "description": "

Descrição da unidade.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.sinProtocolo", + "description": "

Descrição pendente da área de negócio.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.sinArquivamento", + "description": "

Descrição pendente da área de negócio.

" + }, + { + "group": "Sucesso Response Body - 200", + "type": "String", + "optional": false, + "field": "unidades.unidade.sinOuvidoria", + "description": "

Descrição pendente da área de negócio.

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n[\n\t{\n \t \"idUnidade\": \"110000934\",\n \t \"sigla\": \"COSAP\",\n \t \"descricao\": \"Coordenadoria de Sistemas e Aplicativos\",\n \t \"sinProtocolo\": \"S\",\n \t \"sinArquivamento\": \"N\",\n \t \"sinOuvidoria\": \"N\"\n\t}\n]", + "type": "json" + } + ] + }, + "error": { + "examples": [ + { + "title": "Error-Response:", + "content": "HTTP/1.1 500 Internal Server Error\n{\n\t\"error\":\"Mensagem de erro.\"\n\t\"code\":\"código do erro\"\n}", + "type": "json" + } + ] + }, + "filename": "sei-broker/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java", + "groupTitle": "Processo" + }, + { "type": "delete", "url": "/:unidade/processos/:processo/anexados/:processoAnexado", "title": "Desanexar processo", diff --git a/src/main/webapp/api-docs/api_project.js b/src/main/webapp/api-docs/api_project.js index dc63cc7..07e89c7 100644 --- a/src/main/webapp/api-docs/api_project.js +++ b/src/main/webapp/api-docs/api_project.js @@ -4,11 +4,19 @@ define({ "description": "Documentação da camada de integração ANS X SEI. Essa documentação serve para apoiar aos consumidores da camada de integração, pode ser necessário consultar a documentação oficial do SEI para melhor entendimento do negócio e seus objetos. Mais informações do SEI-Broker veja o artigo wiki.", "title": "Documentação - sei-broker", "url": "https:///sei-broker/service", + "order": [ + "Processo", + "Documento", + "Bloco", + "Unidade", + "Contato", + "Arquivo" + ], "sampleUrl": false, "apidoc": "0.2.0", "generator": { "name": "apidoc", - "time": "2018-05-22T12:20:37.124Z", + "time": "2018-06-01T13:15:34.429Z", "url": "http://apidocjs.com", "version": "0.15.1" } diff --git a/src/main/webapp/api-docs/api_project.json b/src/main/webapp/api-docs/api_project.json index 4b6cfc0..4394616 100644 --- a/src/main/webapp/api-docs/api_project.json +++ b/src/main/webapp/api-docs/api_project.json @@ -4,11 +4,19 @@ "description": "Documentação da camada de integração ANS X SEI. Essa documentação serve para apoiar aos consumidores da camada de integração, pode ser necessário consultar a documentação oficial do SEI para melhor entendimento do negócio e seus objetos. Mais informações do SEI-Broker veja o artigo wiki.", "title": "Documentação - sei-broker", "url": "https:///sei-broker/service", + "order": [ + "Processo", + "Documento", + "Bloco", + "Unidade", + "Contato", + "Arquivo" + ], "sampleUrl": false, "apidoc": "0.2.0", "generator": { "name": "apidoc", - "time": "2018-05-22T12:20:37.124Z", + "time": "2018-06-01T13:15:34.429Z", "url": "http://apidocjs.com", "version": "0.15.1" } -- libgit2 0.21.2