브랜치 삭제(Delete Branch) (V2)
지정한 데이터셋에서 branchName에 해당하는 브랜치를 삭제합니다. 토큰에는 해당 브랜치를 삭제할 권한이 필요합니다. 요청 전에 데이터셋과 브랜치 이름이 삭제할 대상인지 확인합니다.
HTTP 요청
DELETE /api/v2/datasets/{datasetRid}/branches/{branchName}
작업 식별자는 v2.deleteBranch입니다. OAuth 클라이언트에는 api:datasets-write 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
datasetRid | string | 필수 | 작업 대상 데이터셋의 RID입니다. | ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da |
branchName | string | 필수 | 브랜치 이름입니다. | master |
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
요청 본문을 사용하지 않습니다.
응답
별도 응답 본문이 정의되어 있지 않습니다.
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
BranchNotFound | NOT_FOUND | 404 | 브랜치를 찾을 수 없거나 토큰이 접근할 수 없습니다. | datasetRid, branchName |
DatasetNotFound | NOT_FOUND | 404 | 데이터셋을 찾을 수 없거나 토큰이 접근할 수 없습니다. | datasetRid |
InvalidBranchName | INVALID_ARGUMENT | 400 | 브랜치 이름이 비어 있거나 RID 또는 UUID처럼 보입니다. 사용할 수 있는 이름으로 바꿉니다. | branchName |
DeleteBranchPermissionDenied | PERMISSION_DENIED | 403 | 데이터셋의 브랜치를 삭제할 권한이 없습니다. | datasetRid, branchName |
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 아래 RID, 이름과 파일 경로는 예시이며 실제 작업 대상으로 바꾸어야 합니다.
cURL
curl -X DELETE \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches/my-branch"
Python
Requests 라이브러리가 설치된 Python 환경에서 사용합니다.
import os
import requests
HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
"authorization": "Bearer {}".format(TOKEN)
}
response = requests.delete('https://{}/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches/my-branch'.format(HOSTNAME), headers=headers)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 DeleteBranchExample.java 파일에서 사용합니다.
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
public class DeleteBranchExample {
public static void main(String[] args) throws Exception {
String HOSTNAME = System.getenv("FOUNDRY_HOST");
String TOKEN = System.getenv("FOUNDRY_TOKEN");
try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
HttpDelete request = new HttpDelete("https://" + HOSTNAME + "/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches/my-branch");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
try (CloseableHttpResponse response = httpClient.execute(request)) {
System.out.println(response);
}
}
}
}
JavaScript
fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.
const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;
fetch(`https://${HOSTNAME}/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches/my-branch`, {
method: 'DELETE',
headers: {
'Authorization': `Bearer ${TOKEN}`,
}
}).then((response) => {
console.log(response)
});
PowerShell
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST
$headers = @{
"authorization" = "Bearer $TOKEN"
}
$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches/my-branch" `
-Method Delete `
-Headers $headers
$response.content