문서를 공개하는 API입니다.

API 만들기

<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.

다양한 쓰리래빗츠 북 API를 만드는 방법을 설명합니다.

API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다. 대상으로 "공개한 문서"를 선택하면 호출 시점에 공개되어 있는 문서만 대상으로 하고, 공개하지 않은 문서에는 API_HAS_NOT_DOC 예외를 반환합니다.

API 요청

POST 형식으로 요청해야 합니다.

JSON 요청 형식입니다.

DOC_PUBLISH 요청 파라미터
이름	유형	설명	필수 여부	예
action	문자열	작업 유형	예	DOC_PUBLISH
id	UUID	문서 아이디	예	0168a36b30c18e93
isPublic	boolean	공개 여부. 검사하지 않으며 빠뜨리면 `false`로 처리해 비공개 링크를 만듭니다.	아니오	true \| false
link	문자열	공개 주소. 최대 200자입니다.	예	user_guide
tagId	UUID	태그 아이디. 특정 태그로 공개하려면 태그 아이디를 전달합니다. 이 값이 있을 때는 `isPublic`이 `true`이어야 합니다. 이 문서의 태그여야 합니다.	아니오	7518267aca42554f

문서를 변경하는 예제입니다.

{
    "action": "DOC_PUBLISH",
    "id": "0168a36b30c18e93",
    "isPublic": true,
	"link": "user_guide",
	"tagId": "7518267aca42554f"
}

공개하기 전에 문서의 기존 공개 정보를 정리합니다. 링크만 만들어 둔 비공개 공개 정보도 지우므로, 같은 문서를 여러 번 공개해도 공개 정보는 하나만 남습니다. 매뉴얼웍스 6.0.26 버전 전에는 링크만 만들어 둔 공개 정보가 남아 공개 정보가 두 개가 될 수 있었습니다.

API 응답

`DOC_PUBLISH` 응답

JSON 형식의 응답은 다음과 같습니다.

`DOC_PUBLISH` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오

예외 항목

예외 항목은 다음과 같습니다.

DOC_PUBLISH 예외 항목
예외	설명
API_HAS_NOT_DOC	API에 해당 문서를 포함시키지 않았을 때
DOC_NOT_EXIST	문서가 존재하지 않을 때
PUBLISHING_BY_TAG_REQUIRE_PUBLIC	태그로 공개할 때 `isPublic`이 `false`일 때
TAG_NOT_EXIST	태그가 존재하지 않거나 이 문서의 태그가 아닐 때
INVALID_LINK	동일한 링크가 존재하거나 링크 형식이 맞지 않을 때
INVALID_PARAMETER	문자열의 길이 등이 형식에 맞지 않을 때(`link`는 최대 200자)
IS_NOT_TIME_TAG	타임 태그가 아닐 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목(`id`, `link`)이 없을 때

예제

예제입니다.

{
	"status": "success"
}

API 만들기

API 요청

API 응답

DOC_PUBLISH 응답

예외 항목

예제

`DOC_PUBLISH` 응답