Skip to content

Commit 0b75e00

Browse files
pasha-zaykopasha-zayko
committed
Simplify Correlation Record definition
Define single version of correlation record. Update references and examples to match the established data structure.
1 parent 4e753d4 commit 0b75e00

File tree

1 file changed

+10
-117
lines changed

1 file changed

+10
-117
lines changed

‎specs/Data-Gateway.json‎

Lines changed: 10 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -642,7 +642,7 @@
642642
"type": "object"
643643
},
644644
"correlation": {
645-
"$ref": "#/components/schemas/Report.CorrelationRecordV0"
645+
"$ref": "#/components/schemas/Report.CorrelationRecord"
646646
},
647647
"licenseData": {
648648
"additionalProperties": {
@@ -675,9 +675,7 @@
675675
"auditTenantAccount": "user@example.com",
676676
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
677677
"createdAt": "2023-11-19T10:00:00.000Z",
678-
"isMigrating": false,
679678
"reportTenantAccount": "user@example.com",
680-
"schemaVersion": 1,
681679
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
682680
"updatedAt": "2023-11-19T10:05:00.000Z"
683681
},
@@ -831,7 +829,7 @@
831829
]
832830
},
833831
"correlation": {
834-
"$ref": "#/components/schemas/Report.CorrelationRecordV1"
832+
"$ref": "#/components/schemas/Report.CorrelationRecord"
835833
},
836834
"principalData": {
837835
"$ref": "#/components/schemas/Report.PrincipalData"
@@ -853,7 +851,7 @@
853851
],
854852
"title": "License Report V1 - Complete Object"
855853
},
856-
"Report.CorrelationRecordV0": {
854+
"Report.CorrelationRecord": {
857855
"description": "Metadata that describes the execution session (run) that is used to tie/relate report versions together.",
858856
"examples": [
859857
{
@@ -923,97 +921,6 @@
923921
"title": "License Report - Correlation Record",
924922
"type": "object"
925923
},
926-
"Report.CorrelationRecordV1": {
927-
"description": "Metadata that describes the execution session (run) that is used to tie/relate report versions together.",
928-
"examples": [
929-
{
930-
"auditTenantAccount": "user@example.com",
931-
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
932-
"createdAt": "2023-11-19T10:00:00.000Z",
933-
"isMigrating": false,
934-
"reportTenantAccount": "user@example.com",
935-
"schemaVersion": 1,
936-
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
937-
"updatedAt": "2023-11-19T10:05:00.000Z"
938-
}
939-
],
940-
"properties": {
941-
"auditTenantAccount": {
942-
"description": "The user account used to retrieve the license information in the tenant being audited.",
943-
"examples": [
944-
"user@example.com"
945-
],
946-
"format": "email",
947-
"type": "string"
948-
},
949-
"correlationId": {
950-
"description": "The ID of the execution session (run) that is used to tie/relate all of the data together.",
951-
"examples": [
952-
"88da2253-758f-4135-9d37-64448c8b65c1"
953-
],
954-
"format": "uuid",
955-
"type": "string",
956-
"maxLength": 36,
957-
"minLength": 36,
958-
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$"
959-
},
960-
"createdAt": {
961-
"description": "Timestamp of when the report was created.",
962-
"examples": [
963-
"2024-08-01T21:12:22.148Z"
964-
],
965-
"format": "date-time",
966-
"type": "string"
967-
},
968-
"isMigrating": {
969-
"description": "Flag indicating whether the current license report is migrating. If true, data is currently migrating from one version to another.",
970-
"examples": [
971-
true
972-
],
973-
"type": "boolean"
974-
},
975-
"reportTenantAccount": {
976-
"description": "User account used to store/report the license report to the SHI Lab cloud service.",
977-
"examples": [
978-
"user@example.com"
979-
],
980-
"format": "email",
981-
"type": "string"
982-
},
983-
"schemaVersion": {
984-
"description": "Specifies the version of the current license report.",
985-
"examples": [
986-
1
987-
],
988-
"format": "int32",
989-
"type": "integer"
990-
},
991-
"tenantId": {
992-
"description": "Unique ID of customer's Microsoft tenant that the license report is for.",
993-
"examples": [
994-
"0e1fe83f-a33f-4250-8546-225b8d45ae01"
995-
],
996-
"format": "uuid",
997-
"type": "string",
998-
"maxLength": 36,
999-
"minLength": 36,
1000-
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$"
1001-
},
1002-
"updatedAt": {
1003-
"description": "Timestamp of when the report was last updated.",
1004-
"examples": [
1005-
"2024-08-01T21:12:22.148Z"
1006-
],
1007-
"format": "date-time",
1008-
"type": "string"
1009-
}
1010-
},
1011-
"required": [
1012-
"auditTenantAccount"
1013-
],
1014-
"title": "Report - Correlation Record V1",
1015-
"type": "object"
1016-
},
1017924
"Report.PrincipalData": {
1018925
"description": "Contains user and device records included in the report, detailing assigned services, licenses, consumed services, and related metadata for each principal.",
1019926
"type": "object",
@@ -2232,7 +2139,7 @@
22322139
"type": "object",
22332140
"properties": {
22342141
"correlation": {
2235-
"$ref": "#/components/schemas/Report.CorrelationRecordV1"
2142+
"$ref": "#/components/schemas/Report.CorrelationRecord"
22362143
},
22372144
"principalData": {
22382145
"$ref": "#/components/schemas/ArchitectureReport.PrincipalData"
@@ -2261,9 +2168,7 @@
22612168
"auditTenantAccount": "user@example.com",
22622169
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
22632170
"createdAt": "2023-11-19T10:00:00.000Z",
2264-
"isMigrating": false,
22652171
"reportTenantAccount": "user@example.com",
2266-
"schemaVersion": 1,
22672172
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
22682173
"updatedAt": "2023-11-19T10:05:00.000Z"
22692174
},
@@ -2668,7 +2573,7 @@
26682573
"type": "array",
26692574
"minItems": 0,
26702575
"items": {
2671-
"$ref": "#/components/schemas/Report.CorrelationRecordV0"
2576+
"$ref": "#/components/schemas/Report.CorrelationRecord"
26722577
},
26732578
"examples": [
26742579
[
@@ -2755,7 +2660,7 @@
27552660
"type": "array",
27562661
"minItems": 0,
27572662
"items": {
2758-
"$ref": "#/components/schemas/Report.CorrelationRecordV0"
2663+
"$ref": "#/components/schemas/Report.CorrelationRecord"
27592664
},
27602665
"examples": [
27612666
[
@@ -3167,9 +3072,7 @@
31673072
"auditTenantAccount": "user@example.com",
31683073
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
31693074
"createdAt": "2023-11-19T10:00:00.000Z",
3170-
"isMigrating": false,
31713075
"reportTenantAccount": "user@example.com",
3172-
"schemaVersion": 1,
31733076
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
31743077
"updatedAt": "2023-11-19T10:05:00.000Z"
31753078
},
@@ -3309,7 +3212,7 @@
33093212
"type": "array",
33103213
"minItems": 0,
33113214
"items": {
3312-
"$ref": "#/components/schemas/Report.CorrelationRecordV0"
3215+
"$ref": "#/components/schemas/Report.CorrelationRecord"
33133216
},
33143217
"examples": [
33153218
[
@@ -3405,7 +3308,7 @@
34053308
"type": "array",
34063309
"minItems": 0,
34073310
"items": {
3408-
"$ref": "#/components/schemas/Report.CorrelationRecordV0"
3311+
"$ref": "#/components/schemas/Report.CorrelationRecord"
34093312
},
34103313
"examples": [
34113314
[
@@ -3486,9 +3389,7 @@
34863389
"auditTenantAccount": "user@example.com",
34873390
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
34883391
"createdAt": "2023-11-19T10:00:00.000Z",
3489-
"isMigrating": false,
34903392
"reportTenantAccount": "user@example.com",
3491-
"schemaVersion": 1,
34923393
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
34933394
"updatedAt": "2023-11-19T10:05:00.000Z"
34943395
},
@@ -3652,9 +3553,7 @@
36523553
"auditTenantAccount": "user@example.com",
36533554
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
36543555
"createdAt": "2023-11-19T10:00:00.000Z",
3655-
"isMigrating": false,
36563556
"reportTenantAccount": "user@example.com",
3657-
"schemaVersion": 1,
36583557
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
36593558
"updatedAt": "2023-11-19T10:05:00.000Z"
36603559
},
@@ -6251,9 +6150,7 @@
62516150
"auditTenantAccount": "user@example.com",
62526151
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
62536152
"createdAt": "2023-11-19T10:00:00.000Z",
6254-
"isMigrating": false,
62556153
"reportTenantAccount": "user@example.com",
6256-
"schemaVersion": 1,
62576154
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
62586155
"updatedAt": "2023-11-19T10:05:00.000Z"
62596156
},
@@ -6411,7 +6308,7 @@
64116308
]
64126309
],
64136310
"items": {
6414-
"$ref": "#/components/schemas/Report.CorrelationRecordV0"
6311+
"$ref": "#/components/schemas/Report.CorrelationRecord"
64156312
},
64166313
"minItems": 0,
64176314
"type": "array"
@@ -6479,7 +6376,7 @@
64796376
"type": "array",
64806377
"minItems": 0,
64816378
"items": {
6482-
"$ref": "#/components/schemas/Report.CorrelationRecordV0"
6379+
"$ref": "#/components/schemas/Report.CorrelationRecord"
64836380
},
64846381
"examples": [
64856382
[
@@ -6563,9 +6460,7 @@
65636460
"auditTenantAccount": "user@example.com",
65646461
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
65656462
"createdAt": "2023-11-19T10:00:00.000Z",
6566-
"isMigrating": false,
65676463
"reportTenantAccount": "user@example.com",
6568-
"schemaVersion": 1,
65696464
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
65706465
"updatedAt": "2023-11-19T10:05:00.000Z"
65716466
},
@@ -6713,9 +6608,7 @@
67136608
"auditTenantAccount": "user@example.com",
67146609
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
67156610
"createdAt": "2023-11-19T10:00:00.000Z",
6716-
"isMigrating": false,
67176611
"reportTenantAccount": "user@example.com",
6718-
"schemaVersion": 1,
67196612
"tenantId": "123e4567-e89b-12d3-a456-426614174000",
67206613
"updatedAt": "2023-11-19T10:05:00.000Z"
67216614
},

0 commit comments

Comments
 (0)