Controller de projetos. Mais...

Diagrama de heranças da classe WebAPI.Controllers.ProjectController

Diagrama de colaboração para WebAPI.Controllers.ProjectController:

Membros públicos
	ProjectController (IGetProjectById getProjectById, IGetOpenProjects getOpenProjects, IGetClosedProjects getClosedProjects, IOpenProject openProject, IUpdateProject updateProject, ICancelProject cancelProject, IAppealProject appealProject, ISubmitProject submitProject, IGetActivitiesByProjectId getActivitiesByProjectId, ILogger< ProjectController > logger)
	Construtor do Controller de projetos. Mais...

async Task< ActionResult< DetailedReadProjectOutput > >	GetProjectById (Guid? id)
	Busca projeto pelo id. Mais...

async Task< ActionResult< IEnumerable< DetailedReadProjectActivityOutput > > >	GetActivitiesByProjectId (Guid? projectId)
	Busca atividades de projeto pelo id do projeto. Mais...

async Task< ActionResult< IEnumerable< ResumedReadProjectOutput > > >	GetOpenProjects (int skip=0, int take=50, bool onlyMyProjects=true)
	Busca projetos abertos. Mais...

async Task< ActionResult< IEnumerable< ResumedReadProjectOutput > > >	GetClosedProjects (int skip=0, int take=50, bool onlyMyProjects=true)
	Busca projetos fechados. Mais...

async Task< ActionResult< ResumedReadProjectOutput > >	OpenProject ([FromBody] OpenProjectInput request)
	Cria projeto. Mais...

async Task< ActionResult< ResumedReadProjectOutput > >	UpdateProject (Guid? projectId, [FromBody] UpdateProjectInput request)
	Atualiza projeto. Mais...

async Task< ActionResult< ResumedReadProjectOutput > >	CancelProject (Guid? projectId, string? observation)
	Cancela projeto. Mais...

async Task< ActionResult< ResumedReadProjectOutput > >	AppealProject (Guid? projectId, string? appealDescription)
	Solicita recurso para o projeto. Mais...

async Task< ActionResult< ResumedReadProjectOutput > >	SubmitProject (Guid? projectId)
	Submete projeto. Mais...

Descrição detalhada

Controller de projetos.

Documentação dos Construtores & Destrutor

◆ ProjectController()

WebAPI.Controllers.ProjectController.ProjectController	(	IGetProjectById	getProjectById,
		IGetOpenProjects	getOpenProjects,
		IGetClosedProjects	getClosedProjects,
		IOpenProject	openProject,
		IUpdateProject	updateProject,
		ICancelProject	cancelProject,
		IAppealProject	appealProject,
		ISubmitProject	submitProject,
		IGetActivitiesByProjectId	getActivitiesByProjectId,
		ILogger< ProjectController >	logger
	)

inline

Construtor do Controller de projetos.

Parâmetros

getProjectById	Serviço de obtenção de projeto pelo id.
getOpenProjects	Serviço de obtenção de projetos abertos.
getClosedProjects	Serviço de obtenção de projetos fechados.
openProject	Serviço de abertura de projeto.
updateProject	Serviço de atualização de projeto.
cancelProject	Serviço de cancelamento de projeto.
appealProject	Serviço de recurso de projeto.
submitProject	Serviço de submissão de projeto.
getActivitiesByProjectId	Serviço de obtenção de atividades de projeto.
logger	Serviço de log.

Documentação dos métodos

◆ AppealProject()

async Task<ActionResult<ResumedReadProjectOutput> > WebAPI.Controllers.ProjectController.AppealProject	(	Guid?	projectId,
		string?	appealDescription
	)

inline

Solicita recurso para o projeto.

Parâmetros

projectId	Id do projeto
appealDescription	Descrição do recurso

Retorna: Projeto com recurso solicitado

<response code="200">Retorna projeto com recurso solicitado</response> <response code="400">Ocorreu um erro ao solicitar recurso para o projeto.</response> <response code="401">Usuário não autorizado.</response>

◆ CancelProject()

async Task<ActionResult<ResumedReadProjectOutput> > WebAPI.Controllers.ProjectController.CancelProject	(	Guid?	projectId,
		string?	observation
	)

inline

Cancela projeto.

Parâmetros

projectId	Id do projeto
observation	Observação do cancelamento

Retorna: Projeto cancelado

<response code="200">Retorna projeto cancelado</response> <response code="400">Ocorreu um erro ao cancelar projeto.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Projeto não encontrado.</response>

◆ GetActivitiesByProjectId()

async Task<ActionResult<IEnumerable<DetailedReadProjectActivityOutput> > > WebAPI.Controllers.ProjectController.GetActivitiesByProjectId ( Guid? projectId )

inline

Busca atividades de projeto pelo id do projeto.

Parâmetros

projectId Id do projeto

Retorna: Atividades de projeto correspondentes

<response code="200">Retorna atividades de projeto correspondentes</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhuma atividade encontrada.</response>

◆ GetClosedProjects()

async Task<ActionResult<IEnumerable<ResumedReadProjectOutput> > > WebAPI.Controllers.ProjectController.GetClosedProjects	(	int	skip = `0`,
		int	take = `50`,
		bool	onlyMyProjects = `true`
	)

inline

Busca projetos fechados.

Parâmetros

skip	Quantidade de registros a serem ignorados.
take	Quantidade de registros a serem retornados.
onlyMyProjects	Indica que apenas os projetos relacionados ao usuário serão retornados.

Retorna: Projetos fechados do usuário logado.

<response code="200">Retorna projetos fechados do usuário logado.</response> <response code="400">Ocorreu um erro ao buscar projetos fechados.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhum projeto encontrado.</response>

◆ GetOpenProjects()

async Task<ActionResult<IEnumerable<ResumedReadProjectOutput> > > WebAPI.Controllers.ProjectController.GetOpenProjects	(	int	skip = `0`,
		int	take = `50`,
		bool	onlyMyProjects = `true`
	)

inline

Busca projetos abertos.

Parâmetros

skip	Quantidade de registros a serem ignorados.
take	Quantidade de registros a serem retornados.
onlyMyProjects	Indica que apenas os projetos relacionados ao usuário serão retornados.

Retorna: Projetos abertos do usuário logado.

<response code="200">Retorna projetos abertos do usuário logado.</response> <response code="400">Ocorreu um erro ao buscar projetos abertos.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhum projeto encontrado.</response>

◆ GetProjectById()

async Task<ActionResult<DetailedReadProjectOutput> > WebAPI.Controllers.ProjectController.GetProjectById ( Guid? id )

inline

Busca projeto pelo id.

Retorna: Projeto correspondente

<response code="200">Retorna projeto correspondente</response> <response code="400">Requisição incorreta.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhum projeto encontrado.</response>

Este é o diagrama das funções que utilizam esta função:

◆ OpenProject()

async Task<ActionResult<ResumedReadProjectOutput> > WebAPI.Controllers.ProjectController.OpenProject ( [FromBody] OpenProjectInput request )

inline

Cria projeto.

Parâmetros

request Informações de abertura do projeto

Retorna: Projeto criado

<response code="200">Retorna projeto criado</response> <response code="400">Ocorreu um erro ao criar projeto.</response> <response code="401">Usuário não autorizado.</response>

Grafo de chamadas desta função:

◆ SubmitProject()

async Task<ActionResult<ResumedReadProjectOutput> > WebAPI.Controllers.ProjectController.SubmitProject ( Guid? projectId )

inline

Submete projeto.

Parâmetros

projectId Id do projeto

Retorna: Projeto submetido

<response code="200">Retorna projeto submetido</response> <response code="400">Ocorreu um erro ao submeter projeto.</response> <response code="401">Usuário não autorizado.</response>

◆ UpdateProject()

async Task<ActionResult<ResumedReadProjectOutput> > WebAPI.Controllers.ProjectController.UpdateProject	(	Guid?	projectId,
		[FromBody] UpdateProjectInput	request
	)

inline

Atualiza projeto.

Parâmetros

projectId	Id do projeto
request	Informações de atualização do projeto

Retorna: Projeto atualizado

<response code="200">Retorna projeto atualizado</response> <response code="400">Ocorreu um erro ao atualizar projeto.</response> <response code="401">Usuário não autorizado.</response> <response code="404">Nenhum projeto encontrado.</response>

A documentação para esta classe foi gerada a partir do seguinte ficheiro:

src/Infrastructure/WebAPI/Controllers/ProjectController.cs

Membros públicos

Descrição detalhada

Documentação dos Construtores & Destrutor

◆ ProjectController()

Documentação dos métodos

◆ AppealProject()

◆ CancelProject()

◆ GetActivitiesByProjectId()

◆ GetClosedProjects()

◆ GetOpenProjects()

◆ GetProjectById()

◆ OpenProject()

◆ SubmitProject()

◆ UpdateProject()