Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 7e74c3c

Browse files
xxcxyxxcxy
committedAug 7, 2020
#11 - Swagger Updates
1 parent 7eadeb6 commit 7e74c3c

File tree

1 file changed

+200
-10
lines changed

1 file changed

+200
-10
lines changed
 

‎docs/swagger.yaml

Lines changed: 200 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ tags:
3737
description: "Attributes registered in the system"
3838
- name: "Attribute Groups"
3939
description: "Attribute groups registered in the system"
40+
- name: "Search"
41+
description: "Search info registered in the system"
4042
schemes:
4143
- "https"
4244
consumes:
@@ -876,6 +878,10 @@ paths:
876878
in: "query"
877879
description: "The external id of the skill"
878880
type: "string"
881+
- name: "name"
882+
in: "query"
883+
description: "The name of the skill"
884+
type: "string"
879885
responses:
880886
"200":
881887
description: "OK - the request was successful"
@@ -2796,6 +2802,8 @@ paths:
27962802
\ endpoint will only return entities that\nthe user has created.\n"
27972803
operationId: "organizationsOrganizationIdSkillProvidersHEAD"
27982804
parameters:
2805+
- $ref: '#/parameters/page'
2806+
- $ref: '#/parameters/perPage'
27992807
- name: "organizationId"
28002808
in: "path"
28012809
description: "The organization id"
@@ -3710,6 +3718,159 @@ paths:
37103718
security:
37113719
- Bearer: []
37123720
x-swagger-router-controller: "AttributeGroups"
3721+
/search/users:
3722+
post:
3723+
tags:
3724+
- "Search"
3725+
description: "Search for users in the application. If no results, then empty\
3726+
\ array is returned. Multiple filters are\nsupported.\n\n**Security** - Note\
3727+
\ that for non-admin users, this endpoint will only return entities that\n\
3728+
the user has created.\n"
3729+
operationId: "searchUsersGET"
3730+
parameters:
3731+
- $ref: '#/parameters/page'
3732+
- $ref: '#/parameters/perPage'
3733+
- name: "orderBy"
3734+
in: "query"
3735+
description: "Sort order"
3736+
enum: ["name", "location", "isAvailable"]
3737+
type: "string"
3738+
- in: "body"
3739+
name: "body"
3740+
required: true
3741+
schema:
3742+
$ref: "#/definitions/SearchUserRequestBody"
3743+
responses:
3744+
"200":
3745+
description: "OK - the request was successful"
3746+
schema:
3747+
type: "array"
3748+
items:
3749+
$ref: "#/definitions/User"
3750+
"400":
3751+
$ref: "#/definitions/BadRequest"
3752+
"401":
3753+
$ref: "#/definitions/Unauthorized"
3754+
"403":
3755+
$ref: "#/definitions/Forbidden"
3756+
"500":
3757+
$ref: "#/definitions/ServerError"
3758+
security:
3759+
- Bearer: []
3760+
x-swagger-router-controller: "Search"
3761+
/search/userAttributes:
3762+
get:
3763+
tags:
3764+
- "Search"
3765+
description: "Search for user attributes in the application. If no results, then empty\
3766+
\ array is returned. Multiple filters are\nsupported.\n\n**Security** - Note\
3767+
\ that for non-admin users, this endpoint will only return entities that\n\
3768+
the user has created.\n"
3769+
operationId: "searchUserAttributesGET"
3770+
parameters:
3771+
- name: "attributeId"
3772+
in: "query"
3773+
description: "The attribute id"
3774+
type: "string"
3775+
format: "UUID"
3776+
- name: "attributeValue"
3777+
in: "query"
3778+
description: "The attribute value"
3779+
type: "string"
3780+
responses:
3781+
"200":
3782+
description: "OK - the request was successful"
3783+
schema:
3784+
type: "array"
3785+
items:
3786+
$ref: "#/definitions/UserAttribute"
3787+
"400":
3788+
$ref: "#/definitions/BadRequest"
3789+
"401":
3790+
$ref: "#/definitions/Unauthorized"
3791+
"403":
3792+
$ref: "#/definitions/Forbidden"
3793+
"500":
3794+
$ref: "#/definitions/ServerError"
3795+
security:
3796+
- Bearer: []
3797+
x-swagger-router-controller: "Search"
3798+
/search/userAchievements:
3799+
get:
3800+
tags:
3801+
- "Search"
3802+
description: "Search for user achievements in the application. If no results, then empty\
3803+
\ array is returned. Multiple filters are\nsupported.\n\n**Security** - Note\
3804+
\ that for non-admin users, this endpoint will only return entities that\n\
3805+
the user has created.\n"
3806+
operationId: "searchUserAchievementsGET"
3807+
parameters:
3808+
- name: "organizationId"
3809+
in: "query"
3810+
description: "The organization id"
3811+
type: "string"
3812+
format: "UUID"
3813+
required: true
3814+
- name: "keyword"
3815+
in: "query"
3816+
description: "The query keyword"
3817+
type: "string"
3818+
responses:
3819+
"200":
3820+
description: "OK - the request was successful"
3821+
schema:
3822+
type: "array"
3823+
items:
3824+
$ref: "#/definitions/Achievement"
3825+
"400":
3826+
$ref: "#/definitions/BadRequest"
3827+
"401":
3828+
$ref: "#/definitions/Unauthorized"
3829+
"403":
3830+
$ref: "#/definitions/Forbidden"
3831+
"500":
3832+
$ref: "#/definitions/ServerError"
3833+
security:
3834+
- Bearer: []
3835+
x-swagger-router-controller: "Search"
3836+
/search/skills:
3837+
get:
3838+
tags:
3839+
- "Search"
3840+
description: "Search for skills associated with an org in the application. If no results, then empty\
3841+
\ array is returned. Multiple filters are\nsupported.\n\n**Security** - Note\
3842+
\ that for non-admin users, this endpoint will only return entities that\n\
3843+
the user has created.\n"
3844+
operationId: "searchSkillsGET"
3845+
parameters:
3846+
- name: "organizationId"
3847+
in: "query"
3848+
description: "The organization id"
3849+
type: "string"
3850+
format: "UUID"
3851+
required: true
3852+
- name: "keyword"
3853+
in: "query"
3854+
description: "The query keyword"
3855+
type: "string"
3856+
responses:
3857+
"200":
3858+
description: "OK - the request was successful"
3859+
schema:
3860+
type: "array"
3861+
items:
3862+
$ref: "#/definitions/Skill"
3863+
"400":
3864+
$ref: "#/definitions/BadRequest"
3865+
"401":
3866+
$ref: "#/definitions/Unauthorized"
3867+
"403":
3868+
$ref: "#/definitions/Forbidden"
3869+
"500":
3870+
$ref: "#/definitions/ServerError"
3871+
security:
3872+
- Bearer: []
3873+
x-swagger-router-controller: "Search"
37133874
securityDefinitions:
37143875
Bearer:
37153876
type: "apiKey"
@@ -3938,17 +4099,12 @@ definitions:
39384099
type: "object"
39394100
required:
39404101
- "organizationId"
3941-
- "userId"
39424102
- "externalId"
39434103
properties:
39444104
organizationId:
39454105
type: "string"
39464106
format: "UUID"
39474107
description: "The id of the organization this profile belongs to."
3948-
userId:
3949-
type: "string"
3950-
format: "UUID"
3951-
description: "The id of the user this profile belongs to."
39524108
uri:
39534109
type: "string"
39544110
description: "The uri of the external profile."
@@ -3969,16 +4125,11 @@ definitions:
39694125
type: "object"
39704126
required:
39714127
- "organizationId"
3972-
- "userId"
39734128
properties:
39744129
organizationId:
39754130
type: "string"
39764131
format: "UUID"
39774132
description: "The id of the organization this profile belongs to."
3978-
userId:
3979-
type: "string"
3980-
format: "UUID"
3981-
description: "The id of the user this profile belongs to."
39824133
uri:
39834134
type: "string"
39844135
description: "The uri of the external profile."
@@ -4314,6 +4465,45 @@ definitions:
43144465
example:
43154466
name: "name"
43164467
attributeGroupId: "attributeGroupId"
4468+
SearchUserRequestBody:
4469+
type: "object"
4470+
required:
4471+
- organizationId
4472+
properties:
4473+
achievements:
4474+
type: "array"
4475+
items:
4476+
type: "string"
4477+
description: "The achievement name to filter users with. Specify multiple times to provide multiple values"
4478+
attributes:
4479+
type: "array"
4480+
items:
4481+
type: "object"
4482+
properties:
4483+
id:
4484+
type: "string"
4485+
format: "UUID"
4486+
value:
4487+
type: "string"
4488+
description: "Filter by user attributes"
4489+
isAvailable:
4490+
type: "string"
4491+
enum: ["true", "false"]
4492+
description: "`true` corresponds to users that are available. `false` corresponds to users that are not available. `isAvailable` here is an attribute of the user"
4493+
locations:
4494+
type: "array"
4495+
items:
4496+
type: "string"
4497+
description: "The location name to filter users with. Specify multiple times to provide multiple values. `location` here is an attribute of the user"
4498+
organizationId:
4499+
description: "The organization id"
4500+
type: "string"
4501+
format: "UUID"
4502+
skills:
4503+
type: "array"
4504+
items:
4505+
type: "string"
4506+
description: "The skill name to filter users with. Specify multiple times to provide multiple values"
43174507
Unauthorized:
43184508
type: "object"
43194509
properties:

0 commit comments

Comments
 (0)
This repository has been archived.