Skip to content

Commit 21ea119

Browse files
committed
Added missing things from the doc.
1 parent 818679c commit 21ea119

File tree

3 files changed

+90
-93
lines changed

3 files changed

+90
-93
lines changed

api/authorization.yml

+36-36
Original file line numberDiff line numberDiff line change
@@ -413,12 +413,12 @@ components:
413413

414414
paths:
415415
/auth/users:
416-
description: Returns a list of all users in the lakeFS server. Accepts pagination parameters as input and returns a
417-
Pagination object along with a list of users. The results must be sorted by the username property of
418-
each User object. Internally, lakeFS converts the username value to the id field and stores the
419-
creation_date, along with optional fields such as friendly_name and email. This endpoint should be
420-
implemented in a function named listUsers.
421416
get:
417+
description: Returns a list of all the users. Accepts pagination parameters as input and returns a
418+
Pagination object along with a list of users. The results must be sorted by the username property of
419+
each User object. Internally, lakeFS converts the username value to the id field and stores the
420+
creation_date, along with optional fields such as friendly_name and email. This endpoint should be
421+
implemented in a function named listUsers.
422422
tags:
423423
- auth
424424
- users
@@ -458,7 +458,7 @@ paths:
458458
default:
459459
$ref: "#/components/responses/ServerError"
460460
post:
461-
description: Creates a new user in lakeFS. The input is provided in the request body, and the response returns a
461+
description: Creates a new user. The input is provided in the request body, and the response returns a
462462
User object. This endpoint is also used during the setup phase to create the initial admin user with
463463
username="admin" and source="internal". This endpoint should be implemented in a function named
464464
createUser.
@@ -474,7 +474,7 @@ paths:
474474
$ref: "#/components/schemas/UserCreation"
475475
responses:
476476
201:
477-
description: The username in the response must match the `username` provided in the input.
477+
description: The username in the response must match the username provided in the input.
478478
content:
479479
application/json:
480480
schema:
@@ -501,7 +501,7 @@ paths:
501501
type: string
502502
get:
503503
description: Returns the details of a specific user. Takes a unique userId as a path parameter, which must match
504-
an existing user ID in your list. The response returns a User object. Internally, lakeFS uses the
504+
an existing user ID. The response returns a User object. Internally, lakeFS uses the
505505
creation_date, email, and id (derived from the username) fields from the response. This endpoint
506506
should be implemented in a function named getUser.
507507
tags:
@@ -610,7 +610,7 @@ paths:
610610

611611
/auth/groups:
612612
get:
613-
description: Returns a list of groups in lakeFS. Accepts pagination parameters as input and returns a Pagination
613+
description: Returns a list of groups. Accepts pagination parameters as input and returns a Pagination
614614
object along with a list of groups. The results must be sorted by the name property of each Group
615615
object in the GroupList response. This endpoint should be implemented in a function named listGroups.
616616
tags:
@@ -635,7 +635,7 @@ paths:
635635
$ref: "#/components/responses/ServerError"
636636

637637
post:
638-
description: Creates a new group in lakeFS. The input is provided in the request body, and the response returns a
638+
description: Creates a new group. The input is provided in the request body, and the response returns a
639639
Group object. lakeFS expects the name property to be a unique, human-readable group name.
640640
If the id field is not specified, lakeFS will use the name value as the id. lakeFS calls this endpoint
641641
during the setup stage to create initial groups, including "Admins", "SuperUsers", "Developers", and
@@ -675,7 +675,7 @@ paths:
675675
type: string
676676
get:
677677
description: Returns the details of a specific group. Takes a unique groupId as a path parameter, which must
678-
match an existing group ID in your groups list. The response returns a Group object. Internally,
678+
match an existing group ID. The response returns a Group object. Internally,
679679
lakeFS converts the name property in the Group object to the id used on the lakeFS side. During the
680680
setup phase, lakeFS calls this endpoint with the "Admins" group ID to verify that the group was
681681
created. This endpoint should be implemented in a function named getGroup.
@@ -698,8 +698,8 @@ paths:
698698
default:
699699
$ref: "#/components/responses/ServerError"
700700
delete:
701-
description: Deletes a group. Takes a unique groupId as a path parameter, which must match an existing group ID
702-
in your groups list. No output is returned if the deletion is successful. This endpoint should be
701+
description: Deletes a group. Takes a unique groupId as a path parameter, which must match an existing group ID.
702+
No output is returned if the deletion is successful. This endpoint should be
703703
implemented in a function named deleteGroup.
704704
tags:
705705
- auth
@@ -718,7 +718,7 @@ paths:
718718

719719
/auth/policies:
720720
get:
721-
description: Returns a list of policies in lakeFS. Accepts pagination parameters as input and returns a
721+
description: Returns a list of policies. Accepts pagination parameters as input and returns a
722722
Pagination object along with a list of policies. The results must be sorted by the name property of
723723
each Policy object in the PolicyList response. lakeFS internally converts the name property of each
724724
Policy object to the id field. This endpoint should be implemented in a function named listPolicies.
@@ -744,7 +744,7 @@ paths:
744744
default:
745745
$ref: "#/components/responses/ServerError"
746746
post:
747-
description: Creates a new policy in lakeFS. The input is provided in the request body, and the response returns
747+
description: Creates a new policy. The input is provided in the request body, and the response returns
748748
a Policy object. The response fields should match the input parameters. lakeFS calls this endpoint
749749
during the setup phase to create default policies required for operation. The policy IDs (names) that
750750
will be sent include "FSFullAccess", "FSReadWriteAll", "FSReadAll", "RepoManagementFullAccess",
@@ -786,7 +786,7 @@ paths:
786786
type: string
787787
get:
788788
description: Returns the details of a specific policy. Takes a unique policyId as input and returns a Policy
789-
object. lakeFS converts the "name" property of the Policy object to the "id" property in its internal
789+
object. lakeFS converts the name property of the Policy object to the id property in its internal
790790
Policy representation. This endpoint should be implemented in a function named getPolicy.
791791
tags:
792792
- auth
@@ -808,7 +808,7 @@ paths:
808808
$ref: "#/components/responses/ServerError"
809809

810810
put:
811-
description: Updates an existing policy in lakeFS. Takes a unique policyId (name) and a request body containing
811+
description: Updates an existing policy. Takes a unique policyId (name) and a request body containing
812812
the updated policy details, and returns the updated Policy object. The response fields should match
813813
those provided in the request body. This endpoint should be implemented in a function named
814814
updatePolicy.
@@ -839,7 +839,7 @@ paths:
839839

840840
delete:
841841
description: Deletes a policy. Takes a unique policyId as a path parameter, which must match an existing policy
842-
ID in your policies list. No output is returned if the deletion is successful. This endpoint should be
842+
ID. No output is returned if the deletion is successful. This endpoint should be
843843
implemented in a function named deletePolicy.
844844
tags:
845845
- auth
@@ -866,7 +866,7 @@ paths:
866866
get:
867867
description: Returns the list of users associated with a specific group. Takes the groupId and pagination
868868
parameters as input, and returns a Pagination object along with the list of users. The results must be
869-
sorted by the `username` property of each User object in the UserList response. This endpoint should
869+
sorted by the username property of each User object in the UserList response. This endpoint should
870870
be implemented in a function named listGroupMembers.
871871
tags:
872872
- auth
@@ -948,10 +948,9 @@ paths:
948948
type: string
949949
get:
950950
description: Returns a list of all access_key_ids and their creation dates for a specific user. Takes a unique
951-
userId that matches an existing user in your users list along with pagination parameters. The response
952-
includes a Pagination object and a list of results sorted by the access_key_id field in
953-
Credentials object within the CredentialsList. This endpoint should be implemented in a function named
954-
listUserCredentials.
951+
userId that matches an existing user along with pagination parameters. The response includes a Pagination
952+
object and a list of results sorted by the access_key_id field in Credentials object within the CredentialsList.
953+
This endpoint should be implemented in a function named listUserCredentials.
955954
tags:
956955
- auth
957956
- credentials
@@ -979,9 +978,9 @@ paths:
979978
description: Creates new credentials for a specific user. The input might include access_key and secret_key, and
980979
the output is a CredentialsWithSecret object where the username field is required. If either the
981980
access_key or secret_key is empty, RBAC server should generate random values for both and save
982-
them for the user. The path parameter includes a unique userId that matches an existing user in your
983-
list. During lakeFS initialization, credentials must be created for the "admin" userId.
984-
This endpoint should be implemented in a function named createCredentials.
981+
them for the user. The path parameter includes a unique userId that matches an existing user. During lakeFS
982+
initialization, credentials must be created for the "admin" userId, and lakeFS will invoke this API to perform
983+
that action. This endpoint should be implemented in a function named createCredentials.
985984
parameters:
986985
- in: query
987986
name: access_key
@@ -1026,9 +1025,8 @@ paths:
10261025
type: string
10271026
delete:
10281027
description: Deletes credentials for a specific user. Takes the userId and accessKeyId as input. The path
1029-
parameter includes a unique userId that matches an existing user in your users list. No output is
1030-
returned if the deletion is successful. This endpoint should be implemented in a function named
1031-
deleteCredentials.
1028+
parameter includes a unique userId that matches an existing user. No output is returned if the deletion is
1029+
successful. This endpoint should be implemented in a function named deleteCredentials.
10321030
tags:
10331031
- auth
10341032
- credentials
@@ -1046,12 +1044,13 @@ paths:
10461044

10471045
get:
10481046
description: Returns a specific user's credentials. Takes the user's userId and a specific accessKeyId associated
1049-
with that user as input. The output includes the user's access key id and creation date.
1047+
with that user as input. The output includes the user's access key id and creation date. This endpoint should
1048+
be implemented in a function named getCredentialsForUser.
10501049
tags:
10511050
- auth
10521051
- credentials
10531052
operationId: getCredentialsForUser
1054-
summary: get credentials
1053+
summary: get credentials for a user
10551054
responses:
10561055
200:
10571056
description: credentials
@@ -1067,17 +1066,18 @@ paths:
10671066
$ref: "#/components/responses/ServerError"
10681067

10691068
/auth/credentials/{accessKeyId}:
1070-
description: Returns the credentials details associated with a specific accessKeyId. The input is the accessKeyId,
1071-
and the output is a CredentialsWithSecret object containing all credential details.
1072-
Note that the previously required user_id is now deprecated, and the username is required instead, even
1073-
though it is not listed under the "required" section.
10741069
parameters:
10751070
- in: path
10761071
name: accessKeyId
10771072
required: true
10781073
schema:
10791074
type: string
10801075
get:
1076+
description: Returns the credentials details associated with a specific accessKeyId. The input is the accessKeyId,
1077+
and the output is a CredentialsWithSecret object containing all credential details.
1078+
Note that the previously required user_id is now deprecated, and the username is required instead, even
1079+
though it is not listed under the "required" label in this yaml. This endpoint should
1080+
be implemented in a function named getCredentials.
10811081
tags:
10821082
- auth
10831083
- credentials
@@ -1105,7 +1105,7 @@ paths:
11051105
schema:
11061106
type: string
11071107
get:
1108-
description: Returns the list of groups that a specific user is associated with in lakeFS. Takes a unique userId
1108+
description: Returns the list of groups that a specific user is associated with. Takes a unique userId
11091109
and pagination parameters as input, and returns a Pagination object along with the list of results.
11101110
The results must be sorted by the name property of each Group object in the GroupList. This endpoint
11111111
should be implemented in a function named listUserGroups.

0 commit comments

Comments
 (0)