Skip to content
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.

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

Improve Fleet Management API User Stories adding gif and swagger docs #1805

Merged
merged 2 commits into from
May 24, 2024

Conversation

ssinuco
Copy link
Collaborator

@ssinuco ssinuco commented Apr 11, 2024

Para resolver #1753

Se agregaron

  • documentacion swagger de la api. @unjust @cros410 estan de acuerdo con los endpoints propuestos?
  • Gif en las cuatro primeras historias para dar contexto a los endpoints que se quiere desarrollar
  • Historia de usuario para el CRUD de users
  • Historia de usuario para login y obtener un token JWT
  • Historia de usuario para proteger los endpoint con token

Pendiente

  • deliver e2e tests for Fleet Management, hopefully language agnostic

@ssinuco ssinuco requested review from unjust and cros410 April 11, 2024 20:10
@unjust unjust added this to the v8.7.0 milestone Apr 12, 2024
@unjust unjust linked an issue Apr 12, 2024 that may be closed by this pull request
3 tasks
projects/05-fleet-management-api/README.md Outdated Show resolved Hide resolved

* El código de los _endpoints_ debe pasar por una revisión de código realizada
por al menos una compañera.
* El código de los _endpoints_ debe contar con test unitarios y e2e.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quiero definir que pensamos con e2e o quiza deberiamos describirlo mejor en algun momento de readme.

Por ejemplo, hay confusion a veces con ellas si deben levantar un mock database. Cuando no hay CRUD no se si hay necesidad hacer e2e. En python con flask creo el minimo es unas pruebas de integracion con una cliente que hace peticiones y probamos que las respuestas son correctos de los views/rutas, sin necesidad a interactuar con un base de datos (pueden mockear los funciones que habla con el db).
Me gustaria se aclaramos los tipos de tets un poco en los hitos.

@ssinuco ssinuco force-pushed the fleet-management-api-improvements branch from d1fa5db to c5998c0 Compare April 25, 2024 12:42
@ssinuco ssinuco changed the title Improve User Story adding gif and swagger docs Improve Fleet Management API User Stories adding gif and swagger docs Apr 25, 2024
@ssinuco ssinuco force-pushed the fleet-management-api-improvements branch 2 times, most recently from 155b8cf to 31b6d78 Compare April 25, 2024 22:15
.mdlintrc Outdated Show resolved Hide resolved
projects/05-fleet-management-api/project.yml Outdated Show resolved Hide resolved
projects/05-fleet-management-api/docs/extension.md Outdated Show resolved Hide resolved
@unjust unjust removed this from the v8.7.0 milestone May 16, 2024
Copy link
Contributor

@unjust unjust left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aqui mis comentarios son:

  • Usamos Swagger spec 2.0.0 ahora no?
  • Debemos cambiar el orden de HU porque los endpoints en el swagger requiere authenticacion, o si no - comentamos muy claro que el spec que define la respuesta 401 no seria implemenatado hasta HU7 y no debe hacerlo caso hasta este historia.
  • corregimos donde mencionamos e2e tests

En el swagger 2.0 los trajectories deben retornar una propiedad con nombre "timestamp" y no "date" (date es el parametro de query y es solo date, timestamp en la propiedad de trajectory)

projects/05-fleet-management-api/README.md Outdated Show resolved Hide resolved
projects/05-fleet-management-api/README.md Outdated Show resolved Hide resolved
projects/05-fleet-management-api/README.md Outdated Show resolved Hide resolved
projects/05-fleet-management-api/README.md Outdated Show resolved Hide resolved
projects/05-fleet-management-api/README.md Outdated Show resolved Hide resolved
projects/05-fleet-management-api/README.md Show resolved Hide resolved
projects/05-fleet-management-api/README.md Outdated Show resolved Hide resolved
projects/05-fleet-management-api/README.md Show resolved Hide resolved
projects/05-fleet-management-api/README.md Show resolved Hide resolved
@ssinuco ssinuco force-pushed the fleet-management-api-improvements branch from 31b6d78 to 7b6e87a Compare May 23, 2024 16:52
unjust
unjust previously approved these changes May 24, 2024
@unjust unjust merged commit 9b671bb into Laboratoria:next May 24, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Prep Fleet Management to replace BQ API in Bootcamp
2 participants