feat: expose url field on issue api. #982

appleboy · 2017-02-19T15:08:32Z

fix #402

appleboy · 2017-02-20T02:56:24Z

This would be better include in 1.1.0 release.

lunny · 2017-02-20T03:12:50Z

Let's decided it before release

appleboy · 2017-02-20T03:15:06Z

@lunny OK

lunny · 2017-02-26T05:22:58Z

trusted LGTM

lunny · 2017-02-26T05:24:25Z

@rymai @bkcsoft could you confirm this?

rymai · 2017-02-27T06:40:52Z

models/issue.go

@@ -246,6 +246,7 @@ func (issue *Issue) APIFormat() *api.Issue {

 	apiIssue := &api.Issue{
 		ID:       issue.ID,
+		URL:      issue.HTMLURL(),


I'm not sure about that. From GitHub's API it seems that it should be the API URL to get the issue, not the HTML URL: https://developer.github.com/v3/issues/#get-a-single-issue

"url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",

Didn't we define the API URL for Gitea? cc @lunny

Indeed it is the API-URL :) and that function doesn't exist, so we need a issue.APIURL() as well (should be fairly simple)

@appleboy It seems there is not.

But we didn't have API URL in app.ini, we only have ROOT_URL config now.

We don't support a separate api url yet, so just take the regular url and append the api path

func (i *Issue) APIURL() string { return path.Join(settings.AppURL, "/api/v1/repos/", issue.Repo.FullName(), "issues", issue.ID) }

Preferably there should be 2 new functions:

func (repo *Repo) APIURL() string { return path.Join(settings.AppURL, "/api/v1/repos/", repo.FullName()) } func (issue *Issue) APIURL() string { return path.Join(issue.Repo.APIURL(), "issues", issue.ID) }

@bkcsoft maybe you can send a PR and we can close this one.

I will update this PR.

lunny · 2017-02-27T08:56:49Z

build failed.

bkcsoft · 2017-02-27T09:15:01Z

LGTM when the build succeeds :)

bkcsoft · 2017-02-27T09:15:59Z

models/issue.go:205: undefined: path in path.Join
models/issue.go:205: issue.Repo.APIURL undefined (type *Repository has no field or method APIURL)
models/repo.go:268: undefined: Repo
models/repo.go:269: undefined: settings in settings.AppURL
make: *** [Makefile:71: test] Error 1

Need to import "path"

tboerger · 2017-02-27T09:18:42Z

models/repo.go

@@ -264,6 +264,11 @@ func (repo *Repository) HTMLURL() string {
 	return setting.AppURL + repo.FullName()
 }

+// APIURL returns the repository API URL
+func (repo *Repo) APIURL() string {
+	return path.Join(settings.AppURL, "/api/v1/repos/", repo.FullName())


Does appurl include the sub path of gitea is not running on the top folder?

Good catch. path.Join will convert double slash to single slash.

appleboy · 2017-02-27T10:34:29Z

I will fix errors. Please wait.

appleboy · 2017-02-27T12:23:31Z

@tboerger @bkcsoft Done. Please review again.

appleboy · 2017-02-27T16:17:18Z

Add unit testing.

appleboy · 2017-02-27T16:20:46Z

models/repo.go

@@ -264,6 +264,11 @@ func (repo *Repository) HTMLURL() string {
 	return setting.AppURL + repo.FullName()
 }

+// APIURL returns the repository API URL
+func (repo *Repository) APIURL() string {
+	return strings.TrimRight(setting.AppURL, "/") + "/" + path.Join("api/v1/repos", repo.FullName())


Support setting.AppURL include end slash or not

No need for that, path.Join does that automagically 🙂

@bkcsoft path.Join will replace // with /

setting.AppURL = "https://try.gitea.io/" path.Join(setting.AppURL, "api/v1/repos", repo.FullName()) # output: https:/try.gitea.io/api/v1/repos/user01/test

see https://play.golang.org/p/-0CJvOEZ5N

Yeah, path.Join destroys absolute urls.

I don't see how that is relevant, it's supposed to be an absolute URL, not a relative one.

Works just fine IMO: https://play.golang.org/p/Rc734RIuJu

@bkcsoft Please see the result from your url

https:/try.gitea.io/api/v1/repos/user01/repo01

Wrong: https:/
Correct: https://

tboerger · 2017-02-27T17:08:23Z

LGTM

bkcsoft · 2017-02-27T20:12:37Z

models/issue.go

@@ -200,6 +201,11 @@ func (issue *Issue) GetIsRead(userID int64) error {
 	return nil
 }

+// APIURL returns the absolute APIURL to this issue.
+func (issue *Issue) APIURL() string {
+	return strings.TrimRight(issue.Repo.APIURL(), "/") + "/" + path.Join("issues", fmt.Sprint(issue.ID))


Unnecessary, path.Join trims extra slashes

same above.

see https://play.golang.org/p/-0CJvOEZ5N

lunny · 2017-02-28T01:36:41Z

conflicted.

appleboy · 2017-02-28T04:43:52Z

@lunny fix conflicts and wait for build status.

tboerger · 2017-03-01T08:37:45Z

LGTM

lunny · 2017-03-02T09:54:18Z

@appleboy maybe you should rebase and push --force.

appleboy · 2017-03-02T10:04:33Z

@lunny I always use git pull --rebase origin master on target branch.

lunny · 2017-03-02T11:19:46Z

models/repo_test.go

@@ -125,3 +125,10 @@ func TestForkRepository(t *testing.T) {
 	assert.Error(t, err)
 	assert.True(t, IsErrRepoAlreadyExist(err))
 }
+
+func TestRepoAPIURL(t *testing.T) {


Nothing output lint errors after execute make lint command.

Linting doesn't apply to *_test.go 🙂

ethantkoenig · 2017-03-03T02:34:05Z

models/issue_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )

-func TestIssue_ReplaceLabels(t *testing.T) {
+func TestIssueReplaceLabels(t *testing.T) {


Why was this test renamed?

https://golang.org/doc/effective_go.html#mixed-caps

I thought that the naming conventions for tests were the same as the convetions for testable examples (https://blog.golang.org/examples)? Was I mistaken?

@ethantkoenig revert.

appleboy · 2017-03-03T02:42:16Z

@lunny @bkcsoft remove trim from API URL.

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

lunny · 2017-03-03T08:55:21Z

need @ethantkoenig confirmation.

rymai · 2017-03-05T15:16:13Z

Thanks @appleboy! ❤️

lunny added this to the 1.2.0 milestone Feb 20, 2017

lunny added modifies/api This PR adds API routes or modifies them type/enhancement An improvement of existing functionality labels Feb 20, 2017

tboerger added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Feb 20, 2017

tboerger added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Feb 26, 2017

rymai reviewed Feb 27, 2017

View reviewed changes

tboerger added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Feb 27, 2017

tboerger reviewed Feb 27, 2017

View reviewed changes

appleboy force-pushed the api branch 5 times, most recently from 86484f2 to 23285b6 Compare February 27, 2017 11:14

appleboy commented Feb 27, 2017

View reviewed changes

bkcsoft suggested changes Feb 27, 2017

View reviewed changes

appleboy force-pushed the api branch from d2ee5ce to b4ab877 Compare February 28, 2017 04:40

lunny modified the milestones: 1.1.0, 1.2.0 Mar 2, 2017

appleboy force-pushed the api branch 3 times, most recently from d4f04aa to 623aed4 Compare March 2, 2017 02:52

appleboy force-pushed the api branch from 623aed4 to 770d376 Compare March 2, 2017 10:05

lunny reviewed Mar 2, 2017

View reviewed changes

ethantkoenig suggested changes Mar 3, 2017

View reviewed changes

appleboy force-pushed the api branch from dbc8c70 to f1b2fc1 Compare March 3, 2017 02:41

bkcsoft approved these changes Mar 3, 2017

View reviewed changes

appleboy added 5 commits March 3, 2017 16:18

Add api url func.

c425bd6

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

fix: Add unit testing.

2d38a31

fix: conflicts

3bd9e8d

fix: remove trim

d1071d6

fix: revert test function name.

b5d1bd5

appleboy force-pushed the api branch from e2b1eb3 to b5d1bd5 Compare March 3, 2017 08:19

ethantkoenig approved these changes Mar 3, 2017

View reviewed changes

lunny merged commit d76d67d into go-gitea:master Mar 3, 2017

appleboy deleted the api branch March 4, 2017 06:31

go-gitea locked and limited conversation to collaborators Nov 23, 2020

feat: expose url field on issue api. #982

feat: expose url field on issue api. #982

Conversation

appleboy commented Feb 19, 2017

appleboy commented Feb 20, 2017

lunny commented Feb 20, 2017

appleboy commented Feb 20, 2017

lunny commented Feb 26, 2017

lunny commented Feb 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lunny commented Feb 27, 2017

bkcsoft commented Feb 27, 2017

bkcsoft commented Feb 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

appleboy commented Feb 27, 2017

appleboy commented Feb 27, 2017

appleboy commented Feb 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tboerger commented Feb 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lunny commented Feb 28, 2017

appleboy commented Feb 28, 2017

tboerger commented Mar 1, 2017

lunny commented Mar 2, 2017

appleboy commented Mar 2, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ethantkoenig Mar 3, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

appleboy commented Mar 3, 2017

lunny commented Mar 3, 2017

rymai commented Mar 5, 2017

ethantkoenig Mar 3, 2017 •

edited