how to add screenshots to an extension

[LukasFritzeDev]

Affected URL

https://developer.mittwald.de/docs/v2/contribution/how-to/create-extension/

Describe the issue

Missing information on how to add screenshots to an extension.

After some digging I found the route extension-request-asset-upload, but the process should also be described in the documentation.

[martin-helmich]

Not a direct reply, rather a tangentially-related remark:

Doing this via the API is cumbersome in any case (even if properly documented); ideally (and hopefully in the very-near future), I'd like to include the asset handling in the CLI in the mw contributor extension deploy command (already in-progress in mittwald/cli#1140).

[LukasFritzeDev]

The said route appears to have this response property:

    "assetRefId": {
      "description": "Use the ID as upload token at `/v2/files/{assetRefId}`. This ID will also be the ID of your asset in extension.",
      "format": "uuid",
      "type": "string"
    },

I can not find any route matching this description. file-create-file has no path parameter and the other file routes are only GET. 🤔

[LukasFritzeDev]

ideally, I'd like to include the asset handling in the CLI […] command

If such a command exists, its existence should also be documented in the contributor documentation.

And it would be great to have a command to add screenshots to an existing extension as well.

[martin-helmich]

If such a command exists, its existence should also be documented in the contributor documentation.

Please note that mittwald/cli#1140 is not merged, yet. 😉

And it would be great to have a command to add screenshots to an existing extension as well.

The extension deploy command is meant to be declarative, anyway. So, it should also work with existing extensions. 😄

[martin-helmich]

I can not find any route matching this description. file-create-file has no path parameter and the other file routes are only GET. 🤔

IIRC, that route has a special implementation, and is not handled by the usual API gateway. Maybe that's where there's no OpenAPI spec for it? 🤔

[LukasFritzeDev]

The same issue occurs when I try to add Logo to an extension using extension-request-logo-upload

[LukasFritzeDev]

I can not find any route matching this description. file-create-file has no path parameter and the other file routes are only GET. 🤔

IIRC, that route has a special implementation, and is not handled by the usual API gateway. Maybe that's where there's no OpenAPI spec for it? 🤔

There is an route to upload a file and it has an spec in the documentation: file-create-file.

The problem is, the documentation of the extension endpoints names the wrong URL and the documentation of this route does not show the information necessary to upload the file:

• Content-Type: multipart/form-data must be used
• The file content must be set in the file filed of the form

The raw OpenAPI-Spec contains this information.

[martin-helmich]

Correctly observed. I created #530 as a follow-up.