Skip to content
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.

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

tiny API docs fixups #1301

Merged
merged 2 commits into from
Nov 19, 2024
Merged
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
15 changes: 7 additions & 8 deletions docs/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1003,7 +1003,7 @@ paths:
- App User Authentication
summary: Using App User Authentication
description: |-
To use App User Authentication, first obtain a App User, typically by using the configuration panel in the user interface, or else by using the [App User API Resource](/central-api-accounts-and-users/#app-users). Once you have the token, you can apply it to any eligible action by prefixing the URL with `/key/{appUser}` as follows:
To use App User Authentication, first obtain an App User, typically by using the configuration panel in the user interface, or else by using the [App User API Resource](/central-api-accounts-and-users/#app-users). Once you have the token, you can apply it to any eligible action by prefixing the URL with `/key/{appUser}` as follows:

`/v1/key/!Ms7V3$Zdnd63j5HFacIPFEvFAuwNqTUZW$AsVOmaQFf$vIC!F8dJjdgiDnJXXOt/example/request/path`

Expand Down Expand Up @@ -1035,9 +1035,9 @@ paths:

**Revoking an App User**

The token associated with a App User is actually just its Session Token. As a result, although a App User Token can uniquely be used as a URL prefix as described here, the session associated with it can be revoked in exactly the same way a session is logged out, by issuing a `DELETE` request to its Session resource.
The token associated with an App User is actually just its Session Token. As a result, although an App User Token can uniquely be used as a URL prefix as described here, the session associated with it can be revoked in exactly the same way a session is logged out, by issuing a `DELETE` request to its Session resource.

Note, however, that a App User cannot revoke itself; a `User` must perform this action.
Note, however, that an App User cannot revoke itself; a `User` must perform this action.
operationId: Revoking an App User
parameters:
- name: token
Expand Down Expand Up @@ -1865,12 +1865,12 @@ paths:
delete:
tags:
- App Users
summary: Deleting a App User
summary: Deleting an App User
description: |-
You don't have to delete a `App User` in order to cut off its access. Using a `User`'s credentials you can simply [log the App User's session out](/central-api-authentication/#logging-out-current-session) using its token. This will end its session without actually deleting the App User, which allows you to still see it in the configuration panel and inspect its history. This is what the administrative panel does when you choose to "Revoke" the App User.

That said, if you do wish to delete the App User altogether, you can do so by issuing a `DELETE` request to its resource path. App Users cannot delete themselves.
operationId: Deleting a App User
operationId: Deleting an App User
parameters:
- name: id
in: path
Expand Down Expand Up @@ -6379,9 +6379,8 @@ paths:
tags:
- Submissions
summary: Retrieving Submission XML
description: To get only the XML of the `Submission` rather than all of the
details with the XML as one of many properties, just add `.xml` to the end
of the request URL.
description: To retrieve the XML of the `Submission`, just append `.xml` to
the end of the request URL.
operationId: Retrieving Submission XML
parameters:
- name: projectId
Expand Down