@@ -328,6 +328,7 @@ components:
328328 type: string
329329 FilterByRef:
330330 description: Filter entities by reference
331+ example: service:shopping-cart
331332 explode: true
332333 in: query
333334 name: filter[ref]
@@ -342,6 +343,32 @@ components:
342343 required: false
343344 schema:
344345 $ref: '#/components/schemas/RelationType'
346+ FilterRelationByFromRef:
347+ description: Filter relations by the reference of the first entity in the relation.
348+ example: service:shopping-cart
349+ explode: true
350+ in: query
351+ name: filter[from_ref]
352+ required: false
353+ schema:
354+ type: string
355+ FilterRelationByToRef:
356+ description: Filter relations by the reference of the second entity in the relation.
357+ example: service:shopping-cart
358+ explode: true
359+ in: query
360+ name: filter[to_ref]
361+ required: false
362+ schema:
363+ type: string
364+ FilterRelationByType:
365+ description: Filter relations by type.
366+ explode: true
367+ in: query
368+ name: filter[type]
369+ required: false
370+ schema:
371+ $ref: '#/components/schemas/RelationType'
345372 GCPSTSServiceAccountID:
346373 description: Your GCP STS enabled service account's unique ID.
347374 in: path
@@ -652,6 +679,14 @@ components:
652679 required: true
653680 schema:
654681 type: string
682+ RelationInclude:
683+ description: Include relationship data.
684+ explode: true
685+ in: query
686+ name: include
687+ required: false
688+ schema:
689+ $ref: '#/components/schemas/RelationIncludeType'
655690 ReportID:
656691 description: The ID of the report job.
657692 in: path
@@ -19081,6 +19116,38 @@ components:
1908119116 meta:
1908219117 $ref: '#/components/schemas/PowerpacksResponseMeta'
1908319118 type: object
19119+ ListRelationCatalogResponse:
19120+ description: List entity relation response.
19121+ properties:
19122+ data:
19123+ $ref: '#/components/schemas/RelationResponseData'
19124+ included:
19125+ $ref: '#/components/schemas/ListRelationCatalogResponseIncluded'
19126+ links:
19127+ $ref: '#/components/schemas/ListRelationCatalogResponseLinks'
19128+ meta:
19129+ $ref: '#/components/schemas/RelationResponseMeta'
19130+ type: object
19131+ ListRelationCatalogResponseIncluded:
19132+ description: List relation response included entities.
19133+ items:
19134+ $ref: '#/components/schemas/EntityData'
19135+ type: array
19136+ ListRelationCatalogResponseLinks:
19137+ description: List relation response links.
19138+ properties:
19139+ next:
19140+ description: Next link.
19141+ example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2
19142+ type: string
19143+ previous:
19144+ description: Previous link.
19145+ type: string
19146+ self:
19147+ description: Current link.
19148+ example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0
19149+ type: string
19150+ type: object
1908419151 ListRulesResponse:
1908519152 description: Scorecard rules response.
1908619153 properties:
@@ -28383,6 +28450,114 @@ components:
2838328450 x-enum-varnames:
2838428451 - ANY
2838528452 - ALL
28453+ RelationAttributes:
28454+ description: Relation attributes.
28455+ properties:
28456+ from:
28457+ $ref: '#/components/schemas/RelationEntity'
28458+ to:
28459+ $ref: '#/components/schemas/RelationEntity'
28460+ type:
28461+ $ref: '#/components/schemas/RelationType'
28462+ type: object
28463+ RelationEntity:
28464+ description: Relation entity reference.
28465+ properties:
28466+ kind:
28467+ description: Entity kind.
28468+ type: string
28469+ name:
28470+ description: Entity name.
28471+ type: string
28472+ namespace:
28473+ description: Entity namespace.
28474+ type: string
28475+ type: object
28476+ RelationIncludeType:
28477+ description: Supported include types for relations.
28478+ enum:
28479+ - entity
28480+ - schema
28481+ type: string
28482+ x-enum-varnames:
28483+ - ENTITY
28484+ - SCHEMA
28485+ RelationMeta:
28486+ description: Relation metadata.
28487+ properties:
28488+ createdAt:
28489+ description: Relation creation time.
28490+ format: date-time
28491+ type: string
28492+ definedBy:
28493+ description: Relation defined by.
28494+ type: string
28495+ modifiedAt:
28496+ description: Relation modification time.
28497+ format: date-time
28498+ type: string
28499+ source:
28500+ description: Relation source.
28501+ type: string
28502+ type: object
28503+ RelationRelationships:
28504+ description: Relation relationships.
28505+ properties:
28506+ fromEntity:
28507+ $ref: '#/components/schemas/RelationToEntity'
28508+ toEntity:
28509+ $ref: '#/components/schemas/RelationToEntity'
28510+ type: object
28511+ RelationResponse:
28512+ description: Relation response data.
28513+ properties:
28514+ attributes:
28515+ $ref: '#/components/schemas/RelationAttributes'
28516+ id:
28517+ description: Relation ID.
28518+ type: string
28519+ meta:
28520+ $ref: '#/components/schemas/RelationMeta'
28521+ relationships:
28522+ $ref: '#/components/schemas/RelationRelationships'
28523+ subtype:
28524+ description: Relation subtype.
28525+ type: string
28526+ type:
28527+ $ref: '#/components/schemas/RelationResponseType'
28528+ type: object
28529+ RelationResponseData:
28530+ description: Array of relation responses
28531+ items:
28532+ $ref: '#/components/schemas/RelationResponse'
28533+ type: array
28534+ RelationResponseMeta:
28535+ description: Relation response metadata.
28536+ properties:
28537+ count:
28538+ description: Total relations count.
28539+ format: int64
28540+ type: integer
28541+ includeCount:
28542+ description: Total included data count.
28543+ format: int64
28544+ type: integer
28545+ type: object
28546+ RelationResponseType:
28547+ description: Relation type.
28548+ enum:
28549+ - relation
28550+ type: string
28551+ x-enum-varnames:
28552+ - RELATION
28553+ RelationToEntity:
28554+ description: Relation to entity.
28555+ properties:
28556+ data:
28557+ $ref: '#/components/schemas/RelationshipItem'
28558+ meta:
28559+ $ref: '#/components/schemas/EntityMeta'
28560+ type: object
2838628561 RelationType:
2838728562 description: Supported relation types.
2838828563 enum:
@@ -42436,6 +42611,48 @@ paths:
4243642611 summary: Delete a single entity
4243742612 tags:
4243842613 - Software Catalog
42614+ /api/v2/catalog/relation:
42615+ get:
42616+ description: Get a list of entity relations from Software Catalog.
42617+ operationId: ListCatalogRelation
42618+ parameters:
42619+ - $ref: '#/components/parameters/PageOffset'
42620+ - description: Maximum number of relations in the response.
42621+ example: 100
42622+ in: query
42623+ name: page[limit]
42624+ required: false
42625+ schema:
42626+ default: 100
42627+ format: int64
42628+ type: integer
42629+ - $ref: '#/components/parameters/FilterRelationByType'
42630+ - $ref: '#/components/parameters/FilterRelationByFromRef'
42631+ - $ref: '#/components/parameters/FilterRelationByToRef'
42632+ - $ref: '#/components/parameters/RelationInclude'
42633+ responses:
42634+ '200':
42635+ content:
42636+ application/json:
42637+ schema:
42638+ $ref: '#/components/schemas/ListRelationCatalogResponse'
42639+ description: OK
42640+ '403':
42641+ $ref: '#/components/responses/ForbiddenResponse'
42642+ '429':
42643+ $ref: '#/components/responses/TooManyRequestsResponse'
42644+ security:
42645+ - apiKeyAuth: []
42646+ appKeyAuth: []
42647+ - AuthZ:
42648+ - apm_service_catalog_read
42649+ summary: Get a list of entity relations
42650+ tags:
42651+ - Software Catalog
42652+ x-pagination:
42653+ limitParam: page[limit]
42654+ pageOffsetParam: page[offset]
42655+ resultsPath: data
4243942656 /api/v2/ci/pipeline:
4244042657 post:
4244142658 description: 'Send your pipeline event to your Datadog platform over HTTP. For
0 commit comments