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
40 lines
935 B
JSON
40 lines
935 B
JSON
{
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"upload_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"avatar",
|
|
"profile_background",
|
|
"card_background",
|
|
"custom_emoji",
|
|
"composer"
|
|
]
|
|
},
|
|
"file_name": {
|
|
"type": "string",
|
|
"example": "IMG_2021.jpeg"
|
|
},
|
|
"file_size": {
|
|
"type": "integer",
|
|
"description": "File size should be represented in bytes.",
|
|
"example": 4096
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"sha1-checksum": {
|
|
"type": "string",
|
|
"description": "The SHA1 checksum of the upload binary blob. Optionally be provided and serves as an additional security check when later processing the file in complete-external-upload endpoint."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"upload_type",
|
|
"file_name",
|
|
"file_size"
|
|
]
|
|
}
|