[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1enterprises~1{enterprise}~1consumed-licenses/get`

Open
#5,485 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api, documentation

Research direction

Search the OpenAPI description for components/examples/get-consumed-licenses/value and the GET operation at /enterprises/{enterprise}/consumed-licenses. Compare the example fields with the corresponding schema, then validate that the schema and example are synchronized and that the reported github_com_enterprise_role mismatch is resolved.

Written by the indexing model from the issue text.

Description

content documentation

Schema Inaccuracy

This is the json ref for the example

#/components/examples/get-consumed-licenses/value

The field github_com_enterprise_role doesn't exist in the schema, but exists in the example.

Here's a snippet

   29:     "visual_studio_subscription_user" : false,
   30:     "license_type" : "enterprise",
   31:     "github_com_profile" : "",
   32:     "github_com_member_roles" : [ ],
>  33:     "github_com_enterprise_role" : "",
   34:     "github_com_enterprise_roles" : [ ],
   35:     "github_com_verified_domain_emails" : [ ],
   36:     "github_com_saml_name_id" : "",
   37:     "github_com_orgs_with_pending_invites" : [ ],

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • ghec
Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.