Skip to content

Commit

Permalink
API docs: nest user preferences documentation under users topic
Browse files Browse the repository at this point in the history
  • Loading branch information
brontolosone committed Nov 19, 2024
1 parent 8db63d5 commit e6a236e
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -592,11 +592,6 @@ tags:
* The **Metadata Document** defines the data schema using [an XML-based standard](https://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/odata-csdl-xml-v4.01.html#sec_Introduction). It is linked in every OData response.

* The **data documents**, linked from the Service Document, are a simple JSON representation of the Submission or Entity data, conforming to the schema we describe in our Metadata Document.
- name: User Preferences
description: |-
The Central frontend uses this API to save various user preferences, such as the sorting order of certain listings. When a user starts a new session, these preferences are loaded in.

Preferences can be set site-wide or per-project.
- name: System Endpoints
description: There are some resources available for getting or setting system information
and configuration. You can set the [Usage Reporting configuration](/central-api-system-endpoints/#usage-reporting-configuration)
Expand Down Expand Up @@ -650,6 +645,12 @@ tags:
x-parent-tag: Accounts and Users
description: |-
Presently, it is possible to create and list `User`s in the system, as well as to perform password reset operations. In future versions of this API it will be possible to manage existing user information and delete accounts as well.
- name: User Preferences
x-parent-tag: Accounts and Users
description: |-
The Central frontend uses this API to save various user preferences, such as the sorting order of certain listings. When a user starts a new session, these preferences are loaded in.

Preferences can be set site-wide or per-project.
- name: App Users
x-parent-tag: Accounts and Users
description: |-
Expand Down

0 comments on commit e6a236e

Please sign in to comment.