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

docs(openapi): Update spec #41

Merged
merged 5 commits into from
Oct 12, 2023
Merged

docs(openapi): Update spec #41

merged 5 commits into from
Oct 12, 2023

Conversation

MiguelMRojas
Copy link
Member

  • Update OpenApi

@MiguelMRojas MiguelMRojas added the documentation Improvements or additions to documentation label Oct 10, 2023
@MiguelMRojas MiguelMRojas self-assigned this Oct 10, 2023
@PedroChaparro PedroChaparro linked an issue Oct 10, 2023 that may be closed by this pull request
Copy link
Contributor

@PedroChaparro PedroChaparro left a comment

Choose a reason for hiding this comment

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

Please, add the following to the endpoints that require authentication:

security:
        - bearer: []

@MiguelMRojas
Copy link
Member Author

Please, add the following to the endpoints that require authentication:

security:
        - bearer: []

Done :)

Copy link
Contributor

@PedroChaparro PedroChaparro left a comment

Choose a reason for hiding this comment

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

  1. There are some duplicated endpoints, Eg. POST /file/upload and POST /files.
  2. The Bearer token should only be added to the endpoints that require authentication. For instance, the /auth/login and /account/register do not require authentication, while the /files/download does.
  3. There are some endpoints with incorrect tags. For instance, the account/register endpoint should have the account tag.

@MiguelMRojas
Copy link
Member Author

  1. There are some duplicated endpoints, Eg. POST /file/upload and POST /files.
  2. The Bearer token should only be added to the endpoints that require authentication. For instance, the /auth/login and /account/register do not require authentication, while the /files/download does.
  3. There are some endpoints with incorrect tags. For instance, the account/register endpoint should have the account tag.

Done, thanks for comment 💯

docs/spec.openapi.yaml Outdated Show resolved Hide resolved
docs/spec.openapi.yaml Outdated Show resolved Hide resolved
docs/spec.openapi.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

@PedroChaparro PedroChaparro left a comment

Choose a reason for hiding this comment

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

Note that this spec is not fully compatible with the .net one; however, I think all the methods exposed by the gateway are covered by this spec. Let's see what happens.

Squash and merge.

@MiguelMRojas MiguelMRojas merged commit 9dc6959 into dev Oct 12, 2023
3 checks passed
@MiguelMRojas MiguelMRojas deleted the docs/update-openapi-spec branch October 12, 2023 01:39
@PedroChaparro PedroChaparro changed the title feat: update docs openapi docs(openapi): Update spec Oct 12, 2023
@MiguelMRojas MiguelMRojas mentioned this pull request Oct 14, 2023
MiguelMRojas added a commit that referenced this pull request Oct 14, 2023
* feat: Register endpoint (#39)

* feat: enpoint registration coverage 57%

Implementation of the registration endpoint, 57% coverage is achieved

* style: Fix formatter and linter warnings

* test: Use random data in register tests

* refactor: Update register endpoint according to the `.net` spec

* test: Fix broken test

---------

Co-authored-by: Andvelavi <[email protected]>
Co-authored-by: Pedro Andrés Chaparro Quintero <[email protected]>


* fix: Enable all CORS origins (#44)

* chore: Remove origins environment variable

* fix: Enable all origins in CORS config

* ci: Fix tagging pipeline (#48)

* ci: Fix typo

* feat: update docs openapi (#41)

* feat: Endpoint to get the file status (#49)

* refactor: Remove exception from responses

* ci: Remove unnecessary field in tagging pipeline

* fix: Update metadata base url in docker-compose

* feat(file): Endpoint to get the state of a file

* test(file): Add tests to the endpoint to get file state

* chore: Set current version

* feat: Endpoint to rename a file (#50)

* feat: Update password (#51)

* feat: Endpoint to update password + tests

Endpoint to update password, with 42% coverage.  Problems when querying with an invalid token

* fix(account): Update endpoint to change the password

* test(account): Update tests related to update password

Increment coverage to 83%

---------

Co-authored-by: Andvelavi <[email protected]>
Co-authored-by: Pedro Andrés Chaparro Quintero <[email protected]>

* feat: create a folder (#52)

* feat: file upload (#53)

* feat: file upload endpoint.

Start of file upload endpoint , testing is still pending, in addition to possible changes according to the API update

* feat: Progress and small corrections in upload_endpoint

Progress is made in the endpoint in addition to correcting syntax and .py file creation problems

* fix: upload file endpont corrections

Corrections are made to the endpoint upload_file according to API update

* fix: error message

* fix: error messages in upload controller

* feat: Create helper function to check if an UUID is valid

* fix(files): Use multipart form data instead of JSON

* test(files): Add success case test to the endpoint to upload files

---------

Co-authored-by: Andvelavi <[email protected]>
Co-authored-by: Pedro Andrés Chaparro Quintero <[email protected]>


* fix(files): Keep files extension (#56)

* test: Increment save file endpoint coverage (#54)

* refactor(files): Remove unreachable block

Since JSON is not being used in the endpoint, the block is unreachable

* test(files): Increment upload handler coverage to 88%

All lines, except the `500` status code error, are covered now

---------

Co-authored-by: Antonio Donis <[email protected]>
Co-authored-by: Pedro Andrés Chaparro Quintero <[email protected]>
Co-authored-by: Pedro Andrés Chaparro Quintero <[email protected]>
Co-authored-by: Andrea Velasquez <[email protected]>
Co-authored-by: Andvelavi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Update openapi spec
2 participants