Skip to content

Let API create and edit system webhooks, attempt 2#33180

Merged
lunny merged 8 commits into
go-gitea:mainfrom
philipparndt:fix/23139-system-webhooks
Jan 13, 2025
Merged

Let API create and edit system webhooks, attempt 2#33180
lunny merged 8 commits into
go-gitea:mainfrom
philipparndt:fix/23139-system-webhooks

Conversation

@mbollmann-v
Copy link
Copy Markdown
Contributor

@mbollmann-v mbollmann-v commented Jan 9, 2025 •
edited
Loading

This PR fixes inconsistencies between system and default webhooks in the Gitea API. (See also #26418)

  • A system webhook is a webhook that captures events for all repositories.
  • A default webhook is copied to a new repository when it is created.

Before this PR POST /api/v1/admin/hooks/ creates default webhooks (if not configured otherwise) and GET /api/v1/admin/hooks/ returns system webhooks.

The PR introduces an optional query parameter to GET /api/v1/admin/hooks/ to enable selecting if either default, system or both kind of webhooks should be retrieved. By default the flag is set to return system webhooks keep current behaviour.

Examples

System Webhooks

Create

POST /api/v1/admin/hooks/

{
  "type": "gitea",
  "active": false,
  "branch_filter": "*",
  "events": [ "create", "..." ],
  "config": {
    "url": "http://...",
    "content_type": "json",
    "secret": "secret",
    "is_system_webhook": true // <-- controls hook type
  }
}

List

GET/api/v1/admin/hooks?type=system //type argument is optional here since it's the default

Others

The other relevant endpoints work as expected by referencing the hook by id

GET /api/v1/admin/hooks/:id
PATCH /api/v1/admin/hooks/:id
DELETE /api/v1/admin/hooks/:id

Default Webhooks

Create

POST /api/v1/admin/hooks/

{
  "type": "gitea",
  "active": false,
  "branch_filter": "*",
  "events": [ "create", "..." ],
  "config": {
    "url": "http://...",
    "content_type": "json",
    "secret": "secret",
    "is_system_webhook": false // optional, as false is the default value
  }
}

List

GET/api/v1/admin/hooks?type=default

Others

The other relevant endpoints work as expected by referencing the hook by id

GET /api/v1/admin/hooks/:id
PATCH /api/v1/admin/hooks/:id
DELETE /api/v1/admin/hooks/:id

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jan 9, 2025
@mbollmann-v mbollmann-v mentioned this pull request Jan 9, 2025
Closed
lunny
lunny reviewed Jan 9, 2025
View reviewed changes
Comment thread models/webhook/webhook_system.go
@lunny lunny added this to the 1.24.0 milestone Jan 9, 2025
@pull-request-size pull-request-size Bot added size/L and removed size/M labels Jan 10, 2025
@mbollmann-v mbollmann-v requested a review from lunny January 10, 2025 11:56
@GiteaBot GiteaBot 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 Jan 10, 2025
@GiteaBot GiteaBot 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 Jan 13, 2025
@lunny lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jan 13, 2025
@lunny lunny enabled auto-merge (squash) January 13, 2025 16:51
@lunny lunny merged commit a90af22 into go-gitea:main Jan 13, 2025
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jan 13, 2025
zjjhot added a commit to zjjhot/gitea that referenced this pull request Jan 14, 2025
@zjjhot
Merge remote-tracking branch 'giteaofficial/main'
589d5fc 
* giteaofficial/main: (21 commits)
  Support public code/issue access for private repositories (go-gitea#33127)
  Validate that the tag doesn't exist when creating a tag via the web (go-gitea#33241)
  [skip ci] Updated translations via Crowdin
  Switch back to `vue-tsc` (go-gitea#33248)
  Let API create and edit system webhooks, attempt 2 (go-gitea#33180)
  Fix incorrect ref "blob" (go-gitea#33240)
  Refactor RefName (go-gitea#33234)
  Refactor context RefName and RepoAssignment (go-gitea#33226)
  [skip ci] Updated translations via Crowdin
  Fix upload file form (go-gitea#33230)
  Fix mirror bug (go-gitea#33224)
  Remove unused CSS styles and move some styles to proper files (go-gitea#33217)
  Refactor context repository (go-gitea#33202)
  [skip ci] Updated translations via Crowdin
  Fix unpin hint on the pinned pull requests (go-gitea#33207)
  fix(cache): cache test triggered by non memory cache (go-gitea#33220)
  Update README.md (go-gitea#33149)
  Fix editor markdown not incrementing in a numbered list (go-gitea#33187)
  Some small refactors (go-gitea#33144)
  Fix sync fork for consistency (go-gitea#33147)
  ...
@mbollmann-v mbollmann-v deleted the fix/23139-system-webhooks branch January 14, 2025 15:04
@philipparndt philipparndt mentioned this pull request Jan 16, 2025
Closed
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Apr 13, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@lunny lunny lunny approved these changes

@wxiaoguang wxiaoguang wxiaoguang approved these changes

Assignees

No one assigned

Labels

lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore.

Projects

None yet

Milestone

1.24.0

Development

Successfully merging this pull request may close these issues.

4 participants

@mbollmann-v @lunny @wxiaoguang @GiteaBot