Skip to content

[Improvement]: Wrong code samples for the management console REST API docs #6485

@megbird

Description

@megbird

What article(s) is affected?

https://docs.github.com/en/[email protected]/rest/reference/enterprise-admin#management-console

Briefly summarize the problem with the docs and its impact on GitHub's users.

All code samples for the Management Console API have the /api/v3 which is unnecessary

Describe the desired docs changes and the problem they solve for customers.

Let's take this as an example.

https://docs.github.com/en/[email protected]/rest/reference/enterprise-admin#get-the-configuration-status--code-samples

The shell code sample is

curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/setup/api/configcheck

This is wrong. The correct endpoint URL is

curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/setup/api/configcheck

All code samples in this section has the same error.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamgood first issueGood for newcomerstriageDo not begin working on this issue until triaged by the team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions