Skip to content

Commit 2be441e

Browse files
author
MOSTLY CI
committed
Updating OpenAPI Specification for release 4.2.3
1 parent 14987f2 commit 2be441e

1 file changed

Lines changed: 44 additions & 5 deletions

File tree

public-api.yaml

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1382,6 +1382,20 @@ paths:
13821382
properties:
13831383
apiKey:
13841384
type: "string"
1385+
/users/{userId}:
1386+
parameters:
1387+
- $ref: "#/components/parameters/userIdPath"
1388+
get:
1389+
summary: "Retrieve public user info"
1390+
operationId: "getUserInfo"
1391+
tags: [ "Users" ]
1392+
responses:
1393+
"200":
1394+
description: "OK"
1395+
content:
1396+
application/json:
1397+
schema:
1398+
$ref: "#/components/schemas/User"
13851399
/users/me:
13861400
get:
13871401
summary: "Retrieve current user info"
@@ -2060,7 +2074,7 @@ components:
20602074
# USERS
20612075
User:
20622076
type: "object"
2063-
description: "A user of the service."
2077+
description: "The public attributes of a user of the service."
20642078
properties:
20652079
id:
20662080
$ref: "#/components/schemas/UserId"
@@ -2070,10 +2084,13 @@ components:
20702084
$ref: "#/components/schemas/UserFirstName"
20712085
lastName:
20722086
$ref: "#/components/schemas/UserLastName"
2073-
email:
2074-
$ref: "#/components/schemas/UserEmail"
20752087
avatar:
20762088
$ref: "#/components/schemas/UserAvatar"
2089+
organizations:
2090+
type: "array"
2091+
description: "The organizations the user belongs to"
2092+
items:
2093+
$ref: "#/components/schemas/OrganizationListItem"
20772094
UserListItem:
20782095
type: "object"
20792096
description: "Essential information about a user for public listings."
@@ -2082,14 +2099,21 @@ components:
20822099
$ref: "#/components/schemas/UserId"
20832100
name:
20842101
$ref: "#/components/schemas/UserName"
2102+
firstName:
2103+
$ref: "#/components/schemas/UserFirstName"
2104+
lastName:
2105+
$ref: "#/components/schemas/UserLastName"
20852106
avatar:
20862107
$ref: "#/components/schemas/UserAvatar"
20872108
UserId:
20882109
type: "string"
20892110
description: "The unique identifier of a user."
20902111
UserName:
20912112
type: "string"
2092-
description: "The name of a user. As of now, it is the concatenation of the first name and last name."
2113+
description: |
2114+
The name of a user.
2115+
Contains only alphanumeric characters, hyphens, and underscores. Must start or end with alphanumeric.
2116+
It must be globally case-insensitive unique considering organizations and users.
20932117
UserFirstName:
20942118
type: "string"
20952119
description: "First name of a user"
@@ -2129,6 +2153,8 @@ components:
21292153
properties:
21302154
id:
21312155
$ref: "#/components/schemas/UserId"
2156+
name:
2157+
$ref: "#/components/schemas/UserName"
21322158
firstName:
21332159
$ref: "#/components/schemas/UserFirstName"
21342160
lastName:
@@ -2163,6 +2189,8 @@ components:
21632189
UserSettingsProfileUpdateConfig:
21642190
type: "object"
21652191
properties:
2192+
name:
2193+
$ref: "#/components/schemas/UserName"
21662194
firstName:
21672195
$ref: "#/components/schemas/UserFirstName"
21682196
lastName:
@@ -3871,9 +3899,18 @@ components:
38713899
$ref: "#/components/schemas/OrganizationDescription"
38723900
logo:
38733901
$ref: "#/components/schemas/OrganizationLogo"
3902+
metadata:
3903+
$ref: "#/components/schemas/OrganizationMetadata"
38743904
required:
38753905
- "id"
38763906
- "displayName"
3907+
OrganizationMetadata:
3908+
type: "object"
3909+
description: "The metadata of an organization."
3910+
readOnly: true
3911+
properties:
3912+
currentUserMemberRole:
3913+
$ref: "#/components/schemas/MemberRole"
38773914
Organization:
38783915
type: "object"
38793916
description: "An organization that owns resources."
@@ -3896,6 +3933,8 @@ components:
38963933
type: "array"
38973934
items:
38983935
$ref: "#/components/schemas/UserListItem"
3936+
metadata:
3937+
$ref: "#/components/schemas/OrganizationMetadata"
38993938
required:
39003939
- "id"
39013940
- "name"
@@ -3917,7 +3956,7 @@ components:
39173956
description: "A member of an organization."
39183957
properties:
39193958
user:
3920-
$ref: "#/components/schemas/User"
3959+
$ref: "#/components/schemas/UserListItem"
39213960
role:
39223961
$ref: "#/components/schemas/MemberRole"
39233962
Visibility:

0 commit comments

Comments
 (0)