Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.

Commit 5de7523

Browse files
#11 - swagger updates on the response body
1 parent 5afa6b0 commit 5de7523

File tree

1 file changed

+88
-5
lines changed

1 file changed

+88
-5
lines changed

docs/swagger.yaml

Lines changed: 88 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3746,7 +3746,7 @@ paths:
37463746
schema:
37473747
type: "array"
37483748
items:
3749-
$ref: "#/definitions/User"
3749+
$ref: "#/definitions/EnhancedUser"
37503750
"400":
37513751
$ref: "#/definitions/BadRequest"
37523752
"401":
@@ -3783,7 +3783,7 @@ paths:
37833783
schema:
37843784
type: "array"
37853785
items:
3786-
$ref: "#/definitions/UserAttribute"
3786+
$ref: "#/definitions/LookupAttribute"
37873787
"400":
37883788
$ref: "#/definitions/BadRequest"
37893789
"401":
@@ -3821,7 +3821,7 @@ paths:
38213821
schema:
38223822
type: "array"
38233823
items:
3824-
$ref: "#/definitions/Achievement"
3824+
$ref: "#/definitions/LookupAchievement"
38253825
"400":
38263826
$ref: "#/definitions/BadRequest"
38273827
"401":
@@ -3859,7 +3859,7 @@ paths:
38593859
schema:
38603860
type: "array"
38613861
items:
3862-
$ref: "#/definitions/Skill"
3862+
$ref: "#/definitions/LookupSkill"
38633863
"400":
38643864
$ref: "#/definitions/BadRequest"
38653865
"401":
@@ -3953,6 +3953,17 @@ definitions:
39533953
format: "date-time"
39543954
description: "The date when certification occurred."
39553955
- $ref: "#/definitions/AuditFields"
3956+
LookupAchievement:
3957+
allOf:
3958+
- type: "object"
3959+
properties:
3960+
id:
3961+
type: "string"
3962+
format: "UUID"
3963+
description: "The id of the user achievement."
3964+
name:
3965+
type: "string"
3966+
description: "Name of achievement."
39563967
AchievementRequestBody:
39573968
allOf:
39583969
- type: "object"
@@ -4028,6 +4039,21 @@ definitions:
40284039
type: "string"
40294040
description: "The uri for the skill"
40304041
- $ref: "#/definitions/AuditFields"
4042+
LookupSkill:
4043+
allOf:
4044+
- type: "object"
4045+
properties:
4046+
skillId:
4047+
type: "string"
4048+
format: "UUID"
4049+
description: "The skill id"
4050+
skillProviderId:
4051+
type: "string"
4052+
format: "UUID"
4053+
description: "The referenced skill provider id"
4054+
name:
4055+
type: "string"
4056+
description: "The name of the skill"
40314057
SkillRequestBody:
40324058
allOf:
40334059
- type: "object"
@@ -4117,7 +4143,6 @@ definitions:
41174143
description: "If the external profile is inactive."
41184144
example:
41194145
organizationId: "organizationId"
4120-
userId: "userId"
41214146
uri: "uri"
41224147
externalId: "externalId"
41234148
isInactive: false
@@ -4208,6 +4233,49 @@ definitions:
42084233
type: "string"
42094234
description: "The last name of the user."
42104235
- $ref: "#/definitions/AuditFields"
4236+
EnhancedUser:
4237+
allOf:
4238+
- type: "object"
4239+
properties:
4240+
id:
4241+
type: "string"
4242+
format: "UUID"
4243+
description: "The id of the user."
4244+
handle:
4245+
type: "string"
4246+
description: "The handle of the user."
4247+
firstName:
4248+
type: "string"
4249+
description: "The first name of the user."
4250+
lastName:
4251+
type: "string"
4252+
description: "The last name of the user."
4253+
skills:
4254+
type: "array"
4255+
items:
4256+
type: "object"
4257+
description: "Array of skill objects"
4258+
achievements:
4259+
type: "array"
4260+
items:
4261+
type: "object"
4262+
description: "Array of achievement objects"
4263+
groups:
4264+
type: "array"
4265+
items:
4266+
type: "object"
4267+
description: "Array of group objects"
4268+
externalProfiles:
4269+
type: "array"
4270+
items:
4271+
type: "object"
4272+
description: "Array of external profile objects"
4273+
attributes:
4274+
type: "array"
4275+
items:
4276+
type: "object"
4277+
description: "Array of attribute objects"
4278+
- $ref: "#/definitions/AuditFields"
42114279
UserSkill:
42124280
allOf:
42134281
- type: "object"
@@ -4288,6 +4356,21 @@ definitions:
42884356
type: "string"
42894357
description: "The user attribute value."
42904358
- $ref: "#/definitions/AuditFields"
4359+
LookupAttribute:
4360+
allOf:
4361+
- type: "object"
4362+
properties:
4363+
id:
4364+
type: "string"
4365+
format: "UUID"
4366+
description: "The id of the user attribute."
4367+
attributeId:
4368+
type: "string"
4369+
format: "UUID"
4370+
description: "The attribute id."
4371+
value:
4372+
type: "string"
4373+
description: "The user attribute value."
42914374
UserAttributeRequestBody:
42924375
allOf:
42934376
- type: "object"

0 commit comments

Comments
 (0)