Function Test_normalizeDocURL

tools/metadata/metadata_test.go:32–89

(t *testing.T)

}

func Test_normalizeDocURL(t *testing.T) {
	t.Parallel()

	for _, td := range []struct {
		name   string
		docURL string
		want   string
	}{
		{
			name:   "invalid URL",
			docURL: "://bad",
			want:   "://bad",
		},
		{
			name:   "clean path and add api version",
			docURL: "https://docs.github.com//rest/repos/repos#get-a-repository",
			want:   "https://docs.github.com/rest/repos/repos?apiVersion=2022-11-28#get-a-repository",
		},
		{
			name:   "preserve query and add api version",
			docURL: "https://docs.github.com/rest/repos/repos?foo=bar",
			want:   "https://docs.github.com/rest/repos/repos?apiVersion=2022-11-28&foo=bar",
		},
		{
			name:   "preserve existing api version",
			docURL: "https://docs.github.com/rest/repos/repos?apiVersion=2021-01-01&foo=bar",
			want:   "https://docs.github.com/rest/repos/repos?apiVersion=2021-01-01&foo=bar",
		},
		{
			name:   "preserve non-default api version",
			docURL: "https://docs.github.com/rest/private-registries/organization-configurations?apiVersion=2026-03-10#list-private-registries-for-an-organization",
			want:   "https://docs.github.com/rest/private-registries/organization-configurations?apiVersion=2026-03-10#list-private-registries-for-an-organization",
		},
		{
			name:   "enterprise cloud latest rest is normalized",
			docURL: "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository",
			want:   "https://docs.github.com/enterprise-cloud@latest/rest/repos/repos?apiVersion=2022-11-28#get-a-repository",
		},
		{
			name:   "non rest docs path unchanged",
			docURL: "https://gist.github.com/jonmagic/5282384165e0f86ef105",
			want:   "https://gist.github.com/jonmagic/5282384165e0f86ef105",
		},
		{
			name:   "non docs host unchanged",
			docURL: "https://example.com/rest/repos/repos",
			want:   "https://example.com/rest/repos/repos",
		},
	} {
		t.Run(td.name, func(t *testing.T) {
			t.Parallel()
			got := normalizeDocURL(td.docURL)
			if got != td.want {
				t.Errorf("normalizeDocURL() = %v, want %v", got, td.want)
			}
		})
	}
}