엔터프라이즈 공지 배너
엔터프라이즈 공지 배너 API를 사용하면 엔터프라이즈에 대한 공지 배너를 가져와서 설정하고 제거할 수 있습니다.
Get announcement banner for enterprise
Gets the announcement banner currently set for the enterprise.
"Get announcement banner for enterprise"에 대한 매개 변수
| 헤더 |
|---|
| 속성, 형식, Description |
accept string Setting to |
| 경로 매개 변수 |
| 속성, 형식, Description |
enterprise string 필수The slug version of the enterprise name. You can also substitute this value with the enterprise id. |
"Get announcement banner for enterprise"에 대한 HTTP 응답 상태 코드
| 상태 코드 | Description |
|---|---|
200 | OK |
"Get announcement banner for enterprise"에 대한 코드 샘플
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/announcementAnnouncement banner
Status: 200{
"announcement": "Very **important** announcement about _something_.",
"expires_at": "2021-01-01T00:00:00.000+00:00",
"user_dismissible": false
}Set announcement banner for enterprise
Sets the announcement banner to display for the enterprise.
"Set announcement banner for enterprise"에 대한 매개 변수
| 헤더 |
|---|
| 속성, 형식, Description |
accept string Setting to |
| 경로 매개 변수 |
| 속성, 형식, Description |
enterprise string 필수The slug version of the enterprise name. You can also substitute this value with the enterprise id. |
| 본문 매개 변수 |
| 속성, 형식, Description |
announcement string or null 필수The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax." |
expires_at string or null The time at which the announcement expires. This is a timestamp in ISO 8601 format: |
"Set announcement banner for enterprise"에 대한 HTTP 응답 상태 코드
| 상태 코드 | Description |
|---|---|
200 | OK |
"Set announcement banner for enterprise"에 대한 코드 샘플
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/announcement \
-d '{"announcement":"Very **important** announcement about _something_.","expires_at":"2021-01-01T00:00:00.000+00:00","user_dismissible":false}'Announcement banner
Status: 200{
"announcement": "Very **important** announcement about _something_.",
"expires_at": "2021-01-01T00:00:00.000+00:00",
"user_dismissible": false
}Remove announcement banner from enterprise
Removes the announcement banner currently set for the enterprise.
"Remove announcement banner from enterprise"에 대한 매개 변수
| 헤더 |
|---|
| 속성, 형식, Description |
accept string Setting to |
| 경로 매개 변수 |
| 속성, 형식, Description |
enterprise string 필수The slug version of the enterprise name. You can also substitute this value with the enterprise id. |
"Remove announcement banner from enterprise"에 대한 HTTP 응답 상태 코드
| 상태 코드 | Description |
|---|---|
204 | No Content |
"Remove announcement banner from enterprise"에 대한 코드 샘플
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/announcementResponse
Status: 204