Skip to content

Commit 03f1451

Browse files
committed
STAC-24593 Update openapi spec
1 parent 93b33ae commit 03f1451

18 files changed

Lines changed: 780 additions & 331 deletions

generated/stackstate_api/.openapi-generator/FILES

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ docs/ComponentApi.md
9292
docs/ComponentCheckState.md
9393
docs/ComponentCheckStates.md
9494
docs/ComponentData.md
95+
docs/ComponentEvents.md
9596
docs/ComponentField.md
9697
docs/ComponentHealthChange.md
9798
docs/ComponentHealthHistory.md
@@ -117,7 +118,6 @@ docs/ComponentPresentationRank.md
117118
docs/ComponentProvisioning.md
118119
docs/ComponentQuery.md
119120
docs/ComponentSummaryLocation.md
120-
docs/ComponentTypeEvents.md
121121
docs/ComponentViewArguments.md
122122
docs/ContainerImageProjection.md
123123
docs/CreateSubject.md
@@ -454,6 +454,7 @@ docs/PresentationFilter.md
454454
docs/PresentationFilterName.md
455455
docs/PresentationFiltersResponse.md
456456
docs/PresentationHighlight.md
457+
docs/PresentationHighlightEvents.md
457458
docs/PresentationHighlightField.md
458459
docs/PresentationHighlightProvisioning.md
459460
docs/PresentationMainMenu.md
@@ -676,6 +677,7 @@ model_component_action.go
676677
model_component_check_state.go
677678
model_component_check_states.go
678679
model_component_data.go
680+
model_component_events.go
679681
model_component_field.go
680682
model_component_health_change.go
681683
model_component_health_history.go
@@ -700,7 +702,6 @@ model_component_presentation_rank.go
700702
model_component_provisioning.go
701703
model_component_query.go
702704
model_component_summary_location.go
703-
model_component_type_events.go
704705
model_component_view_arguments.go
705706
model_container_image_projection.go
706707
model_create_subject.go
@@ -1019,6 +1020,7 @@ model_presentation_filter.go
10191020
model_presentation_filter_name.go
10201021
model_presentation_filters_response.go
10211022
model_presentation_highlight.go
1023+
model_presentation_highlight_events.go
10221024
model_presentation_highlight_field.go
10231025
model_presentation_highlight_provisioning.go
10241026
model_presentation_main_menu.go

generated/stackstate_api/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,7 @@ Class | Method | HTTP request | Description
309309
- [ComponentCheckState](docs/ComponentCheckState.md)
310310
- [ComponentCheckStates](docs/ComponentCheckStates.md)
311311
- [ComponentData](docs/ComponentData.md)
312+
- [ComponentEvents](docs/ComponentEvents.md)
312313
- [ComponentField](docs/ComponentField.md)
313314
- [ComponentHealthChange](docs/ComponentHealthChange.md)
314315
- [ComponentHealthHistory](docs/ComponentHealthHistory.md)
@@ -333,7 +334,6 @@ Class | Method | HTTP request | Description
333334
- [ComponentProvisioning](docs/ComponentProvisioning.md)
334335
- [ComponentQuery](docs/ComponentQuery.md)
335336
- [ComponentSummaryLocation](docs/ComponentSummaryLocation.md)
336-
- [ComponentTypeEvents](docs/ComponentTypeEvents.md)
337337
- [ComponentViewArguments](docs/ComponentViewArguments.md)
338338
- [ContainerImageProjection](docs/ContainerImageProjection.md)
339339
- [CreateSubject](docs/CreateSubject.md)
@@ -652,6 +652,7 @@ Class | Method | HTTP request | Description
652652
- [PresentationFilterName](docs/PresentationFilterName.md)
653653
- [PresentationFiltersResponse](docs/PresentationFiltersResponse.md)
654654
- [PresentationHighlight](docs/PresentationHighlight.md)
655+
- [PresentationHighlightEvents](docs/PresentationHighlightEvents.md)
655656
- [PresentationHighlightField](docs/PresentationHighlightField.md)
656657
- [PresentationHighlightProvisioning](docs/PresentationHighlightProvisioning.md)
657658
- [PresentationMainMenu](docs/PresentationMainMenu.md)

generated/stackstate_api/api/openapi.yaml

Lines changed: 90 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -510,33 +510,46 @@ paths:
510510
- stackpack
511511
/stackpack/{stackPackName}/versions:
512512
delete:
513-
description: Delete versions of a StackPack by range or threshold. Versions
514-
currently in use are skipped.
513+
description: "Delete versions of a StackPack. Versions currently in use are\
514+
\ skipped.\n\nSupported parameter combinations:\n- `?to=X` — delete all versions\
515+
\ up to and including X\n- `?from=X` — delete all versions from X onwards\n\
516+
- `?from=X&to=Y` — delete versions in the inclusive range [X, Y]\n- `?all=true`\
517+
\ — delete all versions\n- Any of the above combined with `&dev=true` to restrict\
518+
\ to development versions only\n"
515519
operationId: stackPackDeleteVersions
516520
parameters:
517521
- in: path
518522
name: stackPackName
519523
required: true
520524
schema:
521525
type: string
522-
- description: Delete all versions strictly less than this version
526+
- description: Inclusive lower bound. Deletes versions >= this version. Can
527+
be used alone or combined with 'to' for a range.
523528
in: query
524-
name: before
529+
name: from
525530
required: false
526531
schema:
527532
type: string
528-
- description: Inclusive start of version range to delete
533+
- description: Inclusive upper bound. Deletes versions <= this version. Can
534+
be used alone or combined with 'from' for a range.
529535
in: query
530-
name: from
536+
name: to
531537
required: false
532538
schema:
533539
type: string
534-
- description: Inclusive end of version range to delete
540+
- description: Delete all versions. Cannot be combined with 'from' or 'to'.
535541
in: query
536-
name: to
542+
name: all
537543
required: false
538544
schema:
539-
type: string
545+
type: boolean
546+
- description: "Filter to development versions only (versions with metadata,\
547+
\ e.g. SNAPSHOT). Can be combined with any scope selector."
548+
in: query
549+
name: dev
550+
required: false
551+
schema:
552+
type: boolean
540553
responses:
541554
"200":
542555
content:
@@ -551,7 +564,22 @@ paths:
551564
items:
552565
type: string
553566
type: array
554-
description: bad request
567+
description: "Invalid parameters (e.g. invalid version string, incompatible\
568+
\ parameter combination)"
569+
"404":
570+
content:
571+
application/json:
572+
schema:
573+
items:
574+
type: string
575+
type: array
576+
description: StackPack not found
577+
"409":
578+
content:
579+
application/json:
580+
schema:
581+
$ref: '#/components/schemas/DeleteVersionsResult'
582+
description: All targeted versions are currently in use
555583
"500":
556584
content:
557585
application/json:
@@ -14363,9 +14391,6 @@ components:
1436314391
name: name
1436414392
description: description
1436514393
defaultExpanded: true
14366-
events:
14367-
showEvents: true
14368-
relatedResourcesTemplate: relatedResourcesTemplate
1436914394
data:
1437014395
lastUpdateTimestamp: 5
1437114396
identifiers:
@@ -14435,6 +14460,9 @@ components:
1443514460
stql: stql
1443614461
title: title
1443714462
presentationIdentifier: presentationIdentifier
14463+
events:
14464+
relatedResourcesQuery: relatedResourcesQuery
14465+
showEvents: true
1443814466
boundMetrics:
1443914467
- layout:
1444014468
metricPerspective:
@@ -14515,6 +14543,8 @@ components:
1451514543
items:
1451614544
$ref: '#/components/schemas/RelatedResource'
1451714545
type: array
14546+
events:
14547+
$ref: '#/components/schemas/ComponentEvents'
1451814548
data:
1451914549
$ref: '#/components/schemas/ComponentData'
1452014550
highlights:
@@ -14700,6 +14730,18 @@ components:
1470014730
- stql
1470114731
- title
1470214732
type: object
14733+
ComponentEvents:
14734+
example:
14735+
relatedResourcesQuery: relatedResourcesQuery
14736+
showEvents: true
14737+
properties:
14738+
showEvents:
14739+
type: boolean
14740+
relatedResourcesQuery:
14741+
description: Topology query for resources related to the highlighted component
14742+
type: string
14743+
required:
14744+
- showEvents
1470314745
ComponentData:
1470414746
example:
1470514747
lastUpdateTimestamp: 5
@@ -14771,27 +14813,19 @@ components:
1477114813
name: name
1477214814
description: description
1477314815
defaultExpanded: true
14774-
events:
14775-
showEvents: true
14776-
relatedResourcesTemplate: relatedResourcesTemplate
1477714816
properties:
1477814817
namePlural:
1477914818
type: string
14780-
events:
14781-
$ref: '#/components/schemas/ComponentTypeEvents'
1478214819
showLogs:
1478314820
type: boolean
1478414821
metrics:
1478514822
items:
1478614823
$ref: '#/components/schemas/ComponentHighlightMetrics'
1478714824
type: array
1478814825
required:
14789-
- events
14790-
- externalComponent
1479114826
- metrics
1479214827
- namePlural
1479314828
- relatedResources
14794-
- showLastChange
1479514829
- showLogs
1479614830
ComponentAction:
1479714831
example:
@@ -15215,9 +15249,6 @@ components:
1521515249
name: name
1521615250
description: description
1521715251
defaultExpanded: true
15218-
events:
15219-
showEvents: true
15220-
relatedResourcesTemplate: relatedResourcesTemplate
1522115252
data:
1522215253
lastUpdateTimestamp: 5
1522315254
identifiers:
@@ -15287,6 +15318,9 @@ components:
1528715318
stql: stql
1528815319
title: title
1528915320
presentationIdentifier: presentationIdentifier
15321+
events:
15322+
relatedResourcesQuery: relatedResourcesQuery
15323+
showEvents: true
1529015324
boundMetrics:
1529115325
- layout:
1529215326
metricPerspective:
@@ -15392,9 +15426,6 @@ components:
1539215426
name: name
1539315427
description: description
1539415428
defaultExpanded: true
15395-
events:
15396-
showEvents: true
15397-
relatedResourcesTemplate: relatedResourcesTemplate
1539815429
data:
1539915430
lastUpdateTimestamp: 5
1540015431
identifiers:
@@ -15464,6 +15495,9 @@ components:
1546415495
stql: stql
1546515496
title: title
1546615497
presentationIdentifier: presentationIdentifier
15498+
events:
15499+
relatedResourcesQuery: relatedResourcesQuery
15500+
showEvents: true
1546715501
boundMetrics:
1546815502
- layout:
1546915503
metricPerspective:
@@ -17271,6 +17305,10 @@ components:
1727117305
topologyQuery: topologyQuery
1727217306
order: 5.637376656633329
1727317307
presentationIdentifier: presentationIdentifier
17308+
events:
17309+
excludedRelatedResourcesQuery: excludedRelatedResourcesQuery
17310+
relatedResourcesQuery: relatedResourcesQuery
17311+
showEvents: true
1727417312
icon: icon
1727517313
filters:
1727617314
- filterId: filterId
@@ -18688,17 +18726,6 @@ components:
1868818726
- offsetNanos
1868918727
- timestamp
1869018728
type: object
18691-
ComponentTypeEvents:
18692-
example:
18693-
showEvents: true
18694-
relatedResourcesTemplate: relatedResourcesTemplate
18695-
properties:
18696-
showEvents:
18697-
type: boolean
18698-
relatedResourcesTemplate:
18699-
type: string
18700-
required:
18701-
- showEvents
1870218729
ComponentHighlightMetrics:
1870318730
example:
1870418731
bindings:
@@ -19478,6 +19505,10 @@ components:
1947819505
topologyQuery: topologyQuery
1947919506
order: 5.637376656633329
1948019507
presentationIdentifier: presentationIdentifier
19508+
events:
19509+
excludedRelatedResourcesQuery: excludedRelatedResourcesQuery
19510+
relatedResourcesQuery: relatedResourcesQuery
19511+
showEvents: true
1948119512
icon: icon
1948219513
filters:
1948319514
- filterId: filterId
@@ -19785,6 +19816,10 @@ components:
1978519816
topologyQuery: topologyQuery
1978619817
order: 5.637376656633329
1978719818
presentationIdentifier: presentationIdentifier
19819+
events:
19820+
excludedRelatedResourcesQuery: excludedRelatedResourcesQuery
19821+
relatedResourcesQuery: relatedResourcesQuery
19822+
showEvents: true
1978819823
properties:
1978919824
title:
1979019825
type: string
@@ -19798,6 +19833,8 @@ components:
1979819833
items:
1979919834
$ref: '#/components/schemas/PresentationRelatedResource'
1980019835
type: array
19836+
events:
19837+
$ref: '#/components/schemas/PresentationHighlightEvents'
1980119838
required:
1980219839
- fields
1980319840
- title
@@ -19918,6 +19955,21 @@ components:
1991819955
- resourceId
1991919956
- title
1992019957
type: object
19958+
PresentationHighlightEvents:
19959+
example:
19960+
excludedRelatedResourcesQuery: excludedRelatedResourcesQuery
19961+
relatedResourcesQuery: relatedResourcesQuery
19962+
showEvents: true
19963+
properties:
19964+
showEvents:
19965+
type: boolean
19966+
relatedResourcesQuery:
19967+
type: string
19968+
excludedRelatedResourcesQuery:
19969+
type: string
19970+
required:
19971+
- showEvents
19972+
type: object
1992119973
ComponentPresentationFilter:
1992219974
description: "Filter definition for ComponentPresentation.\nWhen only `filterId`\
1992319975
\ is provided, the filter references a definition from a less specific presentation.\n\

0 commit comments

Comments
 (0)