Skip to content

AB#111051 Add more details to readme #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lardo-de-arnaud merged 2 commits into from
Jan 14, 2026
Merged

AB#111051 Add more details to readme #198

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d97dcb3
AB#111051 Add more details to readme
Jan 13, 2026
bffcfea
Update README.md
lardo-de-arnaud Jan 13, 2026
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
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ To get a specific tool by ID:
curl -u "user:pass1234" http://localhost:8080/admin/tools/04a0aa49-a74f-4dd1-96c5-895c8d68d776
```

The API also supports looks by lti/proxy client ID and registration ID, the supported ID prefixes are:
The API also supports look ups by lti/proxy client ID and registration ID, the supported ID prefixes are:
- `ltiClientId:`
- `ltiRegistrationId:`
- `proxyClientId:`
Expand All @@ -365,9 +365,18 @@ For example to lookup by a client ID of `123450000000000678`:
```
curl -u "user:pass1234" http://localhost:8080/admin/tools/ltiClientId:123450000000000678
```
or for an LTI Registration ID

```
curl -u "user:pass1234" http://localhost:8080/admin/tools/ltiRegistrationId:my-lovely-lti-tool
```

All other operations will need to reference the tool's ID so the value should be copied.

**UPDATE:**

An update can be made by citing the tool's ID

```
curl -u "user:pass1234" -d '{
"id": "93f3fab4-0559-420b-b1d4-9d4a62a896ec",
Expand Down Expand Up @@ -426,6 +435,8 @@ curl -u "user:pass1234" -d '{

**DELETE:**

A tool can be deleted by citing the tool's ID

```
curl -u "user:pass1234" -X DELETE http://localhost:8080/admin/tools/04a0aa49-a74f-4dd1-96c5-895c8d68d776
```
Expand Down