Skip to content

Commit

Permalink
Update openapi
Browse files Browse the repository at this point in the history
  • Loading branch information
@manuraf @github-actions
manuraf authored and github-actions[bot] committed Sep 6, 2024
1 parent d65954f commit 1831ce1
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 307 deletions.
2 changes: 1 addition & 1 deletion infra/apim_v2/api/external_api_contract/v1/openapi.uat.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"name": "productId",
"in": "query",
"description": "Product's unique identifier",
"required": true,
"required": false,
"style": "form",
"schema": {
"type": "string"
Expand Down
299 changes: 1 addition & 298 deletions infra/apim_v2/api/ms_external_api/v2/openapi.uat.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@
]
}
},
"/institutions/": {
"/institutions": {
"get": {
"tags": [
"Institution"
Expand Down Expand Up @@ -265,91 +265,6 @@
]
}
},
"/institutions": {
"get": {
"tags": [
"Institution"
],
"summary": "getInstitutions",
"deprecated": true,
"description": "The service retrieves all the onboarded institutions related to the provided user and the product retrieved from Subscription Key. It is deprecated in favor of endpoint /users?institutionId={institutionId}",
"operationId": "getInstitutionsUsingGETDeprecated",
"parameters": [
{
"name": "userIdForAuth",
"in": "query",
"description": "User's unique identifier",
"required": true,
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstitutionResource"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"bearerAuth": [
"global"
]
}
]
}
},
"/institutions/{id}": {
"get": {
"tags": [
Expand Down Expand Up @@ -2544,218 +2459,6 @@
}
}
},
"InstitutionResource": {
"title": "InstitutionResource",
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Institution's physical address"
},
"aooParentCode": {
"type": "string",
"description": "AOO unit parent institution Code"
},
"assistanceContacts": {
"description": "Institution's assistance contacts",
"$ref": "#/components/schemas/AssistanceContactsResource"
},
"city": {
"type": "string",
"description": "Institution's physical address city"
},
"companyInformations": {
"description": "GPS, SCP, PT optional data",
"$ref": "#/components/schemas/CompanyInformationsResource"
},
"country": {
"type": "string",
"description": "Institution's physical address country"
},
"county": {
"type": "string",
"description": "Institution's physical address county"
},
"description": {
"type": "string",
"description": "Institution's legal name"
},
"digitalAddress": {
"type": "string",
"description": "Institution's digitalAddress"
},
"dpoData": {
"description": "Data Protection Officer (DPO) specific data",
"$ref": "#/components/schemas/DpoDataResource"
},
"externalId": {
"type": "string",
"description": "Institution's unique external identifier"
},
"id": {
"type": "string",
"description": "Institution's unique internal Id",
"format": "uuid"
},
"institutionType": {
"type": "string",
"description": "Institution's type",
"enum": [
"AS",
"GSP",
"PA",
"PG",
"PSP",
"PT",
"SA",
"SCP",
"REC",
"CON"
]
},
"origin": {
"type": "string",
"description": "Institution data origin"
},
"originId": {
"type": "string",
"description": "Institution's details origin Id"
},
"pspData": {
"description": "Payment Service Provider (PSP) specific data",
"$ref": "#/components/schemas/PspDataResource"
},
"recipientCode": {
"type": "string",
"description": "Billing recipient code, not required only for institutionType SA"
},
"rootParent": {
"description": "Institution AOO/UO root institutionDescription",
"$ref": "#/components/schemas/RootParentResource"
},
"status": {
"type": "string",
"description": "Institution onboarding status"
},
"subunitCode": {
"type": "string",
"description": "Institutions AOO/UO unit Code"
},
"subunitType": {
"type": "string",
"description": "Institutions AOO/UO unit type"
},
"taxCode": {
"type": "string",
"description": "Institution's taxCode"
},
"userProductRoles": {
"type": "array",
"description": "Logged user's roles on product",
"items": {
"type": "string"
}
},
"zipCode": {
"type": "string",
"description": "Institution's zipCode"
}
}
},
"AssistanceContactsResource": {
"title": "AssistanceContactsResource",
"type": "object",
"properties": {
"supportEmail": {
"type": "string",
"description": "Institution's support email contact"
},
"supportPhone": {
"type": "string",
"description": "Institution's support phone contact"
}
}
},
"CompanyInformationsResource": {
"title": "CompanyInformationsResource",
"type": "object",
"properties": {
"businessRegisterPlace": {
"type": "string",
"description": "Institution's business register place"
},
"rea": {
"type": "string",
"description": "Institution's REA"
},
"shareCapital": {
"type": "string",
"description": "Institution's share capital value"
}
}
},"DpoDataResource": {
"title": "DpoDataResource",
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "DPO's address"
},
"email": {
"type": "string",
"description": "DPO's email",
"format": "email",
"example": "email@example.com"
},
"pec": {
"type": "string",
"description": "DPO's PEC",
"format": "email",
"example": "email@example.com"
}
}
},
"RootParentResource": {
"title": "RootParentResource",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "swagger.external_api.institutions.model.parentDescription"
},
"id": {
"type": "string",
"description": "Institution's unique internal Id"
}
}
},
"PspDataResource": {
"title": "PspDataResource",
"type": "object",
"properties": {
"abiCode": {
"type": "string",
"description": "PSP's ABI code"
},
"businessRegisterNumber": {
"type": "string",
"description": "PSP's Business Register number"
},
"legalRegisterName": {
"type": "string",
"description": "PSP's legal register name"
},
"legalRegisterNumber": {
"type": "string",
"description": "PSP's legal register number"
},
"vatNumberGroup": {
"type": "boolean",
"description": "PSP's Vat Number group",
"example": false
}
}
},
"UserGroupResource": {
"title": "UserGroupResource",
"required": [
Expand Down
Loading

0 comments on commit 1831ce1

Please sign in to comment.