mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node allows users to patch (update) an existing extension in a marketplace system. It is designed for contributors who manage extensions and want to update various metadata or configuration details of their published extensions. Typical use cases include updating the extension's description, assets order, deprecation status, support information, tags, webhook URLs, and other descriptive fields.

For example, a contributor might use this node to:

  • Mark an extension as deprecated with a note.
  • Update the detailed descriptions in multiple languages.
  • Change the order of assets associated with the extension.
  • Add or modify webhook URLs related to extension lifecycle events.

Properties

Name Meaning
Contributor Id The unique identifier of the contributor who owns the extension.
Extension Id The unique identifier of the extension to be patched.
Assets JSON array used to patch the order or details of assets associated with the extension.
Deprecation JSON object indicating if the extension is deprecated, including a note and optional expiry date.
Description A short textual description of the extension.
Detailed Descriptions JSON object containing detailed descriptions of the extension, typically localized by language codes (e.g., "de", "en").
External Frontends JSON array describing external frontends related to the extension.
Frontend Fragments JSON object representing frontend fragments associated with the extension.
Name The name/title of the extension.
Scopes JSON array defining scopes or permissions relevant to the extension.
Sub Title JSON object with localized subtitles or promotional phrases for the extension.
Support JSON object containing support contact information, e.g., email address.
Tags JSON array of tags or keywords associated with the extension.
Webhook Urls JSON object specifying webhook URLs for various extension lifecycle events like addition, removal, secret rotation, and updates.

Output

The node outputs JSON data representing the response from the API after patching the extension. This typically includes the updated extension object with all its properties reflecting the changes made. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authentication with the mittwald mStudio API.
  • The base URL for API requests is https://api.mittwald.de.
  • The node uses standard HTTP headers for JSON content (Accept: application/json, Content-Type: application/json).
  • No additional external dependencies are indicated beyond the API access.

Troubleshooting

  • Invalid Contributor or Extension Id: If the provided IDs do not exist or are incorrect, the API will likely return an error. Verify the IDs before making the request.
  • Malformed JSON Inputs: Properties such as assets, deprecation, detailedDescriptions, etc., expect valid JSON strings. Invalid JSON will cause parsing errors. Ensure JSON syntax correctness.
  • Missing Required Fields: contributorId and extensionId are required. Omitting these will result in errors.
  • API Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Deprecation Date Format: If a deprecation expiry date is included, ensure it follows the expected format by the API to avoid validation errors.

Links and References

  • mittwald mStudio API Documentation (assumed base URL; consult official docs for full reference)
  • JSON formatting guides for constructing complex property values such as assets and webhookUrls.

Discussion