Skip to content

Commit 92f1186

Browse files
authored
Changes to API docs for 2024.3 release (#1347)
* changes to API docs for 2024.3 release * Small changes in response to review comments
1 parent efdbc3a commit 92f1186

File tree

1 file changed

+15
-25
lines changed

1 file changed

+15
-25
lines changed

docs/api.yaml

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,14 @@ info:
4242

4343
## ODK Central v2024.3
4444

45+
**Added**:
46+
- Endpoints for managing [User Preferences](/central-api-accounts-and-users/#user-preferences), mainly to be used by the frontend.
47+
4548
**Changed**:
4649

4750
- [Submissions Odata]() now returns `__system/deletedAt`. It can also be used in $filter, $sort and $select query parameters.
4851
- Dataset (Entity List) properties with the same name but different capitalization are not allowed.
52+
- Form Attachments for both [published Forms](/central-api-form-management/#listing-form-attachments) and [draft Forms](/central-api-form-management/#listing-expected-draft-form-attachments) now return a property representing the hash of the attachment file.
4953

5054
## ODK Central v2024.2
5155

@@ -847,6 +851,7 @@ tags:
847851
* `form.update.draft.set` when a Draft Form definition is set.
848852
* `form.update.draft.delete` when a Draft Form definition is deleted.
849853
* `form.update.publish` when a Draft Form is published to the Form.
854+
* `form.update.draft.replace` when a Draft Form is changed in place.
850855
* `form.attachment.update` when a Form Attachment binary is set or cleared.
851856
* `form.submissions.export` when a Form's Submissions are exported to CSV.
852857
* `form.delete` when a Form is deleted.
@@ -872,6 +877,7 @@ tags:
872877
* `submission.backlog.hold` when an Entity Submission is first held in processing backlog.
873878
* `submission.backlog.reprocess` when an Entity Submission is reprocessed and removed from the backlog.
874879
* `submission.backlog.force` when an Entity Submission is force-processed after being in backlog.
880+
* `upgrade.process.form.entities_version` when Central flags an Entity-related Form for a potential automatic upgrade.
875881
* `dataset.create` when a Dataset is created.
876882
* `dataset.update` when a Dataset is updated.
877883
* `dataset.update.publish` when a Dataset is published.
@@ -1553,13 +1559,6 @@ paths:
15531559
schema:
15541560
type: string
15551561
example: "frobwazzleEnabled"
1556-
- name: Authorization
1557-
in: header
1558-
description: Bearer encoding of a token of the user whose preferences to operate on
1559-
required: true
1560-
schema:
1561-
type: string
1562-
example: Bearer lSpAIeksRu1CNZs7!qjAot2T17dPzkrw9B4iTtpj7OoIJBmXvnHM8z8Ka4QPEjR7
15631562
responses:
15641563
200:
15651564
description: The preference was stored
@@ -1592,13 +1591,6 @@ paths:
15921591
schema:
15931592
type: string
15941593
example: "frobwazzleEnabled"
1595-
- name: Authorization
1596-
in: header
1597-
description: Bearer encoding of a token of the user whose preferences to operate on
1598-
required: true
1599-
schema:
1600-
type: string
1601-
example: Bearer lSpAIeksRu1CNZs7!qjAot2T17dPzkrw9B4iTtpj7OoIJBmXvnHM8z8Ka4QPEjR7
16021594
requestBody:
16031595
content:
16041596
'application/json':
@@ -1639,13 +1631,6 @@ paths:
16391631
schema:
16401632
type: string
16411633
example: "frobwazzleEnabled"
1642-
- name: Authorization
1643-
in: header
1644-
description: Bearer encoding of a token of the user whose preferences to operate on
1645-
required: true
1646-
schema:
1647-
type: string
1648-
example: Bearer lSpAIeksRu1CNZs7!qjAot2T17dPzkrw9B4iTtpj7OoIJBmXvnHM8z8Ka4QPEjR7
16491634
responses:
16501635
200:
16511636
description: The preference was deleted
@@ -3852,7 +3837,9 @@ paths:
38523837
summary: Listing Form Attachments
38533838
description: This endpoint allows you to fetch the list of expected attachment
38543839
files, and will tell you whether the server is in possession of each file
3855-
or not. To modify an attachment, you'll need to create a Draft.
3840+
or not, and a hash of the file contents. To modify an attachment, you'll need to
3841+
create a Draft. The property `datasetExists` indicates whether the attachment is
3842+
a link to a Dataset instead of an actual file.
38563843
operationId: Listing Form Attachments
38573844
parameters:
38583845
- name: projectId
@@ -3883,7 +3870,8 @@ paths:
38833870
type: image
38843871
exists: true
38853872
blobExists: true
3886-
datasetExists: true
3873+
datasetExists: false
3874+
hash: 'd41d8cd98f00b204e9800998ecf8427e'
38873875
updatedAt: 2018-03-21T12:45:02.312Z
38883876
403:
38893877
description: Forbidden
@@ -4411,7 +4399,8 @@ paths:
44114399
type: image
44124400
exists: true
44134401
blobExists: true
4414-
datasetExists: true
4402+
datasetExists: false
4403+
hash: 'd41d8cd98f00b204e9800998ecf8427e'
44154404
updatedAt: 2018-03-21T12:45:02.312Z
44164405
403:
44174406
description: Forbidden
@@ -5112,7 +5101,8 @@ paths:
51125101
type: image
51135102
exists: true
51145103
blobExists: true
5115-
datasetExists: true
5104+
datasetExists: false
5105+
hash: 'd41d8cd98f00b204e9800998ecf8427e'
51165106
updatedAt: 2018-03-21T12:45:02.312Z
51175107
403:
51185108
description: Forbidden

0 commit comments

Comments
 (0)