Skip to content

Commit 5eb01f0

Browse files
authored
Update REST API docs (#71)
1 parent 3ac406a commit 5eb01f0

File tree

59 files changed

+149
-601
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+149
-601
lines changed

api/openapi.yaml

Lines changed: 50 additions & 198 deletions
Original file line numberDiff line numberDiff line change
@@ -3837,7 +3837,7 @@ paths:
38373837
schema:
38383838
type: array
38393839
items:
3840-
$ref: "#/components/schemas/Role"
3840+
type: string
38413841
/user/userRealmRoles:
38423842
get:
38433843
tags:
@@ -3865,103 +3865,7 @@ paths:
38653865
schema:
38663866
type: array
38673867
items:
3868-
$ref: "#/components/schemas/Role"
3869-
/user/userRoles:
3870-
get:
3871-
tags:
3872-
- User
3873-
summary: Retrieve client roles for the currently authenticated user
3874-
operationId: getCurrentUserRoles
3875-
parameters:
3876-
- name: Authorization
3877-
in: header
3878-
schema:
3879-
type: string
3880-
- name: X-Forwarded-Proto
3881-
in: header
3882-
schema:
3883-
type: string
3884-
- name: X-Forwarded-Host
3885-
in: header
3886-
schema:
3887-
type: string
3888-
responses:
3889-
default:
3890-
description: default response
3891-
content:
3892-
application/json:
3893-
schema:
3894-
type: array
3895-
items:
3896-
$ref: "#/components/schemas/Role"
3897-
/user/{realm}/roles:
3898-
get:
3899-
tags:
3900-
- User
3901-
summary: Retrieve roles for a realm
3902-
operationId: getRoles
3903-
parameters:
3904-
- name: Authorization
3905-
in: header
3906-
schema:
3907-
type: string
3908-
- name: X-Forwarded-Proto
3909-
in: header
3910-
schema:
3911-
type: string
3912-
- name: X-Forwarded-Host
3913-
in: header
3914-
schema:
3915-
type: string
3916-
- name: realm
3917-
in: path
3918-
required: true
3919-
schema:
3920-
type: string
3921-
responses:
3922-
default:
3923-
description: default response
3924-
content:
3925-
application/json:
3926-
schema:
3927-
type: array
3928-
items:
3929-
$ref: "#/components/schemas/Role"
3930-
put:
3931-
tags:
3932-
- User
3933-
summary: Update roles for a realm
3934-
operationId: updateRoles
3935-
parameters:
3936-
- name: Authorization
3937-
in: header
3938-
schema:
3939-
type: string
3940-
- name: X-Forwarded-Proto
3941-
in: header
3942-
schema:
3943-
type: string
3944-
- name: X-Forwarded-Host
3945-
in: header
3946-
schema:
3947-
type: string
3948-
- name: realm
3949-
in: path
3950-
required: true
3951-
schema:
3952-
type: string
3953-
requestBody:
3954-
content:
3955-
application/json:
3956-
schema:
3957-
type: array
3958-
items:
3959-
$ref: "#/components/schemas/Role"
3960-
responses:
3961-
default:
3962-
description: default response
3963-
content:
3964-
'*/*': {}
3868+
type: string
39653869
/user/{realm}/userRoles/{userId}/{clientId}:
39663870
get:
39673871
tags:
@@ -4004,7 +3908,7 @@ paths:
40043908
schema:
40053909
type: array
40063910
items:
4007-
$ref: "#/components/schemas/Role"
3911+
type: string
40083912
put:
40093913
tags:
40103914
- User
@@ -4044,7 +3948,7 @@ paths:
40443948
schema:
40453949
type: array
40463950
items:
4047-
$ref: "#/components/schemas/Role"
3951+
type: string
40483952
responses:
40493953
default:
40503954
description: default response
@@ -4087,7 +3991,7 @@ paths:
40873991
schema:
40883992
type: array
40893993
items:
4090-
$ref: "#/components/schemas/Role"
3994+
type: string
40913995
put:
40923996
tags:
40933997
- User
@@ -4122,85 +4026,7 @@ paths:
41224026
schema:
41234027
type: array
41244028
items:
4125-
$ref: "#/components/schemas/Role"
4126-
responses:
4127-
default:
4128-
description: default response
4129-
content:
4130-
'*/*': {}
4131-
/user/{realm}/userRoles/{userId}:
4132-
get:
4133-
tags:
4134-
- User
4135-
summary: Retrieve client roles for a user in a realm
4136-
operationId: getUserRoles
4137-
parameters:
4138-
- name: Authorization
4139-
in: header
4140-
schema:
4141-
type: string
4142-
- name: X-Forwarded-Proto
4143-
in: header
4144-
schema:
4145-
type: string
4146-
- name: X-Forwarded-Host
4147-
in: header
4148-
schema:
4149-
type: string
4150-
- name: realm
4151-
in: path
4152-
required: true
4153-
schema:
4154-
type: string
4155-
- name: userId
4156-
in: path
4157-
required: true
4158-
schema:
4159-
type: string
4160-
responses:
4161-
default:
4162-
description: default response
4163-
content:
4164-
application/json:
4165-
schema:
4166-
type: array
4167-
items:
4168-
$ref: "#/components/schemas/Role"
4169-
put:
4170-
tags:
4171-
- User
4172-
summary: Update client roles for a user in a realm
4173-
operationId: updateUserRoles
4174-
parameters:
4175-
- name: Authorization
4176-
in: header
4177-
schema:
4178-
type: string
4179-
- name: X-Forwarded-Proto
4180-
in: header
4181-
schema:
4182-
type: string
4183-
- name: X-Forwarded-Host
4184-
in: header
4185-
schema:
4186-
type: string
4187-
- name: realm
4188-
in: path
4189-
required: true
4190-
schema:
4191-
type: string
4192-
- name: userId
4193-
in: path
4194-
required: true
4195-
schema:
4196-
type: string
4197-
requestBody:
4198-
content:
4199-
application/json:
4200-
schema:
4201-
type: array
4202-
items:
4203-
$ref: "#/components/schemas/Role"
4029+
type: string
42044030
responses:
42054031
default:
42064032
description: default response
@@ -4381,6 +4207,42 @@ paths:
43814207
description: default response
43824208
content:
43834209
'*/*': {}
4210+
/user/{realm}/roles:
4211+
put:
4212+
tags:
4213+
- User
4214+
summary: Update roles for a realm
4215+
operationId: updateRoles
4216+
parameters:
4217+
- name: Authorization
4218+
in: header
4219+
schema:
4220+
type: string
4221+
- name: X-Forwarded-Proto
4222+
in: header
4223+
schema:
4224+
type: string
4225+
- name: X-Forwarded-Host
4226+
in: header
4227+
schema:
4228+
type: string
4229+
- name: realm
4230+
in: path
4231+
required: true
4232+
schema:
4233+
type: string
4234+
requestBody:
4235+
content:
4236+
application/json:
4237+
schema:
4238+
type: array
4239+
items:
4240+
$ref: "#/components/schemas/Role"
4241+
responses:
4242+
default:
4243+
description: default response
4244+
content:
4245+
'*/*': {}
43844246
/syslog/event:
43854247
get:
43864248
tags:
@@ -4580,9 +4442,6 @@ components:
45804442
items:
45814443
type: object
45824444
AssetObject:
4583-
required:
4584-
- name
4585-
- realm
45864445
type: object
45874446
properties:
45884447
id:
@@ -4644,8 +4503,6 @@ components:
46444503
additionalProperties:
46454504
$ref: "#/components/schemas/AttributeObject"
46464505
AttributeObject:
4647-
required:
4648-
- name
46494506
type: object
46504507
properties:
46514508
type:
@@ -4654,6 +4511,7 @@ components:
46544511
type: object
46554512
writeOnly: true
46564513
name:
4514+
minLength: 1
46574515
pattern: ^\w+$
46584516
type: string
46594517
meta:
@@ -4685,8 +4543,6 @@ components:
46854543
max:
46864544
type: number
46874545
MetaItemObject:
4688-
required:
4689-
- name
46904546
type: object
46914547
properties:
46924548
type:
@@ -4695,6 +4551,7 @@ components:
46954551
type: object
46964552
writeOnly: true
46974553
name:
4554+
minLength: 1
46984555
pattern: ^\w+$
46994556
type: string
47004557
MetaMap:
@@ -4989,9 +4846,6 @@ components:
49894846
binary:
49904847
type: boolean
49914848
AgentObjectObjectObject:
4992-
required:
4993-
- name
4994-
- realm
49954849
type: object
49964850
properties:
49974851
id:
@@ -5664,8 +5518,6 @@ components:
56645518
discriminator:
56655519
propertyName: predicateType
56665520
AttributeRef:
5667-
required:
5668-
- name
56695521
type: object
56705522
properties:
56715523
id:
@@ -5674,6 +5526,7 @@ components:
56745526
description: The asset identifier
56755527
example: 7Bt8M3cXEP6BHPh8r47DYf
56765528
name:
5529+
minLength: 1
56775530
pattern: ^\w+$
56785531
type: string
56795532
description: The attribute name
@@ -5786,19 +5639,19 @@ components:
57865639
type: object
57875640
ConsoleRegistration:
57885641
required:
5789-
- name
5790-
- platform
57915642
- providers
5792-
- version
57935643
type: object
57945644
properties:
57955645
id:
57965646
type: string
57975647
name:
5648+
minLength: 1
57985649
type: string
57995650
version:
5651+
minLength: 1
58005652
type: string
58015653
platform:
5654+
minLength: 1
58025655
type: string
58035656
providers:
58045657
type: object
@@ -5812,8 +5665,6 @@ components:
58125665
type: string
58135666
Dashboard:
58145667
required:
5815-
- displayName
5816-
- realm
58175668
- template
58185669
type: object
58195670
properties:
@@ -5844,6 +5695,7 @@ components:
58445695
- SHARED
58455696
- PRIVATE
58465697
displayName:
5698+
minLength: 1
58475699
type: string
58485700
template:
58495701
$ref: "#/components/schemas/DashboardTemplate"
@@ -5886,13 +5738,13 @@ components:
58865738
type: boolean
58875739
DashboardScreenPreset:
58885740
required:
5889-
- displayName
58905741
- scalingPreset
58915742
type: object
58925743
properties:
58935744
id:
58945745
type: string
58955746
displayName:
5747+
minLength: 1
58965748
type: string
58975749
breakpoint:
58985750
minimum: 1

0 commit comments

Comments
 (0)