Skip to content

Commit

Permalink
feat(jans-config-api): pagination functionality for endpoints and swa…
Browse files Browse the repository at this point in the history 
…gger spec rectification (#2397)

* feat(jans-config-api): pagination functionality

* feat(config-api): pagination changes

* feat(config-api): pagination enhacement

* feat(config-api): pagination enhacement

* feat(config-api): swagger spec issues fix - wip

* feat(config-api): swagger spec fix for CouchbaseConfiguration

* feat(config-api): swagger spec fix for Custom Script

* feat(config-api): swagger spec fix for JWKS

* feat(config-api): swagger spec fix for UmaResource

* feat(config-api): swagger spec fix

* feat(config-api): pagination enhancement

* feat(config-api): pagination enhancement
  • Loading branch information
@pujavs
pujavs authored Sep 15, 2022
1 parent 2e02d5e commit d893e13
Show file tree
Hide file tree
Showing 33 changed files with 967 additions and 386 deletions.
1 change: 1 addition & 0 deletions jans-config-api/common/src/main/java/io/jans/configapi/util/ApiAccessConstants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ private ApiAccessConstants() {

public static final String JWKS_READ_ACCESS = "https://jans.io/oauth/config/jwks.readonly";
public static final String JWKS_WRITE_ACCESS = "https://jans.io/oauth/config/jwks.write";
public static final String JWKS_DELETE_ACCESS = "https://jans.io/oauth/config/jwks.delete";

public static final String OPENID_CLIENTS_READ_ACCESS = "https://jans.io/oauth/config/openid/clients.readonly";
public static final String OPENID_CLIENTS_WRITE_ACCESS = "https://jans.io/oauth/config/openid/clients.write";
Expand Down
180 changes: 136 additions & 44 deletions jans-config-api/docs/jans-config-api-swagger-auto.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ paths:
tags:
- Health - Check
summary: Returns application health status
description: Gets a list of Gluu attributes.
description: Returns application health status
operationId: get-config-health
responses:
"200":
Expand Down Expand Up @@ -171,6 +171,22 @@ paths:
type: integer
format: int32
default: 50
- name: startIndex
in: query
schema:
type: integer
format: int32
default: 1
- name: sortBy
in: query
schema:
type: string
default: qname
- name: sortOrder
in: query
schema:
type: string
default: ascending
- name: includeSource
in: query
schema:
Expand All @@ -182,9 +198,7 @@ paths:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Flow'
$ref: '#/components/schemas/PagedResult'
"401":
description: Unauthorized
"500":
Expand Down Expand Up @@ -423,9 +437,7 @@ paths:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GluuAttribute'
$ref: '#/components/schemas/PagedResult'
"401":
description: Unauthorized
"500":
Expand Down Expand Up @@ -963,9 +975,7 @@ paths:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Client'
$ref: '#/components/schemas/PagedResult'
"401":
description: Unauthorized
"500":
Expand Down Expand Up @@ -1502,15 +1512,41 @@ paths:
summary: Fetch custom script by name
description: Gets a list of custom scripts
operationId: get-config-scripts
parameters:
- name: limit
in: query
schema:
type: integer
format: int32
default: 50
- name: pattern
in: query
schema:
type: string
default: ""
- name: startIndex
in: query
schema:
type: integer
format: int32
default: 1
- name: sortBy
in: query
schema:
type: string
default: inum
- name: sortOrder
in: query
schema:
type: string
default: ascending
responses:
"200":
description: Ok
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomScript'
$ref: '#/components/schemas/PagedResult'
"401":
description: Unauthorized
"500":
Expand Down Expand Up @@ -1704,26 +1740,40 @@ paths:
required: true
schema:
type: string
- name: limit
in: query
schema:
type: integer
format: int32
default: 50
- name: pattern
in: query
schema:
type: string
default: ""
- name: limit
- name: startIndex
in: query
schema:
type: integer
format: int32
default: 50
default: 1
- name: sortBy
in: query
schema:
type: string
default: inum
- name: sortOrder
in: query
schema:
type: string
default: ascending
responses:
"200":
description: Ok
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomScript'
$ref: '#/components/schemas/PagedResult'
"401":
description: Unauthorized
"404":
Expand Down Expand Up @@ -1799,7 +1849,7 @@ paths:
description: InternalServerError
security:
- oauth2:
- https://jans.io/oauth/config/jwks.write
- https://jans.io/oauth/config/jwks.delete
patch:
tags:
- Configuration – JWK - JSON Web Key (JWK)
Expand Down Expand Up @@ -2187,7 +2237,7 @@ paths:
description: Updates Jans Authorization Server logging settings
operationId: put-config-logging
requestBody:
description: GluuAttribute object
description: Logging object
content:
application/json:
schema:
Expand Down Expand Up @@ -2283,6 +2333,20 @@ paths:
schema:
type: string
default: ""
- name: startIndex
in: query
schema:
type: integer
format: int32
default: 1
- name: sortBy
in: query
schema:
type: string
- name: sortOrder
in: query
schema:
type: string
- name: withAssociatedClients
in: query
schema:
Expand All @@ -2294,9 +2358,7 @@ paths:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomScope'
$ref: '#/components/schemas/PagedResult'
"401":
description: Unauthorized
"500":
Expand Down Expand Up @@ -2817,15 +2879,27 @@ paths:
schema:
type: string
default: ""
- name: startIndex
in: query
schema:
type: integer
format: int32
default: 1
- name: sortBy
in: query
schema:
type: string
- name: sortOrder
in: query
schema:
type: string
responses:
"200":
description: Ok
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UmaResource'
$ref: '#/components/schemas/PagedResult'
"401":
description: Unauthorized
"500":
Expand Down Expand Up @@ -3112,6 +3186,22 @@ components:
type: object
additionalProperties:
type: object
PagedResult:
type: object
properties:
start:
type: integer
format: int32
totalEntriesCount:
type: integer
format: int32
entriesCount:
type: integer
format: int32
entries:
type: array
items:
type: object
JsonPatch:
type: object
AttributeValidation:
Expand Down Expand Up @@ -3227,20 +3317,20 @@ components:
$ref: '#/components/schemas/AttributeValidation'
tooltip:
type: string
whitePagesCanView:
type: boolean
adminCanAccess:
type: boolean
adminCanEdit:
userCanAccess:
type: boolean
adminCanView:
type: boolean
userCanAccess:
type: boolean
userCanEdit:
type: boolean
adminCanAccess:
type: boolean
userCanView:
type: boolean
adminCanEdit:
type: boolean
whitePagesCanView:
type: boolean
baseDn:
type: string
PatchRequest:
Expand Down Expand Up @@ -3566,8 +3656,6 @@ components:
format: int32
displayName:
type: string
tokenBindingSupported:
type: boolean
authenticationMethod:
type: string
enum:
Expand All @@ -3579,6 +3667,8 @@ components:
- tls_client_auth
- self_signed_tls_client_auth
- none
tokenBindingSupported:
type: boolean
baseDn:
type: string
inum:
Expand All @@ -3588,7 +3678,7 @@ components:
properties:
tlsClientAuthSubjectDn:
type: string
runIntrospectionScriptBeforeJwtCreation:
runIntrospectionScriptBeforeAccessTokenAsJwtCreationAndIncludeClaims:
type: boolean
keepClientAuthorizationAfterExpiration:
type: boolean
Expand Down Expand Up @@ -3668,24 +3758,24 @@ components:
type: array
items:
type: string
value:
type: string
displayValue:
type: string
value:
type: string
LocalizedString:
type: object
properties:
values:
type: object
additionalProperties:
type: string
value:
type: string
languageTags:
uniqueItems: true
type: array
items:
type: string
value:
type: string
AppConfiguration:
type: object
properties:
Expand Down Expand Up @@ -4268,6 +4358,8 @@ components:
enum:
- internal
- remote
disableAuthnForMaxAgeZero:
type: boolean
keepAuthenticatorAttributesOnAcrChange:
type: boolean
deviceAuthzRequestExpiresIn:
Expand Down Expand Up @@ -4360,8 +4452,6 @@ components:
type: string
agamaConfiguration:
$ref: '#/components/schemas/EngineConfig'
fapi:
type: boolean
enabledFeatureFlags:
uniqueItems: true
type: array
Expand Down Expand Up @@ -4397,6 +4487,8 @@ components:
- code
- token
- id_token
fapi:
type: boolean
AuthenticationFilter:
required:
- baseDn
Expand Down Expand Up @@ -5064,10 +5156,10 @@ components:
type: array
items:
type: object
value:
type: object
displayValue:
type: string
value:
type: object
SessionId:
type: object
properties:
Expand Down
Loading

0 comments on commit d893e13

Please sign in to comment.