Skip to content

Commit 76c3391

Browse files
ajakzajakz
authored
wordsmithing
1 parent 1722950 commit 76c3391

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

‎schemas-core/src/main/resources/avro/psi/analysis.avsc‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@
288288
"ValidDescriptor"
289289
],
290290
"default": null,
291-
"doc": "Describes the state of the temporal bounding's beginning, e.g. valid, invalid, undefined"
291+
"doc": "Describes the state of the temporal bounding's beginning, i.e. VALID, INVALID, or UNDEFINED."
292292
},
293293
{
294294
"name": "beginPrecision",
@@ -297,7 +297,7 @@
297297
"string"
298298
],
299299
"default": null,
300-
"doc": "The precision of the beginning of the analyzed bounding, e.g. 'Years', 'Seconds', etc. See java.time.temporal.ChronoUnit. Note that this may sometimes not exactly match the input data, since it reflects the Java class the date is able to be parsed into"
300+
"doc": "The precision of the beginning of the analyzed bounding, e.g. 'Years', 'Seconds', etc. See java.time.temporal.ChronoUnit. Note that this may sometimes not exactly match the input data, since it reflects the Java class the date is able to be parsed into."
301301
},
302302
{
303303
"name": "beginIndexable",
@@ -306,7 +306,7 @@
306306
"boolean"
307307
],
308308
"default": null,
309-
"doc": "Indicates whether or not beginUtcDateTimeString can be indexed for searching"
309+
"doc": "Indicates whether or not beginUtcDateTimeString can be indexed into Elasticsearch for searching."
310310
},
311311
{
312312
"name": "beginZoneSpecified",
@@ -324,7 +324,7 @@
324324
"string"
325325
],
326326
"default": null,
327-
"doc": "If possible, a full ISO-8601 formatted date time string in the UTC time zone for the analyzed beginning value"
327+
"doc": "If provided begin date is VALID, a full ISO-8601 formatted date time string in the UTC time zone for the analyzed value."
328328
},
329329
{
330330
"name": "beginYear",
@@ -333,7 +333,7 @@
333333
"long"
334334
],
335335
"default": null,
336-
"doc": "If possible, an long indicating the beginning year"
336+
"doc": "If provided begin date is VALID, a long indicating the beginning year."
337337
},
338338
{
339339
"name": "beginDayOfYear",
@@ -342,7 +342,7 @@
342342
"int"
343343
],
344344
"default": null,
345-
"doc": "If possible, an integer indicating the day of year for the beginning value. This may be populated by extrapolating into a DateTime. See beginPrecision for the best indicator of if this value is extrapolated or provided in the original date format"
345+
"doc": "If provided begin date is VALID, an integer indicating the day of year for the beginning value. This may be populated by extrapolating into a DateTime. See beginPrecision for the best indicator of if this value is extrapolated or provided in the original date format."
346346
},
347347
{
348348
"name": "beginDayOfMonth",
@@ -351,7 +351,7 @@
351351
"int"
352352
],
353353
"default": null,
354-
"doc": "If possible, an integer indicating the day of month for the beginning value. This may be populated by extrapolating into a DateTime. See beginPrecision for the best indicator of if this value is extrapolated or provided in the original date format"
354+
"doc": "If provided begin date is VALID, an integer indicating the day of month for the beginning value. This may be populated by extrapolating into a DateTime. See beginPrecision for the best indicator of if this value is extrapolated or provided in the original date format."
355355
},
356356
{
357357
"name": "beginMonth",
@@ -360,7 +360,7 @@
360360
"int"
361361
],
362362
"default": null,
363-
"doc": "If possible, an integer indicating the month for the beginning value. This may be populated by extrapolating into a DateTime. See beginPrecision for the best indicator of if this value is extrapolated or provided in the original date format"
363+
"doc": "If provided begin date is VALID, an integer indicating the month for the beginning value. This may be populated by extrapolating into a DateTime. See beginPrecision for the best indicator of if this value is extrapolated or provided in the original date format."
364364
},
365365
{
366366
"name": "endDescriptor",
@@ -369,7 +369,7 @@
369369
"ValidDescriptor"
370370
],
371371
"default": null,
372-
"doc": "Describes the state of the temporal bounding's end, e.g. valid, invalid, undefined"
372+
"doc": "Describes the state of the temporal bounding's end, i.e. VALID, INVALID, or UNDEFINED."
373373
},
374374
{
375375
"name": "endPrecision",
@@ -378,7 +378,7 @@
378378
"string"
379379
],
380380
"default": null,
381-
"doc": "The precision of the end of the analyzed bounding, e.g. 'Years', 'Seconds', etc. See java.time.temporal.ChronoUnit. Note that this may sometimes not exactly match the input data, since it reflects the Java class the date is able to be parsed into"
381+
"doc": "The precision of the end of the analyzed bounding, e.g. 'Years', 'Seconds', etc. See java.time.temporal.ChronoUnit. Note that this may sometimes not exactly match the input data, since it reflects the Java class the date is able to be parsed into."
382382
},
383383
{
384384
"name": "endIndexable",
@@ -387,7 +387,7 @@
387387
"boolean"
388388
],
389389
"default": null,
390-
"doc": "Indicates whether or not endUtcDateTimeString can be indexed for searching"
390+
"doc": "Indicates whether or not endUtcDateTimeString can be indexed into Elasticsearch for searching."
391391
},
392392
{
393393
"name": "endZoneSpecified",
@@ -405,7 +405,7 @@
405405
"string"
406406
],
407407
"default": null,
408-
"doc": "If possible, a full ISO-8601 formatted date time string in the UTC time zone for the analyzed end value"
408+
"doc": "If provided end date is VALID, a full ISO-8601 formatted date time string in the UTC time zone for the analyzed end value."
409409
},
410410
{
411411
"name": "endYear",
@@ -414,7 +414,7 @@
414414
"long"
415415
],
416416
"default": null,
417-
"doc": "If possible, an long indicating the end year"
417+
"doc": "If provided end date is VALID, an long indicating the end year."
418418
},
419419
{
420420
"name": "endDayOfYear",
@@ -423,7 +423,7 @@
423423
"int"
424424
],
425425
"default": null,
426-
"doc": "If possible, an integer indicating the day of year for the end value. This may be populated by extrapolating into a DateTime. See endPrecision for the best indicator of if this value is extrapolated or provided in the original date format"
426+
"doc": "If provided end date is VALID, an integer indicating the day of year for the end value. This may be populated by extrapolating into a DateTime. See endPrecision for the best indicator of if this value is extrapolated or provided in the original date format."
427427
},
428428
{
429429
"name": "endDayOfMonth",
@@ -432,7 +432,7 @@
432432
"int"
433433
],
434434
"default": null,
435-
"doc": "If possible, an integer indicating the day of month for the end value. This may be populated by extrapolating into a DateTime. See endPrecision for the best indicator of if this value is extrapolated or provided in the original date format"
435+
"doc": "If provided end date is VALID, an integer indicating the day of month for the end value. This may be populated by extrapolating into a DateTime. See endPrecision for the best indicator of if this value is extrapolated or provided in the original date format."
436436
},
437437
{
438438
"name": "endMonth",
@@ -441,7 +441,7 @@
441441
"int"
442442
],
443443
"default": null,
444-
"doc": "If possible, an integer indicating the month for the end value. This may be populated by extrapolating into a DateTime. See endPrecision for the best indicator of if this value is extrapolated or provided in the original date format"
444+
"doc": "If provided end date is VALID, an integer indicating the month for the end value. This may be populated by extrapolating into a DateTime. See endPrecision for the best indicator of if this value is extrapolated or provided in the original date format."
445445
},
446446
{
447447
"name": "instantDescriptor",
@@ -450,7 +450,7 @@
450450
"ValidDescriptor"
451451
],
452452
"default": null,
453-
"doc": "Describes the state of the temporal bounding's instant, e.g. valid, invalid, undefined"
453+
"doc": "Describes the state of the temporal bounding's instant, i.e. VALID, INVALID, or UNDEFINED."
454454
},
455455
{
456456
"name": "instantPrecision",
@@ -459,7 +459,7 @@
459459
"string"
460460
],
461461
"default": null,
462-
"doc": "The precision of the instant of the analyzed bounding, e.g. 'Years', 'Seconds', etc. See java.time.temporal.ChronoUnit. Note that this may sometimes not exactly match the input data, since it reflects the Java class the date is able to be parsed into"
462+
"doc": "The precision of the instant of the analyzed bounding, e.g. 'Years', 'Seconds', etc. See java.time.temporal.ChronoUnit. Note that this may sometimes not exactly match the input data, since it reflects the Java class the date is able to be parsed into."
463463
},
464464
{
465465
"name": "instantIndexable",
@@ -468,7 +468,7 @@
468468
"boolean"
469469
],
470470
"default": null,
471-
"doc": "Indicates whether or not instantUtcDateTimeString can be indexed for searching"
471+
"doc": "Indicates whether or not instantUtcDateTimeString/instantEndUtcDateTimeString can be indexed into Elasticsearch for searching."
472472
},
473473
{
474474
"name": "instantZoneSpecified",
@@ -486,7 +486,7 @@
486486
"string"
487487
],
488488
"default": null,
489-
"doc": "If possible, a full ISO-8601 formatted date time string in the UTC time zone for the analyzed instant value"
489+
"doc": "If provided instant is VALID, a full ISO-8601 formatted date time string in the UTC time zone for the analyzed instant value."
490490
},
491491
{
492492
"name": "instantEndUtcDateTimeString",
@@ -495,7 +495,7 @@
495495
"string"
496496
],
497497
"default": null,
498-
"doc": "If possible, a full ISO-8601 formatted date time string in the UTC time zone for the end analyzed instant value. The actual or assumed end date time based on precision of original data"
498+
"doc": "If provided instant is VALID, a full ISO-8601 formatted date time string in the UTC time zone for the end analyzed instant value. The actual or assumed end date time based on precision of original data."
499499
},
500500
{
501501
"name": "instantYear",
@@ -504,7 +504,7 @@
504504
"long"
505505
],
506506
"default": null,
507-
"doc": "If possible, an long indicating the instant year"
507+
"doc": "If provided instant is VALID, an long indicating the instant year."
508508
},
509509
{
510510
"name": "instantDayOfYear",
@@ -513,7 +513,7 @@
513513
"int"
514514
],
515515
"default": null,
516-
"doc": "If possible, an integer indicating the day of year for the instant value. This may be populated by extrapolating into a DateTime. See instantPrecision for the best indicator of if this value is extrapolated or provided in the original date format"
516+
"doc": "If provided instant is VALID, an integer indicating the day of year for the instant value. This may be populated by extrapolating into a DateTime. See instantPrecision for the best indicator of if this value is extrapolated or provided in the original date format."
517517
},
518518
{
519519
"name": "instantEndDayOfYear",
@@ -522,7 +522,7 @@
522522
"int"
523523
],
524524
"default": null,
525-
"doc": "An integer indicating the actual or assumed day of year the instant ends depending on the precision of the original content, e.g. the last day of a month or year."
525+
"doc": "If provided instant is VALID, an integer indicating the actual or assumed day of year the instant ends depending on the precision of the original content, e.g. the last day of a month or year."
526526
},
527527
{
528528
"name": "instantDayOfMonth",
@@ -531,7 +531,7 @@
531531
"int"
532532
],
533533
"default": null,
534-
"doc": "If possible, an integer indicating the day of month for the instant value. This may be populated by extrapolating into a DateTime. See instantPrecision for the best indicator of if this value is extrapolated or provided in the original date format"
534+
"doc": "If provided instant is VALID, an integer indicating the day of month for the instant value. This may be populated by extrapolating into a DateTime. See instantPrecision for the best indicator of if this value is extrapolated or provided in the original date format."
535535
},
536536
{
537537
"name": "instantEndDayOfMonth",
@@ -540,7 +540,7 @@
540540
"int"
541541
],
542542
"default": null,
543-
"doc": "An integer indicating the actual or assumed day of month the instant ends depending on precision, e.g. the last day of a month or year"
543+
"doc": "If provided instant is VALID, an integer indicating the actual or assumed day of month the instant ends depending on precision, e.g. the last day of a month or year."
544544
},
545545
{
546546
"name": "instantMonth",
@@ -549,7 +549,7 @@
549549
"int"
550550
],
551551
"default": null,
552-
"doc": "If possible, an integer indicating the month for the instant value. This may be populated by extrapolating into a DateTime. See instantPrecision for the best indicator of if this value is extrapolated or provided in the original date format"
552+
"doc": "If provided instant is VALID, an integer indicating the month for the instant value. This may be populated by extrapolating into a DateTime. See instantPrecision for the best indicator of if this value is extrapolated or provided in the original date format."
553553
},
554554
{
555555
"name": "instantEndMonth",
@@ -558,7 +558,7 @@
558558
"int"
559559
],
560560
"default": null,
561-
"doc": "If instantPrecision does not include day, an integer indicating the assumed month the instant ends, e.g. the last month of the year"
561+
"doc": "If provided instant is VALID and instantPrecision does not include day, an integer indicating the assumed month the instant ends, e.g. the last month of the year."
562562
},
563563
{
564564
"name": "rangeDescriptor",

0 commit comments

Comments
 (0)