Update module metadata

Updates the metadata of an existing module. Can update name, description, tags, license, and other module properties.

PATCH /modules/{id}

Update module metadata

cURL

curl --request PATCH \
  --url https://staging.hdp.api.herodotus.cloud/modules/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "abi": "<unknown>",
  "description": "<string>",
  "license": "<string>",
  "name": "<string>",
  "source_code": "<unknown>",
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://staging.hdp.api.herodotus.cloud/modules/{id}"

payload = {
    "abi": "<unknown>",
    "description": "<string>",
    "license": "<string>",
    "name": "<string>",
    "source_code": "<unknown>",
    "tags": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    abi: '<unknown>',
    description: '<string>',
    license: '<string>',
    name: '<string>',
    source_code: '<unknown>',
    tags: ['<string>']
  })
};

fetch('https://staging.hdp.api.herodotus.cloud/modules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.hdp.api.herodotus.cloud/modules/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'abi' => '<unknown>',
    'description' => '<string>',
    'license' => '<string>',
    'name' => '<string>',
    'source_code' => '<unknown>',
    'tags' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.hdp.api.herodotus.cloud/modules/{id}"

	payload := strings.NewReader("{\n  \"abi\": \"<unknown>\",\n  \"description\": \"<string>\",\n  \"license\": \"<string>\",\n  \"name\": \"<string>\",\n  \"source_code\": \"<unknown>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://staging.hdp.api.herodotus.cloud/modules/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"abi\": \"<unknown>\",\n  \"description\": \"<string>\",\n  \"license\": \"<string>\",\n  \"name\": \"<string>\",\n  \"source_code\": \"<unknown>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging.hdp.api.herodotus.cloud/modules/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"abi\": \"<unknown>\",\n  \"description\": \"<string>\",\n  \"license\": \"<string>\",\n  \"name\": \"<string>\",\n  \"source_code\": \"<unknown>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "compilerVersion": "<string>",
  "createdAt": "<string>",
  "downloadsCount": 123,
  "id": "<string>",
  "isVerified": true,
  "name": "<string>",
  "publishedOnMarketplace": true,
  "updatedAt": "<string>",
  "usageCount": 123,
  "usersCount": 123,
  "abi": "<unknown>",
  "creatorUser": "<string>",
  "description": "<string>",
  "latestModuleVersionProgramHash": "<string>",
  "license": "<string>",
  "scarbToml": "<string>",
  "sourceCode": "<unknown>",
  "tags": [
    "<string>"
  ]
}

Path Parameters

id · string · required

The unique identifier of the module to update

Body

application/json

abi · any

description · string | null

license · string | null

name · string | null

source_code · any

tags · string[] | null

Response

200

application/json

Module updated successfully

compilerVersion · string · required

createdAt · string · required

downloadsCount · integer<int64> · required

id · string · required

isVerified · boolean · required

name · string · required

publishedOnMarketplace · boolean · required

updatedAt · string · required

usageCount · integer<int64> · required

usersCount · integer<int64> · required

abi · any

creatorUser · string | null

description · string | null

latestModuleVersionProgramHash · string | null

license · string | null

scarbToml · string | null

sourceCode · any

tags · string[] | null