Add Attachment API #3478

jonasfranz · 2018-02-08T21:30:50Z

Fixes #711

API endpoints:

GET repos/:owner/:repo/releases (add attachments)
GET repos/:owner/:repo/releases/:id (add attachments)
GET repos/:owner/:repo/releases/:id/assets
GET repos/:owner/:repo/releases/:id/assets/:attachment_id
POST repos/:owner/:repo/releases/:id/assets
PATCH repos/:owner/:repo/releases/:id/assets/:attachment_id
DELETE repos/:owner/:repo/releases/:id/assets/:attachment_id

Example response

[
   {
      "id":1,
      "tag_name":"test",
      "target_commitish":"master",
      "name":"",
      "body":"test",
      "url":"http://localhost:3000/api/v1/jonas/re/releases/1",
      "tarball_url":"http://localhost:3000/jonas/re/archive/test.tar.gz",
      "zipball_url":"http://localhost:3000/jonas/re/archive/test.zip",
      "draft":false,
      "prerelease":false,
      "created_at":"2018-02-08T21:17:42+01:00",
      "published_at":"2018-02-08T21:17:42+01:00",
      "author":{
         "id":1,
         "login":"jonas",
         "full_name":"",
         "email":"admin@admin.admin",
         "avatar_url":"https://secure.gravatar.com/avatar/839531d0faa3e6efb8d874dd74a8e530?d=identicon",
         "username":"jonas"
      },
      "assets":[
         {
            "id":1,
            "name":"device manager.PNG",
            "size":9453,
            "download_count":1,
            "created_at":"2018-02-08T21:17:39+01:00",
            "uuid":"b780ab51-c0f2-4c6e-b16c-12fe07636d52",
            "browser_download_url":"http://localhost:3000/attachments/b780ab51-c0f2-4c6e-b16c-12fe07636d52"
         }
      ]
   }
]

TODO

Unit tests

* repos/:owner/:repo/releases (add attachments) * repos/:owner/:repo/releases/:id (add attachments) * repos/:owner/:repo/releases/:id/attachments * repos/:owner/:repo/releases/:id/attachments/:attachment_id Signed-off-by: Jonas Franz <info@jonasfranz.de>

Fix comments Signed-off-by: Jonas Franz <info@jonasfranz.software>

lafriks · 2018-02-09T07:20:56Z

Go lint fails with error

Signed-off-by: Jonas Franz <info@jonasfranz.software>

…ses-api

Signed-off-by: Jonas Franz <info@jonasfranz.software>

Add missing license header Signed-off-by: Jonas Franz <info@jonasfranz.software>

codecov-io · 2018-02-09T10:14:36Z

Codecov Report

Merging #3478 into master will decrease coverage by 0.23%.
The diff coverage is 9.82%.

@@            Coverage Diff             @@
##           master    #3478      +/-   ##
==========================================
- Coverage   36.15%   35.91%   -0.24%     
==========================================
  Files         285      286       +1     
  Lines       40928    41257     +329     
==========================================
+ Hits        14797    14818      +21     
- Misses      23957    24259     +302     
- Partials     2174     2180       +6

Impacted Files	Coverage Δ
routers/api/v1/repo/release_attachment.go	`0% <0%> (ø)`
routers/api/v1/repo/release.go	`43.84% <100%> (ø)`	⬆️
routers/api/v1/api.go	`75.82% <100%> (+0.4%)`	⬆️
models/attachment.go	`46.76% <40.47%> (-2.73%)`	⬇️
models/release.go	`45.7% <50%> (-0.1%)`	⬇️
modules/process/manager.go	`76.81% <0%> (-4.35%)`	⬇️
models/repo_list.go	`65.62% <0%> (-1.57%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 69ea5e4...3812137. Read the comment docs.

Add EditReleaseAttachment Add DeleteReleaseAttachment Signed-off-by: Jonas Franz <info@jonasfranz.software>

Signed-off-by: Jonas Franz <info@jonasfranz.software>

lunny · 2018-02-10T03:07:24Z

models/attachment.go

@@ -15,6 +15,8 @@ import (

 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/util"
+	api "code.gitea.io/sdk/gitea"
+	"github.com/go-xorm/xorm"


blank line needed.

lunny · 2018-02-10T10:51:52Z

models/attachment.go

+		// Use uuid only if id is not set and uuid is set
+		sess = e.Where("uuid = ?", atta.UUID)
+	}
+	_, err := sess.AllCols().Update(atta)


I don't think this is a good idea to update all the columns.

What do you propose alternatively?

sess.Cols("col1", "col2"...).Update()
Only update needed columns.

Signed-off-by: Jonas Franz <info@jonasfranz.software>

…ses-api

…ses-api # Conflicts: # vendor/code.gitea.io/sdk/gitea/attachment.go # vendor/vendor.json

Signed-off-by: Jonas Franz <info@jonasfranz.software>

Update code.gitea.io/sdk Signed-off-by: Jonas Franz <info@jonasfranz.software>

jonasfranz · 2018-03-02T19:48:55Z

@appleboy I've fixed this bug in go-gitea/go-sdk#96

thehowl · 2018-03-03T17:21:15Z

routers/api/v1/api.go

+						m.Combo("").Get(repo.GetRelease).
+							Patch(reqToken(), reqRepoWriter(), context.ReferencesGitRepo(), bind(api.EditReleaseOption{}), repo.EditRelease).
+							Delete(reqToken(), reqRepoWriter(), repo.DeleteRelease)
+						m.Group("/assets", func() {


documented as /attachments but it's actually /assets. which is it?

It is documented as assets as shown in the go sdk and the PR description.

thehowl

Then it should become assets everywhere else as well.

thehowl · 2018-03-03T17:29:29Z

models/attachment.go

+
+// DownloadURL returns the download url of the attached file
+func (a *Attachment) DownloadURL() string {
+	return fmt.Sprintf("%sattachments/%s", setting.AppURL, a.UUID)


This is unrelated since it is used to generade the download link and not for API usage.

thehowl · 2018-03-03T17:29:50Z

models/attachment_test.go

+		UUID: "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
+		ID:   1,
+	}
+	assert.Equal(t, "https://try.gitea.io/attachments/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", attach.DownloadURL())


That is required because assets is only used at the release API. And the attachment API uses attachment and a change would be breaking.

thehowl · 2018-03-03T17:32:18Z

public/swagger.v1.json

@@ -3351,6 +3420,247 @@
        }
      }
    },
+    "/repos/{owner}/{repo}/releases/{id}/attachments": {


And swagger.json needs to be regenerated.

Signed-off-by: Jonas Franz <info@jonasfranz.software>

appleboy · 2018-03-05T03:34:09Z

models/attachment.go

+
+func updateAttachment(e Engine, atta *Attachment) error {
+	var sess *xorm.Session
+	if atta.ID != 0 || atta.UUID == "" {


maybe change to atta.ID != 0 && atta.UUID == ""

or

if atta.ID != 0 { .... } else if atta.UUID != "" { .... } else { // return err if missing id and uuid }

appleboy · 2018-03-05T08:37:42Z

@thehowl need your approval.

lunny · 2018-03-28T06:05:30Z

routers/api/v1/repo/release_attachment.go

+	"code.gitea.io/gitea/modules/context"
+	"code.gitea.io/gitea/modules/setting"
+	api "code.gitea.io/sdk/gitea"
+	"errors"


wrong import order

This PR is already merged.

maybe another PR to fix that.

* SECURITY * Limit uploaded avatar image-size to 4096x3072 by default (go-gitea#4353) * Do not allow to reuse TOTP passcode (go-gitea#3878) * FEATURE * Add cli commands to regen hooks & keys (go-gitea#3979) * Add support for FIDO U2F (go-gitea#3971) * Added user language setting (go-gitea#3875) * LDAP Public SSH Keys synchronization (go-gitea#1844) * Add topic support (go-gitea#3711) * Multiple assignees (go-gitea#3705) * Add protected branch whitelists for merging (go-gitea#3689) * Global code search support (go-gitea#3664) * Add label descriptions (go-gitea#3662) * Add issue search via API (go-gitea#3612) * Add repository setting to enable/disable health checks (go-gitea#3607) * Emoji Autocomplete (go-gitea#3433) * Implements generator cli for secrets (go-gitea#3531) * ENHANCEMENT * Add more webhooks support and refactor webhook templates directory (go-gitea#3929) * Add new option to allow only OAuth2/OpenID user registration (go-gitea#3910) * Add option to use paged LDAP search when synchronizing users (go-gitea#3895) * Symlink icons (go-gitea#1416) * Improve release page UI (go-gitea#3693) * Add admin dashboard option to run health checks (go-gitea#3606) * Add branch link in branch list (go-gitea#3576) * Reduce sql query times in retrieveFeeds (go-gitea#3547) * Option to enable or disable swagger endpoints (go-gitea#3502) * Add missing licenses (go-gitea#3497) * Reduce repo indexer disk usage (go-gitea#3452) * Enable caching on assets and avatars (go-gitea#3376) * Add repository search ordered by stars/forks. Forks column in admin repo list (go-gitea#3969) * Add Environment Variables to Docker template (go-gitea#4012) * LFS: make HTTP auth period configurable (go-gitea#4035) * Add config path as an optionial flag when changing pass via CLI (go-gitea#4184) * Refactor User Settings sections (go-gitea#3900) * Allow square brackets in external issue patterns (go-gitea#3408) * Add Attachment API (go-gitea#3478) * Add EnableTimetracking option to app settings (go-gitea#3719) * Add config option to enable or disable log executed SQL (go-gitea#3726) * Shows total tracked time in issue and milestone list (go-gitea#3341) * TRANSLATION * Improve English grammar and consistency (go-gitea#3614) * DEPLOYMENT * Allow Gitea to run as different USER in Docker (go-gitea#3961) * Provide compressed release binaries (go-gitea#3991) * Sign release binaries (go-gitea#4188)

Add Attachment API

25615b1

* repos/:owner/:repo/releases (add attachments) * repos/:owner/:repo/releases/:id (add attachments) * repos/:owner/:repo/releases/:id/attachments * repos/:owner/:repo/releases/:id/attachments/:attachment_id Signed-off-by: Jonas Franz <info@jonasfranz.de>

jonasfranz mentioned this pull request Feb 8, 2018

Add Attachment API go-gitea/go-sdk#90

Merged

1 task

Add unit tests for new attachment functions

b2a780d

Fix comments Signed-off-by: Jonas Franz <info@jonasfranz.software>

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

root and others added 5 commits February 9, 2018 09:08

fix lint

1407c1c

Update vendor.json

80c6555

Signed-off-by: Jonas Franz <info@jonasfranz.software>

Merge remote-tracking branch 'origin/711-releases-api' into 711-relea…

ea14f48

…ses-api

remove version of sdk

95965d8

Signed-off-by: Jonas Franz <info@jonasfranz.software>

Fix unit tests

640ef5a

Add missing license header Signed-off-by: Jonas Franz <info@jonasfranz.software>

jonasfranz added 2 commits February 9, 2018 12:35

Add CreateReleaseAttachment

ad41258

Add EditReleaseAttachment Add DeleteReleaseAttachment Signed-off-by: Jonas Franz <info@jonasfranz.software>

Add filename query parameter for choosing another name for an attachment

ca954a7

Signed-off-by: Jonas Franz <info@jonasfranz.software>

lunny requested changes Feb 10, 2018

View reviewed changes

jonasfranz added 11 commits February 10, 2018 12:53

Fix order of imports

151f594

Signed-off-by: Jonas Franz <info@jonasfranz.software>

Restricting updatable attachment columns

030d4e8

Signed-off-by: Jonas Franz <info@jonasfranz.software>

Merge branch 'master' into 711-releases-api

69539dc

gofmt

da162ad

Signed-off-by: Jonas Franz <info@jonasfranz.software>

Merge remote-tracking branch 'origin/711-releases-api' into 711-relea…

e3aedec

…ses-api

Merge branch 'master' into 711-releases-api

8c6ad76

Merge branch 'master' into 711-releases-api

f55249d

Merge branch 'master' into 711-releases-api

97ef292

Merge branch 'master' into 711-releases-api

14f27bb

Merge branch 'master' into 711-releases-api

ffed1a5

Merge branch 'master' into 711-releases-api

b4698a8

lunny approved these changes Feb 26, 2018

View reviewed changes

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, 2018

lunny added type/feature Completely new functionality. Can only be merged if feature freeze is not active. modifies/api This PR adds API routes or modifies them labels Feb 26, 2018

jonasfranz added 4 commits March 2, 2018 11:35

Merge remote-tracking branch 'origin/711-releases-api' into 711-relea…

62e93ab

…ses-api # Conflicts: # vendor/code.gitea.io/sdk/gitea/attachment.go # vendor/vendor.json

Merge branch 'master' into 711-releases-api

30258dc

Add missing file of go-sdk

08c778d

Signed-off-by: Jonas Franz <info@jonasfranz.software>

Change origin of code.gitea.io/sdk to code.gitea.io/sdk

73b705e

Update code.gitea.io/sdk Signed-off-by: Jonas Franz <info@jonasfranz.software>

jonasfranz added 2 commits March 3, 2018 00:01

Merge branch 'master' into 711-releases-api

b2bdd60

Merge branch 'master' into 711-releases-api

d0d80aa

thehowl reviewed Mar 3, 2018

View reviewed changes

thehowl suggested changes Mar 3, 2018

View reviewed changes

jonasfranz added 2 commits March 4, 2018 16:47

Merge branch 'master' into 711-releases-api

555521c

Update swagger

e317350

Signed-off-by: Jonas Franz <info@jonasfranz.software>

appleboy suggested changes Mar 5, 2018

View reviewed changes

jonasfranz added 2 commits March 5, 2018 09:17

Merge branch 'master' into 711-releases-api

410e801

Update updateAttachment

7a6c7dd

appleboy approved these changes Mar 5, 2018

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 Mar 5, 2018

Merge branch 'master' into 711-releases-api

3812137

thehowl approved these changes Mar 5, 2018

View reviewed changes

appleboy merged commit 9a5e628 into go-gitea:master Mar 6, 2018

jonasfranz deleted the 711-releases-api branch March 6, 2018 07:13

jonasfranz mentioned this pull request Mar 16, 2018

Added attachments to releases API #3075

Closed

techknowlogick mentioned this pull request Mar 19, 2018

Issue API and Attachments #3690

Closed

4 tasks

lunny reviewed Mar 28, 2018

View reviewed changes

sapk mentioned this pull request Apr 17, 2018

GET vs POST swagger.json #3501

Closed

lafriks added the type/changelog Adds the changelog for a new Gitea version label Jul 3, 2018

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

delvh removed the type/changelog Adds the changelog for a new Gitea version label Oct 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Attachment API #3478

Add Attachment API #3478

jonasfranz commented Feb 8, 2018 •

edited

Loading

lafriks commented Feb 9, 2018

codecov-io commented Feb 9, 2018 •

edited

Loading

lunny Feb 10, 2018

lunny Feb 10, 2018

jonasfranz Feb 10, 2018

lunny Feb 15, 2018

jonasfranz commented Mar 2, 2018

thehowl Mar 3, 2018

jonasfranz Mar 3, 2018

thehowl left a comment

thehowl Mar 3, 2018

jonasfranz Mar 4, 2018

thehowl Mar 3, 2018

jonasfranz Mar 3, 2018

thehowl Mar 3, 2018

appleboy Mar 5, 2018

appleboy commented Mar 5, 2018

lunny Mar 28, 2018

jonasfranz Mar 28, 2018

lunny Mar 29, 2018

Add Attachment API #3478

Add Attachment API #3478

Conversation

jonasfranz commented Feb 8, 2018 • edited Loading

API endpoints:

Example response

TODO

lafriks commented Feb 9, 2018

codecov-io commented Feb 9, 2018 • edited Loading

Codecov Report

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

jonasfranz commented Mar 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thehowl left a 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

appleboy commented Mar 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonasfranz commented Feb 8, 2018 •

edited

Loading

codecov-io commented Feb 9, 2018 •

edited

Loading