Skip to content

feat: return only spec param #346

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

Open
josill wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: return only spec param #346

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
134cb0e
init
josill Jan 29, 2026
625c04e
optimize queries at db level
josill Jan 29, 2026
c8e6ee7
CR for myself
josill Jan 29, 2026
54ee238
add db index
josill Jan 29, 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
87 changes: 85 additions & 2 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ const docTemplate = `{
"description": "Page number for pagination, default is 1",
"name": "page",
"in": "query"
},
{
"type": "boolean",
"description": "When true, returns only the Spec field from each Config object",
"name": "spec_only",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -238,6 +244,12 @@ const docTemplate = `{
"description": "Page number for pagination, default is 1",
"name": "page",
"in": "query"
},
{
"type": "boolean",
"description": "When true, returns only the Spec field from each Config object",
"name": "spec_only",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -358,6 +370,12 @@ const docTemplate = `{
"description": "Page number for pagination, default is 1",
"name": "page",
"in": "query"
},
{
"type": "boolean",
"description": "When true, returns only the Spec field from each Config object",
"name": "spec_only",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -444,6 +462,12 @@ const docTemplate = `{
"/api/pipeline/reports": {
"get": {
"description": "List all pipeline reports from the database",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Pipeline Reports"
],
Expand All @@ -466,6 +490,18 @@ const docTemplate = `{
"description": "Page number for pagination, default is 1",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Start time for filtering reports (RFC3339 format)",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"description": "End time for filtering reports (RFC3339 format)",
"name": "end_time",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -701,6 +737,18 @@ const docTemplate = `{
"description": "Page number for pagination, default is 1",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Start time for filtering SCMs (RFC3339 format)",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"description": "End time for filtering SCMs (RFC3339 format)",
"name": "end_time",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -923,7 +971,15 @@ const docTemplate = `{
]
},
"pipelineID": {
"description": "PipelineID represent the ID of the pipeline executed by Updatecli.\ndifferent execution of the same pipeline will have the same PipelineID.\nThis value is coming from the pipeline report to improve the search of reports.",
"description": "PipelineID represent the unique identifier of the pipeline.\nSeveral reports can be associated to the same PipelineID.",
"type": "string"
},
"reportID": {
"description": "ReportID represent the ID of the pipeline executed by Updatecli.\ndifferent execution of the same pipeline will have the same ReportID.\nThis value is coming from the pipeline report to improve the search of reports.",
"type": "string"
},
"result": {
"description": "Result represent the result of the pipeline execution.",
"type": "string"
},
"sourceConfigIDs": {
Expand Down Expand Up @@ -1563,6 +1619,10 @@ const docTemplate = `{
"description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of ` + "`" + `0` + "`" + ` for ` + "`" + `captureIndex` + "`" + ` returns all submatches, and individual submatch indexes start at ` + "`" + `1` + "`" + `.",
"type": "integer"
},
"capturePattern": {
"description": "Uses the match group(s) to generate the output using \\0, \\1, \\2, etc",
"type": "string"
},
"deprecatedCaptureIndex": {
"type": "integer"
},
Expand All @@ -1572,6 +1632,26 @@ const docTemplate = `{
}
}
},
"transformer.JsonMatch": {
"type": "object",
"properties": {
"joinMultipleMatches": {
"description": "If we find multiple matches, join them by this",
"type": "string"
},
"key": {
"type": "string"
},
"multipleMatchSelector": {
"description": "If we find multiple matches, select the \"first\" or the \"last\"",
"type": "string"
},
"noMatchResult": {
"description": "If we don't find a match then return the following string or the input value",
"type": "string"
}
}
},
"transformer.Replacer": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -1624,6 +1704,9 @@ const docTemplate = `{
}
]
},
"jsonMatch": {
"$ref": "#/definitions/transformer.JsonMatch"
},
"quote": {
"description": "Quote add quote around the value",
"type": "boolean"
Expand All @@ -1644,7 +1727,7 @@ const docTemplate = `{
}
},
"semVerInc": {
"description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded.",
"description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded.",
"type": "string"
},
"trimPrefix": {
Expand Down
87 changes: 85 additions & 2 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,12 @@
"description": "Page number for pagination, default is 1",
"name": "page",
"in": "query"
},
{
"type": "boolean",
"description": "When true, returns only the Spec field from each Config object",
"name": "spec_only",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -227,6 +233,12 @@
"description": "Page number for pagination, default is 1",
"name": "page",
"in": "query"
},
{
"type": "boolean",
"description": "When true, returns only the Spec field from each Config object",
"name": "spec_only",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -347,6 +359,12 @@
"description": "Page number for pagination, default is 1",
"name": "page",
"in": "query"
},
{
"type": "boolean",
"description": "When true, returns only the Spec field from each Config object",
"name": "spec_only",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -433,6 +451,12 @@
"/api/pipeline/reports": {
"get": {
"description": "List all pipeline reports from the database",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Pipeline Reports"
],
Expand All @@ -455,6 +479,18 @@
"description": "Page number for pagination, default is 1",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Start time for filtering reports (RFC3339 format)",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"description": "End time for filtering reports (RFC3339 format)",
"name": "end_time",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -690,6 +726,18 @@
"description": "Page number for pagination, default is 1",
"name": "page",
"in": "query"
},
{
"type": "string",
"description": "Start time for filtering SCMs (RFC3339 format)",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"description": "End time for filtering SCMs (RFC3339 format)",
"name": "end_time",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -912,7 +960,15 @@
]
},
"pipelineID": {
"description": "PipelineID represent the ID of the pipeline executed by Updatecli.\ndifferent execution of the same pipeline will have the same PipelineID.\nThis value is coming from the pipeline report to improve the search of reports.",
"description": "PipelineID represent the unique identifier of the pipeline.\nSeveral reports can be associated to the same PipelineID.",
"type": "string"
},
"reportID": {
"description": "ReportID represent the ID of the pipeline executed by Updatecli.\ndifferent execution of the same pipeline will have the same ReportID.\nThis value is coming from the pipeline report to improve the search of reports.",
"type": "string"
},
"result": {
"description": "Result represent the result of the pipeline execution.",
"type": "string"
},
"sourceConfigIDs": {
Expand Down Expand Up @@ -1552,6 +1608,10 @@
"description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`.",
"type": "integer"
},
"capturePattern": {
"description": "Uses the match group(s) to generate the output using \\0, \\1, \\2, etc",
"type": "string"
},
"deprecatedCaptureIndex": {
"type": "integer"
},
Expand All @@ -1561,6 +1621,26 @@
}
}
},
"transformer.JsonMatch": {
"type": "object",
"properties": {
"joinMultipleMatches": {
"description": "If we find multiple matches, join them by this",
"type": "string"
},
"key": {
"type": "string"
},
"multipleMatchSelector": {
"description": "If we find multiple matches, select the \"first\" or the \"last\"",
"type": "string"
},
"noMatchResult": {
"description": "If we don't find a match then return the following string or the input value",
"type": "string"
}
}
},
"transformer.Replacer": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -1613,6 +1693,9 @@
}
]
},
"jsonMatch": {
"$ref": "#/definitions/transformer.JsonMatch"
},
"quote": {
"description": "Quote add quote around the value",
"type": "boolean"
Expand All @@ -1633,7 +1716,7 @@
}
},
"semVerInc": {
"description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded.",
"description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded.",
"type": "string"
},
"trimPrefix": {
Expand Down
Loading