Improve authenticators.yaml

wso2 · Dec 12, 2024 · 3569c1b · 3569c1b
1 parent b834703
commit 3569c1b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/...src/gen/java/org/wso2/carbon/identity/api/server/authenticators/v1/AuthenticatorsApi.java b/...src/gen/java/org/wso2/carbon/identity/api/server/authenticators/v1/AuthenticatorsApi.java
@@ -60,7 +60,6 @@ public class AuthenticatorsApi  {
         @ApiResponse(code = 400, message = "Bad Request", response = Error.class),
         @ApiResponse(code = 401, message = "Unauthorized", response = Void.class),
         @ApiResponse(code = 403, message = "Forbidden", response = Void.class),
-        @ApiResponse(code = 409, message = "Conflict", response = Error.class),
         @ApiResponse(code = 500, message = "Server Error", response = Error.class)
     })
     public Response addUserDefinedLocalAuthenticator(@ApiParam(value = "This represents the user defined local authenticator to be created." ,required=true) @Valid UserDefinedLocalAuthenticatorCreation userDefinedLocalAuthenticatorCreation) {
@@ -133,7 +132,6 @@ public Response authenticatorsMetaTagsGet() {
         @ApiResponse(code = 400, message = "Bad Request", response = Error.class),
         @ApiResponse(code = 401, message = "Unauthorized", response = Void.class),
         @ApiResponse(code = 403, message = "Forbidden", response = Void.class),
-        @ApiResponse(code = 409, message = "Conflict", response = Error.class),
         @ApiResponse(code = 500, message = "Server Error", response = Error.class)
     })
     public Response deleteUserDefinedLocalAuthenticator(@ApiParam(value = "ID of an authenticator",required=true) @PathParam("authenticator-id") String authenticatorId) {
@@ -181,7 +179,6 @@ public Response getConnectedAppsOfLocalAuthenticator(@ApiParam(value = "ID of an
         @ApiResponse(code = 400, message = "Bad Request", response = Error.class),
         @ApiResponse(code = 401, message = "Unauthorized", response = Void.class),
         @ApiResponse(code = 403, message = "Forbidden", response = Void.class),
-        @ApiResponse(code = 409, message = "Conflict", response = Error.class),
         @ApiResponse(code = 500, message = "Server Error", response = Error.class)
     })
     public Response updateUserDefinedLocalAuthenticator(@ApiParam(value = "ID of an authenticator",required=true) @PathParam("authenticator-id") String authenticatorId, @ApiParam(value = "This represents the user defined local authenticator to be created." ,required=true) @Valid UserDefinedLocalAuthenticatorUpdate userDefinedLocalAuthenticatorUpdate) {

diff --git a/....wso2.carbon.identity.api.server.authenticators.v1/src/main/resources/authenticators.yaml b/....wso2.carbon.identity.api.server.authenticators.v1/src/main/resources/authenticators.yaml
@@ -323,6 +323,7 @@ components:
         id:
           type: string
           example: QmFzaWNBdXRoZW50aWNhdG9y
+          readOnly: true
         name:
           type: string
           example: BasicAuthenticator
@@ -337,11 +338,13 @@ components:
           enum:
             - SYSTEM
             - USER
+          readOnly: true
         type:
           type: string
           enum:
             - LOCAL
             - FEDERATED
+          readOnly: true
         image:
           type: string
           example: basic-authenticator-logo-url
@@ -353,6 +356,7 @@ components:
           items:
             type: string
           example: [2FA, MFA]
+          readOnly: true
         self:
           type: string
           example: /t/carbon.super/api/server/v1/configs/authenticators/eDUwOUNlcnRpZmljYXRlQXV0aGVudGljYXRvcg