Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update open api contract with documentation updates #751

Merged
merged 2 commits into from
Dec 2, 2024
Merged

Update open api contract with documentation updates #751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7aeb732
Update open api file with updated documentation.
malithie Dec 2, 2024
731c06c
Merge branch 'master' into rule-api-version-update
malithie Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...tadata.v1/src/gen/java/org/wso2/carbon/identity/api/server/rule/metadata/v1/RulesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public class RulesApi {
@ApiResponse(code = 401, message = "Unauthorized", response = Void.class),
@ApiResponse(code = 500, message = "Server Error", response = Error.class)
})
public Response getExpressionMeta( @Valid @NotNull(message = "Property cannot be null.") @ApiParam(value = "Specifies the flow to retrieve rule metadata. This ensures that the metadata returned is relevant to the given flow.",required=true, allowableValues="preIssueAccessToken, prePasswordUpdate, preProfileUpdate, preLogin, postLogin, inLogin, preRegistration, inRegistration, inPasswordExpiry") @QueryParam("flow") String flow) {
public Response getExpressionMeta( @Valid @NotNull(message = "Property cannot be null.") @ApiParam(value = "Specifies the flow to retrieve rule metadata. This ensures that the metadata returned is relevant to the given flow. Note: At present, only the 'preIssueAccessToken' flow is supported. ",required=true, allowableValues="preIssueAccessToken, prePasswordUpdate, preProfileUpdate, preLogin, postLogin, inLogin, preRegistration, inRegistration, inPasswordExpiry") @QueryParam("flow") String flow) {

return delegate.getExpressionMeta(flow );
}
Expand Down
14 changes: 11 additions & 3 deletions ...rg.wso2.carbon.identity.api.server.rule.metadata.v1/src/main/resources/rule-metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.1
info:
title: WSO2 Identity Server Rule Metadata Service REST API
description: "The Rule Metadata Service API provides the essential metadata required to configure rules dynamically based on the flow context. \nThe metadata retrieved by this API is designed to support rule configuration in the user interface (UI) by delivering information about each configurable field, the set of applicable comparison operators (e.g., equals, contains) for each field, and lists of possible values or options for fields.\n"
title: WSO2 Identity Server Rule Metadata REST API
description: "The Rule Metadata API provides the essential metadata required to configure rules dynamically based on the flow context. \nThe metadata retrieved by this API is designed to support rule configuration in the user interface (UI) by delivering information about each configurable field, the set of applicable comparison operators (e.g., equals, contains) for each field, and lists of possible values or options for fields.\n"
contact:
name: WSO2
url: https://wso2.com/identity-and-access-management/
Expand Down Expand Up @@ -34,7 +34,10 @@ paths:
parameters:
- name: flow
in: query
description: Specifies the flow to retrieve rule metadata. This ensures that the metadata returned is relevant to the given flow.
description: |
Specifies the flow to retrieve rule metadata. This ensures that the metadata returned is relevant to the given flow.

Note: At present, only the 'preIssueAccessToken' flow is supported.
required: true
style: form
explode: true
Expand Down Expand Up @@ -212,6 +215,11 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codeSamples:
- lang: Curl
source: |
curl --location 'https://localhost:9443/api/server/v1/rules/metadata?flow=preIssueAccessToken' \
--header 'Authorization: Basic YWRtaW46YWRtaW4='
components:
schemas:
ExpressionMeta:
Expand Down
Loading