Skip to content

fix: Add missing documentation #2735

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
Chartman123 merged 1 commit into from
May 10, 2025
+10 −1
Merged

fix: Add missing documentation #2735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion docs/API_v3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ This file contains the API-Documentation. For more information on the returned D
- `POST /api/v3/forms/{formId}/questions/{questionId}/options` does now accept more options at once
- `PATCH /api/v3/forms/{formId}/questions/{questionId}/options/reorder` to reorder the options
- `POST /api/v3/forms/{formId}/submissions/files/{questionId}` to upload a file to a file question before submitting the form
- `GET /api/v3/forms/{formId}/submissions/{submissionId}` to get a single submission
- `PUT /api/v3/forms/{formId}/submissions/{submissionId}` to update an existing submission
- In API version 2.5 the following endpoints were introduced:
- `POST /api/v2.5/uploadFiles/{formId}/{questionId}` to upload files to answer before form submitting
- In API version 2.4 the following endpoints were introduced:
Expand Down Expand Up @@ -163,6 +165,7 @@ Returns the full-depth object of the requested form (without submissions).
"filePath": "foo/bar",
"isAnonymous": false,
"submitMultiple": true,
"allowEditSubmissions": false,
"showExpiration": false,
"canSubmit": true,
"state": 0,
Expand Down Expand Up @@ -225,7 +228,9 @@ Returns the full-depth object of the requested form (without submissions).
"shareWith": "dYcTWjrSsxjMFFQzFAywzq5J",
"displayName": ""
}
]
],
"submissionCount": 0,
"submissionMessage": "",
}
```

Expand Down
4 changes: 4 additions & 0 deletions docs/DataStructure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ This document describes the Object-Structure, that is used within the Forms App
| questions | Array of [Questions](#question) | | Array of questions belonging to the form |
| shares | Array of [Shares](#share) | | Array of shares of the form |
| submissions | Array of [Submissions](#submission) | | Array of submissions belonging to the form |
| submissionCount | Integer | | Number of submissions to the form |
| submissionMessage | String | | Message to show after a submission |

```
{
Expand All @@ -59,6 +61,8 @@ This document describes the Object-Structure, that is used within the Forms App
"state": 0,
"shares": []
"submissions": [],
"submissionCount": 0,
"submissionMessage": "string"
}
```

Expand Down
Loading