Deprecate previews

hub4j · Jun 20, 2024 · f191180 · f191180
1 parent c3ba272
commit f191180
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 3 deletions.
diff --git a/src/main/java/org/kohsuke/github/GHRepository.java b/src/main/java/org/kohsuke/github/GHRepository.java
@@ -2468,7 +2468,7 @@ public PagedIterable<GHUser> listStargazers() {
      */
     public PagedIterable<GHStargazer> listStargazers2() {
         return root().createRequest()
-                .withPreview("application/vnd.github.v3.star+json")
+                .withAccept("application/vnd.github.star+json")
                 .withUrlPath(getApiTailUrl("stargazers"))
                 .toIterable(GHStargazer[].class, item -> item.wrapUp(this));
     }

diff --git a/src/main/java/org/kohsuke/github/GitHubClient.java b/src/main/java/org/kohsuke/github/GitHubClient.java
@@ -619,10 +619,12 @@ private static GitHubConnectorRequest prepareConnectorRequest(GitHubRequest requ
             }
         }
         if (request.header("Accept") == null) {
-            builder.setHeader("Accept", "application/vnd.github.v3+json");
+            builder.setHeader("Accept", "application/vnd.github+json");
         }
         builder.setHeader("Accept-Encoding", "gzip");
 
+        builder.setHeader("X-GitHub-Api-Version", "2022-11-28");
+
         if (request.hasBody()) {
             if (request.body() != null) {
                 builder.contentType(defaultString(request.contentType(), "application/x-www-form-urlencoded"));

diff --git a/src/main/java/org/kohsuke/github/GitHubRequest.java b/src/main/java/org/kohsuke/github/GitHubRequest.java
@@ -507,8 +507,9 @@ public B injectMappingValue(@NonNull String name, Object value) {
          *            the name
          * @return the b
          */
+        @Deprecated
         public B withPreview(String name) {
-            return withHeader("Accept", name);
+            return withAccept(name);
         }
 
         /**
@@ -518,10 +519,22 @@ public B withPreview(String name) {
          *            the preview
          * @return the b
          */
+        @Deprecated
         public B withPreview(Previews preview) {
             return withPreview(preview.mediaType());
         }
 
+        /**
+         * With accept header.
+         *
+         * @param name
+         *            the name
+         * @return the b
+         */
+        public B withAccept(String name) {
+            return withHeader("Accept", name);
+        }
+
         /**
          * With requester.
          *

diff --git a/src/main/java/org/kohsuke/github/internal/Previews.java b/src/main/java/org/kohsuke/github/internal/Previews.java
@@ -1,12 +1,15 @@
 package org.kohsuke.github.internal;
 
+import java.lang.Deprecated;
+
 /**
  * Provides the media type strings for GitHub API previews
  *
  * https://developer.github.com/v3/previews/
  *
  * @author Kohsuke Kawaguchi
  */
+@Deprecated
 public enum Previews {
 
     /**