fix!: Fix LicenseStatus response and Supportkey type#4297
Open
s4mur4i wants to merge 3 commits into
Open
Conversation
gmlewis
changed the title
Supportkey type
gmlewis
changed the title
Supportkey typeLicenseStatus response and Supportkey type
gmlewis
added
NeedsReview
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4297 +/- ##
=======================================
Coverage 97.46% 97.47%
=======================================
Files 192 192
Lines 19258 19310 +52
=======================================
+ Hits 18770 18822 +52
Misses 270 270
Partials 218 218 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
gmlewis
approved these changes
Jun 12, 2026
gmlewis
left a comment
gmlewis
left a comment
Collaborator
There was a problem hiding this comment.
Thank you, @s4mur4i!
LGTM.
Awaiting second LGTM+Approval from any other contributor to this repo before merging.
cc: @stevehipwell - @alexandear - @zyfy29 - @Not-Dhananjay-Mishra
alexandear
reviewed
Jun 12, 2026
| // | ||
| //meta:operation GET /manage/v1/config/license | ||
| func (s *EnterpriseService) License(ctx context.Context) ([]*LicenseStatus, *Response, error) { | ||
| func (s *EnterpriseService) License(ctx context.Context) (*LicenseStatus, *Response, error) { |
Contributor
There was a problem hiding this comment.
Let's add a comment to the function that GitHub documentation is wrong about the response.
Contributor
Author
There was a problem hiding this comment.
Their last response was:
We’ll treat this as a documentation/schema mismatch and route it for review so the example can be corrected to match the actual GHES behavior.
Eventually it should be corrected, in that case wouldn't that cause confusion?
alexandear
approved these changes
Jun 15, 2026
alexandear
reviewed
Jun 15, 2026
Comment on lines
354
to
+360
| // License gets the current license information for the GitHub Enterprise instance. | ||
| // | ||
| // GitHub API docs: https://docs.github.com/enterprise-server@3.21/rest/enterprise-admin/manage-ghes#get-the-enterprise-license-information | ||
| // | ||
| //meta:operation GET /manage/v1/config/license | ||
| func (s *EnterpriseService) License(ctx context.Context) ([]*LicenseStatus, *Response, error) { | ||
| // Current Docs shouw incorrect return type. They list as [{...}] but actual is {...} | ||
| // TODO: Remove comment after github updates schema documentation |
Contributor
There was a problem hiding this comment.
I propose adding a note:
// License gets the current license information for the GitHub Enterprise instance.
//
// NOTE: The GitHub documentation incorrectly shows the return type as a list ([{...}]),
// but the actual response is a single object ({...}).
// TODO: Remove this note once GitHub corrects the schema documentation.
//
// GitHub API docs: https://docs.github.com/enterprise-server@3.21/rest/enterprise-admin/manage-ghes#get-the-enterprise-license-information
//
//meta:operation GET /manage/v1/config/license
Contributor
Author
There was a problem hiding this comment.
I cannot accept this, should I just update with commit?
Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE:
LicenseStatus.SupportKeytype changed from*stringto*boolandLicensereturn type is no longer a slice.Closes: #4296
License status response was implemented according to documentation, which is not according to actual response.
Fix:
Corrected the response
Fixed incorrect data type for SupportKey
Fixed tests