Skip to content

feat(ssp-templates): discovery planner and preview route #524

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
gusfcarvalho merged 3 commits into from
Oct 22, 2026
Merged

feat(ssp-templates): discovery planner and preview route #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04e3f9d
feat(ssp-templates): discovery planner and preview route
ccf-lisa[bot] Oct 19, 2026
4b18bcb
fix(ssp-templates): treat a group whose title renders empty as invalid
ccf-lisa[bot] Oct 19, 2026
5307915
fix(ssp-templates): keep evidence value casing in plans
ccf-lisa[bot] Oct 19, 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
242 changes: 242 additions & 0 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2654,6 +2654,63 @@ const docTemplate = `{
]
}
},
"/admin/ssp-templates/preview": {
"post": {
"description": "Show what discovery would do now for a template, saved or not: the SSPs it would create or update, the scope entries it would learn, groups under min-streams, streams lacking a key and groups whose key values cannot be stored. Writes nothing.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SSP Templates"
],
"summary": "Preview an SSP template",
"parameters": [
{
"description": "SSP template, with its id when saved",
"name": "template",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/templates.sspTemplatePreviewRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/templates.sspTemplatePreviewResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/api.Error"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
},
"security": [
{
"OAuth2Password": []
}
]
}
},
"/admin/ssp-templates/{id}": {
"get": {
"produces": [
Expand Down Expand Up @@ -53261,6 +53318,129 @@ const docTemplate = `{
}
}
},
"ssptemplates.GroupStreams": {
"type": "object",
"properties": {
"key-values": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"streams": {
"type": "integer"
}
}
},
"ssptemplates.InvalidEntry": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/relational.ScopeLabel"
}
},
"reason": {
"type": "string"
}
}
},
"ssptemplates.InvalidGroup": {
"type": "object",
"properties": {
"key-values": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"reason": {
"type": "string"
}
}
},
"ssptemplates.Plan": {
"type": "object",
"properties": {
"below-threshold": {
"type": "array",
"items": {
"$ref": "#/definitions/ssptemplates.GroupStreams"
}
},
"invalid": {
"type": "array",
"items": {
"$ref": "#/definitions/ssptemplates.InvalidGroup"
}
},
"missing-keys": {
"description": "streams that matched the filter but lacked a usable key value",
"type": "integer"
},
"ssps": {
"type": "array",
"items": {
"$ref": "#/definitions/ssptemplates.PlannedSSP"
}
}
}
},
"ssptemplates.PlannedSSP": {
"type": "object",
"properties": {
"exists": {
"description": "Exists is true when an instance records this group. Its SSPID is nil when the SSP\nwas deleted: discovery then leaves the group alone.",
"type": "boolean"
},
"invalid-entries": {
"description": "InvalidEntries are learned entries a scope cannot hold (a value over the length\nlimit, say); discovery skips them.",
"type": "array",
"items": {
"$ref": "#/definitions/ssptemplates.InvalidEntry"
}
},
"key-hash": {
"type": "string"
},
"key-values": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"learn": {
"description": "Learn are the scope entries discovery would add: not in the scope yet and not\nexcepted.",
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/relational.ScopeLabel"
}
}
},
"skipped-by-exception": {
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/relational.ScopeLabel"
}
}
},
"ssp-id": {
"type": "string"
},
"streams": {
"description": "Streams is the number of streams in the group.",
"type": "integer"
},
"title": {
"type": "string"
}
}
},
"subjects.IdentityLabel": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -53930,6 +54110,68 @@ const docTemplate = `{
}
}
},
"templates.sspTemplatePreviewRequest": {
"type": "object",
"properties": {
"description-template": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"filter": {
"$ref": "#/definitions/labelfilter.Filter"
},
"id": {
"description": "ID names the saved template, when there is one, so the preview knows which SSPs\nit already created.",
"type": "string"
},
"keys": {
"type": "array",
"items": {
"type": "string"
}
},
"min-streams": {
"type": "integer"
},
"name": {
"type": "string"
},
"profile-ids": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "array",
"items": {
"$ref": "#/definitions/relational.SSPTemplateProp"
}
},
"scope-labels": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title-template": {
"type": "string"
}
}
},
"templates.sspTemplatePreviewResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/ssptemplates.Plan"
}
}
},
"templates.sspTemplateRequest": {
"type": "object",
"properties": {
Expand Down
Loading
Loading