update docs
continuous-integration/drone/pr Build is passing Details

This commit is contained in:
Max Erenberg 2021-10-23 20:46:33 -04:00
parent f767408c2c
commit 7b2fc9b026
3 changed files with 24 additions and 7 deletions

View File

@ -219,6 +219,6 @@ Here's an example of making a request to an endpoint which writes to LDAP:
kinit
# Make the request
curl --negotiate -u : --service-name ceod --delegation always \
-d '{"uid":"test_1","cn":"Test One","program":"Math","terms":["s2021"]}' \
-d '{"uid":"test_1","cn":"Test One","given_name":"Test","sn":"One","program":"Math","terms":["s2021"]}' \
-X POST http://phosphoric-acid:9987/api/members
```

View File

@ -52,6 +52,10 @@ paths:
$ref: "#/components/schemas/UID"
cn:
$ref: "#/components/schemas/UserCN"
sn:
$ref: "#/components/schemas/UserSN"
given_name:
$ref: "#/components/schemas/UserGivenName"
program:
$ref: "#/components/schemas/Program"
terms:
@ -76,7 +80,7 @@ paths:
{"status": "in progress", "operation": "send_welcome_message"}
{"status": "in progress", "operation": "subscribe_to_mailing_list"}
{"status": "in progress", "operation": "announce_new_user"}
{"status": "completed", "result": {"cn": "Calum Dalek", "uid": "ctdalek", "uid_number": 20001, "gid_number": 20001, "login_shell": "/bin/bash", "home_directory": "/users/ctdalek", "is_club": false, "program": "MAT/Mathematics Computer Science", "terms": ["f2021"], "forwarding_addresses": ["ctdalek@uwaterloo.ca"], "password": "Wlw1wOTofERTEBlXWzR6/MZL"}}
{"status": "completed", "result": {"cn": "Calum Dalek", "given_name": "Calum", "sn": "Dalek", "uid": "ctdalek", "uid_number": 20001, "gid_number": 20001, "login_shell": "/bin/bash", "home_directory": "/users/ctdalek", "is_club": false, "program": "MAT/Mathematics Computer Science", "terms": ["f2021"], "forwarding_addresses": ["ctdalek@uwaterloo.ca"], "password": "Wlw1wOTofERTEBlXWzR6/MZL"}}
/members/{username}:
get:
tags: ['members']
@ -718,6 +722,14 @@ components:
type: string
description: Full name
example: Calum Dalek
UserSN:
type: string
description: Last name
example: Dalek
UserGivenName:
type: string
description: First name
example: Calum
UID:
type: string
description: Username
@ -753,6 +765,10 @@ components:
properties:
cn:
$ref: "#/components/schemas/UserCN"
sn:
$ref: "#/components/schemas/UserSN"
given_name:
$ref: "#/components/schemas/UserGivenName"
uid:
$ref: "#/components/schemas/UID"
uid_number:
@ -858,4 +874,3 @@ components:
DBConnectionOrPermissionErrorResponse:
<<: *ErrorResponse
description: Unable to connect to database or action failed due to permissions

File diff suppressed because one or more lines are too long