Skip to content

Commit 4786dc8

Browse files
Commit via running ake Sources/licenses
1 parent cff0413 commit 4786dc8

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

Sources/licenses/Client.swift

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,10 @@ public struct Client: APIProtocol {
237237
///
238238
/// This method returns the contents of the repository's license file, if one is detected.
239239
///
240-
/// Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.
240+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
241+
///
242+
/// - **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
243+
/// - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
241244
///
242245
/// - Remark: HTTP `GET /repos/{owner}/{repo}/license`.
243246
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/license/get(licenses/get-for-repo)`.

Sources/licenses/Types.swift

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ public protocol APIProtocol: Sendable {
2929
///
3030
/// This method returns the contents of the repository's license file, if one is detected.
3131
///
32-
/// Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.
32+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
33+
///
34+
/// - **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
35+
/// - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
3336
///
3437
/// - Remark: HTTP `GET /repos/{owner}/{repo}/license`.
3538
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/license/get(licenses/get-for-repo)`.
@@ -72,7 +75,10 @@ extension APIProtocol {
7275
///
7376
/// This method returns the contents of the repository's license file, if one is detected.
7477
///
75-
/// Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.
78+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
79+
///
80+
/// - **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
81+
/// - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
7682
///
7783
/// - Remark: HTTP `GET /repos/{owner}/{repo}/license`.
7884
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/license/get(licenses/get-for-repo)`.
@@ -910,7 +916,10 @@ public enum Operations {
910916
///
911917
/// This method returns the contents of the repository's license file, if one is detected.
912918
///
913-
/// Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.
919+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
920+
///
921+
/// - **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
922+
/// - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
914923
///
915924
/// - Remark: HTTP `GET /repos/{owner}/{repo}/license`.
916925
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/license/get(licenses/get-for-repo)`.

0 commit comments

Comments
 (0)