mirror of
https://github.com/discourse/discourse.git
synced 2025-02-06 11:28:18 +00:00
19089f21d2
This commit adds API documentation for the new upload endpoints related to direct + multipart external uploads. Also included is a rake task which watches the files in the spec/requests/api directory and calls a script file (spec/regenerate_swagger_docs) whenever one changes. This script runs rake rswag:specs:swaggerize and then copies the openapi.yml file over to the discourse_api_docs repo directory, and hits a script there to convert the YML to JSON so the API docs are refreshed while the server is still running. This makes the loop of making a doc change and seeing it in the local server much faster. The rake task is rake autospec:swagger
26 lines
963 B
JSON
26 lines
963 B
JSON
{
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"key": {
|
|
"type": "string",
|
|
"description": "The path of the temporary file on the external storage service.",
|
|
"example": "temp/site/uploads/default/12345/67890.jpg"
|
|
},
|
|
"external_upload_identifier": {
|
|
"type": "string",
|
|
"description": "The identifier of the multipart upload in the external storage provider. This is the multipart upload_id in AWS S3.",
|
|
"example": "84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ"
|
|
},
|
|
"unique_identifier": {
|
|
"type": "string",
|
|
"description": "A unique string that identifies the external upload. This must be stored and then sent in the /complete-multipart and /batch-presign-multipart-parts endpoints.",
|
|
"example": "66e86218-80d9-4bda-b4d5-2b6def968705"
|
|
}
|
|
},
|
|
"required": [
|
|
"external_upload_identifier",
|
|
"key",
|
|
"unique_identifier"
|
|
]
|
|
}
|