Könyvtár módosítása

A könyvtár átnevezése, vagy az attribútumok módosítása. A könyvtár átnevezésével az elérési út nem módosítható (ez azt jelenti, hogy a new_name paraméter nem tartalmazhat útvonalat, csak nevet).

Kérelem

Figyelem: Vagy a projekt kulcs vagy a felhasználónév és a fiók kulcs kombinációja adható át ehhez a végponthoz. Projekt azonosítója mindkét esetben átadásra kerül.

POST https://api.crowdin.com/api/project/{project-identifier}/change-directory?key={project-key}
POST https://api.crowdin.com/api/project/{project-identifier}/change-directory?login={username}&account-key={account-key}

Paraméterek

Név Érték Leírás
name szükséges string A könyvtár teljes elérési útvonala, melyet módosítani kell (pl. /MainPage/AboutUs).
new_name opcionális string Új könyvtárnév.
title opcionális string A Crowdin felületen megjelenítendő új könyvtárnév.
export_pattern opcionális string Új könyvtár exportálási minta. A könyvtár nevének és elérési útvonalának létrehozásához használt az eredményül kapott fordítások csomagjában.
branch opcionális string Kapcsolódó verzió-ág neve (Verziók kezelése).
json opcionális string Nem tartalmazhat értéket. Meghatározza, hogy a válasz JSON formátumban kell legyen.
jsonp opcionális string Visszahívási funkció neve. Meghatározza, hogy a válasz JSONP formátumban legyen.
Változók
project-identifier szükséges string Projekt azonosítója.
project-key opcionális string Projekt API kulcs. Vagy a projekt kulcs vagy a felhasználónév és fiók kulcs kombinációja szükséges.
username opcionális string A felhasználóneve a Crowdinban. Vagy a projekt kulcs vagy a felhasználónév és fiók kulcs kombinációja szükséges.
account-key opcionális string Fiók API kulcs. Vagy a projekt kulcs vagy a felhasználónév és fiók kulcs kombinációja szükséges.

Válasz

Ha sikeres, akkor ez a módszer XML struktúrát ad vissza, ahogy az az alábbiakban látható.
<?xml version="1.0" encoding="ISO-8859-1"?>
<success>
</success>
Sikertelen válasz példa:
<?xml version="1.0" encoding="ISO-8859-1"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Példák

curl \
  -F "name=localizable" \
  -F "title=Website" \
  -F "new_name=translatable" \
  https://api.crowdin.com/api/project/{project-identifier}/change-directory?key={project-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/change-directory?key={project-key}';
$post_params['name'] = '/localizable/texts';
$post_params['new_name'] = 'translations';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_params);

$result = curl_exec($ch);
curl_close($ch);

echo $result;

Hasznos volt ez a cikk?