All files / schemas/oada/as-harvested/yield-moisture-dataset v1.schema.cts

100% Statements 597/597
100% Branches 0/0
100% Functions 0/0
100% Lines 597/597

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 5981x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x  
/**
 * @license
 * Copyright 2022 Open Ag Data Alliance
 *
 * Use of this source code is governed by an MIT-style
 * license that can be found in the LICENSE file or at
 * https://opensource.org/licenses/MIT.
 */
 
import type { JSONSchema8 as Schema } from 'jsonschema8';
 
const schema: Schema = {
  $id: 'https://formats.openag.io/oada/as-harvested/yield-moisture-dataset/v1.schema.json',
  $schema: 'http://json-schema.org/draft-07/schema#',
  description:
    'The "yield-moisture" document contains as-harvested yield-moisture data. This is where a typical "yield map" from an existing FMIS software would go.  We encourage geospatial indexing here (rather than field-based).',
  properties: {
    'templates': {
      description:
        'templates is a general key for holding a collection of data points indexed by random strings.  Templates serve as prototypes for data points under "data" keys. If you have a piece of information that exists is all or almost all of the data points in a particular group of points, you can put the repeated things in templates and then just put the name of the template into the data point.  The full data point is therefore a merge of the template object and the data point itself, with the data point overruling when there are any keys that exist in both objects.  Schema is therefore identical to "data".',
      patternProperties: {
        '^(?!(indexing|.*-index|_.*)).*$': {
          description:
            'data-point never appears as a word in any document or URL.  It is a general type of object that can hold any type of data.  It represents the type of object that can sit under "data" or "templates".',
          properties: {
            id: {
              description:
                'id (note this is NOT "_id") can be used to identify a particular data point, perhaps across documents which simply re-index the same data.',
              type: 'string',
            },
            template: {
              description:
                'template sits inside a data point and gives the name of a template (key in the templates object) which serves as prototype for a given data point.  The full data point is the merge of that template object with the data point, with the data point taking precedence in key collisions. This is a string because its value is the key in templates, not the template itself.',
              type: 'string',
            },
            time: {
              description:
                'time is a data type which holds a reading of...time...',
              properties: {
                units: {
                  type: 'string',
                  examples: ['unix-timestamp', 'sec'],
                },
              },
              type: 'object',
            },
            area: {
              description:
                'area is a data type which holds a reading of...area...',
              properties: {
                units: {
                  type: 'string',
                  examples: ['ac', 'acres', 'ha', 'hectares', 'sqft'],
                },
              },
              type: 'object',
            },
            weight: {
              description:
                'weight is a data type which holds a reading of weight, as in bushels, lbs, or kg.',
              properties: {
                units: {
                  type: 'string',
                  examples: ['bu', 'bushels', 'lbs', 'kg'],
                },
              },
              type: 'object',
            },
            moisture: {
              description:
                'moisture is a data type which holds a reading of the amount of moisture in a crop. It is typically in units of % water (%H2O).',
              properties: {
                units: {
                  type: 'string',
                  examples: ['%H2O'],
                },
              },
              type: 'object',
            },
            location: {
              description:
                'location represents a point in space, usually a GPS coordinate or geohash',
              properties: {
                datum: {
                  description:
                    'datum describes the model of the earth used for GPS coordinates.  It can be from a set of known strings, or an EPSG model from http://spatialreference.org',
                  anyOf: [
                    {
                      type: 'string',
                      examples: ['WGS84'],
                    },
                    {
                      required: ['type', 'properties'],
                      properties: {
                        type: {
                          enum: ['EPSG'],
                        },
                        properties: {
                          required: ['code'],
                          properties: {
                            code: {
                              type: 'number',
                            },
                          },
                          type: 'object',
                        },
                      },
                      type: 'object',
                    },
                  ],
                },
                latitude: {
                  description: 'latitude is a string in the format of a number',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                longitude: {
                  description:
                    'longitude is a string in the format of a number',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                altitude: {
                  description: 'altitude is a string in the format of a number',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                lat: {
                  description: 'lat is shorthand for latitude',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                lon: {
                  description: 'lon is shorthand for longitude',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                alt: {
                  description: 'alt is shorthand for altitude',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                geohash: {
                  description:
                    'A geohash is a base 32 encoded string which represents the combination of latitude and longitude into a single number which, in general, has a property such that points close in number are close on the globe.',
                  type: 'string',
                  pattern: '^[0-9bcdefghjkmnpqrstuvwxyz]+$',
                },
              },
              type: 'object',
            },
            width: {
              description:
                'width is a data type which holds readings of swath width, or other widths of things.',
              properties: {
                units: {
                  type: 'string',
                  examples: ['ft', 'feet', 'm', 'meters'],
                },
              },
              type: 'object',
            },
          },
          type: 'object',
        },
      },
    },
    'data': {
      description:
        'data is a general key for holding a collection of data points indexed by random strings.',
      patternProperties: {
        '^(?!(indexing|.*-index|_.*)).*$': {
          description:
            'data-point never appears as a word in any document or URL.  It is a general type of object that can hold any type of data.  It represents the type of object that can sit under "data" or "templates".',
          properties: {
            id: {
              description:
                'id (note this is NOT "_id") can be used to identify a particular data point, perhaps across documents which simply re-index the same data.',
              type: 'string',
            },
            template: {
              description:
                'template sits inside a data point and gives the name of a template (key in the templates object) which serves as prototype for a given data point.  The full data point is the merge of that template object with the data point, with the data point taking precedence in key collisions. This is a string because its value is the key in templates, not the template itself.',
              type: 'string',
            },
            time: {
              description:
                'time is a data type which holds a reading of...time...',
              properties: {
                units: {
                  type: 'string',
                  examples: ['unix-timestamp', 'sec'],
                },
              },
              type: 'object',
            },
            area: {
              description:
                'area is a data type which holds a reading of...area...',
              properties: {
                units: {
                  type: 'string',
                  examples: ['ac', 'acres', 'ha', 'hectares', 'sqft'],
                },
              },
              type: 'object',
            },
            weight: {
              description:
                'weight is a data type which holds a reading of weight, as in bushels, lbs, or kg.',
              properties: {
                units: {
                  type: 'string',
                  examples: ['bu', 'bushels', 'lbs', 'kg'],
                },
              },
              type: 'object',
            },
            moisture: {
              description:
                'moisture is a data type which holds a reading of the amount of moisture in a crop. It is typically in units of % water (%H2O).',
              properties: {
                units: {
                  type: 'string',
                  examples: ['%H2O'],
                },
              },
              type: 'object',
            },
            location: {
              description:
                'location represents a point in space, usually a GPS coordinate or geohash',
              properties: {
                datum: {
                  description:
                    'datum describes the model of the earth used for GPS coordinates. It can be from a set of known strings, or an EPSG model from http://spatialreference.org',
                  anyOf: [
                    {
                      type: 'string',
                      examples: ['WGS84'],
                    },
                    {
                      required: ['type', 'properties'],
                      properties: {
                        type: {
                          enum: ['EPSG'],
                        },
                        properties: {
                          required: ['code'],
                          properties: {
                            code: {
                              type: 'number',
                            },
                          },
                          type: 'object',
                        },
                      },
                      type: 'object',
                    },
                  ],
                },
                latitude: {
                  description: 'latitude is a string in the format of a number',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                longitude: {
                  description:
                    'longitude is a string in the format of a number',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                altitude: {
                  description: 'altitude is a string in the format of a number',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                lat: {
                  description: 'lat is shorthand for latitude',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                lon: {
                  description: 'lon is shorthand for longitude',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                alt: {
                  description: 'alt is shorthand for altitude',
                  type: 'string',
                  pattern: '^-?([0-9]*[.])[0-9]+',
                },
                geohash: {
                  description:
                    'A geohash is a base 32 encoded string which represents the combination of latitude and longitude into a single number which, in general, has a property such that points close in number are close on the globe.',
                  type: 'string',
                  pattern: '^[0-9bcdefghjkmnpqrstuvwxyz]+$',
                },
              },
              type: 'object',
            },
            width: {
              description:
                'width is a data type which holds readings of swath width, or other widths of things.',
              properties: {
                units: {
                  type: 'string',
                  examples: ['ft', 'feet', 'm', 'meters'],
                },
              },
              type: 'object',
            },
          },
          required: ['area', 'weight', 'moisture', 'location'],
          type: 'object',
        },
      },
    },
    '_id': {
      description: '_id identifies a resource in the OADA API.',
      type: 'string',
    },
    '_rev': {
      description:
        '_rev is the revision string for a resource in the OADA API.',
      type: 'integer',
    },
    '_meta': {
      description: '_meta is a link to the meta document for a resources.',
      properties: {
        _id: {
          description: '_id identifies a resource in the OADA API.',
          type: 'string',
        },
        _rev: {
          description:
            '_rev is the revision string for a resource in the OADA API.',
          type: 'integer',
        },
      },
      required: ['_id', '_rev'],
      type: 'object',
    },
    '_type': {
      enum: ['application/vnd.oada.as-harvested.yield-moisture-dataset.1+json'],
    },
    'indexing': {
      type: 'array',
      items: {
        anyOf: [
          {
            properties: {
              index: {
                enum: ['year-index'],
              },
              source: {
                enum: ['oada.vocab.year-index'],
              },
              value: {
                type: 'string',
                pattern: '^[0-9]{4}$',
              },
            },
            type: 'object',
          },
          {
            properties: {
              index: {
                enum: ['crop-index'],
              },
              value: {
                type: 'string',
                examples: ['corn', 'soybeans', 'wheat'],
              },
              source: {
                type: 'string',
                examples: ['oada.vocab.crop-type'],
              },
            },
            type: 'object',
          },
          {
            properties: {
              index: {
                enum: ['geohash-length-index'],
              },
              value: {
                type: 'string',
                pattern: '^geohash-[1-9][0-9]*$',
              },
              source: {
                type: 'string',
                examples: ['oada.vocab.geohash-length-index'],
              },
            },
            type: 'object',
          },
          {
            properties: {
              index: {
                enum: ['geohash-index'],
              },
              value: {
                description:
                  'A geohash is a base 32 encoded string which represents the combination of latitude and longitude into a single number which, in general, has a property such that points close in number are close on the globe.',
                type: 'string',
                pattern: '^[0-9bcdefghjkmnpqrstuvwxyz]+$',
              },
              source: {
                type: 'string',
                examples: ['oada.vocab.geohash'],
              },
            },
            type: 'object',
          },
        ],
      },
    },
    'year-index': {
      description: 'year-index splits things up by a 4-digit year',
      patternProperties: {
        '^[0-9]{4}$': {
          description:
            'A link in OADA has at least an _id key and links one resource to another.',
          properties: {
            _id: {
              description: '_id identifies a resource in the OADA API.',
              type: 'string',
            },
          },
          required: ['_id'],
          type: 'object',
        },
      },
    },
    'crop-index': {
      description:
        "crop-index is an object that sits inside other objects and gives links to documents based on the name of a particular crop. It's known keys are also not considered part of the OADA vocabulary and therefore do not appear as vocabulary terms even though they will be in OADA URLs.  This is standard for indexes.",
      properties: {
        corn: {
          description:
            'A link in OADA has at least an _id key and links one resource to another.',
          properties: {
            _id: {
              description: '_id identifies a resource in the OADA API.',
              type: 'string',
            },
          },
          required: ['_id'],
          type: 'object',
        },
        soybeans: {
          description:
            'A link in OADA has at least an _id key and links one resource to another.',
          properties: {
            _id: {
              description: '_id identifies a resource in the OADA API.',
              type: 'string',
            },
          },
          required: ['_id'],
          type: 'object',
        },
        wheat: {
          description:
            'A link in OADA has at least an _id key and links one resource to another.',
          properties: {
            _id: {
              description: '_id identifies a resource in the OADA API.',
              type: 'string',
            },
          },
          required: ['_id'],
          type: 'object',
        },
      },
      type: 'object',
    },
    'geohash-length-index': {
      $ref: '../../indexes/geohash-length-index.schema.json',
    },
    'geohash-index': {
      description:
        'geohash-index is a key that holds under it a set of geohash keys of a particular length.  It is necessary because some geohashes may be legitimate words and therefore we need to place all the geohashes specifically under one key. This key usually sits at the top-level of a document reached via a geohash-length-index. It is intended to hold links to resources containing data that is grouped under a particular geohash.',
      patternProperties: {
        '^[0-9bcdefghjkmnpqrstuvwxyz]+$': {
          description:
            'A link in OADA has at least an _id key and links one resource to another.',
          properties: {
            _id: {
              description: '_id identifies a resource in the OADA API.',
              type: 'string',
            },
          },
          required: ['_id'],
          type: 'object',
        },
      },
    },
  },
  additionalProperties: true,
  required: ['_type'],
  type: 'object',
  examples: [
    {
      _id: 'ifjo2ifkl23',
      _rev: 2,
      _type: 'application/vnd.oada.as-harvested.yield-moisture-dataset.1+json',
      indexing: [
        {
          index: 'year-index',
          value: '2018',
          source: 'oada.vocab.year-index',
        },
        {
          index: 'crop-index',
          value: 'corn',
          source: 'oada.vocab.crop-type',
        },
        {
          index: 'geohash-length-index',
          source: 'oada.vocab.geohash-length-index',
          value: 'geohash-7',
        },
        {
          index: 'geohash-index',
          value: '9j9j12f',
          source: 'oada.vocab.geohash-index',
        },
      ],
      templates: {
        k20ifkj: {
          time: {
            units: 'unix-timestamp',
          },
          area: {
            units: 'acres',
          },
          weight: {
            units: 'bushels',
          },
          moisture: {
            units: '%H2O',
          },
          location: {
            datum: 'WGS84',
          },
        },
      },
      data: {
        'kdjf02ijk3f': {
          id: '902jfl3jo2kf2l3f',
          template: 'k20ifkj',
          time: {
            value: 192_847_322.145_21,
          },
          area: {
            value: 1.1,
          },
          weight: {
            value: 2.5,
          },
          moisture: {
            value: 28.79,
          },
          location: {
            latitude: '-41.9384932',
            longitude: '80.9284923',
            altitude: '200.49583',
          },
        },
        '0f2jflk2j3l': {
          id: 'llll23jf02i2o3ffdsf',
          template: 'k20ifkj',
          time: {
            value: 192_847_323.783_21,
          },
          area: {
            value: '0.9',
          },
          weight: {
            value: '2.3',
          },
          moisture: {
            value: 23.81,
          },
          location: {
            latitude: '-41.9384931',
            longitude: '80.9284921',
            altitude: '200.49581',
          },
        },
      },
    },
  ],
};
export = schema;