Register an Extension

POST/contributors/{contributorId}/extensions/

API version

v2

Request method

POST

Operation ID

extension-register-extension

---

Request

• contributorIdstring

  required

Responses

Format

application/json

Description

The extension has been registered.

Schema documentation

• idstring (uuid)

  required

Example

Content-Type: application/json

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"context":"project","description":"string","detailedDescriptions":{"de":{"markdown":"string","plain":"string"},"en":{"markdown":"string","plain":"string"}},"externalFrontends":[{"name":"string","url":"string"}],"frontendFragments":{"string":null},"name":"string","scopes":["string"],"subTitle":{"de":"Ping deine App an","en":"Ping your app"},"support":{"email":"a.lovelace@example.com","phone":"string"},"tags":["string"],"webhookURLs":null,"webhookUrls":{"extensionAddedToContext":{"url":"string"},"extensionInstanceRemovedFromContext":{"url":"string"},"extensionInstanceSecretRotated":{"url":"string"},"extensionInstanceUpdated":{"url":"string"}}}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/contributors/string/extensions

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.extensionRegisterExtension({
  "contributorId": "string",
  "data": {
    "context": "project",
    "description": "string",
    "detailedDescriptions": {
      "de": {
        "markdown": "string",
        "plain": "string"
      },
      "en": {
        "markdown": "string",
        "plain": "string"
      }
    },
    "externalFrontends": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "frontendFragments": {
      "string": null
    },
    "name": "string",
    "scopes": [
      "string"
    ],
    "subTitle": {
      "de": "Ping deine App an",
      "en": "Ping your app"
    },
    "support": {
      "email": "a.lovelace@example.com",
      "phone": "string"
    },
    "tags": [
      "string"
    ],
    "webhookURLs": null,
    "webhookUrls": {
      "extensionAddedToContext": {
        "url": "string"
      },
      "extensionInstanceRemovedFromContext": {
        "url": "string"
      },
      "extensionInstanceSecretRotated": {
        "url": "string"
      },
      "extensionInstanceUpdated": {
        "url": "string"
      }
    }
  }
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionRegisterExtension\ExtensionRegisterExtensionRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionRegisterExtension\ExtensionRegisterExtensionRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// ExtensionRegisterExtensionRequestBody to learn how to construct a valid instance
$body = new ExtensionRegisterExtensionRequestBody(/* TODO: ... */);

$request = (new ExtensionRegisterExtensionRequest(
  contributorId: "string",
  body: $body
));
$response = $client->marketplace()->extensionRegisterExtension($request);

var_dump($response->getBody();