diff --git a/Makefile b/Makefile index b63412b76..42eda37f1 100644 --- a/Makefile +++ b/Makefile @@ -167,4 +167,16 @@ api-docs: .PHONY: api-docs-lint api-docs-lint: - npx --no @redocly/cli lint --extends=minimal docs/api.yaml + npx --no @redocly/cli lint \ + --extends recommended \ + --skip-rule no-ambiguous-paths \ + --skip-rule no-invalid-media-type-examples \ + --skip-rule no-unused-components \ + --skip-rule operation-2xx-response \ + --skip-rule operation-4xx-response \ + --skip-rule operation-operationId \ + --skip-rule operation-operationId-url-safe \ + --skip-rule path-not-include-query \ + --skip-rule path-parameters-defined \ + --skip-rule security-defined \ + docs/api.yaml diff --git a/docs/api.yaml b/docs/api.yaml index 10cced759..4ca741289 100644 --- a/docs/api.yaml +++ b/docs/api.yaml @@ -6,6 +6,9 @@ openapi: 3.0.1 info: title: ODK Central API version: "" + license: + name: Apache License 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0 description: |- [ODK Central Backend](https://github.com/getodk/central-backend) is a RESTful API server that provides key functionality for creating and managing ODK data collection campaigns. It couples with [Central Frontend](https://github.com/getodk/central-frontend), an independent frontend interface, to form [ODK Central](https://github.com/getodk/central), a complete user-installable ODK server solution. While Central Frontend is the primary consumer of the ODK Central API, the API this server provides is fully public and generic: anything that can be done in the user interface can be done directly via the API. @@ -745,6 +748,8 @@ tags: It is not yet possible to modify a Form's XML definition once it is created. - name: Individual Form x-parent-tag: Form Management + description: |- + These endpoints operate on a specific `Form` within a Project. They return the metadata for the Form, its XML definition, and artifacts like the XLSX representation or manifest that clients need to download and work with the Form. - name: Draft Form x-parent-tag: Form Management description: |- @@ -975,7 +980,7 @@ paths: example: my.super.secure.password required: false responses: - 200: + "200": description: OK content: application/json: @@ -1001,7 +1006,7 @@ paths: createdAt: 2018-04-18T03:04:51.695Z expiresAt: 2018-04-19T03:04:51.695Z token: lSpAIeksRu1CNZs7!qjAot2T17dPzkrw9B4iTtpj7OoIJBmXvnHM8z8Ka4QPEjR7 - 401: + "401": description: Unauthorized content: application/json: @@ -1026,7 +1031,7 @@ paths: type: string example: Bearer lSpAIeksRu1CNZs7!qjAot2T17dPzkrw9B4iTtpj7OoIJBmXvnHM8z8Ka4QPEjR7 responses: - 200: + "200": description: OK content: application/json: @@ -1059,7 +1064,7 @@ paths: type: string example: Basic bXkuZW1haWwuYWRkcmVzc0BvcGVuZGF0YWtpdC5vcmc6bXkucGFzc3dvcmQ= responses: - 200: + "200": description: OK content: application/json: @@ -1087,7 +1092,7 @@ paths: type: string example: '!Ms7V3$Zdnd63j5HFacIPFEvFAuwNqTUZW$AsVOmaQFf$vIC!F8dJjdgiDnJXXOt' responses: - 200: + "200": description: OK content: application/json: @@ -1116,13 +1121,13 @@ paths: type: string example: lSpAIeksRu1CNZs7!qjAot2T17dPzkrw9B4iTtpj7OoIJBmXvnHM8z8Ka4QPEjR7 responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -1139,13 +1144,13 @@ paths: Only the session that was used to authenticate the request is logged out. If the Actor associated with the session has other sessions as well, those are not logged out. operationId: Logging out current session responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -1173,7 +1178,7 @@ paths: type: string example: alice responses: - 200: + "200": description: OK content: application/json: @@ -1189,7 +1194,7 @@ paths: updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z email: my.email.address@getodk.org - 403: + "403": description: Forbidden content: application/json: @@ -1226,7 +1231,7 @@ paths: email: my.email.address@getodk.org required: false responses: - 200: + "200": description: OK content: application/json: @@ -1274,7 +1279,7 @@ paths: updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z email: my.email.address@getodk.org - 400: + "400": description: Bad Request content: application/json: @@ -1295,7 +1300,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -1323,7 +1328,7 @@ paths: type: string example: "42" responses: - 200: + "200": description: OK content: application/json: @@ -1371,7 +1376,7 @@ paths: updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z email: my.email.address@getodk.org - 403: + "403": description: Forbidden content: application/json: @@ -1403,13 +1408,13 @@ paths: type: string example: "42" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -1455,7 +1460,7 @@ paths: email: new.email.address@getodk.org required: false responses: - 200: + "200": description: OK content: application/json: @@ -1503,7 +1508,7 @@ paths: updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z email: my.email.address@getodk.org - 400: + "400": description: Bad Request content: application/json: @@ -1524,7 +1529,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -1564,19 +1569,19 @@ paths: propertyValue: true required: true responses: - 200: + "200": description: The preference was stored content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden - supplied bearer token was not valid content: application/json: schema: $ref: '#/components/schemas/Error403' - 404: + "404": description: The specified project does not exist content: application/json: @@ -1602,19 +1607,19 @@ paths: type: string example: "frobwazzleEnabled" responses: - 200: + "200": description: The preference was stored content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden - supplied bearer token was not valid content: application/json: schema: $ref: '#/components/schemas/Error403' - 404: + "404": description: The preference does not exist content: application/json: @@ -1647,13 +1652,13 @@ paths: required: true responses: - 200: + "200": description: The preference was stored content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden - supplied bearer token was not valid content: application/json: @@ -1672,19 +1677,19 @@ paths: type: string example: "frobwazzleEnabled" responses: - 200: + "200": description: The preference was deleted content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden - supplied bearer token was not valid content: application/json: schema: $ref: '#/components/schemas/Error403' - 404: + "404": description: The specified preference does not exist content: application/json: @@ -1706,7 +1711,7 @@ paths: - an object containing the preferences of the authenticated User/Actor operationId: Getting authenticated User details responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -1818,7 +1823,7 @@ paths: projects: "1": formTrashCollapsed: false - 403: + "403": description: Forbidden content: application/json: @@ -1862,13 +1867,13 @@ paths: new: new.password required: false responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -1911,13 +1916,13 @@ paths: email: my.email.address@getodk.org required: false responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -1943,7 +1948,7 @@ paths: type: number example: "7" responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -1985,7 +1990,7 @@ paths: updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z lastUsed: 2018-04-14T08:34:21.633Z - 403: + "403": description: Forbidden content: application/json: @@ -2023,7 +2028,7 @@ paths: displayName: My Display Name required: false responses: - 200: + "200": description: OK content: application/json: @@ -2077,7 +2082,7 @@ paths: deletedAt: 2018-04-18T23:42:11.406Z token: d1!E2GVHgpr4h9bpxxtqUJ7EVJ1Q$Dusm2RBXg8XyVJMCBCbvyE8cGacxUx3bcUT projectId: 1 - 400: + "400": description: Bad Request content: application/json: @@ -2098,7 +2103,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -2131,13 +2136,13 @@ paths: type: number example: "7" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -2154,7 +2159,7 @@ paths: at any time.' operationId: Listing all Roles responses: - 200: + "200": description: OK content: application/json: @@ -2193,7 +2198,7 @@ paths: type: string example: "1" responses: - 200: + "200": description: OK content: application/json: @@ -2219,7 +2224,7 @@ paths: This endpoint supports retrieving extended metadata; provide a header `X-Extended-Metadata: true` to expand the `actorId` into a full `actor` objects. The Role reference remains a numeric ID. operationId: Listing all Assignments responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -2246,7 +2251,7 @@ paths: updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z roleId: 4 - 403: + "403": description: Forbidden content: application/json: @@ -2271,7 +2276,7 @@ paths: type: string example: admin responses: - 200: + "200": description: OK content: application/json: @@ -2286,7 +2291,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 403: + "403": description: Forbidden content: application/json: @@ -2319,13 +2324,13 @@ paths: type: number example: "14" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -2356,13 +2361,13 @@ paths: type: number example: "14" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -2400,7 +2405,7 @@ paths: type: boolean example: "true" responses: - 200: + "200": description: OK content: application/json: @@ -2454,7 +2459,7 @@ paths: name: Project Name required: false responses: - 200: + "200": description: OK content: application/json: @@ -2490,7 +2495,7 @@ paths: description: Description of this Project to show on Central. keyId: 3 archived: false - 403: + "403": description: Forbidden content: application/json: @@ -2518,7 +2523,7 @@ paths: type: number example: "16" responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -2552,7 +2557,7 @@ paths: verbs: - "form.create" - "form.delete" - 403: + "403": description: Forbidden content: application/json: @@ -2621,7 +2626,7 @@ paths: state: closed required: false responses: - 200: + "200": description: OK content: application/json: @@ -2657,13 +2662,13 @@ paths: description: Description of this Project to show on Central. keyId: 3 archived: false - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 501: + "501": description: Not Implemented content: application/json: @@ -2699,13 +2704,13 @@ paths: type: number example: "16" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -2751,7 +2756,7 @@ paths: archived: true required: false responses: - 200: + "200": description: OK content: application/json: @@ -2787,7 +2792,7 @@ paths: description: Description of this Project to show on Central. keyId: 3 archived: false - 403: + "403": description: Forbidden content: application/json: @@ -2836,7 +2841,7 @@ paths: hint: it was a secret required: false responses: - 200: + "200": description: OK content: application/json: @@ -2872,7 +2877,7 @@ paths: description: Description of this Project to show on Central. keyId: 3 archived: false - 400: + "400": description: Bad Request content: application/json: @@ -2893,13 +2898,13 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 409: + "409": description: Conflict content: application/json: @@ -2935,7 +2940,7 @@ paths: type: number example: "2" responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -2961,7 +2966,7 @@ paths: updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z roleId: 4 - 403: + "403": description: Forbidden content: application/json: @@ -2993,7 +2998,7 @@ paths: type: number example: "16" responses: - 200: + "200": description: OK content: application/json: @@ -3008,7 +3013,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 403: + "403": description: Forbidden content: application/json: @@ -3048,13 +3053,13 @@ paths: type: number example: "14" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -3092,13 +3097,13 @@ paths: type: number example: "14" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -3123,7 +3128,7 @@ paths: type: number example: "16" responses: - 200: + "200": description: OK content: application/json: @@ -3150,7 +3155,7 @@ paths: deletedAt: 2018-04-18T23:42:11.406Z xmlFormId: simple roleId: 4 - 403: + "403": description: Forbidden content: application/json: @@ -3182,7 +3187,7 @@ paths: type: number example: "16" responses: - 200: + "200": description: OK content: application/json: @@ -3209,7 +3214,7 @@ paths: deletedAt: 2018-04-18T23:42:11.406Z xmlFormId: simple roleId: 4 - 403: + "403": description: Forbidden content: application/json; extended: @@ -3244,7 +3249,7 @@ paths: type: boolean example: "true" responses: - 200: + "200": description: OK content: application/json: @@ -3296,7 +3301,7 @@ paths: deletedAt: 2018-04-18T23:42:11.406Z entityRelated: false publicLinks: 4 - 403: + "403": description: Forbidden content: application/json: @@ -3358,7 +3363,7 @@ paths: type: string example: filename.xlsx responses: - 200: + "200": description: OK content: application/json: @@ -3434,7 +3439,7 @@ paths: publishedAt: 2018-01-21T00:04:11.153Z createdAt: 2018-01-19T23:58:03.395Z updatedAt: 2018-03-21T12:45:02.312Z - 400: + "400": description: Bad Request content: application/json: @@ -3455,13 +3460,13 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 409: + "409": description: Conflict content: application/json: @@ -3503,7 +3508,7 @@ paths: type: number example: "16" responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -3552,7 +3557,7 @@ paths: deletedAt: 2018-04-18T23:42:11.406Z entityRelated: false publicLinks: 4 - 403: + "403": description: Forbidden content: application/json: @@ -3591,13 +3596,13 @@ paths: type: number example: "16" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -3645,7 +3650,7 @@ paths: state: open required: false responses: - 200: + "200": description: OK content: application/json: @@ -3721,7 +3726,7 @@ paths: publishedAt: 2018-01-21T00:04:11.153Z createdAt: 2018-01-19T23:58:03.395Z updatedAt: 2018-03-21T12:45:02.312Z - 400: + "400": description: Bad Request content: application/json: @@ -3742,7 +3747,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -3765,7 +3770,7 @@ paths: type: string example: abcdef responses: - 200: + "200": description: OK content: application/json: @@ -3783,7 +3788,7 @@ paths: publishedAt: 2018-01-21T00:04:11.153Z createdAt: 2018-01-19T23:58:03.395Z updatedAt: 2018-03-21T12:45:02.312Z - 403: + "403": description: Forbidden content: application/json: @@ -3813,7 +3818,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/xml: @@ -3847,7 +3852,7 @@ paths: - 403: + "403": description: Forbidden content: application/xml: @@ -3888,13 +3893,13 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: example: | (binary data) - 403: + "403": description: Forbidden content: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: @@ -3937,7 +3942,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json: @@ -3953,7 +3958,7 @@ paths: datasetExists: false hash: 'd41d8cd98f00b204e9800998ecf8427e' updatedAt: 2018-03-21T12:45:02.312Z - 403: + "403": description: Forbidden content: application/json: @@ -3998,7 +4003,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK headers: Content-Disposition: @@ -4013,9 +4018,9 @@ paths: schema: type: object example: (binary data) - 304: + "304": description: Not Modified - 403: + "403": description: Forbidden content: application/json: @@ -4059,7 +4064,7 @@ paths: type: boolean example: "false" responses: - 200: + "200": description: OK content: application/json: @@ -4114,7 +4119,7 @@ paths: path: /photo type: binary binary: true - 403: + "403": description: Forbidden content: application/json: @@ -4148,13 +4153,13 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -4184,13 +4189,13 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DraftForm' - 403: + "403": description: Forbidden content: application/json: @@ -4246,13 +4251,13 @@ paths: type: string example: filename.xlsx responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 400: + "400": description: Bad Request content: application/json: @@ -4273,7 +4278,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -4304,13 +4309,13 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -4340,7 +4345,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/xml: @@ -4374,7 +4379,7 @@ paths: - 403: + "403": description: Forbidden content: application/xml: @@ -4417,7 +4422,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK headers: ETag: @@ -4428,7 +4433,7 @@ paths: application/xml: example: | (binary data) - 403: + "403": description: Forbidden content: application/xml: @@ -4472,7 +4477,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json: @@ -4488,7 +4493,7 @@ paths: datasetExists: false hash: 'd41d8cd98f00b204e9800998ecf8427e' updatedAt: 2018-03-21T12:45:02.312Z - 403: + "403": description: Forbidden content: application/json: @@ -4529,7 +4534,7 @@ paths: type: string example: people.csv responses: - 200: + "200": description: OK headers: Content-Disposition: @@ -4543,7 +4548,7 @@ paths: '{the MIME type of the attachment file itself or text/csv for a Dataset}': example: | (binary data) - 403: + "403": description: Forbidden content: '{the MIME type of the attachment file itself or text/csv for a Dataset}': @@ -4591,13 +4596,13 @@ paths: type: string example: people.csv responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FormAttachment' - 403: + "403": description: Forbidden content: application/json: @@ -4636,13 +4641,13 @@ paths: type: string example: people.csv responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -4688,19 +4693,19 @@ paths: $ref: '#/components/schemas/PatchAttachment' required: false responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 404: + "404": description: Not Found content: application/json: @@ -4748,7 +4753,7 @@ paths: type: boolean example: "false" responses: - 200: + "200": description: OK content: application/json: @@ -4803,7 +4808,7 @@ paths: path: /photo type: binary binary: true - 403: + "403": description: Forbidden content: application/json: @@ -4847,19 +4852,19 @@ paths: type: string example: newVersion responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 409: + "409": description: Conflict content: application/json: @@ -4901,7 +4906,7 @@ paths: type: string example: simple responses: - 200: + "200": description: Ok content: application/json: @@ -4945,7 +4950,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 403: + "403": description: Forbidden content: application/json; extended: @@ -4986,13 +4991,13 @@ paths: type: string example: one responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Form' - 403: + "403": description: Forbidden content: application/json: @@ -5030,7 +5035,7 @@ paths: type: string example: one responses: - 200: + "200": description: OK content: application/xml: @@ -5064,7 +5069,7 @@ paths: - 403: + "403": description: Forbidden content: application/xml: @@ -5115,7 +5120,7 @@ paths: type: string example: one responses: - 200: + "200": description: OK headers: ETag: @@ -5126,7 +5131,7 @@ paths: application/xml: example: | (binary data) - 403: + "403": description: Forbidden content: application/xml: @@ -5174,7 +5179,7 @@ paths: type: string example: one responses: - 200: + "200": description: OK content: application/json: @@ -5190,7 +5195,7 @@ paths: datasetExists: false hash: 'd41d8cd98f00b204e9800998ecf8427e' updatedAt: 2018-03-21T12:45:02.312Z - 403: + "403": description: Forbidden content: application/json: @@ -5243,7 +5248,7 @@ paths: type: string example: people.csv responses: - 200: + "200": description: OK headers: Content-Disposition: @@ -5258,9 +5263,9 @@ paths: schema: type: object example: (binary data) - 304: + "304": description: Not Modified - 403: + "403": description: Forbidden content: application/json: @@ -5305,7 +5310,7 @@ paths: type: boolean example: "false" responses: - 200: + "200": description: OK content: application/json: @@ -5360,7 +5365,7 @@ paths: path: /photo type: binary binary: true - 403: + "403": description: Forbidden content: application/json: @@ -5392,7 +5397,7 @@ paths: type: string example: simple responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -5418,7 +5423,7 @@ paths: updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z roleId: 4 - 403: + "403": description: Forbidden content: application/json; extended: @@ -5457,7 +5462,7 @@ paths: type: string example: manager responses: - 200: + "200": description: OK content: application/json: @@ -5472,7 +5477,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 403: + "403": description: Forbidden content: application/json: @@ -5519,13 +5524,13 @@ paths: type: number example: "14" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: {} delete: @@ -5567,13 +5572,13 @@ paths: type: number example: "14" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -5605,7 +5610,7 @@ paths: type: string example: simple responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -5694,7 +5699,7 @@ paths: once: false required: false responses: - 200: + "200": description: OK content: application/json: @@ -5748,7 +5753,7 @@ paths: deletedAt: 2018-04-18T23:42:11.406Z token: d1!E2GVHgpr4h9bpxxtqUJ7EVJ1Q$Dusm2RBXg8XyVJMCBCbvyE8cGacxUx3bcUT once: false - 403: + "403": description: Forbidden content: application/json: @@ -5788,13 +5793,13 @@ paths: type: integer example: "42" responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -5826,7 +5831,7 @@ paths: type: string example: simple responses: - 200: + "200": description: This is the standard response content: application/json: @@ -5866,7 +5871,7 @@ paths: type: string example: simple responses: - 200: + "200": description: This is the standard response content: application/json: @@ -5913,7 +5918,7 @@ paths: type: boolean example: true responses: - 200: + "200": description: OK content: application/json: @@ -5967,7 +5972,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 403: + "403": description: Forbidden content: application/json; extended: @@ -6008,7 +6013,7 @@ paths: type: string example: b1628661-65ed-4cab-8e30-19c17fef2de0 responses: - 200: + "200": description: OK content: application/json: @@ -6031,7 +6036,7 @@ paths: userAgent: Enketo/3.0.4 createdAt: 2018-01-19T23:58:03.395Z current: true - 400: + "400": description: Bad Request content: application/json: @@ -6052,13 +6057,13 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 409: + "409": description: Conflict content: application/json: @@ -6111,7 +6116,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -6162,12 +6167,12 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 301: + "301": description: Returns 301 with URL of the specific Submission version if `instanceId` of a Submission edit is provided content: text/html: example: "" - 403: + "403": description: Forbidden content: application/json: @@ -6213,7 +6218,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/json: @@ -6236,7 +6241,7 @@ paths: userAgent: Enketo/3.0.4 createdAt: 2018-01-19T23:58:03.395Z current: true - 400: + "400": description: Bad Request content: application/json: @@ -6257,13 +6262,13 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 409: + "409": description: Conflict content: application/json: @@ -6311,7 +6316,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/json: @@ -6334,7 +6339,7 @@ paths: userAgent: Enketo/3.0.4 createdAt: 2018-01-19T23:58:03.395Z current: true - 403: + "403": description: Forbidden content: application/json: @@ -6371,19 +6376,19 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 404: + "404": description: Not Found content: application/json: @@ -6429,19 +6434,19 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 404: + "404": description: Not Found content: application/json: @@ -6488,7 +6493,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/xml: @@ -6535,14 +6540,14 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 302: + "302": description: Found headers: Location: schema: type: string content: {} - 403: + "403": description: Forbidden content: application/json: @@ -6624,14 +6629,14 @@ paths: type: boolean example: "false" responses: - 200: + "200": description: OK headers: Content-Disposition: schema: type: string content: {} - 400: + "400": description: Bad Request content: application/json: @@ -6652,7 +6657,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -6727,14 +6732,14 @@ paths: type: boolean example: "false" responses: - 200: + "200": description: OK headers: Content-Disposition: schema: type: string content: {} - 400: + "400": description: Bad Request content: application/json: @@ -6755,7 +6760,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -6801,10 +6806,10 @@ paths: type: string example: year(__system/submissionDate) lt year(now()) responses: - 200: + "200": description: OK content: {} - 400: + "400": description: Bad Request content: application/json: @@ -6825,7 +6830,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -6870,10 +6875,10 @@ paths: type: string example: year(__system/submissionDate) lt year(now()) responses: - 200: + "200": description: OK content: {} - 400: + "400": description: Bad Request content: application/json: @@ -6894,7 +6899,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -6935,7 +6940,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/json: @@ -6965,7 +6970,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 403: + "403": description: Forbidden content: application/json: @@ -6998,7 +7003,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json: @@ -7011,7 +7016,7 @@ paths: public: bcFeKDF3Sg8W91Uf5uxaIlsuhzmjbgUnIyiLzIjrx4CAaf9Y9LG7TAu6wKPqfbH6ZAkJTFSfjLNovbKhpOQcmO5VZGGay6yvXrX1TFW6C6RLITy74erxfUAStdtpP4nraCYqQYqn5zD4/1OmgweJt5vzGXW2ch7lrROEQhXB9lK+bjEeWx8TFW/+6ha/oRLnl6a2RBRL6mhwy3PoByNTKndB2MP4TygCJ/Ini4ivk74iSqVnoeuNJR/xUcU+kaIpZEIjxpAS2VECJU9fZvS5Gt84e5wl/t7bUKu+dlh/cUgHfk6+6bwzqGQYOe5A== managed: true hint: it was a secret - 403: + "403": description: Forbidden content: application/json: @@ -7042,7 +7047,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json: @@ -7057,7 +7062,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 403: + "403": description: Forbidden content: application/json: @@ -7096,7 +7101,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/json: @@ -7122,7 +7127,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 403: + "403": description: Forbidden content: application/json: @@ -7172,7 +7177,7 @@ paths: body: this is the text of my comment required: false responses: - 200: + "200": description: OK content: application/json: @@ -7191,7 +7196,7 @@ paths: example: body: this is my comment actorId: 42 - 403: + "403": description: Forbidden content: application/json: @@ -7232,7 +7237,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/json: @@ -7247,7 +7252,7 @@ paths: exists: false - name: file3.jpg exists: true - 403: + "403": description: Forbidden content: application/json: @@ -7293,7 +7298,7 @@ paths: type: string example: file1.jpg responses: - 200: + "200": description: OK headers: Content-Disposition: @@ -7307,7 +7312,7 @@ paths: '{the MIME type of the attachment file itself}': example: | (binary data) - 403: + "403": description: Forbidden content: '{the MIME type of the attachment file itself}': @@ -7362,13 +7367,13 @@ paths: type: string example: file1.jpg responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -7413,13 +7418,13 @@ paths: type: string example: file1.jpg responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -7459,7 +7464,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/json: @@ -7497,7 +7502,7 @@ paths: updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z formVersion: "1.0" - 403: + "403": description: Forbidden content: application/json; extended: @@ -7544,7 +7549,7 @@ paths: type: string example: uuid:b1628661-65ed-4cab-8e30-19c17fef2de0 responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -7579,7 +7584,7 @@ paths: updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z formVersion: "1.0" - 403: + "403": description: Forbidden content: application/json: @@ -7623,7 +7628,7 @@ paths: type: string example: uuid:b1628661-65ed-4cab-8e30-19c17fef2de0 responses: - 200: + "200": description: OK content: application/xml: @@ -7633,7 +7638,7 @@ paths: Alice 32 - 403: + "403": description: Forbidden content: application/xml: @@ -7691,7 +7696,7 @@ paths: type: string example: uuid:b1628661-65ed-4cab-8e30-19c17fef2de0 responses: - 200: + "200": description: OK content: application/json: @@ -7706,7 +7711,7 @@ paths: exists: false - name: file3.jpg exists: true - 403: + "403": description: Forbidden content: application/json: @@ -7761,7 +7766,7 @@ paths: type: string example: file1.jpg responses: - 200: + "200": description: OK headers: Content-Disposition: @@ -7775,7 +7780,7 @@ paths: '{the MIME type of the attachment file itself}': example: | (binary data) - 403: + "403": description: Forbidden content: '{the MIME type of the attachment file itself}': @@ -7827,7 +7832,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/json: @@ -7857,7 +7862,7 @@ paths: path: - meta - deprecatedID - 403: + "403": description: Forbidden content: application/json: @@ -7887,7 +7892,7 @@ paths: type: string example: simple responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -7940,7 +7945,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 403: + "403": description: Forbidden content: application/json: @@ -7973,7 +7978,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json: @@ -7996,7 +8001,7 @@ paths: userAgent: Enketo/3.0.4 createdAt: 2018-01-19T23:58:03.395Z current: true - 400: + "400": description: Bad Request content: application/json: @@ -8017,13 +8022,13 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 409: + "409": description: Conflict content: application/json: @@ -8063,14 +8068,14 @@ paths: type: string example: simple responses: - 200: + "200": description: OK headers: Content-Disposition: schema: type: string content: {} - 400: + "400": description: Bad Request content: application/json: @@ -8091,7 +8096,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -8120,14 +8125,14 @@ paths: type: string example: simple responses: - 200: + "200": description: OK headers: Content-Disposition: schema: type: string content: {} - 400: + "400": description: Bad Request content: application/json: @@ -8148,7 +8153,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -8178,7 +8183,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json: @@ -8191,7 +8196,7 @@ paths: public: bcFeKDF3Sg8W91Uf5uxaIlsuhzmjbgUnIyiLzIjrx4CAaf9Y9LG7TAu6wKPqfbH6ZAkJTFSfjLNovbKhpOQcmO5VZGGay6yvXrX1TFW6C6RLITy74erxfUAStdtpP4nraCYqQYqn5zD4/1OmgweJt5vzGXW2ch7lrROEQhXB9lK+bjEeWx8TFW/+6ha/oRLnl6a2RBRL6mhwy3PoByNTKndB2MP4TygCJ/Ini4ivk74iSqVnoeuNJR/xUcU+kaIpZEIjxpAS2VECJU9fZvS5Gt84e5wl/t7bUKu+dlh/cUgHfk6+6bwzqGQYOe5A== managed: true hint: it was a secret - 403: + "403": description: Forbidden content: application/json: @@ -8228,7 +8233,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: 'This is the Extended Metadata response, if requested via the appropriate header:' content: @@ -8279,7 +8284,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 403: + "403": description: Forbidden content: application/json: @@ -8316,7 +8321,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/xml: @@ -8357,7 +8362,7 @@ paths: type: string example: uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44 responses: - 200: + "200": description: OK content: application/json: @@ -8372,7 +8377,7 @@ paths: exists: false - name: file3.jpg exists: true - 403: + "403": description: Forbidden content: application/json: @@ -8416,7 +8421,7 @@ paths: type: string example: file1.jpg responses: - 200: + "200": description: OK headers: Content-Disposition: @@ -8426,7 +8431,7 @@ paths: '{the MIME type of the attachment file itself}': example: | (binary data) - 403: + "403": description: Forbidden content: '{the MIME type of the attachment file itself}': @@ -8479,13 +8484,13 @@ paths: type: string example: file1.jpg responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -8528,13 +8533,13 @@ paths: type: string example: file1.jpg responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -8556,7 +8561,7 @@ paths: type: number example: "16" responses: - 200: + "200": description: OK content: application/json: @@ -8584,7 +8589,7 @@ paths: lastEntity: '2018-04-18T03:04:51.695Z' entities: 10 conflicts: 2 - 403: + "403": description: Forbidden content: application/json: @@ -8633,7 +8638,7 @@ paths: approvalRequired: false required: false responses: - 200: + "200": description: OK content: application/json: @@ -8649,13 +8654,13 @@ paths: sourceForms: [] linkedForms: [] properties: [] - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 409: + "409": description: Conflict content: application/json: @@ -8695,7 +8700,7 @@ paths: type: string example: people responses: - 200: + "200": description: OK content: application/json: @@ -8721,7 +8726,7 @@ paths: forms: - xmlFormId: simple name: Simple - 403: + "403": description: Forbidden content: application/json: @@ -8770,7 +8775,7 @@ paths: example: approvalRequired: true responses: - 200: + "200": description: OK content: application/json: @@ -8796,7 +8801,7 @@ paths: forms: - xmlFormId: simple name: Simple - 403: + "403": description: Forbidden content: application/json: @@ -8844,13 +8849,13 @@ paths: name: circumference required: false responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -8900,7 +8905,7 @@ paths: type: string example: john responses: - 200: + "200": description: OK headers: Content-Disposition: @@ -8916,7 +8921,7 @@ paths: __id,label,geometry,species,circumference_cm,__createdAt,__creatorId,__creatorName,__updates,__updatedAt,__version 2c1ee90b-dde8-434b-9985-2eefd8465339,666cm purpleheart,-29.281608 -67.624883 0 0,purpleheart,667,2023-05-31T19:49:28.902Z,22,Alice,1,2023-05-31T19:52:34.467Z,1 84ac3a03-9980-4098-93a5-b81fdc6ea749,555cm wallaba,18.921876 77.309451 0 0,wallaba,555,2023-05-31T19:49:20.152Z,22,Alice,0,,1 - 403: + "403": description: Forbidden content: text/csv: @@ -8958,7 +8963,7 @@ paths: type: string example: people responses: - 200: + "200": description: OK content: application/json: @@ -9024,7 +9029,7 @@ paths: type: user updatedAt: '2018-04-18T23:42:11.406Z' deletedAt: '2018-04-18T23:42:11.406Z' - 403: + "403": description: Forbidden content: application/json: @@ -9054,7 +9059,7 @@ paths: type: string example: people responses: - 200: + "200": description: OK content: application/json: @@ -9076,7 +9081,7 @@ paths: createdAt: '2018-03-15T15:30:22.150Z' updatedAt: '2018-03-15T15:30:22.150Z' deletedAt: null - 403: + "403": description: Forbidden content: application/json: @@ -9157,7 +9162,7 @@ paths: name: my_dataset.csv size: 100 responses: - 200: + "200": description: OK content: application/json: @@ -9192,7 +9197,7 @@ paths: application/json; bulk: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -9242,7 +9247,7 @@ paths: type: string example: 54a405a0-53ce-4748-9788-d23a30cc3afa responses: - 200: + "200": description: OK content: application/json: @@ -9321,7 +9326,7 @@ paths: type: user updatedAt: '2018-04-18T23:42:11.406Z' deletedAt: '2018-04-18T23:42:11.406Z' - 403: + "403": description: Forbidden content: application/json: @@ -9402,7 +9407,7 @@ paths: firstName: John age: '88' responses: - 200: + "200": description: OK content: application/json: @@ -9434,7 +9439,7 @@ paths: firstName: John age: '88' label: John (88) - 403: + "403": description: Forbidden content: application/json: @@ -9472,13 +9477,13 @@ paths: type: string example: 54a405a0-53ce-4748-9788-d23a30cc3afa responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -9515,19 +9520,19 @@ paths: type: string example: 54a405a0-53ce-4748-9788-d23a30cc3afa responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 404: + "404": description: Not Found content: application/json: @@ -9574,7 +9579,7 @@ paths: type: boolean example: true responses: - 200: + "200": description: OK content: application/json: @@ -9648,7 +9653,7 @@ paths: type: user updatedAt: '2018-04-18T23:42:11.406Z' deletedAt: '2018-04-18T23:42:11.406Z' - 403: + "403": description: Forbidden content: application/json: @@ -9688,7 +9693,7 @@ paths: type: string example: 54a405a0-53ce-4748-9788-d23a30cc3afa responses: - 200: + "200": description: + Response 200 content: application/json: @@ -9712,7 +9717,7 @@ paths: - new: Robert Doe old: Doe Doe propertyName: label - 403: + "403": description: Forbidden content: application/json: @@ -9749,7 +9754,7 @@ paths: type: string example: 54a405a0-53ce-4748-9788-d23a30cc3afa responses: - 200: + "200": description: OK content: application/json: @@ -9762,7 +9767,7 @@ paths: action: entity.create acteeId: 85cb9aff-005e-4edd-9739-dc9c1a829c44 loggedAt: 2018-04-18T23:19:14.802Z - 403: + "403": description: Forbidden content: application/json: @@ -9808,7 +9813,7 @@ paths: example: ids: ["12345678-1234-4123-8234-123456789abc", "12345678-1234-4123-8234-123456789aaa"] responses: - 200: + "200": description: Success content: application/json: @@ -9818,13 +9823,13 @@ paths: success: type: boolean example: true - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 404: + "404": description: Not Found content: application/json: @@ -9870,7 +9875,7 @@ paths: example: ids: ["12345678-1234-4123-8234-123456789abc", "12345678-1234-4123-8234-123456789aaa"] responses: - 200: + "200": description: Success content: application/json: @@ -9880,13 +9885,13 @@ paths: success: type: boolean example: true - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 404: + "404": description: Not Found content: application/json: @@ -9937,7 +9942,7 @@ paths: type: string example: "1.0" responses: - 200: + "200": description: OK headers: X-OpenRosa-Version: @@ -10011,7 +10016,7 @@ paths: type: string example: "1.0" responses: - 201: + "201": description: Created headers: X-OpenRosa-Version: @@ -10023,7 +10028,7 @@ paths: full submission upload was successful! - 400: + "400": description: 'This is one of several possible `400` failures the API might return:' headers: @@ -10036,7 +10041,7 @@ paths: A resource already exists with a attachment file name of attachment1.jpg. - 403: + "403": description: Forbidden headers: X-OpenRosa-Version: @@ -10048,7 +10053,7 @@ paths: The authenticated actor does not have rights to perform that action. - 409: + "409": description: Conflict headers: X-OpenRosa-Version: @@ -10106,7 +10111,7 @@ paths: type: string example: "1.0" responses: - 200: + "200": description: OK headers: X-OpenRosa-Version: @@ -10134,7 +10139,7 @@ paths: https://your.odk.server/v1/projects/7/datasets/people/integrity - 403: + "403": description: Forbidden headers: X-OpenRosa-Version: @@ -10187,7 +10192,7 @@ paths: type: string example: "1.0" responses: - 200: + "200": description: OK headers: X-OpenRosa-Version: @@ -10207,7 +10212,7 @@ paths: - 403: + "403": description: Forbidden headers: X-OpenRosa-Version: @@ -10256,7 +10261,7 @@ paths: type: string example: "1.0" responses: - 200: + "200": description: OK headers: X-OpenRosa-Version: @@ -10313,7 +10318,7 @@ paths: type: string example: "1.0" responses: - 201: + "201": description: Created headers: X-OpenRosa-Version: @@ -10325,7 +10330,7 @@ paths: full submission upload was successful! - 400: + "400": description: 'This is one of several possible `400` failures the API might return:' headers: @@ -10338,7 +10343,7 @@ paths: A resource already exists with a attachment file name of attachment1.jpg. - 403: + "403": description: Forbidden headers: X-OpenRosa-Version: @@ -10350,7 +10355,7 @@ paths: The authenticated actor does not have rights to perform that action. - 409: + "409": description: Conflict headers: X-OpenRosa-Version: @@ -10398,7 +10403,7 @@ paths: type: string example: "1.0" responses: - 200: + "200": description: OK headers: X-OpenRosa-Version: @@ -10415,7 +10420,7 @@ paths: https://your.odk.server/v1/test/IeksRu1CNZs7!qjAot2T17dPzkrw9B4iTtpj7OoIJBmXvnHM8z8Ka4QP/projects/7/forms/basic/draft/attachments/question.jpg - 403: + "403": description: Forbidden headers: X-OpenRosa-Version: @@ -10464,7 +10469,7 @@ paths: type: string example: file1.jpg responses: - 200: + "200": description: OK headers: Content-Disposition: @@ -10474,7 +10479,7 @@ paths: '{the MIME type of the attachment file itself}': example: | (binary data) - 403: + "403": description: Forbidden content: '{the MIME type of the attachment file itself}': @@ -10519,7 +10524,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json; charset=utf-8; odata.metadata=minimal: @@ -10591,7 +10596,7 @@ paths: - kind: EntitySet name: Submissions.children.child url: Submissions.children.child - 403: + "403": description: Forbidden content: application/json; charset=utf-8; odata.metadata=minimal: @@ -10607,7 +10612,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Error403' - 406: + "406": description: Not Acceptable content: application/json; charset=utf-8; odata.metadata=minimal: @@ -10671,7 +10676,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/xml: @@ -10730,7 +10735,7 @@ paths: - 403: + "403": description: Forbidden content: application/xml: @@ -10746,7 +10751,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Error403' - 406: + "406": description: Not Acceptable content: application/xml: @@ -10905,7 +10910,7 @@ paths: schema: type: string responses: - 200: + "200": description: OK content: application/json: @@ -10961,13 +10966,13 @@ paths: meta: instanceID: uuid:297000fd-8eb2-4232-8863-d25f82521b87 name: Alice - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 406: + "406": description: Not Acceptable content: application/json: @@ -10984,7 +10989,7 @@ paths: code: "406.1" message: 'Requested format not acceptable; this resource allows: (application/json, json).' - 501: + "501": description: Not Implemented content: application/json: @@ -11048,7 +11053,7 @@ paths: type: string example: file1.jpg responses: - 200: + "200": description: OK content: text/html: @@ -11080,7 +11085,7 @@ paths: type: string example: trees responses: - 200: + "200": description: OK content: application/json; charset=utf-8; odata.metadata=minimal: @@ -11152,13 +11157,13 @@ paths: - kind: EntitySet name: Entities.children.child url: Entities.children.child - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 406: + "406": description: Not Acceptable content: application/json: @@ -11201,7 +11206,7 @@ paths: type: string example: people responses: - 200: + "200": description: OK content: application/xml: @@ -11278,7 +11283,7 @@ paths: - 403: + "403": description: Forbidden content: application/xml: @@ -11294,7 +11299,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Error403' - 406: + "406": description: Not Acceptable content: application/xml: @@ -11425,7 +11430,7 @@ paths: schema: type: string responses: - 200: + "200": description: Ok content: application/json: @@ -11462,13 +11467,13 @@ paths: geometry: 47.722581 18.562111 0 0, species: mora, circumference_cm: 345 - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 406: + "406": description: Not Acceptable content: application/json: @@ -11485,7 +11490,7 @@ paths: code: "406.1" message: 'Requested format not acceptable; this resource allows: (application/json, json).' - 501: + "501": description: Not Implemented content: application/json: @@ -11527,7 +11532,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/json; charset=utf-8; odata.metadata=minimal: @@ -11599,7 +11604,7 @@ paths: - kind: EntitySet name: Submissions.children.child url: Submissions.children.child - 403: + "403": description: Forbidden content: application/json; charset=utf-8; odata.metadata=minimal: @@ -11615,7 +11620,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Error403' - 406: + "406": description: Not Acceptable content: application/json; charset=utf-8; odata.metadata=minimal: @@ -11667,7 +11672,7 @@ paths: type: string example: simple responses: - 200: + "200": description: OK content: application/xml: @@ -11726,7 +11731,7 @@ paths: - 403: + "403": description: Forbidden content: application/xml: @@ -11742,7 +11747,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Error403' - 406: + "406": description: Not Acceptable content: application/xml: @@ -11853,7 +11858,7 @@ paths: type: string example: __id, age, name, meta/instanceID responses: - 200: + "200": description: OK content: application/json: @@ -11909,13 +11914,13 @@ paths: meta: instanceID: uuid:297000fd-8eb2-4232-8863-d25f82521b87 name: Alice - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 406: + "406": description: Not Acceptable content: application/json: @@ -11932,7 +11937,7 @@ paths: code: "406.1" message: 'Requested format not acceptable; this resource allows: (application/json, json).' - 501: + "501": description: Not Implemented content: application/json: @@ -11961,7 +11966,7 @@ paths: will also return the provided work email address and organization name. operationId: Getting the current configuration responses: - 200: + "200": description: OK content: application/json: @@ -12004,13 +12009,13 @@ paths: enabled: true email: my.email.address@getodk.org organization: Organization Name - 403: + "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error403' - 404: + "404": description: Not Found content: application/json: @@ -12062,7 +12067,7 @@ paths: organization: Organization Name required: false responses: - 200: + "200": description: OK content: application/json: @@ -12105,7 +12110,7 @@ paths: enabled: true email: my.email.address@getodk.org organization: Organization Name - 403: + "403": description: Forbidden content: application/json: @@ -12120,13 +12125,13 @@ paths: once again see a message on the the Central administration website. operationId: Unsetting the current configuration responses: - 200: + "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Success' - 403: + "403": description: Forbidden content: application/json: @@ -12143,10 +12148,10 @@ paths: Usage Report; that is handled internally as a scheduled Central task. operationId: Getting the Usage Report preview responses: - 200: + "200": description: OK content: {} - 403: + "403": description: Forbidden content: application/json: @@ -12200,7 +12205,7 @@ paths: type: number example: "200" responses: - 200: + "200": description: OK content: application/json: @@ -12234,7 +12239,7 @@ paths: type: user updatedAt: 2018-04-18T23:42:11.406Z deletedAt: 2018-04-18T23:42:11.406Z - 400: + "400": description: Bad Request content: application/json: @@ -12243,7 +12248,7 @@ paths: example: code: "400" message: Could not parse the given data (2 chars) as json. - 403: + "403": description: Forbidden content: application/json: @@ -12272,14 +12277,14 @@ paths: passphrase: my-password required: false responses: - 200: + "200": description: OK headers: Content-Disposition: schema: type: string content: {} - 403: + "403": description: Forbidden content: application/json: