Skip to content

[software catalog] Update entity version documentation #2469

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.

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

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 9 additions & 2 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13699,14 +13699,21 @@ components:
type: string
type: object
EntityV3APIVersion:
description: The schema version of entity type. The field is known as schema-version
in the previous version.
description: The version of the schema data that was used to populate this entity's
data. This could be via the API, Terraform, or YAML file in a repository.
The field is known as schema-version in the previous version.
enum:
- v3
- v2.2
- v2.1
- v2
example: v3
type: string
x-enum-varnames:
- V3
- V2_2
- V2_1
- V2
EntityV3DatadogCodeLocationItem:
additionalProperties: false
description: Code location item.
Expand Down
2 changes: 1 addition & 1 deletion services/software_catalog/src/v2/models/EntityV3API.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { EntityV3Metadata } from "./EntityV3Metadata";
*/
export class EntityV3API {
/**
* The schema version of entity type. The field is known as schema-version in the previous version.
* The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
*/
"apiVersion": EntityV3APIVersion;
/**
Expand Down
12 changes: 10 additions & 2 deletions services/software_catalog/src/v2/models/EntityV3APIVersion.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
import { UnparsedObject } from "@datadog/datadog-api-client";

/**
* The schema version of entity type. The field is known as schema-version in the previous version.
* The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
*/
export type EntityV3APIVersion = typeof V3 | UnparsedObject;
export type EntityV3APIVersion =
| typeof V3
| typeof V2_2
| typeof V2_1
| typeof V2
| UnparsedObject;
export const V3 = "v3";
export const V2_2 = "v2.2";
export const V2_1 = "v2.1";
export const V2 = "v2";
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { EntityV3Metadata } from "./EntityV3Metadata";
*/
export class EntityV3Datastore {
/**
* The schema version of entity type. The field is known as schema-version in the previous version.
* The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
*/
"apiVersion": EntityV3APIVersion;
/**
Expand Down
2 changes: 1 addition & 1 deletion services/software_catalog/src/v2/models/EntityV3Queue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { EntityV3QueueSpec } from "./EntityV3QueueSpec";
*/
export class EntityV3Queue {
/**
* The schema version of entity type. The field is known as schema-version in the previous version.
* The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
*/
"apiVersion": EntityV3APIVersion;
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { EntityV3ServiceSpec } from "./EntityV3ServiceSpec";
*/
export class EntityV3Service {
/**
* The schema version of entity type. The field is known as schema-version in the previous version.
* The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
*/
"apiVersion": EntityV3APIVersion;
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { EntityV3SystemSpec } from "./EntityV3SystemSpec";
*/
export class EntityV3System {
/**
* The schema version of entity type. The field is known as schema-version in the previous version.
* The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
*/
"apiVersion": EntityV3APIVersion;
/**
Expand Down
2 changes: 1 addition & 1 deletion services/software_catalog/src/v2/models/TypingInfo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ export const TypingInfo: ModelTypingInfo = {
EntityResponseIncludedRelatedEntityType: ["relatedEntity"],
EntityResponseIncludedSchemaType: ["schema"],
EntityV3APIKind: ["api"],
EntityV3APIVersion: ["v3"],
EntityV3APIVersion: ["v3", "v2.2", "v2.1", "v2"],
EntityV3DatastoreKind: ["datastore"],
EntityV3QueueKind: ["queue"],
EntityV3ServiceKind: ["service"],
Expand Down
Loading