Skip to content

feat: add a new endpoint to collect acknowledge pull request #480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olblak merged 4 commits into from
Oct 10, 2026
Merged

feat: add a new endpoint to collect acknowledge pull request #480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26b28ea
feat: acknowledge open actions
olblak Oct 9, 2026
a2f02c3
feat(gc): delete expired action acknowledgements
olblak Oct 9, 2026
968652d
docs: regenerate swagger for action acknowledgements
olblak Oct 9, 2026
6254958
chore: use american english
olblak Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 118 additions & 0 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,98 @@ const docTemplate = `{
}
}
},
"/api/pipeline/actions/ack": {
"put": {
"description": "Leave an open action out of the search for a number of days, or until the worst result of its pipelines is no longer the given one",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Pipeline Actions"
],
"summary": "Acknowledge an open action",
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
}
}
},
"delete": {
"description": "Bring an acknowledged open action back in the search",
"produces": [
"application/json"
],
"tags": [
"Pipeline Actions"
],
"summary": "Unacknowledge an open action",
"parameters": [
{
"type": "string",
"description": "Link of the action",
"name": "url",
"in": "query",
"required": true
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
}
}
}
},
"/api/pipeline/actions/search": {
"post": {
"description": "Search the actions left open by the latest report of every pipeline, one entry per action URL along with the pipelines feeding it",
Expand Down Expand Up @@ -1323,9 +1415,30 @@ const docTemplate = `{
}
}
},
"database.OpenActionAcknowledgement": {
"type": "object",
"properties": {
"by": {
"description": "By is who acknowledged the action. It is empty when authentication is off.",
"type": "string"
},
"until": {
"description": "Until is when the acknowledgement expires. It lifts earlier if the worst result changes.",
"type": "string"
}
}
},
"database.OpenActionData": {
"type": "object",
"properties": {
"acknowledgement": {
"description": "Acknowledgement is only set on acknowledged actions, which the search returns\nwhen SearchOpenActionsParams.Acknowledged is true.",
"allOf": [
{
"$ref": "#/definitions/database.OpenActionAcknowledgement"
}
]
},
"branch": {
"description": "Branch is the target branch of that same scm, which the pull request is merged into.",
"type": "string"
Expand Down Expand Up @@ -2327,13 +2440,18 @@ const docTemplate = `{
"server.SearchOpenActionsResponse": {
"type": "object",
"properties": {
"acknowledged_count": {
"description": "AcknowledgedCount counts the acknowledged actions, whatever the request asked for.",
"type": "integer"
},
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/database.OpenActionData"
}
},
"total_count": {
"description": "TotalCount counts the actions matching the request, across every page.",
"type": "integer"
}
}
Expand Down
118 changes: 118 additions & 0 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,98 @@
}
}
},
"/api/pipeline/actions/ack": {
"put": {
"description": "Leave an open action out of the search for a number of days, or until the worst result of its pipelines is no longer the given one",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Pipeline Actions"
],
"summary": "Acknowledge an open action",
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
}
}
},
"delete": {
"description": "Bring an acknowledged open action back in the search",
"produces": [
"application/json"
],
"tags": [
"Pipeline Actions"
],
"summary": "Unacknowledge an open action",
"parameters": [
{
"type": "string",
"description": "Link of the action",
"name": "url",
"in": "query",
"required": true
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/server.DefaultResponseModel"
}
}
}
}
},
"/api/pipeline/actions/search": {
"post": {
"description": "Search the actions left open by the latest report of every pipeline, one entry per action URL along with the pipelines feeding it",
Expand Down Expand Up @@ -1315,9 +1407,30 @@
}
}
},
"database.OpenActionAcknowledgement": {
"type": "object",
"properties": {
"by": {
"description": "By is who acknowledged the action. It is empty when authentication is off.",
"type": "string"
},
"until": {
"description": "Until is when the acknowledgement expires. It lifts earlier if the worst result changes.",
"type": "string"
}
}
},
"database.OpenActionData": {
"type": "object",
"properties": {
"acknowledgement": {
"description": "Acknowledgement is only set on acknowledged actions, which the search returns\nwhen SearchOpenActionsParams.Acknowledged is true.",
"allOf": [
{
"$ref": "#/definitions/database.OpenActionAcknowledgement"
}
]
},
"branch": {
"description": "Branch is the target branch of that same scm, which the pull request is merged into.",
"type": "string"
Expand Down Expand Up @@ -2319,13 +2432,18 @@
"server.SearchOpenActionsResponse": {
"type": "object",
"properties": {
"acknowledged_count": {
"description": "AcknowledgedCount counts the acknowledged actions, whatever the request asked for.",
"type": "integer"
},
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/database.OpenActionData"
}
},
"total_count": {
"description": "TotalCount counts the actions matching the request, across every page.",
"type": "integer"
}
}
Expand Down
Loading
Loading