@@ -563,6 +563,14 @@ components:
563
563
required: true
564
564
schema:
565
565
type: string
566
+ KindID:
567
+ description: Entity kind.
568
+ in: path
569
+ name: kind_id
570
+ required: true
571
+ schema:
572
+ example: my-job
573
+ type: string
566
574
MetricID:
567
575
description: The name of the log-based metric.
568
576
in: path
@@ -19303,6 +19311,90 @@ components:
19303
19311
- index
19304
19312
- caseIndex
19305
19313
type: object
19314
+ KindAttributes:
19315
+ description: Kind attributes.
19316
+ properties:
19317
+ description:
19318
+ description: Short description of the kind.
19319
+ type: string
19320
+ displayName:
19321
+ description: User friendly name of the kind.
19322
+ type: string
19323
+ name:
19324
+ description: The kind name.
19325
+ example: my-job
19326
+ minLength: 1
19327
+ type: string
19328
+ type: object
19329
+ KindData:
19330
+ description: Schema that defines the structure of a Kind object in the Software
19331
+ Catalog.
19332
+ properties:
19333
+ attributes:
19334
+ $ref: '#/components/schemas/KindAttributes'
19335
+ id:
19336
+ description: A read-only globally unique identifier for the entity generated
19337
+ by Datadog. User supplied values are ignored.
19338
+ example: 4b163705-23c0-4573-b2fb-f6cea2163fcb
19339
+ minLength: 1
19340
+ type: string
19341
+ meta:
19342
+ $ref: '#/components/schemas/KindMetadata'
19343
+ type:
19344
+ description: Kind.
19345
+ type: string
19346
+ type: object
19347
+ KindMetadata:
19348
+ description: Kind metadata.
19349
+ properties:
19350
+ createdAt:
19351
+ description: The creation time.
19352
+ type: string
19353
+ modifiedAt:
19354
+ description: The modification time.
19355
+ type: string
19356
+ type: object
19357
+ KindObj:
19358
+ description: Schema for kind.
19359
+ properties:
19360
+ description:
19361
+ description: Short description of the kind.
19362
+ type: string
19363
+ displayName:
19364
+ description: The display name of the kind. Automatically generated if not
19365
+ provided.
19366
+ type: string
19367
+ kind:
19368
+ description: The name of the kind to create or update. This must be in kebab-case
19369
+ format.
19370
+ example: my-job
19371
+ type: string
19372
+ required:
19373
+ - kind
19374
+ type: object
19375
+ KindRaw:
19376
+ description: Kind definition in raw JSON or YAML representation.
19377
+ example: 'kind: service
19378
+
19379
+ displayName: Service
19380
+
19381
+ description: A service entity in the catalog.
19382
+
19383
+ '
19384
+ type: string
19385
+ KindResponseData:
19386
+ description: List of kind responses.
19387
+ items:
19388
+ $ref: '#/components/schemas/KindData'
19389
+ type: array
19390
+ KindResponseMeta:
19391
+ description: Kind response metadata.
19392
+ properties:
19393
+ count:
19394
+ description: Total kinds count.
19395
+ format: int64
19396
+ type: integer
19397
+ type: object
19306
19398
Layer:
19307
19399
description: Encapsulates a layer resource, holding attributes like rotation
19308
19400
details, plus relationships to the members covering that layer.
@@ -19789,6 +19881,14 @@ components:
19789
19881
meta:
19790
19882
$ref: '#/components/schemas/HistoricalJobListMeta'
19791
19883
type: object
19884
+ ListKindCatalogResponse:
19885
+ description: List kind response.
19886
+ properties:
19887
+ data:
19888
+ $ref: '#/components/schemas/KindResponseData'
19889
+ meta:
19890
+ $ref: '#/components/schemas/KindResponseMeta'
19891
+ type: object
19792
19892
ListPipelinesResponse:
19793
19893
description: Represents the response payload containing a list of pipelines
19794
19894
and associated metadata.
@@ -39531,6 +39631,19 @@ components:
39531
39631
description: Upsert entity response included item.
39532
39632
oneOf:
39533
39633
- $ref: '#/components/schemas/EntityResponseIncludedSchema'
39634
+ UpsertCatalogKindRequest:
39635
+ description: Create or update kind request.
39636
+ oneOf:
39637
+ - $ref: '#/components/schemas/KindObj'
39638
+ - $ref: '#/components/schemas/KindRaw'
39639
+ UpsertCatalogKindResponse:
39640
+ description: Upsert kind response.
39641
+ properties:
39642
+ data:
39643
+ $ref: '#/components/schemas/KindResponseData'
39644
+ meta:
39645
+ $ref: '#/components/schemas/KindResponseMeta'
39646
+ type: object
39534
39647
Urgency:
39535
39648
description: Specifies the level of urgency for a routing rule (low, high, or
39536
39649
dynamic).
@@ -43768,6 +43881,105 @@ paths:
43768
43881
summary: Delete a single entity
43769
43882
tags:
43770
43883
- Software Catalog
43884
+ /api/v2/catalog/kind:
43885
+ get:
43886
+ description: Get a list of entity kinds from Software Catalog.
43887
+ operationId: ListCatalogKind
43888
+ parameters:
43889
+ - $ref: '#/components/parameters/PageOffset'
43890
+ - description: Maximum number of kinds 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/FilterByID'
43900
+ - $ref: '#/components/parameters/FilterByName'
43901
+ responses:
43902
+ '200':
43903
+ content:
43904
+ application/json:
43905
+ schema:
43906
+ $ref: '#/components/schemas/ListKindCatalogResponse'
43907
+ description: OK
43908
+ '400':
43909
+ $ref: '#/components/responses/BadRequestResponse'
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 kinds
43920
+ tags:
43921
+ - Software Catalog
43922
+ x-pagination:
43923
+ limitParam: page[limit]
43924
+ pageOffsetParam: page[offset]
43925
+ resultsPath: data
43926
+ post:
43927
+ description: Create or update kinds in Software Catalog.
43928
+ operationId: UpsertCatalogKind
43929
+ requestBody:
43930
+ content:
43931
+ application/json:
43932
+ schema:
43933
+ $ref: '#/components/schemas/UpsertCatalogKindRequest'
43934
+ description: Kind YAML or JSON.
43935
+ required: true
43936
+ responses:
43937
+ '202':
43938
+ content:
43939
+ application/json:
43940
+ schema:
43941
+ $ref: '#/components/schemas/UpsertCatalogKindResponse'
43942
+ description: ACCEPTED
43943
+ '400':
43944
+ $ref: '#/components/responses/BadRequestResponse'
43945
+ '403':
43946
+ $ref: '#/components/responses/ForbiddenResponse'
43947
+ '429':
43948
+ $ref: '#/components/responses/TooManyRequestsResponse'
43949
+ security:
43950
+ - apiKeyAuth: []
43951
+ appKeyAuth: []
43952
+ - AuthZ:
43953
+ - apm_service_catalog_write
43954
+ summary: Create or update kinds
43955
+ tags:
43956
+ - Software Catalog
43957
+ x-codegen-request-body-name: body
43958
+ /api/v2/catalog/kind/{kind_id}:
43959
+ delete:
43960
+ description: Delete a single kind in Software Catalog.
43961
+ operationId: DeleteCatalogKind
43962
+ parameters:
43963
+ - $ref: '#/components/parameters/KindID'
43964
+ responses:
43965
+ '204':
43966
+ description: OK
43967
+ '400':
43968
+ $ref: '#/components/responses/BadRequestResponse'
43969
+ '403':
43970
+ $ref: '#/components/responses/ForbiddenResponse'
43971
+ '404':
43972
+ $ref: '#/components/responses/NotFoundResponse'
43973
+ '429':
43974
+ $ref: '#/components/responses/TooManyRequestsResponse'
43975
+ security:
43976
+ - apiKeyAuth: []
43977
+ appKeyAuth: []
43978
+ - AuthZ:
43979
+ - apm_service_catalog_write
43980
+ summary: Delete a single kind
43981
+ tags:
43982
+ - Software Catalog
43771
43983
/api/v2/catalog/relation:
43772
43984
get:
43773
43985
description: Get a list of entity relations from Software Catalog.
0 commit comments