Download as
Browse Code »

Commit 5d41cfe8a84db61193d981a06a340a449419f23d

Authored by andre.guimaraes
1 parent a1e3c1bb
Exists in master and in 1 other branch removing-depencies

Atualiza a documentação 

Atualizações na documentação do api-docs.

- Incluído o serviço de consultar unidades do processo.
- Alterada a ordem de exibição dos domínios, priorizando os mais
utilizados.
Showing 6 changed files with 298 additions and 9 deletions   Show diff stats
apidoc.json
  Diff comments   View file @5d41cfe
... ... @@ -3,5 +3,6 @@
3 3 "version": "2.0.0",
4 4 "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 <a href=\"https://softwarepublico.gov.br/social/sei/manuais\">documentação oficial do SEI</a> para melhor entendimento do negócio e seus objetos. Mais informações do SEI-Broker veja o <a href=\"http://wiki.ans.gov.br/index.php/Sei-broker\">artigo wiki</a>.",
5 5 "title": "Documentação - sei-broker",
6   - "url":"https://<host>/sei-broker/service"
  6 + "url":"https://<host>/sei-broker/service",
  7 + "order":["Processo","Documento","Bloco","Unidade","Contato","Arquivo"]
7 8 }
8 9 \ No newline at end of file
... ...
src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java
  Diff comments   View file @5d41cfe
... ... @@ -1299,6 +1299,50 @@ public class ProcessoResource {
1299 1299 }
1300 1300 }
1301 1301  
  1302 + /**
  1303 + * @api {get} /processos/:processo/unidades Consultar unidades
  1304 + * @apiName consultarUnidadesProcesso
  1305 + * @apiGroup Processo
  1306 + * @apiVersion 2.0.0
  1307 + *
  1308 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  1309 + *
  1310 + * @apiDescription Consulta as unidades onde o processo está aberto.
  1311 + *
  1312 + * @apiParam (Path Parameters) {String} processo Número do processo.
  1313 + *
  1314 + * @apiExample Exemplo de requisição:
  1315 + * curl -i https://<host>/sei-broker/service/processos/33910002924201874/unidades
  1316 + *
  1317 + * @apiSuccess (Sucesso Response Body - 200) {List} unidades Lista da unidades onde o processo está aberto.
  1318 + * @apiSuccess (Sucesso Response Body - 200) {Unidade} unidades.unidade Objeto Unidade.
  1319 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.idUnidade Identificador da unidade.
  1320 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sigla Sigla de unidade.
  1321 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.descricao Descrição da unidade.
  1322 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinProtocolo Descrição pendente da área de negócio.
  1323 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinArquivamento Descrição pendente da área de negócio.
  1324 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinOuvidoria Descrição pendente da área de negócio.
  1325 + *
  1326 + * @apiSuccessExample {json} Success-Response:
  1327 + * HTTP/1.1 200 OK
  1328 + * [
  1329 + * {
  1330 + * "idUnidade": "110000934",
  1331 + * "sigla": "COSAP",
  1332 + * "descricao": "Coordenadoria de Sistemas e Aplicativos",
  1333 + * "sinProtocolo": "S",
  1334 + * "sinArquivamento": "N",
  1335 + * "sinOuvidoria": "N"
  1336 + * }
  1337 + * ]
  1338 + *
  1339 + * @apiErrorExample {json} Error-Response:
  1340 + * HTTP/1.1 500 Internal Server Error
  1341 + * {
  1342 + * "error":"Mensagem de erro."
  1343 + * "code":"código do erro"
  1344 + * }
  1345 + */
1302 1346 @GET
1303 1347 @Path("/processos/{processo:\\d+}/unidades")
1304 1348 @Produces(MediaType.APPLICATION_JSON)
... ...
src/main/webapp/api-docs/api_data.js
  Diff comments   View file @5d41cfe
... ... @@ -1352,9 +1352,9 @@ define({ &quot;api&quot;: [
1352 1352 "type": "",
1353 1353 "url": "",
1354 1354 "version": "0.0.0",
1355   - "filename": "sei-broker/target/sei-broker-2.5.1/api-docs/main.js",
1356   - "group": "C__git_sei_broker_target_sei_broker_2_5_1_api_docs_main_js",
1357   - "groupTitle": "C__git_sei_broker_target_sei_broker_2_5_1_api_docs_main_js",
  1355 + "filename": "sei-broker/target/sei-broker-2.6/api-docs/main.js",
  1356 + "group": "C__git_sei_broker_target_sei_broker_2_6_api_docs_main_js",
  1357 + "groupTitle": "C__git_sei_broker_target_sei_broker_2_6_api_docs_main_js",
1358 1358 "name": ""
1359 1359 },
1360 1360 {
... ... @@ -6886,6 +6886,120 @@ define({ &quot;api&quot;: [
6886 6886 "groupTitle": "Processo"
6887 6887 },
6888 6888 {
  6889 + "type": "get",
  6890 + "url": "/processos/:processo/unidades",
  6891 + "title": "Consultar unidades",
  6892 + "name": "consultarUnidadesProcesso",
  6893 + "group": "Processo",
  6894 + "version": "2.0.0",
  6895 + "permission": [
  6896 + {
  6897 + "name": "RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA"
  6898 + }
  6899 + ],
  6900 + "description": "<p>Consulta as unidades onde o processo está aberto.</p>",
  6901 + "parameter": {
  6902 + "fields": {
  6903 + "Path Parameters": [
  6904 + {
  6905 + "group": "Path Parameters",
  6906 + "type": "String",
  6907 + "optional": false,
  6908 + "field": "processo",
  6909 + "description": "<p>Número do processo.</p>"
  6910 + }
  6911 + ]
  6912 + }
  6913 + },
  6914 + "examples": [
  6915 + {
  6916 + "title": "Exemplo de requisição:\t",
  6917 + "content": "curl -i https://<host>/sei-broker/service/processos/33910002924201874/unidades",
  6918 + "type": "json"
  6919 + }
  6920 + ],
  6921 + "success": {
  6922 + "fields": {
  6923 + "Sucesso Response Body - 200": [
  6924 + {
  6925 + "group": "Sucesso Response Body - 200",
  6926 + "type": "List",
  6927 + "optional": false,
  6928 + "field": "unidades",
  6929 + "description": "<p>Lista da unidades onde o processo está aberto.</p>"
  6930 + },
  6931 + {
  6932 + "group": "Sucesso Response Body - 200",
  6933 + "type": "Unidade",
  6934 + "optional": false,
  6935 + "field": "unidades.unidade",
  6936 + "description": "<p>Objeto Unidade.</p>"
  6937 + },
  6938 + {
  6939 + "group": "Sucesso Response Body - 200",
  6940 + "type": "String",
  6941 + "optional": false,
  6942 + "field": "unidades.unidade.idUnidade",
  6943 + "description": "<p>Identificador da unidade.</p>"
  6944 + },
  6945 + {
  6946 + "group": "Sucesso Response Body - 200",
  6947 + "type": "String",
  6948 + "optional": false,
  6949 + "field": "unidades.unidade.sigla",
  6950 + "description": "<p>Sigla de unidade.</p>"
  6951 + },
  6952 + {
  6953 + "group": "Sucesso Response Body - 200",
  6954 + "type": "String",
  6955 + "optional": false,
  6956 + "field": "unidades.unidade.descricao",
  6957 + "description": "<p>Descrição da unidade.</p>"
  6958 + },
  6959 + {
  6960 + "group": "Sucesso Response Body - 200",
  6961 + "type": "String",
  6962 + "optional": false,
  6963 + "field": "unidades.unidade.sinProtocolo",
  6964 + "description": "<p>Descrição pendente da área de negócio.</p>"
  6965 + },
  6966 + {
  6967 + "group": "Sucesso Response Body - 200",
  6968 + "type": "String",
  6969 + "optional": false,
  6970 + "field": "unidades.unidade.sinArquivamento",
  6971 + "description": "<p>Descrição pendente da área de negócio.</p>"
  6972 + },
  6973 + {
  6974 + "group": "Sucesso Response Body - 200",
  6975 + "type": "String",
  6976 + "optional": false,
  6977 + "field": "unidades.unidade.sinOuvidoria",
  6978 + "description": "<p>Descrição pendente da área de negócio.</p>"
  6979 + }
  6980 + ]
  6981 + },
  6982 + "examples": [
  6983 + {
  6984 + "title": "Success-Response:",
  6985 + "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]",
  6986 + "type": "json"
  6987 + }
  6988 + ]
  6989 + },
  6990 + "error": {
  6991 + "examples": [
  6992 + {
  6993 + "title": "Error-Response:",
  6994 + "content": "HTTP/1.1 500 Internal Server Error\n{\n\t\"error\":\"Mensagem de erro.\"\n\t\"code\":\"código do erro\"\n}",
  6995 + "type": "json"
  6996 + }
  6997 + ]
  6998 + },
  6999 + "filename": "sei-broker/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java",
  7000 + "groupTitle": "Processo"
  7001 + },
  7002 + {
6889 7003 "type": "delete",
6890 7004 "url": "/:unidade/processos/:processo/anexados/:processoAnexado",
6891 7005 "title": "Desanexar processo",
... ...
src/main/webapp/api-docs/api_data.json
  Diff comments   View file @5d41cfe
... ... @@ -1352,9 +1352,9 @@
1352 1352 "type": "",
1353 1353 "url": "",
1354 1354 "version": "0.0.0",
1355   - "filename": "sei-broker/target/sei-broker-2.5.1/api-docs/main.js",
1356   - "group": "C__git_sei_broker_target_sei_broker_2_5_1_api_docs_main_js",
1357   - "groupTitle": "C__git_sei_broker_target_sei_broker_2_5_1_api_docs_main_js",
  1355 + "filename": "sei-broker/target/sei-broker-2.6/api-docs/main.js",
  1356 + "group": "C__git_sei_broker_target_sei_broker_2_6_api_docs_main_js",
  1357 + "groupTitle": "C__git_sei_broker_target_sei_broker_2_6_api_docs_main_js",
1358 1358 "name": ""
1359 1359 },
1360 1360 {
... ... @@ -6886,6 +6886,120 @@
6886 6886 "groupTitle": "Processo"
6887 6887 },
6888 6888 {
  6889 + "type": "get",
  6890 + "url": "/processos/:processo/unidades",
  6891 + "title": "Consultar unidades",
  6892 + "name": "consultarUnidadesProcesso",
  6893 + "group": "Processo",
  6894 + "version": "2.0.0",
  6895 + "permission": [
  6896 + {
  6897 + "name": "RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA"
  6898 + }
  6899 + ],
  6900 + "description": "<p>Consulta as unidades onde o processo está aberto.</p>",
  6901 + "parameter": {
  6902 + "fields": {
  6903 + "Path Parameters": [
  6904 + {
  6905 + "group": "Path Parameters",
  6906 + "type": "String",
  6907 + "optional": false,
  6908 + "field": "processo",
  6909 + "description": "<p>Número do processo.</p>"
  6910 + }
  6911 + ]
  6912 + }
  6913 + },
  6914 + "examples": [
  6915 + {
  6916 + "title": "Exemplo de requisição:\t",
  6917 + "content": "curl -i https://<host>/sei-broker/service/processos/33910002924201874/unidades",
  6918 + "type": "json"
  6919 + }
  6920 + ],
  6921 + "success": {
  6922 + "fields": {
  6923 + "Sucesso Response Body - 200": [
  6924 + {
  6925 + "group": "Sucesso Response Body - 200",
  6926 + "type": "List",
  6927 + "optional": false,
  6928 + "field": "unidades",
  6929 + "description": "<p>Lista da unidades onde o processo está aberto.</p>"
  6930 + },
  6931 + {
  6932 + "group": "Sucesso Response Body - 200",
  6933 + "type": "Unidade",
  6934 + "optional": false,
  6935 + "field": "unidades.unidade",
  6936 + "description": "<p>Objeto Unidade.</p>"
  6937 + },
  6938 + {
  6939 + "group": "Sucesso Response Body - 200",
  6940 + "type": "String",
  6941 + "optional": false,
  6942 + "field": "unidades.unidade.idUnidade",
  6943 + "description": "<p>Identificador da unidade.</p>"
  6944 + },
  6945 + {
  6946 + "group": "Sucesso Response Body - 200",
  6947 + "type": "String",
  6948 + "optional": false,
  6949 + "field": "unidades.unidade.sigla",
  6950 + "description": "<p>Sigla de unidade.</p>"
  6951 + },
  6952 + {
  6953 + "group": "Sucesso Response Body - 200",
  6954 + "type": "String",
  6955 + "optional": false,
  6956 + "field": "unidades.unidade.descricao",
  6957 + "description": "<p>Descrição da unidade.</p>"
  6958 + },
  6959 + {
  6960 + "group": "Sucesso Response Body - 200",
  6961 + "type": "String",
  6962 + "optional": false,
  6963 + "field": "unidades.unidade.sinProtocolo",
  6964 + "description": "<p>Descrição pendente da área de negócio.</p>"
  6965 + },
  6966 + {
  6967 + "group": "Sucesso Response Body - 200",
  6968 + "type": "String",
  6969 + "optional": false,
  6970 + "field": "unidades.unidade.sinArquivamento",
  6971 + "description": "<p>Descrição pendente da área de negócio.</p>"
  6972 + },
  6973 + {
  6974 + "group": "Sucesso Response Body - 200",
  6975 + "type": "String",
  6976 + "optional": false,
  6977 + "field": "unidades.unidade.sinOuvidoria",
  6978 + "description": "<p>Descrição pendente da área de negócio.</p>"
  6979 + }
  6980 + ]
  6981 + },
  6982 + "examples": [
  6983 + {
  6984 + "title": "Success-Response:",
  6985 + "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]",
  6986 + "type": "json"
  6987 + }
  6988 + ]
  6989 + },
  6990 + "error": {
  6991 + "examples": [
  6992 + {
  6993 + "title": "Error-Response:",
  6994 + "content": "HTTP/1.1 500 Internal Server Error\n{\n\t\"error\":\"Mensagem de erro.\"\n\t\"code\":\"código do erro\"\n}",
  6995 + "type": "json"
  6996 + }
  6997 + ]
  6998 + },
  6999 + "filename": "sei-broker/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java",
  7000 + "groupTitle": "Processo"
  7001 + },
  7002 + {
6889 7003 "type": "delete",
6890 7004 "url": "/:unidade/processos/:processo/anexados/:processoAnexado",
6891 7005 "title": "Desanexar processo",
... ...
src/main/webapp/api-docs/api_project.js
  Diff comments   View file @5d41cfe
... ... @@ -4,11 +4,19 @@ define({
4 4 "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 <a href=\"https://softwarepublico.gov.br/social/sei/manuais\">documentação oficial do SEI</a> para melhor entendimento do negócio e seus objetos. Mais informações do SEI-Broker veja o <a href=\"http://wiki.ans.gov.br/index.php/Sei-broker\">artigo wiki</a>.",
5 5 "title": "Documentação - sei-broker",
6 6 "url": "https://<host>/sei-broker/service",
  7 + "order": [
  8 + "Processo",
  9 + "Documento",
  10 + "Bloco",
  11 + "Unidade",
  12 + "Contato",
  13 + "Arquivo"
  14 + ],
7 15 "sampleUrl": false,
8 16 "apidoc": "0.2.0",
9 17 "generator": {
10 18 "name": "apidoc",
11   - "time": "2018-05-22T12:20:37.124Z",
  19 + "time": "2018-06-01T13:15:34.429Z",
12 20 "url": "http://apidocjs.com",
13 21 "version": "0.15.1"
14 22 }
... ...
src/main/webapp/api-docs/api_project.json
  Diff comments   View file @5d41cfe
... ... @@ -4,11 +4,19 @@
4 4 "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 <a href=\"https://softwarepublico.gov.br/social/sei/manuais\">documentação oficial do SEI</a> para melhor entendimento do negócio e seus objetos. Mais informações do SEI-Broker veja o <a href=\"http://wiki.ans.gov.br/index.php/Sei-broker\">artigo wiki</a>.",
5 5 "title": "Documentação - sei-broker",
6 6 "url": "https://<host>/sei-broker/service",
  7 + "order": [
  8 + "Processo",
  9 + "Documento",
  10 + "Bloco",
  11 + "Unidade",
  12 + "Contato",
  13 + "Arquivo"
  14 + ],
7 15 "sampleUrl": false,
8 16 "apidoc": "0.2.0",
9 17 "generator": {
10 18 "name": "apidoc",
11   - "time": "2018-05-22T12:20:37.124Z",
  19 + "time": "2018-06-01T13:15:34.429Z",
12 20 "url": "http://apidocjs.com",
13 21 "version": "0.15.1"
14 22 }
... ...