Skip to content

Commit

Permalink
add operationId in OnboardingV2Controller and update openapi
Browse files Browse the repository at this point in the history
  • Loading branch information
giulia-tremolada committed Feb 4, 2025
1 parent 813c4bc commit f7b823c
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 15 deletions.
10 changes: 5 additions & 5 deletions apps/onboarding-ms/src/main/docs/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -1813,7 +1813,7 @@
"tags" : [ "Onboarding Controller", "internal-v1" ],
"summary" : "Complete onboarding request and set status to COMPLETED.",
"description" : "Perform onboarding as /onboarding but completing the onboarding request to COMPLETED phase.",
"operationId" : "onboardingCompletion",
"operationId" : "onboardingCompletionV2",
"requestBody" : {
"content" : {
"application/json" : {
Expand Down Expand Up @@ -1851,7 +1851,7 @@
"tags" : [ "support", "internal-v1", "Onboarding" ],
"summary" : "Get onboardings by institution taxCode, subunitCode, origin, or originId.",
"description" : "Returns onboardings record by institution taxCode/subunitCode/origin/originId",
"operationId" : "onboardingInstitutionUsingGET",
"operationId" : "onboardingInstitutionUsingGETV2",
"parameters" : [ {
"name" : "origin",
"in" : "query",
Expand Down Expand Up @@ -1915,7 +1915,7 @@
"tags" : [ "Onboarding Controller", "internal-v1" ],
"summary" : "Complete PA onboarding request and set status to COMPLETED.",
"description" : "Perform onboarding as /onboarding/pa but completing the onboarding request to COMPLETED phase.",
"operationId" : "onboardingPaCompletion",
"operationId" : "onboardingPaCompletionV2",
"requestBody" : {
"content" : {
"application/json" : {
Expand Down Expand Up @@ -1953,7 +1953,7 @@
"tags" : [ "Onboarding Controller", "internal-pnpg" ],
"summary" : "Complete PG onboarding request on PNPG domain and set status to COMPLETED.",
"description" : "Perform onboarding as /onboarding/psp but completing the onboarding request to COMPLETED phase.",
"operationId" : "onboardingPgCompletion",
"operationId" : "onboardingPgCompletionV2",
"requestBody" : {
"content" : {
"application/json" : {
Expand Down Expand Up @@ -1991,7 +1991,7 @@
"tags" : [ "Onboarding Controller", "internal-v1" ],
"summary" : "Complete PSP onboarding request and set status to COMPLETED.",
"description" : "Perform onboarding as /onboarding/psp but completing the onboarding request to COMPLETED phase.",
"operationId" : "onboardingPspCompletion",
"operationId" : "onboardingPspCompletionV2",
"requestBody" : {
"content" : {
"application/json" : {
Expand Down
10 changes: 5 additions & 5 deletions apps/onboarding-ms/src/main/docs/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1336,7 +1336,7 @@ paths:
summary: Complete onboarding request and set status to COMPLETED.
description: Perform onboarding as /onboarding but completing the onboarding
request to COMPLETED phase.
operationId: onboardingCompletion
operationId: onboardingCompletionV2
requestBody:
content:
application/json:
Expand All @@ -1363,7 +1363,7 @@ paths:
- Onboarding
summary: "Get onboardings by institution taxCode, subunitCode, origin, or originId."
description: Returns onboardings record by institution taxCode/subunitCode/origin/originId
operationId: onboardingInstitutionUsingGET
operationId: onboardingInstitutionUsingGETV2
parameters:
- name: origin
in: query
Expand Down Expand Up @@ -1409,7 +1409,7 @@ paths:
summary: Complete PA onboarding request and set status to COMPLETED.
description: Perform onboarding as /onboarding/pa but completing the onboarding
request to COMPLETED phase.
operationId: onboardingPaCompletion
operationId: onboardingPaCompletionV2
requestBody:
content:
application/json:
Expand All @@ -1436,7 +1436,7 @@ paths:
summary: Complete PG onboarding request on PNPG domain and set status to COMPLETED.
description: Perform onboarding as /onboarding/psp but completing the onboarding
request to COMPLETED phase.
operationId: onboardingPgCompletion
operationId: onboardingPgCompletionV2
requestBody:
content:
application/json:
Expand All @@ -1463,7 +1463,7 @@ paths:
summary: Complete PSP onboarding request and set status to COMPLETED.
description: Perform onboarding as /onboarding/psp but completing the onboarding
request to COMPLETED phase.
operationId: onboardingPspCompletion
operationId: onboardingPspCompletionV2
requestBody:
content:
application/json:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ public class OnboardingV2Controller {

@Operation(
summary = "Complete onboarding request and set status to COMPLETED.",
description = "Perform onboarding as /onboarding but completing the onboarding request to COMPLETED phase."
description = "Perform onboarding as /onboarding but completing the onboarding request to COMPLETED phase.",
operationId = "onboardingCompletionV2"
)
@Path("/completion")
@POST
Expand All @@ -58,7 +59,9 @@ public Uni<OnboardingResponse> onboardingCompletion(@Valid OnboardingDefaultRequ
@Operation(
summary = "Complete PA onboarding request and set status to COMPLETED.",
description =
"Perform onboarding as /onboarding/pa but completing the onboarding request to COMPLETED phase.")
"Perform onboarding as /onboarding/pa but completing the onboarding request to COMPLETED phase.",
operationId = "onboardingPaCompletionV2"
)
@POST
@Path("/pa/completion")
@Tag(name = "Onboarding Controller")
Expand All @@ -75,7 +78,9 @@ public Uni<OnboardingResponse> onboardingPaCompletion(@Valid OnboardingPaRequest
@Operation(
summary = "Complete PSP onboarding request and set status to COMPLETED.",
description =
"Perform onboarding as /onboarding/psp but completing the onboarding request to COMPLETED phase.")
"Perform onboarding as /onboarding/psp but completing the onboarding request to COMPLETED phase.",
operationId = "onboardingPspCompletionV2"
)
@POST
@Path("/psp/completion")
@Tag(name = "Onboarding Controller")
Expand All @@ -90,7 +95,8 @@ public Uni<OnboardingResponse> onboardingPspCompletion(@Valid OnboardingPspReque

@Operation(
summary = "Complete PG onboarding request on PNPG domain and set status to COMPLETED.",
description = "Perform onboarding as /onboarding/psp but completing the onboarding request to COMPLETED phase."
description = "Perform onboarding as /onboarding/psp but completing the onboarding request to COMPLETED phase.",
operationId = "onboardingPgCompletionV2"
)
@POST
@Path("/pg/completion")
Expand Down Expand Up @@ -125,7 +131,7 @@ private Uni<String> readUserIdFromToken(SecurityContext ctx) {
@Operation(
summary = "Get onboardings by institution taxCode, subunitCode, origin, or originId.",
description = "Returns onboardings record by institution taxCode/subunitCode/origin/originId",
operationId = "onboardingInstitutionUsingGET",
operationId = "onboardingInstitutionUsingGETV2",
extensions = @Extension(name = "x-legacy-api", value = "true")
)
@GET
Expand Down

0 comments on commit f7b823c

Please sign in to comment.