Skip to content

Commit 54cbe49

Browse files
committed
design: change logs - updates for change log entry format
Signed-off-by: Jared Watts <[email protected]>
1 parent bbfa8a3 commit 54cbe49

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

design/one-pager-change-logs.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,14 @@ Each entry in the change log will contain the following data:
8080
|-------------------| ------- |
8181
| Timestamp | ISO 8601 format, e.g. `2023-04-01T12:34:56Z` |
8282
| Provider name | `xpkg.upbound.io/upbound/provider-aws-ec2:v1.8.0` |
83-
| Type (GVK) | `apiVersion: ec2.aws.upbound.io/v1beta2, kind: Instance` |
83+
| API Version | `ec2.aws.upbound.io/v1beta2` |
84+
| Kind | `Instance` |
8485
| Name | `dev-instance-bt66d` |
8586
| External Name | `vpc-4fa03d9fb92dfec50` |
8687
| Operation Type | `create\|update\|delete` |
8788
| Desired/observed state of resource before operation | `{full JSON dump of resource}` which includes desired `spec.forProvider` and observed `status.AtProvider` |
8889
| Result of operation | `success` or error object |
89-
| (optional) Additional information that Providers can set as they choose | `{JSON object of arbitrary data}` |
90+
| (optional) Additional information that Providers can set as they choose | `map[string]string` of arbitrary key value pairs |
9091

9192
An additional information field is available in each change log entry for
9293
Providers to store any provider specific data they choose. Providers are not

0 commit comments

Comments
 (0)