Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions apis/cf/latest/components/parameters/UserGuid.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: guid
in: path
required: true
schema:
type: string
description: The unique identifier for the user, matching either a UAA user id or client id. A client id may not be a uuid.
49 changes: 29 additions & 20 deletions apis/cf/latest/components/schemas/User.yaml
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
type: object
allOf:
- $ref: './BaseSchema.yaml'
- properties:
username:
type: [string, "null"]
description: The username of the user
presentation_name:
type: string
description: The presentation name of the user
origin:
type: [string, "null"]
description: The origin of the user
metadata:
$ref: './Metadata.yaml'
links:
type: object
properties:
self:
$ref: './Link.yaml'
description: The URL to get this user
properties:
guid:
type: string
description: Unique identifier for the user, matching either a UAA user id or client id. A client id may not be a uuid.
created_at:
type: string
format: date-time
description: The ISO8601 compatible date and time when resource was created
updated_at:
type: string
format: date-time
description: The ISO8601 compatible date and time when resource was last updated
username:
type: [string, "null"]
description: The username of the user
presentation_name:
type: string
description: The presentation name of the user
origin:
type: [string, "null"]
description: The origin of the user
metadata:
$ref: './Metadata.yaml'
links:
type: object
properties:
self:
$ref: './Link.yaml'
description: The URL to get this user
3 changes: 1 addition & 2 deletions apis/cf/latest/components/schemas/UserRelationshipToOne.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ properties:
properties:
guid:
type: string
format: uuid
description: The GUID of the user
description: The GUID of the user, matching either a UAA user id or client id. A client id may not be a uuid.
required:
- guid
additionalProperties: false
Expand Down
10 changes: 5 additions & 5 deletions apis/cf/latest/paths/Users.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
type: array
items:
type: string
description: Comma-delimited list of user guids to filter by
description: Comma-delimited list of user guids to filter by (can include UAA user IDs or client IDs)
- name: usernames
in: query
schema:
Expand Down Expand Up @@ -111,7 +111,7 @@
tags:
- Users
parameters:
- $ref: '../components/parameters/Guid.yaml'
- $ref: '../components/parameters/UserGuid.yaml'
responses:
'200':
description: OK
Expand All @@ -127,12 +127,12 @@
$ref: '../components/responses/Forbidden.yaml'
patch:
summary: Update a user
description: Update a users metadata.
description: Update a user's metadata.
operationId: updateUser
tags:
- Users
parameters:
- $ref: '../components/parameters/Guid.yaml'
- $ref: '../components/parameters/UserGuid.yaml'
requestBody:
$ref: '../components/requestBodies/UserUpdate.yaml'
responses:
Expand Down Expand Up @@ -161,7 +161,7 @@
tags:
- Users
parameters:
- $ref: '../components/parameters/Guid.yaml'
- $ref: '../components/parameters/UserGuid.yaml'
responses:
'202':
description: Accepted
Expand Down