@@ -347,6 +347,7 @@ components:
347
347
type: string
348
348
FilterByRef:
349
349
description: Filter entities by reference
350
+ example: service:shopping-cart
350
351
explode: true
351
352
in: query
352
353
name: filter[ref]
@@ -361,6 +362,32 @@ components:
361
362
required: false
362
363
schema:
363
364
$ref: '#/components/schemas/RelationType'
365
+ FilterRelationByFromRef:
366
+ description: Filter relations by the reference of the first entity in the relation.
367
+ example: service:shopping-cart
368
+ explode: true
369
+ in: query
370
+ name: filter[from_ref]
371
+ required: false
372
+ schema:
373
+ type: string
374
+ FilterRelationByToRef:
375
+ description: Filter relations by the reference of the second entity in the relation.
376
+ example: service:shopping-cart
377
+ explode: true
378
+ in: query
379
+ name: filter[to_ref]
380
+ required: false
381
+ schema:
382
+ type: string
383
+ FilterRelationByType:
384
+ description: Filter relations by type.
385
+ explode: true
386
+ in: query
387
+ name: filter[type]
388
+ required: false
389
+ schema:
390
+ $ref: '#/components/schemas/RelationType'
364
391
GCPSTSServiceAccountID:
365
392
description: Your GCP STS enabled service account's unique ID.
366
393
in: path
@@ -664,6 +691,14 @@ components:
664
691
required: true
665
692
schema:
666
693
type: string
694
+ RelationInclude:
695
+ description: Include relationship data.
696
+ explode: true
697
+ in: query
698
+ name: include
699
+ required: false
700
+ schema:
701
+ $ref: '#/components/schemas/RelationIncludeType'
667
702
ReportID:
668
703
description: The ID of the report job.
669
704
in: path
@@ -19618,6 +19653,38 @@ components:
19618
19653
meta:
19619
19654
$ref: '#/components/schemas/PowerpacksResponseMeta'
19620
19655
type: object
19656
+ ListRelationCatalogResponse:
19657
+ description: List entity relation response.
19658
+ properties:
19659
+ data:
19660
+ $ref: '#/components/schemas/RelationResponseData'
19661
+ included:
19662
+ $ref: '#/components/schemas/ListRelationCatalogResponseIncluded'
19663
+ links:
19664
+ $ref: '#/components/schemas/ListRelationCatalogResponseLinks'
19665
+ meta:
19666
+ $ref: '#/components/schemas/RelationResponseMeta'
19667
+ type: object
19668
+ ListRelationCatalogResponseIncluded:
19669
+ description: List relation response included entities.
19670
+ items:
19671
+ $ref: '#/components/schemas/EntityData'
19672
+ type: array
19673
+ ListRelationCatalogResponseLinks:
19674
+ description: List relation response links.
19675
+ properties:
19676
+ next:
19677
+ description: Next link.
19678
+ example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2
19679
+ type: string
19680
+ previous:
19681
+ description: Previous link.
19682
+ type: string
19683
+ self:
19684
+ description: Current link.
19685
+ example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0
19686
+ type: string
19687
+ type: object
19621
19688
ListRulesResponse:
19622
19689
description: Scorecard rules response.
19623
19690
properties:
@@ -28993,6 +29060,114 @@ components:
28993
29060
x-enum-varnames:
28994
29061
- ANY
28995
29062
- ALL
29063
+ RelationAttributes:
29064
+ description: Relation attributes.
29065
+ properties:
29066
+ from:
29067
+ $ref: '#/components/schemas/RelationEntity'
29068
+ to:
29069
+ $ref: '#/components/schemas/RelationEntity'
29070
+ type:
29071
+ $ref: '#/components/schemas/RelationType'
29072
+ type: object
29073
+ RelationEntity:
29074
+ description: Relation entity reference.
29075
+ properties:
29076
+ kind:
29077
+ description: Entity kind.
29078
+ type: string
29079
+ name:
29080
+ description: Entity name.
29081
+ type: string
29082
+ namespace:
29083
+ description: Entity namespace.
29084
+ type: string
29085
+ type: object
29086
+ RelationIncludeType:
29087
+ description: Supported include types for relations.
29088
+ enum:
29089
+ - entity
29090
+ - schema
29091
+ type: string
29092
+ x-enum-varnames:
29093
+ - ENTITY
29094
+ - SCHEMA
29095
+ RelationMeta:
29096
+ description: Relation metadata.
29097
+ properties:
29098
+ createdAt:
29099
+ description: Relation creation time.
29100
+ format: date-time
29101
+ type: string
29102
+ definedBy:
29103
+ description: Relation defined by.
29104
+ type: string
29105
+ modifiedAt:
29106
+ description: Relation modification time.
29107
+ format: date-time
29108
+ type: string
29109
+ source:
29110
+ description: Relation source.
29111
+ type: string
29112
+ type: object
29113
+ RelationRelationships:
29114
+ description: Relation relationships.
29115
+ properties:
29116
+ fromEntity:
29117
+ $ref: '#/components/schemas/RelationToEntity'
29118
+ toEntity:
29119
+ $ref: '#/components/schemas/RelationToEntity'
29120
+ type: object
29121
+ RelationResponse:
29122
+ description: Relation response data.
29123
+ properties:
29124
+ attributes:
29125
+ $ref: '#/components/schemas/RelationAttributes'
29126
+ id:
29127
+ description: Relation ID.
29128
+ type: string
29129
+ meta:
29130
+ $ref: '#/components/schemas/RelationMeta'
29131
+ relationships:
29132
+ $ref: '#/components/schemas/RelationRelationships'
29133
+ subtype:
29134
+ description: Relation subtype.
29135
+ type: string
29136
+ type:
29137
+ $ref: '#/components/schemas/RelationResponseType'
29138
+ type: object
29139
+ RelationResponseData:
29140
+ description: Array of relation responses
29141
+ items:
29142
+ $ref: '#/components/schemas/RelationResponse'
29143
+ type: array
29144
+ RelationResponseMeta:
29145
+ description: Relation response metadata.
29146
+ properties:
29147
+ count:
29148
+ description: Total relations count.
29149
+ format: int64
29150
+ type: integer
29151
+ includeCount:
29152
+ description: Total included data count.
29153
+ format: int64
29154
+ type: integer
29155
+ type: object
29156
+ RelationResponseType:
29157
+ description: Relation type.
29158
+ enum:
29159
+ - relation
29160
+ type: string
29161
+ x-enum-varnames:
29162
+ - RELATION
29163
+ RelationToEntity:
29164
+ description: Relation to entity.
29165
+ properties:
29166
+ data:
29167
+ $ref: '#/components/schemas/RelationshipItem'
29168
+ meta:
29169
+ $ref: '#/components/schemas/EntityMeta'
29170
+ type: object
28996
29171
RelationType:
28997
29172
description: Supported relation types.
28998
29173
enum:
@@ -43706,6 +43881,51 @@ paths:
43706
43881
x-menu-order: 3
43707
43882
x-undo:
43708
43883
type: idempotent
43884
+ /api/v2/catalog/relation:
43885
+ get:
43886
+ description: Get a list of entity relations from Software Catalog.
43887
+ operationId: ListCatalogRelation
43888
+ parameters:
43889
+ - $ref: '#/components/parameters/PageOffset'
43890
+ - description: Maximum number of relations in the response.
43891
+ example: 100
43892
+ in: query
43893
+ name: page[limit]
43894
+ required: false
43895
+ schema:
43896
+ default: 100
43897
+ format: int64
43898
+ type: integer
43899
+ - $ref: '#/components/parameters/FilterRelationByType'
43900
+ - $ref: '#/components/parameters/FilterRelationByFromRef'
43901
+ - $ref: '#/components/parameters/FilterRelationByToRef'
43902
+ - $ref: '#/components/parameters/RelationInclude'
43903
+ responses:
43904
+ '200':
43905
+ content:
43906
+ application/json:
43907
+ schema:
43908
+ $ref: '#/components/schemas/ListRelationCatalogResponse'
43909
+ description: OK
43910
+ '403':
43911
+ $ref: '#/components/responses/ForbiddenResponse'
43912
+ '429':
43913
+ $ref: '#/components/responses/TooManyRequestsResponse'
43914
+ security:
43915
+ - apiKeyAuth: []
43916
+ appKeyAuth: []
43917
+ - AuthZ:
43918
+ - apm_service_catalog_read
43919
+ summary: Get a list of entity relations
43920
+ tags:
43921
+ - Software Catalog
43922
+ x-menu-order: 3
43923
+ x-pagination:
43924
+ limitParam: page[limit]
43925
+ pageOffsetParam: page[offset]
43926
+ resultsPath: data
43927
+ x-undo:
43928
+ type: safe
43709
43929
/api/v2/ci/pipeline:
43710
43930
post:
43711
43931
description: 'Send your pipeline event to your Datadog platform over HTTP. For
0 commit comments