📚 Documentation: Return Type for Download Deployment is Wrong

[ItzNotABug]

💭 Description

This Download Deployment method shows the Response as [200] application/json but this in-fact returns a tar.gz of the requested deployment.

---

The Response from Postman -
Content-Type: application/gzip
Content-Disposition: attachment; filename="************.tar.gz"

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

[namansharma18899]

@ItzNotABug I'm agree with the issue you raised. Not only it's wrong but as of August 2012, the MIME type recommended in [RFC 6713] is application/gzip so application/tar & application/zip will be incorrect as well.

I would like to raise a PR for this if it seems fit 😄

[namansharma18899]

@ItzNotABug can you assign me this one.

[AnanyaJindal1145]

@ItzNotABug Can I be assigned this issue?

[stnguyen90]

The problem with this is our openapi specs don't have anything for the content when the content is binary. Compare:

Get file:

      "get": {
        "summary": "Get file",
        "operationId": "storageGetFile",
        "tags": ["storage"],
        "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.",
        "responses": {
          "200": {
            "description": "File",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/file" }
              }
            }
          }
        },

with Download deployment:

      "get": {
        "summary": "Download Deployment",
        "operationId": "functionsDownloadDeployment",
        "tags": ["functions"],
        "description": "Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.",
        "responses": { "200": { "description": "File" } },

If we fix the specs, we can stop hardcoding the response type:

website/src/routes/docs/references/[version]/[platform]/[service]/(components)/Response.svelte

Line 18 in 1adbcb4

<span class="web-caption-400">application/json</span>

The fix probably needs to happen somewhere in here.