Skip to content

Commit 072ad23

Browse files
taban03Jakub Balhar
authored andcommitted
fix: Add x509 auth info to gw api doc (#2142)
Signed-off-by: at670475 <andrea.tabone@broadcom.com>
1 parent a2b5dda commit 072ad23

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

gateway-service/src/main/resources/gateway-api-doc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"post": {
2525
"tags": ["Security"],
2626
"summary": "Authenticate mainframe user credentials and return authentication token.",
27-
"description": "Use the `/login` API to authenticate mainframe user credentials and return authentication token.\n\n**Request:**\n\nThe login request requires the user credentials in one of the following formats:\n * Basic access authentication\n * JSON body, which provides an object with the user credentials\n\n**Response:**\n\nThe response is an empty body and a token in a secure HttpOnly cookie named `apimlAuthenticationToken`.\n",
27+
"description": "Use the `/login` API to authenticate mainframe user credentials and return authentication token. It is also possible to authenticate using the x509 client certificate authentication, if enabled.\n\n**Request:**\n\nThe login request requires the user credentials in one of the following formats:\n * Basic access authentication\n * JSON body, which provides an object with the user credentials\n * HTTP header containing the client certificate\n\n**Response:**\n\nThe response is an empty body and a token in a secure HttpOnly cookie named `apimlAuthenticationToken`.\n",
2828
"operationId": "loginUsingPOST",
2929
"requestBody": {
3030
"content": {

gateway-service/src/test/resources/api-doc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"Security"
1919
],
2020
"summary": "Authenticate mainframe user credentials and return authentication token.",
21-
"description": "Use the `/login` API to authenticate mainframe user credentials and return authentication token.\n\n**Request:**\n\nThe login request requires the user credentials in one of the following formats:\n * Basic access authentication\n * JSON body, which provides an object with the user credentials\n\n**Response:**\n\nThe response is an empty body and a token in a secure HttpOnly cookie named `apimlAuthenticationToken`.\n",
21+
"description": "Use the `/login` API to authenticate mainframe user credentials and return authentication token. It is also possible to authenticate using the x509 client certificate authentication, if enabled.\n\n**Request:**\n\nThe login request requires the user credentials in one of the following formats:\n * Basic access authentication\n * JSON body, which provides an object with the user credentials\n * HTTP header containing the client certificate\n\n**Response:**\n\nThe response is an empty body and a token in a secure HttpOnly cookie named `apimlAuthenticationToken`.\n",
2222
"operationId": "loginUsingPOST",
2323
"requestBody": {
2424
"content": {

0 commit comments

Comments
 (0)