#3981 - Model SDPR API #4018
Merged
#3981 - Model SDPR API #4018
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
andrepestana-aot
commented
Dec 3, 2024
•
andrepestana-aot
commented
- Created a new module for SIMS API from external access;
- Created a segregated swagger for external endpoints: http://localhost:3000/external/swagger ;
- Created Postman collection to authenticate and request a student by SIN (Teams folder);
- Documented on: https://github.com/bcgov/SIMS/wiki/Keycloak-Config#external-api-access-service-accounts
| @Module({ | ||
| imports: [AuthModule], | ||
| controllers: [StudentExternalController], | ||
| providers: [StudentService], |
There was a problem hiding this comment.
Open for discussion but we can keep those services at the API scope at first.
We can create some specific services for the external module, but I am not sure if we should start creating them in the integrations lib directly.
There was a problem hiding this comment.
@dheepak-aot can you please collaborate on this?
There was a problem hiding this comment.
I agree with @andrewsignori-aot, current scope of the services that serve the external APIs can be in API scope.
sources/packages/backend/apps/api/src/route-controllers/student/student.external.controller.ts
Show resolved
Hide resolved
sources/packages/backend/apps/api/src/route-controllers/student/student.external.controller.ts
Outdated
Show resolved
Hide resolved
sources/packages/backend/apps/api/src/route-controllers/student/student.external.controller.ts
Outdated
Show resolved
Hide resolved
sources/packages/backend/libs/utilities/src/config/config.models.ts
Outdated
Show resolved
Hide resolved
sources/packages/backend/apps/api/src/route-controllers/student/student.external.controller.ts
Outdated
Show resolved
Hide resolved
sources/packages/backend/libs/utilities/src/config/config.service.ts
Outdated
Show resolved
Hide resolved
sources/packages/backend/apps/api/src/route-controllers/student/student.external.controller.ts
Show resolved
Hide resolved
sources/packages/backend/apps/api/src/auth/guards/authorized-parties.guard.ts
Outdated
Show resolved
Hide resolved
|
Just a minor comment. Great work so far. Please take a look at the remaining comments. |
…ead of external azp; using StudentService from API;
|
Backend Unit Tests Coverage Report
|
E2E Workflow Workers Coverage Report
|
E2E Queue Consumers Coverage Report
|
E2E SIMS API Coverage Report
|
andrewsignori-aot
approved these changes
Dec 5, 2024
lewischen-aot
approved these changes
Dec 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.