diff --git a/.gencode_hash.txt b/.gencode_hash.txt index dfa06e50fa..d5ff0566f3 100644 --- a/.gencode_hash.txt +++ b/.gencode_hash.txt @@ -1,35 +1,35 @@ -b35646a2f3d7c30fd34e3ea6ab6a1070b39c469fd1de49cab1093ff32faaf06d gencode/docs/command_discovery.html -cde866298a8a54168d3582b50ec93160209d07338d3d6c58d215855bc35cb158 gencode/docs/command_mapping.html -0ad0aafdfd7fa858f1fa14ff4f044f878fc2df398210d798e64cf6af98c88672 gencode/docs/config.html -4809ac52b172f1754cc311928c9b54611ec52837d7cce11ee03789c603cbc655 gencode/docs/config_mapping.html +433b3c972a2d4de6f54cf32f00f918fa7e3fd80d4bf29a2c7bee182f532bc660 gencode/docs/command_discovery.html +e5ae5dd058ce298448741a75a6ac67166a9f197b32061b9cbfd47655861864e2 gencode/docs/command_mapping.html +62baee9838fffff5f661a4e98598810e49c6642d0d9ebe5241b3d3fb90761b54 gencode/docs/config.html +6e853ce072dde0bccd7cdeb31845301ba681841d7cb21a8ff90d023bc9597729 gencode/docs/config_mapping.html 08583688b20f892c0b453f41787ac01a46ac601663736bcd6ed6f57be0758e79 gencode/docs/configuration_endpoint.html 6cf94d6cb600c75cde32a64bd78acb3ed3b54adfad08dbf6bb159b467e8925c9 gencode/docs/configuration_execution.html 6f8a3766b840e96881e3573d594e28864917efb288e068d6c82de55deb576694 gencode/docs/configuration_pod.html dc77a21a05f9f98a23403a1db0c3b468ef50d028e4c4934734d08e15f36b1d57 gencode/docs/configuration_pubber.html -69bee6bfcd2f786d95cfd563ecb497296361c8945a1422385f78d25008f38ef1 gencode/docs/event.html -0a41807b999f80bd283fcee03e6df5845e13b122d9be7c7d4723b19a334b89d5 gencode/docs/event_discovery.html -79331072f185ca6e875b2e658e7e0dc471cd40be6b973ce9ee3f371aca474e9b gencode/docs/event_mapping.html -d2fe30200f9a1c530d144137a7774b5b97f268aae41185bfcb25de274d399250 gencode/docs/event_pointset.html -d39b9cbfbdd3f6b5a34396b6a7ab0e7f92a07264ce216d26e57483b22f751f37 gencode/docs/event_system.html -04a864b8b37b01a3b234ba86e7e123ebaf3c98bba497c2f06d23c4550ae8194e gencode/docs/event_validation.html -fa237fe9d96c2809bf9562abdc5c4f7c7d933010beb5c54407caa4453dec30f9 gencode/docs/metadata.html -0aa459d46e8dc4c1f40e574cad107ae212d08b41fdde1660c052a4dd21a197cc gencode/docs/monitoring.html +a5454f8dc6a843115823d1122ce34e36a5e9058cd3f6ea42c3482c8b4b5adf72 gencode/docs/event.html +f7268ffd426cd03007e85a7f73347888c569f2ae92f10ec5569885d1a6c5e807 gencode/docs/event_discovery.html +d0db0ed95c6e2aef32cd55749a13053db2809503e82b20ee04b98fd7f58c1e93 gencode/docs/event_mapping.html +f6ca85990e940f109a48e35b25102d8860e5707a7b2145412046f44d599ef635 gencode/docs/event_pointset.html +110090929fdb5af934c852768d25467361a21be7d8a693de333219ce47fa83fb gencode/docs/event_system.html +4c15e549ded3e0489e1717e24a68a94b3995e43c2032ea7ca1c89deaa4f18c21 gencode/docs/event_validation.html +b0b2237e801f880a656490c682de3d0b828864a2edec031c6fff84e056dcd31a gencode/docs/metadata.html +1135e90f2b1922e60c7f991d6a65d4150ff6e7e82d6e307649040ae644644796 gencode/docs/monitoring.html 180b32717db748e164a185b163ef9a97aa83d9d6add306283d5b9852d04af947 gencode/docs/persistent_device.html 5d039d607af9ec75ee552dfe36b16c702687ea16f5663f41fc49b4533b86e00d gencode/docs/properties.html 1766f84518a315fe57e4a4bf934c0a386ad61d87091754a6bab097c686c16019 gencode/docs/readme.md 741b880216be3743f6747800a042f2dbd89f3b0344c6b0a965f4bc010f03a930 gencode/docs/schema_doc.css 878ea88206c974f40643c3cc430875f9c4e8c5e3fd6bcd6358bd3eb6d48699a9 gencode/docs/schema_doc.min.js 7ed934930aee763e0beebc349725ba3909115e8d346bb762f28bcbe745bb163a gencode/docs/schema_extras.js -6b974bc418eff3a9d9e4f4330e7090f77a7c017c7be5a3156beaea667dd5a1b7 gencode/docs/state.html -a80384abe3fb6482259121082b85496b6b193ebce34690b2c6ad35755d3f0873 gencode/docs/state_mapping.html +6786fdedb8009fd14e5feca6820356247105cd914568d36cb61254c17ab0dcb4 gencode/docs/state.html +803eb830c325e0b75f90192d1a4bf46808e8a84198d707ae8950cd519693afb9 gencode/docs/state_mapping.html 567b27a9257816eb9a9063ce089fe0f58c5962f10ea449bb7c653bd6151365a8 gencode/docs/state_udmi.html -0b4142f45b1424910d1bfb3b631afe059842953f28fd3760b7e2642a5539a7f4 gencode/docs/state_validation.html +291b24c48b4c33354de4d3e6c07b9b38ca34c7907b707af7ffe1c9a2e1345f57 gencode/docs/state_validation.html d39d7fe37a41c74a40080af7b0a429d201ab1fdff7444428c4b98eb7b38c332b gencode/java/udmi/schema/Asset.java b405ce628f7819b46b19950aeaba89ee938fea54261000616bc534b9f81bd59c gencode/java/udmi/schema/Auth_provider.java 0825a5cec83003bb0a6488c4ed7010a04ae0d3848ef36fe01bb4e6718ba7b96d gencode/java/udmi/schema/Aux.java a4fba115d3da74885b01f48e18a46dd9289858326236ccc023ae007e23ec5856 gencode/java/udmi/schema/BasePodConfiguration.java ce2c747fab0d374987acc51474a52ca5b3d64659d51cffa671d5442b7114339a gencode/java/udmi/schema/Basic.java -566b998118ccc00ddf6a4d2f6e5f2c5afaa21a62a9562c885ec798d243770900 gencode/java/udmi/schema/BlobBlobsetConfig.java +38dce67231bc305ac4f1421ac7f79185d1196150e586f5e5bd1505109aa55817 gencode/java/udmi/schema/BlobBlobsetConfig.java c033a4b2c9920a4314801d1fbb7885b375a4bb890344de937ed30baf4f2c08e1 gencode/java/udmi/schema/BlobBlobsetState.java b9f903444ab08907e41eb123286434ff3207b1edd01397af3ddefb8475bbdadc gencode/java/udmi/schema/BlobsetConfig.java fcbed49f1af8b791d8c52bcbe18f65521a79d9ac3eb33ec3afd9b342ab2bfc56 gencode/java/udmi/schema/BlobsetState.java @@ -38,21 +38,21 @@ fcbed49f1af8b791d8c52bcbe18f65521a79d9ac3eb33ec3afd9b342ab2bfc56 gencode/java/u 0a4f6bcd5065418c1cdc6c05b900b3de31744847d25b6ab6de7aabb1e724710e gencode/java/udmi/schema/BuildingTranslation.java c47b17d70ed7fffae5cb829623088358eca22c8fa5613edd97518bed0b522620 gencode/java/udmi/schema/CapabilityValidationState.java 24e03efa125f374a785dc90132adec6b4e91abf0bf8cb1f9b4b7de80b27f3d09 gencode/java/udmi/schema/Category.java -4504407cc866014f1dbf6dab565e55d62356d12c6006a1517c4ded9588535c6b gencode/java/udmi/schema/CloudModel.java -a8bf763f1db77446d9e97154630b30ce4f92c13ea1c567102067dd132227ddd5 gencode/java/udmi/schema/Config.java +2ef49dede464fdd16e09fd1b133ca73fc2005282428519e29d09b0c261656d4b gencode/java/udmi/schema/CloudModel.java +aa3fc1777951cb1e1e2a68e4c31a9bdeeacc339cb191c347d88534b185fb04a4 gencode/java/udmi/schema/Config.java cf9762392e02b5d04c6498963222cc0c00f7be6c3cd82bde3d063a5eceba2b65 gencode/java/udmi/schema/Connections.java 8164e93ccc76d78548d456890e064df8427a09bbcd50686b37a10d3ff5ad429f gencode/java/udmi/schema/Credential.java 10d67bf2080403fd196f63097e4ce2151edaafe3cf4ac77598ef83e06f94cb05 gencode/java/udmi/schema/DeviceMappingConfig.java 5ffb3bf92436c469eee16fe1e472efc89d1c466785be6ce30148188439314afe gencode/java/udmi/schema/DeviceMappingState.java 9b3e011019ecd3bd2c7b64714c6c30d765e879d7ab00f9cddb212dd3f51502eb gencode/java/udmi/schema/DevicePersistent.java d4a82e132b2d223c4a82384d22455283c0b64aba3100fc210e72f9700b9df2d0 gencode/java/udmi/schema/DeviceValidationEvent.java -587d67a67431349939dffd37b880c44e798a1eb607d54bd6d8a077bbac668067 gencode/java/udmi/schema/DiscoveryCommand.java +73399ed2459902c3d81e95fde2caa5033c76f8cfd89e96338c8923529763e52c gencode/java/udmi/schema/DiscoveryCommand.java e809df42a73ed843977e447fa3333140dcdbe7d09b4e88bf1b8fd52fbaf9ae1a gencode/java/udmi/schema/DiscoveryConfig.java -0fd94d8145f3bd076a564a5c83fcc4499d8d87eecc02d9f684b1c0722f1fa31b gencode/java/udmi/schema/DiscoveryEvent.java +5b4508ce3ac0235c9ab97494aa0f2d2ccad88ebc83da28eca2c405fd906e84af gencode/java/udmi/schema/DiscoveryEvent.java 04112dd47b0f761131c276c67d3cd8b789d25e6716b5732be9fef14fc6831f1d gencode/java/udmi/schema/DiscoveryModel.java 0a11a539707571f79bd82b1958886cecae3209e2daef36dfca885adb4c61a07a gencode/java/udmi/schema/DiscoveryState.java b01b7a05f21651a01a605466bb80b2e537059dcbb41f33734c851432da57f657 gencode/java/udmi/schema/EndpointConfiguration.java -dd2eb479a8e93a851c535c8b40fbd62e152bd60e0473f3b23800ec61f798bed0 gencode/java/udmi/schema/Entry.java +dc25e685886e11a741418be9191a478e13c0244647b5a0cac65d6c1e55055578 gencode/java/udmi/schema/Entry.java 06758aca1e0043ddf343b504030f47bb19260e99a82e2d66f12e86092a2434ca gencode/java/udmi/schema/Enumerate.java 8a51984458d96d1798d067005902defa57410167a27dcfb0b730ea38a3326011 gencode/java/udmi/schema/Envelope.java e9f5c77be81486b6b8c6d88f70f2d50583d8c3fafa2ac09ead80f44b8d5e751e gencode/java/udmi/schema/Event.java @@ -67,20 +67,20 @@ d33fe8178d2a18cb588dd29edb0e5659af044634b02d7850623cbc057ccb8c6f gencode/java/u d3fdb2d8b485c1e61786dfde45cc8be08294339bb31a1b8f02180485789a3ab2 gencode/java/udmi/schema/FeatureValidationState.java 60a8115ae1acae7c199b63180823198d38ec50d57b48dd85aca1ccc865058f85 gencode/java/udmi/schema/GatewayConfig.java 56b46f4914ef1f4baa59bf597186ff7901b7c8b607720ec798f4e4e6ad59aa08 gencode/java/udmi/schema/GatewayModel.java -f84fd54baf7529fae4347ac9a8c847f4b48ae594e24b917e47158b632861bf90 gencode/java/udmi/schema/GatewayState.java +9d606a8e0a3787fc79c3c89db5a0a3aaa58cf88972ecff7e4052e2ce0f78d3de gencode/java/udmi/schema/GatewayState.java 58881d02bf7047ec9b29d7c80459b0db331e878af8eb9ea978361d855144acd4 gencode/java/udmi/schema/IotAccess.java b0d4bff14a65ebddc2dd253c996708a4cce99592e82978f057f32a6d9c7768a1 gencode/java/udmi/schema/Jwt.java a5e5adfc187709e8646a11c92e804acfb67743f9d72149008aaca954df3177f6 gencode/java/udmi/schema/Level.java 07fd4911363437b274c19b024759b04b116152176702da8d4203c4ff4cb55b7f gencode/java/udmi/schema/LocalnetConfig.java 910c68183db7703b00bcb81146ad73e6fe0d4bbc4caec4dc9c621f3cc2e5eee5 gencode/java/udmi/schema/LocalnetModel.java -53b23511cd6f905aabb3a372acf812894d0d574317a5ebb4b7ce0c74672b9074 gencode/java/udmi/schema/LocalnetState.java +f6dd2fff0e100160f84a5d62c137c618ed616c82f8722a0530f5393bfc82e281 gencode/java/udmi/schema/LocalnetState.java 2df4ae32d0bbecc21f7c3f6a416a195baa766a6210cfa8abca4a7bb45b9c7961 gencode/java/udmi/schema/Location.java -ccc7c234dd522a91d387d55573677681bbc5a6926f0fbf1101c2e9f607cafd63 gencode/java/udmi/schema/MappingCommand.java +0e5e87848de3dabaf6521afc3fa217f162cdbc76e2bc8796b57e2d07865a5107 gencode/java/udmi/schema/MappingCommand.java 0f6f85a4aaffb90735acc2565e8e4afa349d3ded5781cb1dce1ebbaa237feaa7 gencode/java/udmi/schema/MappingConfig.java 39f4cf5f89dc52f24ea02246e17668ebc85ed0fab351e69138e477bcc048d79c gencode/java/udmi/schema/MappingEvent.java 052b6b7f9ca8173901d9d2fae314f5858e034f20efa5d184780b800bd870cb2b gencode/java/udmi/schema/MappingEventEntity.java -d2bf4eea0ca3df47b9ffe31481a52170e2d2bc3a0e7f2eab582e93cc20ccc886 gencode/java/udmi/schema/MappingState.java -991bf3fa8916e0d1745f4734b9bb5c61409cd860277aaa29701335fdf07919e9 gencode/java/udmi/schema/Metadata.java +84fc81b687d42c689b6b9794716e34bdfd06daf3ab3640a5cf47baf74c185cee gencode/java/udmi/schema/MappingState.java +6c766a915871d07a7559e1b21886f69f1be6cebdbdfa0a605a0c3b1ede71d9e9 gencode/java/udmi/schema/Metadata.java df64e4ddbf543ac70e7c2af9d3fbc20ffe3dff68c6718aa9ceadab7f64d3d171 gencode/java/udmi/schema/Metrics.java 14722df90406cdcd29c7c946e5fcdf6a3e513eb879a7fbb493801fc0d9093504 gencode/java/udmi/schema/Monitoring.java b3b7ef6cae004d5fdb4052f860df0aa583df87bb798a027fc769aeaf16489789 gencode/java/udmi/schema/MonitoringMetric.java @@ -92,10 +92,10 @@ d808259db6bbcd26ecf438844ce286d15d4750906be24588d97acfbe8a4ae315 gencode/java/u 8f3fc1cdc2dcd3e524863f4675aebabc450a35f5fd1cdc3fd37289b5cab7f2ec gencode/java/udmi/schema/PointPointsetEvent.java 65337109653a93d873dae40eb517857149bae1b20c7b479f41b35c0822d94ba0 gencode/java/udmi/schema/PointPointsetModel.java a77b840d671100245c7b68ef8b0130d1ea6375c6ed8a2e145b4208b5962bbc66 gencode/java/udmi/schema/PointPointsetState.java -1fd6168df4ee02c8395abc762f6d4d4ddac4eb8ee3b3e329252b2f88c9903a8c gencode/java/udmi/schema/PointsetConfig.java -c385e937c9952be3405a63bf3292790f965960a91ef0267126f39051a8e0b513 gencode/java/udmi/schema/PointsetEvent.java +1ba0fbfeedddc1a4e39efdff85cf5905c91fb7a4b5ff7d87ed9359ee61f060cc gencode/java/udmi/schema/PointsetConfig.java +4d718196af20797b60e745e99a791e41b7bc15b4a9c2e6ab11083a75b233edec gencode/java/udmi/schema/PointsetEvent.java 1e6be912a048065d678962b23b3b8f17e01c426ac8ff463c57c8c2d02e39ebd3 gencode/java/udmi/schema/PointsetModel.java -fc3a9415c04d8a06954dbdbfdff5d68ab113cce3948532c19df555778ffb04fa gencode/java/udmi/schema/PointsetState.java +fe760087ec0ebd71bf31a0bda704d108229a2b78e16d39c560f893ef0bcb4c10 gencode/java/udmi/schema/PointsetState.java 61afd6c9c0364b8982c90df7664147829bad8858408b2141299ee8bbc35f1612 gencode/java/udmi/schema/PointsetSummary.java ca2e7566106818ca7e5190c8041eb86f0c9b3251b0bda8c3ea7ce11a0c891a0a gencode/java/udmi/schema/Position.java 3df66bb1a37a9e0b2b6cf392f8c64d404a73c83e5e13c02bb4844f09b9a04b70 gencode/java/udmi/schema/Properties.java @@ -105,22 +105,22 @@ d5e11dc354995681b894bcb62e4e21da7f0be68aaa3643a3dc5aa13610741f29 gencode/java/u dc7c549b3358f9b2ceccc8633af3d0fca7eed7c05c94c3396815363b889b4c16 gencode/java/udmi/schema/SequenceValidationState.java 9da49b22341a65580d085fd9d00eaadcaefcf7b813988ef844c617aa4b8a9a4f gencode/java/udmi/schema/SetupUdmiConfig.java e79f3842470cc1f12b1d0a9d6691b147aeb4d6bf29e24872721133352aed1cc9 gencode/java/udmi/schema/SetupUdmiState.java -f3d880f0ec7af07a8eb22c19b3c23e943fc54af03723d458664a5d9dcce57584 gencode/java/udmi/schema/State.java +d67a313587648034d5423dc7ea0c6d6a46149a33086a4deec79ee3eb3af65410 gencode/java/udmi/schema/State.java 47ad54328160a1aabce719a3263d4bfea903e8e8255e04a54ace86eb095b0f0c gencode/java/udmi/schema/StateSystemHardware.java c9b920d355e5f6350fa6eb978afbfe55dd1438df171d2ea215845d5ac0b3e7e9 gencode/java/udmi/schema/StateSystemOperation.java 93d8e8acf53b3c84c8169003f405165893546ddb8ccf8750d061ecf3f9999b57 gencode/java/udmi/schema/SystemConfig.java 6f7b213970bfe2b1ac3056b83da8c8f5b4c50eac221dc1d6c6887e193e8bf40c gencode/java/udmi/schema/SystemDiscoveryEvent.java -484939a730497cd27a8eb57c17cd10140ff0710368326b4fe8ba28080b406a79 gencode/java/udmi/schema/SystemEvent.java +0f67f25404460b8dc39486bab8a538f362979e15ace015ca53a931d934f11c31 gencode/java/udmi/schema/SystemEvent.java 2cf23174ef4e2876511fb471d3f9fcb5cefe2fde324db844c2d0d505fd2c8844 gencode/java/udmi/schema/SystemHardware.java b48923eea2caded1badca59376c63d51be6352b9f9fcb375cdef5897c0fc5fda gencode/java/udmi/schema/SystemModel.java -7d8d9f058878d3228a2042b8ffe6a5d897548c32b218307004101699aa17c2b3 gencode/java/udmi/schema/SystemState.java +054090b354601523dd6527fdcdfd9f66907dcc19c1931313a8c2f8877ed06f5b gencode/java/udmi/schema/SystemState.java 7d6dd13e368e7f073738fee69c15e18652a9b7d7ac63bde0a200f747e3aa1b1d gencode/java/udmi/schema/TargetTestingModel.java 7db9435bd72c03d4bc4bff720d6cee1b65c7af5d10687579e44d96d2d1683813 gencode/java/udmi/schema/TestingModel.java 7793d6d76a430dc7acf668d92d2df5f8e0625d6228207731f96e220f3b90e659 gencode/java/udmi/schema/TestingSystemConfig.java 2958978ce5b7418320835e7d6731bd8db6700643f02bb48eed4edc3dd90b686f gencode/java/udmi/schema/UdmiConfig.java 92d94860b963a1b024a6cc55c40870852363da7e08547cc1cea6e6274293cc2a gencode/java/udmi/schema/UdmiState.java -ac6f8fd87c8986cce01e872460c15ff6fe71e3816f9bde610acfe25f7d38c8d4 gencode/java/udmi/schema/ValidationEvent.java -63494b22585e54b5ccdf2f1e000774d2c0ccd447ebe165bc77d748828a54a872 gencode/java/udmi/schema/ValidationState.java +5d3a82e6b5b0f3dc547e78d797ff081787a9e6be58dd358cf7fcc62c2469e3f4 gencode/java/udmi/schema/ValidationEvent.java +d54631f8bada01ffecf34361891ee52d41786b1289ce56a9edb696b6ad2d3ace gencode/java/udmi/schema/ValidationState.java e007ddd1ceeae3603c85110c33e1bb4a418ff9c7a791ca0df25b7ea3caeafd36 gencode/java/udmi/schema/ValidationSummary.java b77d953fd22e655c0f10ae32deeaa222769d971f8c38b3379eba45720fb910cc gencode/java/udmi/schema/VirtualEquipmentLinks.java cf0da75640384f1033a0ac43c758f3ec2f2814878d9a84bd222a4a17d06e2f4d gencode/python/udmi/schema/__init__.py diff --git a/bin/gencode_docs b/bin/gencode_docs index faa279c8fa..4d812c40f5 100755 --- a/bin/gencode_docs +++ b/bin/gencode_docs @@ -6,48 +6,19 @@ # # (default) # Generate HTML documentation from JSON schema. Stored in gencode/docs -# -# gen_bucket [input_file] [output_file] -# Takes a tab delimited text file containing the list of feature buckets -# as copied from Google Sheets and convert into an MD list -# +#a ROOT_DIR=$(realpath $(dirname $0)/..) cd $ROOT_DIR -OP= -if [[ -n $1 ]]; then - OP=$1 - shift -fi - +HIDEME_LIST=etc/schema_hideme.txt OUTPUT_DIR=gencode/docs TMP_DIR=tmp/schema -if [ "$OP" == gen_bucket ]; then - - input_file=$1 - output_file=$2 - tmp_file=$output_file.tmp - - rm -f $tmp_file - cp $input_file $tmp_file - - # Blank Lines - sed -E -i '/^\s*$/d' $tmp_file - # Top level headings - sed -E -i 's;^([a-zA-Z0-9 .\-_\/]+)\t+$;*\t**\1**;g' $tmp_file - # Subheadings - sed -E -i 's;^\t(\t*)([a-zA-Z0-9 .\-_\/]+)\t+$;\t\1*\t**\2**;g' $tmp_file - # List Items - sed -E -i 's;^\t(\t*)([a-zA-Z0-9 .\-_\/]+)\t+([^\t\n].*)$;\t\1*\t_`\2`_ - \3;g' $tmp_file - # Convert tabs to spaces (comply with style guide) - expand -t 4 $tmp_file > $output_file - - rm $tmp_file - exit 0 -fi - +error() { + echo "ERROR $*" >&2 + exit 1 +} # Generate schema documentation (default) @@ -68,6 +39,19 @@ find $TMP_DIR -type f -exec sed -i 's/file://' {} \; # is one level down find $TMP_DIR -type f -exec sed -i 's;(../docs/;(../../docs/;' {} \; +# Hide properties according to the hide me list +echo Processing schema hide me list ... +while read file property; do + [[ -n $file ]] && [[ $file != "#" ]] || continue + actual_file=$TMP_DIR/$file + actual_property=.properties$property + if ! jq -e "$actual_property" $actual_file >/dev/null 2>&1; then + error file $actual_file or property .properties$property do not exist + fi + echo removing $property from $file + jq -r "del($actual_property)" $actual_file | sponge $actual_file +done <$HIDEME_LIST + schemas=$(bin/gencode_root_schemas schema/) echo Processing schemas $schemas @@ -97,7 +81,6 @@ for schema in $schemas; do sed -i "s@## $section@## $section\n* [**$schema**]($schema.html)$description@" $OUTPUT_DIR/readme.md done - # Add navbar navbar=$(cat etc/schema_navbar.html) navbar=$(printf '%q ' $navbar) diff --git a/etc/schema_hideme.txt b/etc/schema_hideme.txt new file mode 100644 index 0000000000..22991730a0 --- /dev/null +++ b/etc/schema_hideme.txt @@ -0,0 +1,29 @@ +# Properties to hide from human readable schema documentation +# +# There are some properties in the schema now which are part of the +# cloud sub-block processing, but are not expected to be published by devices. +# Prime examples include `timestamp` and `version` fields within each +# sub-block within the state message, for example `state.pointset.version`. +# +# The schema docunmentation then becomes very confusing when these fields +# are included, so this is a short term mitigation to just hide the following properties +# +# Usage: +# +# {FILE} {PROPERTY TO HIDE (dot notation address)} +# e.g. state_pointset.json .timestamp + +state_pointset.json .timestamp +state_pointset.json .version + +state_gateway.json .timestamp +state_gateway.json .version + +state_localnet.json .timestamp +state_localnet.json .version + +state_mapping.json .timestamp +state_mapping.json .version + +state_system.json .timestamp +state_system.json .version diff --git a/gencode/docs/command_discovery.html b/gencode/docs/command_discovery.html index 3130995ff4..b583a92c21 100644 --- a/gencode/docs/command_discovery.html +++ b/gencode/docs/command_discovery.html @@ -51,7 +51,7 @@

/> timestampType: string
-

RFC 3339 timestamp the discover telemetry event was generated

+

RFC 3339 UTC timestamp discovery telemetry event was generated

 diff --git a/gencode/docs/command_mapping.html b/gencode/docs/command_mapping.html index 6bce1d0ea6..af80686ff6 100644 --- a/gencode/docs/command_mapping.html +++ b/gencode/docs/command_mapping.html @@ -51,7 +51,7 @@

/> timestampType: string
-

RFC 3339 timestamp the configuration was generated

+

RFC 3339 UTC timestamp the configuration was generated

 @@ -1935,7 +1935,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/docs/config.html b/gencode/docs/config.html index 561b7824c6..eab8c39c32 100644 --- a/gencode/docs/config.html +++ b/gencode/docs/config.html @@ -51,7 +51,7 @@

/> timestampType: string
-

RFC 3339 timestamp the configuration was generated

+

RFC 3339 UTC timestamp the configuration was generated

 @@ -1794,7 +1794,7 @@

/> generationType: string
-

The timestamp of the blob generation

+

RFC 3339 UTC timestamp of the blob generation

 @@ -1883,7 +1883,7 @@

/> timestampType: string
-

RFC 3339 timestamp the configuration was generated

+

RFC 3339 UTC timestamp the configuration was generated

 diff --git a/gencode/docs/config_mapping.html b/gencode/docs/config_mapping.html index 2110ce9b39..50e8a51683 100644 --- a/gencode/docs/config_mapping.html +++ b/gencode/docs/config_mapping.html @@ -2645,7 +2645,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/docs/event.html b/gencode/docs/event.html index ffcce9a80d..4055938095 100644 --- a/gencode/docs/event.html +++ b/gencode/docs/event.html @@ -90,7 +90,7 @@

/> timestampType: string
-

RFC 3339 timestamp the event payload was generated

+

RFC 3339 UTC timestamp the event payload was generated

 @@ -2587,7 +2587,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -3049,7 +3049,7 @@

/> timestampType: string
-

RFC 3339 timestamp the telemetry event was generated

+

RFC 3339 UTC timestamp the telemetry event was generated

 @@ -3412,7 +3412,7 @@

/> timestampType: string
-

RFC 3339 timestamp the discover telemetry event was generated

+

RFC 3339 UTC timestamp the discover telemetry event was generated

 @@ -5560,7 +5560,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -8993,7 +8993,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/docs/event_discovery.html b/gencode/docs/event_discovery.html index 5417dcd91b..a9a08f3f27 100644 --- a/gencode/docs/event_discovery.html +++ b/gencode/docs/event_discovery.html @@ -51,7 +51,7 @@

/> timestampType: string
-

RFC 3339 timestamp the discover telemetry event was generated

+

RFC 3339 UTC timestamp the discover telemetry event was generated

 @@ -1905,7 +1905,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -4946,7 +4946,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/docs/event_mapping.html b/gencode/docs/event_mapping.html index 0505127704..075fe9e4ad 100644 --- a/gencode/docs/event_mapping.html +++ b/gencode/docs/event_mapping.html @@ -1867,7 +1867,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/docs/event_pointset.html b/gencode/docs/event_pointset.html index 71fc8aa885..8070783c99 100644 --- a/gencode/docs/event_pointset.html +++ b/gencode/docs/event_pointset.html @@ -51,7 +51,7 @@

/> timestampType: string
-

RFC 3339 timestamp the telemetry event was generated

+

RFC 3339 UTC timestamp the telemetry event was generated

 diff --git a/gencode/docs/event_system.html b/gencode/docs/event_system.html index 936a040bbe..a8a003083b 100644 --- a/gencode/docs/event_system.html +++ b/gencode/docs/event_system.html @@ -51,7 +51,7 @@

/> timestampType: string
-

RFC 3339 timestamp the event payload was generated

+

RFC 3339 UTC timestamp the event payload was generated

 @@ -2240,7 +2240,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/docs/event_validation.html b/gencode/docs/event_validation.html index 5c4bf85c4e..43ba9cd45e 100644 --- a/gencode/docs/event_validation.html +++ b/gencode/docs/event_validation.html @@ -51,7 +51,7 @@

/> timestampType: string
-

RFC 3339 timestamp the discover telemetry event was generated

+

RFC 3339 UTC timestamp the validation event was generated

 @@ -1935,7 +1935,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -4252,7 +4252,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/docs/metadata.html b/gencode/docs/metadata.html index a61ad352e2..097696de7a 100644 --- a/gencode/docs/metadata.html +++ b/gencode/docs/metadata.html @@ -51,7 +51,7 @@

/> timestampType: string
-

RFC 3339 timestamp the message was generated

+

RFC 3339 timestamp UTC the data was generated

 @@ -298,7 +298,7 @@

/> timestampType: string
-

RFC 3339 Timestamp the state payload was generated

+

Not published by devices which publish , appended to message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated

 diff --git a/gencode/docs/monitoring.html b/gencode/docs/monitoring.html index d7e8f363e8..d83b5a1f0f 100644 --- a/gencode/docs/monitoring.html +++ b/gencode/docs/monitoring.html @@ -136,7 +136,7 @@

/> timestampType: string
-

RFC 3339 timestamp the event payload was generated

+

RFC 3339 UTC timestamp the event payload was generated

 @@ -2941,7 +2941,7 @@

/> timestampType: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/docs/state.html b/gencode/docs/state.html index ed1a310bbc..be9cb3b9fe 100644 --- a/gencode/docs/state.html +++ b/gencode/docs/state.html @@ -51,7 +51,7 @@

/> timestampType: string
-

RFC 3339 Timestamp the state payload was generated

+

RFC 3339 UTC Timestamp the state payload was generated

 @@ -167,92 +167,6 @@

-
-
-
-

- -

-
- -
-
- -
root - - - - system - - - - timestamp
Type: string
-

RFC 3339 timestamp the configuration was generated

- - - - - - -
-
Example:
-
"2019-01-17T14:02:29.364Z"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- -
root - - - - system - - - - version
Type: string
-

Version of the UDMI schema

- - - - - - - -
-
-
-
@@ -3085,7 +2999,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -3193,92 +3107,6 @@

-
-
-
-

- -

-
- -
-
- -
root - - - - gateway - - - - timestamp
Type: string
-

RFC 3339 timestamp the configuration was generated

- - - - - - -
-
Example:
-
"2019-01-17T14:02:29.364Z"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- -
root - - - - gateway - - - - version
Type: string
-

Version of the UDMI schema

- - - - - - - -
-
-
-
@@ -5964,7 +5792,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -8940,7 +8768,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -9069,92 +8897,6 @@

-
-
-
-

- -

-
- -
-
- -
root - - - - localnet - - - - timestamp
Type: string
-

RFC 3339 timestamp the configuration was generated

- - - - - - -
-
Example:
-
"2019-01-17T14:02:29.364Z"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- -
root - - - - localnet - - - - version
Type: string
-

Version of the UDMI schema

- - - - - - - -
-
-
-
@@ -11901,7 +11643,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -14782,7 +14524,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -14971,92 +14713,6 @@

-
-
-
-

- -

-
- -
-
- -
root - - - - pointset - - - - timestamp
Type: string
-

RFC 3339 timestamp the configuration was generated

- - - - - - -
-
Example:
-
"2019-01-17T14:02:29.364Z"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- -
root - - - - pointset - - - - version
Type: string
-

Version of the UDMI schema

- - - - - - - -
-
-
-
@@ -17145,7 +16801,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -20025,7 +19681,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/docs/state_mapping.html b/gencode/docs/state_mapping.html index 96fb1777b6..94ee293338 100644 --- a/gencode/docs/state_mapping.html +++ b/gencode/docs/state_mapping.html @@ -29,78 +29,6 @@ -
-
-
-

- -

-
- -
-
- -
root - - - - timestamp
Type: string
-

RFC 3339 timestamp the configuration was generated

- - - - - - -
-
Example:
-
"2019-01-17T14:02:29.364Z"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- -
root - - - - version
Type: string
-

Version of the UDMI schema

- - - - - - - -
-
-
-
@@ -2789,7 +2717,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/docs/state_validation.html b/gencode/docs/state_validation.html index bde837fd7b..57f560c688 100644 --- a/gencode/docs/state_validation.html +++ b/gencode/docs/state_validation.html @@ -51,7 +51,7 @@

/> timestamp

Type: string
-

RFC 3339 timestamp the discover telemetry event was generated

+

Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated

 @@ -2408,7 +2408,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -6584,7 +6584,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -9799,7 +9799,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -14247,7 +14247,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -17462,7 +17462,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 @@ -20521,7 +20521,7 @@

/> timestamp

Type: string
-

Timestamp the condition was triggered, or most recently updated

+

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 diff --git a/gencode/java/udmi/schema/BlobBlobsetConfig.java b/gencode/java/udmi/schema/BlobBlobsetConfig.java index 86094ed273..3a332a77dc 100644 --- a/gencode/java/udmi/schema/BlobBlobsetConfig.java +++ b/gencode/java/udmi/schema/BlobBlobsetConfig.java @@ -55,12 +55,12 @@ public class BlobBlobsetConfig { @JsonPropertyDescription("Expected hash of the retrieved resource") public String sha256; /** - * The timestamp of the blob generation + * RFC 3339 UTC timestamp of the blob generation * (Required) * */ @JsonProperty("generation") - @JsonPropertyDescription("The timestamp of the blob generation") + @JsonPropertyDescription("RFC 3339 UTC timestamp of the blob generation") public Date generation; @Override diff --git a/gencode/java/udmi/schema/CloudModel.java b/gencode/java/udmi/schema/CloudModel.java index 7e4b454a46..2687da77b3 100644 --- a/gencode/java/udmi/schema/CloudModel.java +++ b/gencode/java/udmi/schema/CloudModel.java @@ -41,11 +41,11 @@ public class CloudModel { /** - * RFC 3339 Timestamp the state payload was generated + * Not published by devices which publish , appended to message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 Timestamp the state payload was generated") + @JsonPropertyDescription("Not published by devices which publish , appended to message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/Config.java b/gencode/java/udmi/schema/Config.java index 17e15c331d..9d52392707 100644 --- a/gencode/java/udmi/schema/Config.java +++ b/gencode/java/udmi/schema/Config.java @@ -31,12 +31,12 @@ public class Config { /** - * RFC 3339 timestamp the configuration was generated + * RFC 3339 UTC timestamp the configuration was generated * (Required) * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the configuration was generated") + @JsonPropertyDescription("RFC 3339 UTC timestamp the configuration was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/DiscoveryCommand.java b/gencode/java/udmi/schema/DiscoveryCommand.java index c007dc9aef..2e108e23cf 100644 --- a/gencode/java/udmi/schema/DiscoveryCommand.java +++ b/gencode/java/udmi/schema/DiscoveryCommand.java @@ -24,12 +24,12 @@ public class DiscoveryCommand { /** - * RFC 3339 timestamp the discover telemetry event was generated + * RFC 3339 UTC timestamp discovery telemetry event was generated * (Required) * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the discover telemetry event was generated") + @JsonPropertyDescription("RFC 3339 UTC timestamp discovery telemetry event was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/DiscoveryEvent.java b/gencode/java/udmi/schema/DiscoveryEvent.java index baf0ac1acb..219b337b13 100644 --- a/gencode/java/udmi/schema/DiscoveryEvent.java +++ b/gencode/java/udmi/schema/DiscoveryEvent.java @@ -33,12 +33,12 @@ public class DiscoveryEvent { /** - * RFC 3339 timestamp the discover telemetry event was generated + * RFC 3339 UTC timestamp the discover telemetry event was generated * (Required) * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the discover telemetry event was generated") + @JsonPropertyDescription("RFC 3339 UTC timestamp the discover telemetry event was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/Entry.java b/gencode/java/udmi/schema/Entry.java index 20a0efecf4..df8fd0eb00 100644 --- a/gencode/java/udmi/schema/Entry.java +++ b/gencode/java/udmi/schema/Entry.java @@ -51,12 +51,12 @@ public class Entry { @JsonProperty("category") public String category; /** - * Timestamp the condition was triggered, or most recently updated + * FC 3339 UTC timestamp the condition was triggered, or most recently updated * (Required) * */ @JsonProperty("timestamp") - @JsonPropertyDescription("Timestamp the condition was triggered, or most recently updated") + @JsonPropertyDescription("FC 3339 UTC timestamp the condition was triggered, or most recently updated") public Date timestamp; /** * The status `level` should conform to the numerical [Stackdriver LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity) levels. The `DEFAULT` value of 0 is not allowed (lowest value is 100, maximum 800).https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity diff --git a/gencode/java/udmi/schema/GatewayState.java b/gencode/java/udmi/schema/GatewayState.java index 62f92b92f9..55b75764ba 100644 --- a/gencode/java/udmi/schema/GatewayState.java +++ b/gencode/java/udmi/schema/GatewayState.java @@ -25,11 +25,11 @@ public class GatewayState { /** - * RFC 3339 timestamp the configuration was generated + * Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the configuration was generated") + @JsonPropertyDescription("Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/LocalnetState.java b/gencode/java/udmi/schema/LocalnetState.java index b3ab5a6d31..9dc9a69dd7 100644 --- a/gencode/java/udmi/schema/LocalnetState.java +++ b/gencode/java/udmi/schema/LocalnetState.java @@ -26,11 +26,11 @@ public class LocalnetState { /** - * RFC 3339 timestamp the configuration was generated + * Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the configuration was generated") + @JsonPropertyDescription("Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/MappingCommand.java b/gencode/java/udmi/schema/MappingCommand.java index 40b79a99d8..0f708e6312 100644 --- a/gencode/java/udmi/schema/MappingCommand.java +++ b/gencode/java/udmi/schema/MappingCommand.java @@ -29,11 +29,11 @@ public class MappingCommand { /** - * RFC 3339 timestamp the configuration was generated + * RFC 3339 UTC timestamp the configuration was generated * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the configuration was generated") + @JsonPropertyDescription("RFC 3339 UTC timestamp the configuration was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/MappingState.java b/gencode/java/udmi/schema/MappingState.java index 27509fbddb..b7e80147dc 100644 --- a/gencode/java/udmi/schema/MappingState.java +++ b/gencode/java/udmi/schema/MappingState.java @@ -26,11 +26,11 @@ public class MappingState { /** - * RFC 3339 timestamp the configuration was generated + * Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the configuration was generated") + @JsonPropertyDescription("Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/Metadata.java b/gencode/java/udmi/schema/Metadata.java index 48cd5c05f2..cfecd909f1 100644 --- a/gencode/java/udmi/schema/Metadata.java +++ b/gencode/java/udmi/schema/Metadata.java @@ -37,12 +37,12 @@ public class Metadata { /** - * RFC 3339 timestamp the message was generated + * RFC 3339 timestamp UTC the data was generated * (Required) * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the message was generated") + @JsonPropertyDescription("RFC 3339 timestamp UTC the data was generated") public Date timestamp; /** * Version of the UDMI schema for this file diff --git a/gencode/java/udmi/schema/PointsetConfig.java b/gencode/java/udmi/schema/PointsetConfig.java index 5767339823..7c78a633c1 100644 --- a/gencode/java/udmi/schema/PointsetConfig.java +++ b/gencode/java/udmi/schema/PointsetConfig.java @@ -30,11 +30,11 @@ public class PointsetConfig { /** - * RFC 3339 timestamp the configuration was generated + * RFC 3339 UTC timestamp the configuration was generated * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the configuration was generated") + @JsonPropertyDescription("RFC 3339 UTC timestamp the configuration was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/PointsetEvent.java b/gencode/java/udmi/schema/PointsetEvent.java index bf5b7bb418..1a1e3312ee 100644 --- a/gencode/java/udmi/schema/PointsetEvent.java +++ b/gencode/java/udmi/schema/PointsetEvent.java @@ -28,12 +28,12 @@ public class PointsetEvent { /** - * RFC 3339 timestamp the telemetry event was generated + * RFC 3339 UTC timestamp the telemetry event was generated * (Required) * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the telemetry event was generated") + @JsonPropertyDescription("RFC 3339 UTC timestamp the telemetry event was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/PointsetState.java b/gencode/java/udmi/schema/PointsetState.java index aaaaf94f2e..a1ea758231 100644 --- a/gencode/java/udmi/schema/PointsetState.java +++ b/gencode/java/udmi/schema/PointsetState.java @@ -28,11 +28,11 @@ public class PointsetState { /** - * RFC 3339 timestamp the configuration was generated + * Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the configuration was generated") + @JsonPropertyDescription("Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/State.java b/gencode/java/udmi/schema/State.java index 966d8d6bdc..b1b99d7ca9 100644 --- a/gencode/java/udmi/schema/State.java +++ b/gencode/java/udmi/schema/State.java @@ -31,12 +31,12 @@ public class State { /** - * RFC 3339 Timestamp the state payload was generated + * RFC 3339 UTC Timestamp the state payload was generated * (Required) * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 Timestamp the state payload was generated") + @JsonPropertyDescription("RFC 3339 UTC Timestamp the state payload was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/SystemEvent.java b/gencode/java/udmi/schema/SystemEvent.java index 847ff2d798..8b494d68ed 100644 --- a/gencode/java/udmi/schema/SystemEvent.java +++ b/gencode/java/udmi/schema/SystemEvent.java @@ -31,12 +31,12 @@ public class SystemEvent { /** - * RFC 3339 timestamp the event payload was generated + * RFC 3339 UTC timestamp the event payload was generated * (Required) * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the event payload was generated") + @JsonPropertyDescription("RFC 3339 UTC timestamp the event payload was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/SystemState.java b/gencode/java/udmi/schema/SystemState.java index db87e54643..55e8ffdfb1 100644 --- a/gencode/java/udmi/schema/SystemState.java +++ b/gencode/java/udmi/schema/SystemState.java @@ -32,11 +32,11 @@ public class SystemState { /** - * RFC 3339 timestamp the configuration was generated + * Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the configuration was generated") + @JsonPropertyDescription("Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/ValidationEvent.java b/gencode/java/udmi/schema/ValidationEvent.java index 2fd8fea9f0..13d76852e0 100644 --- a/gencode/java/udmi/schema/ValidationEvent.java +++ b/gencode/java/udmi/schema/ValidationEvent.java @@ -31,12 +31,12 @@ public class ValidationEvent { /** - * RFC 3339 timestamp the discover telemetry event was generated + * RFC 3339 UTC timestamp the validation event was generated * (Required) * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the discover telemetry event was generated") + @JsonPropertyDescription("RFC 3339 UTC timestamp the validation event was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/gencode/java/udmi/schema/ValidationState.java b/gencode/java/udmi/schema/ValidationState.java index 59ffd1ea87..514c777159 100644 --- a/gencode/java/udmi/schema/ValidationState.java +++ b/gencode/java/udmi/schema/ValidationState.java @@ -34,11 +34,11 @@ public class ValidationState { /** - * RFC 3339 timestamp the discover telemetry event was generated + * Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 timestamp the discover telemetry event was generated") + @JsonPropertyDescription("Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated") public Date timestamp; /** * Version of the UDMI schema diff --git a/schema/command_discovery.json b/schema/command_discovery.json index bead0a848f..4e23b4fb42 100644 --- a/schema/command_discovery.json +++ b/schema/command_discovery.json @@ -7,7 +7,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the discover telemetry event was generated", + "description": "RFC 3339 UTC timestamp discovery telemetry event was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/command_mapping.json b/schema/command_mapping.json index 1f493f44d0..7f350f4a04 100644 --- a/schema/command_mapping.json +++ b/schema/command_mapping.json @@ -7,7 +7,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the configuration was generated", + "description": "RFC 3339 UTC timestamp the configuration was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/config.json b/schema/config.json index b4bf4bf73c..aad8a82096 100644 --- a/schema/config.json +++ b/schema/config.json @@ -12,7 +12,7 @@ ], "properties": { "timestamp": { - "description": "RFC 3339 timestamp the configuration was generated", + "description": "RFC 3339 UTC timestamp the configuration was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/config_blobset_blob.json b/schema/config_blobset_blob.json index b584a3880b..936f82a429 100644 --- a/schema/config_blobset_blob.json +++ b/schema/config_blobset_blob.json @@ -17,7 +17,7 @@ "pattern": "^[0-9a-f]{64}$" }, "generation": { - "description": "The timestamp of the blob generation", + "description": "RFC 3339 UTC timestamp of the blob generation", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/config_pointset.json b/schema/config_pointset.json index 30ad8bd198..5b519b2d5b 100644 --- a/schema/config_pointset.json +++ b/schema/config_pointset.json @@ -7,7 +7,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the configuration was generated", + "description": "RFC 3339 UTC timestamp the configuration was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/entry.json b/schema/entry.json index 5734f515f8..fe0c628644 100644 --- a/schema/entry.json +++ b/schema/entry.json @@ -20,7 +20,7 @@ "$ref": "file:category.json" }, "timestamp": { - "description": "Timestamp the condition was triggered, or most recently updated", + "description": "FC 3339 UTC timestamp the condition was triggered, or most recently updated", "type": "string", "format": "date-time", "examples": [ diff --git a/schema/event_discovery.json b/schema/event_discovery.json index 0aad061ffb..0e84dbe6e7 100644 --- a/schema/event_discovery.json +++ b/schema/event_discovery.json @@ -8,7 +8,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the discover telemetry event was generated", + "description": "RFC 3339 UTC timestamp the discover telemetry event was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/event_pointset.json b/schema/event_pointset.json index 68d345e4c6..adccd99042 100644 --- a/schema/event_pointset.json +++ b/schema/event_pointset.json @@ -8,7 +8,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the telemetry event was generated", + "description": "RFC 3339 UTC timestamp the telemetry event was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/event_system.json b/schema/event_system.json index 55c30b0dac..32f36f6dd2 100644 --- a/schema/event_system.json +++ b/schema/event_system.json @@ -8,7 +8,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the event payload was generated", + "description": "RFC 3339 UTC timestamp the event payload was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/event_validation.json b/schema/event_validation.json index b6df6544ed..d6ca899ea0 100644 --- a/schema/event_validation.json +++ b/schema/event_validation.json @@ -7,7 +7,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the discover telemetry event was generated", + "description": "RFC 3339 UTC timestamp the validation event was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/metadata.json b/schema/metadata.json index 8a87455817..4295e8ffb3 100644 --- a/schema/metadata.json +++ b/schema/metadata.json @@ -13,7 +13,7 @@ ], "properties": { "timestamp": { - "description": "RFC 3339 timestamp the message was generated", + "description": "RFC 3339 timestamp UTC the data was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/model_cloud.json b/schema/model_cloud.json index 6dc526b74e..e6ccdb6872 100644 --- a/schema/model_cloud.json +++ b/schema/model_cloud.json @@ -7,7 +7,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 Timestamp the state payload was generated", + "description": "Not published by devices which publish , appended to message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/state.json b/schema/state.json index 0c5b1a361a..d25cc4ad9d 100644 --- a/schema/state.json +++ b/schema/state.json @@ -13,7 +13,7 @@ ], "properties": { "timestamp": { - "description": "RFC 3339 Timestamp the state payload was generated", + "description": "RFC 3339 UTC Timestamp the state payload was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/state_gateway.json b/schema/state_gateway.json index 5e27342f45..cbc3ba11c9 100644 --- a/schema/state_gateway.json +++ b/schema/state_gateway.json @@ -7,7 +7,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the configuration was generated", + "description": "Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/state_localnet.json b/schema/state_localnet.json index 0959257dce..8f4df8aa46 100644 --- a/schema/state_localnet.json +++ b/schema/state_localnet.json @@ -6,7 +6,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the configuration was generated", + "description": "Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/state_mapping.json b/schema/state_mapping.json index e68e210b94..fd1525cc58 100644 --- a/schema/state_mapping.json +++ b/schema/state_mapping.json @@ -7,7 +7,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the configuration was generated", + "description": "Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/state_pointset.json b/schema/state_pointset.json index d20ee04922..064c331520 100644 --- a/schema/state_pointset.json +++ b/schema/state_pointset.json @@ -7,7 +7,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the configuration was generated", + "description": "Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/state_system.json b/schema/state_system.json index 9877f2907b..4aa6498ddd 100644 --- a/schema/state_system.json +++ b/schema/state_system.json @@ -7,7 +7,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the configuration was generated", + "description": "Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] diff --git a/schema/state_validation.json b/schema/state_validation.json index 73ba83fb6a..889d134e3e 100644 --- a/schema/state_validation.json +++ b/schema/state_validation.json @@ -7,7 +7,7 @@ "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 timestamp the discover telemetry event was generated", + "description": "Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"]