Skip to content

Updated API documentation according to standard verbs #63

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
Elyabe wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated API documentation according to standard verbs #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions application/controllers/ComponenteCurricularController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public function findByCodPpc($codPpc)
}

/**
* @api {get} componentes-curriculares/:codCompCurric Solicitar uma componente curricular
* @api {get} componentes-curriculares/:codCompCurric Listar dados de uma componente curricular
* @apiName findByCodCompCurric
* @apiGroup Componente Curricular
*
Expand Down Expand Up @@ -156,7 +156,7 @@ public function findByCodCompCurric($codCompCurric)
}

/**
* @api {get} componentes-curriculares/tipos Solicitar tipos definidos de componente curricular
* @api {get} componentes-curriculares/tipos Listar tipos definidos de componente curricular
* @apiName findTipos
* @apiGroup Componente Curricular
*
Expand Down Expand Up @@ -375,7 +375,7 @@ public function update($codCompCurric)
}

/**
* @api {delete} componentes-curriculares/:codCompCurric Deletar Componente Curricular
* @api {delete} componentes-curriculares/:codCompCurric Excluir Componente Curricular
* @apiName delete
* @apiGroup Componente Curricular
*
Expand Down
2 changes: 1 addition & 1 deletion application/controllers/CorrespondenciaController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ public function update($codCompCurric, $codCompCorresp)
}

/**
* @api {delete} correspondencias/:codCompCurric/:codCompCorresp Deletar Correspondência
* @api {delete} correspondencias/:codCompCurric/:codCompCorresp Excluir Correspondência
* @apiName delete
* @apiGroup Correspondência
*
Expand Down
4 changes: 2 additions & 2 deletions application/controllers/CursoController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public function __construct()
}

/**
* @api {get} cursos Solicitar todos Cursos registrados.
* @api {get} cursos Listar todos Cursos registrados.
* @apiName findAll
* @apiGroup Curso
* @apiPermission ADMINISTRATOR
Expand Down Expand Up @@ -46,7 +46,7 @@ public function findAll()
}

/**
* @api {get} cursos/:codCurso Solicitar dados de um Curso.
* @api {get} cursos/:codCurso Listar dados de um Curso.
* @apiName findById
* @apiGroup Curso
*
Expand Down
6 changes: 3 additions & 3 deletions application/controllers/DepartamentoController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public function __construct()
}

/**
* @api {get} departamentos Solicitar dados de todos Departamentos.
* @api {get} departamentos Listar dados de todos Departamentos.
* @apiName findAll
* @apiGroup Departamento
* @apiPermission ADMINISTRATOR
Expand Down Expand Up @@ -44,7 +44,7 @@ public function findAll()
}

/**
* @api {get} departamentos/:codDepto Solicitar dados de um Departamento específico.
* @api {get} departamentos/:codDepto Listar dados de um Departamento específico.
* @apiName findById
* @apiGroup Departamento
* @apiPermission ADMINISTRATOR
Expand Down Expand Up @@ -141,7 +141,7 @@ public function create()
}

/**
* @api {put} departamentos/:codDepto Atualizar dados de um Departamento.
* @api {put} departamentos/:codDepto Listar dados de um Departamento.
* @apiName update
* @apiGroup Departamento
* @apiPermission ADMINISTRATOR
Expand Down
8 changes: 4 additions & 4 deletions application/controllers/DependenciaController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public function __construct()
}

/**
* @api {GET} dependencias Solicitar todas dependências existentes entre componentes curriculares.
* @api {GET} dependencias Listar todas dependências existentes entre componentes curriculares.
*
* @apiName findAll
* @apiGroup Dependência
Expand Down Expand Up @@ -45,7 +45,7 @@ public function findAll()
}

/**
* @api {GET} dependencias/:codCompCurric/:codPreReq Solicitar dependências entre componentes curriculares.
* @api {GET} dependencias/:codCompCurric/:codPreReq Listar dependências entre componentes curriculares.
* @apiParam (URL) {Number} codCompCurric Código de identificação de uma componente curricular.
* @apiParam (URL) {Number} codPreReq Código de identificação de uma componente curricular que é pré-requisito.
*
Expand Down Expand Up @@ -89,7 +89,7 @@ public function findById($codCompCurric, $codPreRequisito)


/**
* @api {GET} projetos-pedagogicos-curso/:codPpc/dependencias Solicitar todas dependências entre componentes as curriculares de um Projeto Pedagógico de Curso.
* @api {GET} projetos-pedagogicos-curso/:codPpc/dependencias Listar todas dependências entre componentes as curriculares de um Projeto Pedagógico de Curso.
* @apiParam (URL) {Number} codPpc Código identificador de um projeto pedagógico de curso.
* @apiParam (URL) {bool} allowEmpty Parâmetro que informa se o método deve retornar um array de Depêndencias vazio.
* @apiParam (URL) {bool} senseConnection Parâmetro que informa se o método deve retornar uma string de sentido da dependencia concatenada ao seu respectivo código.
Expand Down Expand Up @@ -303,7 +303,7 @@ public function update($codCompCurric, $codPreRequisito)
}

/**
* @api {DELETE} dependencias/:codCompCurric/:codPreReq Deletar dependência entre componentes curriculares.
* @api {DELETE} dependencias/:codCompCurric/:codPreReq Excluir dependência entre componentes curriculares.
* @apiParam (URL) {Number} codCompCurric Código de identificação de uma componente curricular.
* @apiParam (URL) {Number} codPreReq Código de identificação de uma componente curricular que é pré-requisito.
*
Expand Down
4 changes: 2 additions & 2 deletions application/controllers/DisciplinaController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public function __construct()
}

/**
* @api {get} disciplinas Solicitar dados de todas as disciplinas
* @api {get} disciplinas Listar dados de todas as disciplinas
* @apiName findAll
* @apiGroup Disciplina
*
Expand Down Expand Up @@ -46,7 +46,7 @@ public function findAll()
}

/**
* @api {get} disciplinas/:codDepto/:numDisciplina Solicitar dados de uma disciplina
* @api {get} disciplinas/:codDepto/:numDisciplina Listar dados de uma disciplina
* @apiName findById
* @apiGroup Disciplina
*
Expand Down
4 changes: 2 additions & 2 deletions application/controllers/InstituicaoEnsinoSuperiorController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public function __construct()
}

/**
* @api {get} instituicoes-ensino-superior Solicitar dados de todas Instituições de Ensino Superior.
* @api {get} instituicoes-ensino-superior Listar dados de todas Instituições de Ensino Superior.
* @apiName findAll
* @apiGroup Instituição de Ensino Superior
* @apiPermission ADMINISTRATOR
Expand Down Expand Up @@ -43,7 +43,7 @@ public function findAll()
}

/**
* @api {get} instituicoes-ensino-superior/:codIes Solicitar dados de uma Instituição de Ensino Superior.
* @api {get} instituicoes-ensino-superior/:codIes Listar dados de uma Instituição de Ensino Superior.
* @apiName findById
* @apiGroup Instituição de Ensino Superior
* @apiPermission ADMINISTRATOR
Expand Down
8 changes: 4 additions & 4 deletions application/controllers/ProjetoPedagogicoCursoController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public function __construct()
}

/**
* @api {GET} projetos-pedagogicos-curso Solicitar todos Projetos Pedagógicos de Curso.
* @api {GET} projetos-pedagogicos-curso Listar todos Projetos Pedagógicos de Curso.
*
* @apiName findAll
* @apiGroup Projeto Pedagógico Curso
Expand Down Expand Up @@ -44,7 +44,7 @@ public function findAll()
}

/**
* @api {GET} projetos-pedagogicos-curso/:codPpc Solicitar Projeto Pedagógico de Curso.
* @api {GET} projetos-pedagogicos-curso/:codPpc Listar Projeto Pedagógico de Curso.
* @apiParam (URL) {Number} codPpc Código de identificação de um Projeto Pedagógico de Curso.
*
* @apiName findById
Expand Down Expand Up @@ -93,7 +93,7 @@ public function findById($codPpc)
}

/**
* @api {get} cursos/:codCurso/projetos-pedagogicos-curso Requisitar todos Projetos Pedagógicos de Curso de um Curso.
* @api {get} cursos/:codCurso/projetos-pedagogicos-curso Listar todos Projetos Pedagógicos de Curso de um Curso.
* @apiParam {Number} codCurso Código de identificação de um Curso.
*
* @apiName findByCodCurso
Expand Down Expand Up @@ -377,7 +377,7 @@ public function update($codPpc)
}

/**
* @api {DELETE} projetos-pedagogicos-curso/:codPpc Deletar Projeto Pedagógico de Curso.
* @api {DELETE} projetos-pedagogicos-curso/:codPpc Excluir Projeto Pedagógico de Curso.
* @apiParam (URL) {Number} codPpc Código de identificação de um Projeto Pedagógico de Curso.
*
* @apiName delete
Expand Down
2 changes: 1 addition & 1 deletion application/controllers/TransicaoController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ public function update($codPpcAtual, $codPpcAlvo)
}

/**
* @api {delete} transicoes/:codPpcAtual/:codPpcAlvo Deletar Componente Curricular
* @api {delete} transicoes/:codPpcAtual/:codPpcAlvo Excluir Componente Curricular
* @apiName delete
* @apiGroup Transição
*
Expand Down
4 changes: 2 additions & 2 deletions application/controllers/UnidadeEnsinoController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public function __construct()
}

/**
* @api {get} unidades-ensino Solicitar dados de todas as unidades de ensino
* @api {get} unidades-ensino Listar dados de todas as unidades de ensino
* @apiName findAll
* @apiGroup Unidade de Ensino
*
Expand Down Expand Up @@ -75,7 +75,7 @@ public function findAll()
}

/**
* @api {get} unidades-ensino/:codUnidadeEnsino Solicitar dados de uma unidade de ensino
* @api {get} unidades-ensino/:codUnidadeEnsino Listar dados de uma unidade de ensino
* @apiName findById
* @apiGroup Unidade de Ensino
*
Expand Down
4 changes: 2 additions & 2 deletions application/controllers/UsuarioController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public function __construct()
}

/**
* @api {get} usuarios Solicitar dados da coleção dos usuários
* @api {get} usuarios Listar dados da coleção dos usuários
* @apiName findAll
* @apiGroup Usuário
* @apiPermission ADMINISTRATOR
Expand Down Expand Up @@ -46,7 +46,7 @@ public function findAll()
}

/**
* @api {get} usuarios/:codUsuario Solicitar dados de um usuário
* @api {get} usuarios/:codUsuario Listar dados de um usuário
* @apiName findById
* @apiGroup Usuário
* @apiPermission ADMINISTRATOR
Expand Down
Loading