repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
charlestati/schema-org-json-schemas | e24049d24a7bd3b639876aa7f9a9da997ce29114 | 2020-05-22T22:32:24 | schemas/BroadcastService.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/BroadcastService",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Service.schema.json",
"description": "A service provided by an organization, e.g. delivery service, print services, etc."
}
],
"description": "A delivery service through which content is provided via broadcast over the air or online.",
"format": "http://schema.org/BroadcastService",
"properties": {
"area": {
"$ref": "Place.schema.json",
"description": "The area within which users can expect to reach the broadcast service."
},
"broadcastAffiliateOf": {
"$ref": "Organization.schema.json",
"description": "The media network(s) whose content is broadcast on this station."
},
"broadcastDisplayName": {
"description": "The name displayed in the channel guide. For many US affiliates, it is the network name.",
"type": "string"
},
"broadcastFrequency": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "BroadcastFrequencySpecification.schema.json"
}
],
"description": "The frequency used for over-the-air broadcasts. Numeric values or simple ranges e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. \"87 FM\"."
},
"broadcastTimezone": {
"description": "The timezone in ISO 8601 format for which the service bases its broadcasts",
"type": "string"
},
"broadcaster": {
"$ref": "Organization.schema.json",
"description": "The organization owning or operating the broadcast service."
},
"hasBroadcastChannel": {
"description": "A broadcast channel of a broadcast service.",
"oneOf": [
{
"$ref": "BroadcastChannel.schema.json"
},
{
"items": {
"$ref": "BroadcastChannel.schema.json"
},
"type": "array"
}
]
},
"inLanguage": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "Language.schema.json"
}
],
"description": "The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also availableLanguage."
},
"parentService": {
"description": "A broadcast service to which the broadcast service may belong to such as regional variations of a national channel.",
"oneOf": [
{
"$ref": "BroadcastService.schema.json"
},
{
"items": {
"$ref": "BroadcastService.schema.json"
},
"type": "array"
}
]
},
"videoFormat": {
"description": "The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, etc.).",
"type": "string"
}
},
"title": "BroadcastService",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 804d52988c59583ea5a0208a0ccfa22b31c01f43 | 2020-05-23T02:30:56 | schemas/MoveAction.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/MoveAction",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "http://schema.org/Action",
"description": "An action performed by a direct agent and indirect participants upon a direct object. Optionally happens at a location with the help of an inanimate instrument. The execution of the action may produce a result. Specific action sub-type documentation specifies the exact expectation of each argument/role.\n\nSee also blog post and Actions overview document."
}
],
"description": "The act of an agent relocating to a place.\n\nRelated actions:\n\n\nTransferAction: Unlike TransferAction, the subject of the move is a living Person or Organization rather than an inanimate object.\n\n",
"properties": {
"fromLocation": {
"description": "A sub property of location. The original location of the object or the agent before the action.",
"oneOf": [
{
"$ref": "http://schema.org/Place"
},
{
"items": {
"$ref": "http://schema.org/Place"
},
"type": "array"
}
]
},
"toLocation": {
"description": "A sub property of location. The final location of the object or the agent after the action.",
"oneOf": [
{
"$ref": "http://schema.org/Place"
},
{
"items": {
"$ref": "http://schema.org/Place"
},
"type": "array"
}
]
}
},
"title": "MoveAction",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e8b1f2cc6ffa01721896e87736f87654885d1475 | 2022-01-02T23:44:21 | schemas/MedicalCode.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "schema:MedicalCode",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "schema:CategoryCode",
"description": "A Category Code."
},
{
"$ref": "schema:MedicalIntangible",
"description": "A utility class that serves as the umbrella for a number of 'intangible' things in the medical space."
}
],
"description": "A code for a medical entity.",
"properties": {
"codeValue": {
"description": "A short textual code that uniquely identifies the value.",
"type": "string"
},
"codingSystem": {
"description": "The coding system, e.g. 'ICD-10'.",
"type": "string"
}
},
"title": "MedicalCode",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 6d7567eecede3e8272a2640c2c2081768cb48462 | 2020-05-02T11:06:50 | schemas/ChildrensEvent.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/ChildrensEvent",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Event.schema.json",
"description": "An event happening at a certain time and location, such as a concert, lecture, or festival. Ticketing information may be added via the offers property. Repeated events may be structured as separate Event objects."
}
],
"description": "Event type: Children's event.",
"format": "http://schema.org/ChildrensEvent",
"title": "ChildrensEvent",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e24049d24a7bd3b639876aa7f9a9da997ce29114 | 2020-05-22T22:32:24 | schemas/BedType.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/BedType",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "QualitativeValue.schema.json",
"description": "A predefined value for a product characteristic, e.g. the power cord plug type 'US' or the garment sizes 'S', 'M', 'L', and 'XL'."
}
],
"description": "A type of bed. This is used for indicating the bed or beds available in an accommodation.",
"format": "http://schema.org/BedType",
"title": "BedType",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e24049d24a7bd3b639876aa7f9a9da997ce29114 | 2020-05-22T22:32:24 | schemas/OfferCatalog.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/OfferCatalog",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "ItemList.schema.json",
"description": "A list of items of any sort\u2014for example, Top 10 Movies About Weathermen, or Top 100 Party Songs. Not to be confused with HTML lists, which are often used only for formatting."
}
],
"description": "An OfferCatalog is an ItemList that contains related Offers and/or further OfferCatalogs that are offeredBy the same provider.",
"format": "http://schema.org/OfferCatalog",
"title": "OfferCatalog",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | dcbb428317ce07ab8dcff50247c907f15443fb2f | 2020-05-22T20:27:54 | schemas/Movie.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/Movie",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "CreativeWork.schema.json",
"description": "The most generic kind of creative work, including books, movies, photographs, software programs, etc."
}
],
"description": "A movie.",
"format": "http://schema.org/Movie",
"properties": {
"@context": {
"const": "https://schema.org"
},
"@type": {
"const": "Movie"
},
"actor": {
"description": "An actor, e.g. in tv, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.",
"oneOf": [
{
"$ref": "Person.schema.json"
},
{
"items": {
"$ref": "Person.schema.json"
},
"type": "array"
}
]
},
"actors": {
"description": "An actor, e.g. in tv, radio, movie, video games etc. Actors can be associated with individual items or with a series, episode, clip.",
"oneOf": [
{
"$ref": "Person.schema.json"
},
{
"items": {
"$ref": "Person.schema.json"
},
"type": "array"
}
]
},
"countryOfOrigin": {
"$ref": "Country.schema.json",
"description": "The country of the principal offices of the production company or individual responsible for the movie or program."
},
"director": {
"$ref": "Person.schema.json",
"description": "A director of e.g. tv, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip."
},
"directors": {
"description": "A director of e.g. tv, radio, movie, video games etc. content. Directors can be associated with individual items or with a series, episode, clip.",
"oneOf": [
{
"$ref": "Person.schema.json"
},
{
"items": {
"$ref": "Person.schema.json"
},
"type": "array"
}
]
},
"duration": {
"description": "The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.",
"format": "https://schema.org/Duration",
"type": "string"
},
"musicBy": {
"anyOf": [
{
"$ref": "MusicGroup.schema.json"
},
{
"$ref": "Person.schema.json"
}
],
"description": "The composer of the soundtrack."
},
"productionCompany": {
"$ref": "Organization.schema.json",
"description": "The production company or studio responsible for the item e.g. series, video game, episode etc."
},
"trailer": {
"$ref": "VideoObject.schema.json",
"description": "The trailer of a movie or tv/radio series, season, episode, etc."
}
},
"required": [
"@type"
],
"title": "Movie",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e24049d24a7bd3b639876aa7f9a9da997ce29114 | 2020-05-22T22:32:24 | schemas/TaxiService.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/TaxiService",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Service.schema.json",
"description": "A service provided by an organization, e.g. delivery service, print services, etc."
}
],
"description": "A service for a vehicle for hire with a driver for local travel. Fares are usually calculated based on distance traveled.",
"format": "http://schema.org/TaxiService",
"title": "TaxiService",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 6d7567eecede3e8272a2640c2c2081768cb48462 | 2020-05-02T11:06:50 | schemas/Series.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/Series",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Intangible.schema.json",
"description": "A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc."
}
],
"description": "A Series in schema.org is a group of related items, typically but not necessarily of the same kind. See also CreativeWorkSeries, EventSeries.",
"format": "http://schema.org/Series",
"title": "Series",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e8b1f2cc6ffa01721896e87736f87654885d1475 | 2022-01-02T23:44:21 | schemas/ReviewNewsArticle.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "schema:ReviewNewsArticle",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "schema:CriticReview",
"description": "A [[CriticReview]] is a more specialized form of Review written or published by a source that is recognized for its reviewing activities. These can include online columns, travel and food guides, TV and radio shows, blogs and other independent Web sites. [[CriticReview]]s are typically more in-depth and professionally written. For simpler, casually written user/visitor/viewer/customer reviews, it is more appropriate to use the [[UserReview]] type. Review aggregator sites such as Metacritic already separate out the site's user reviews from selected critic reviews that originate from third-party sources."
},
{
"$ref": "schema:NewsArticle",
"description": "A NewsArticle is an article whose content reports news, or provides background context and supporting materials for understanding the news.\n\nA more detailed overview of [schema.org News markup](/docs/news.html) is also available.\n"
}
],
"description": "A [[NewsArticle]] and [[CriticReview]] providing a professional critic's assessment of a service, product, performance, or artistic or literary work.",
"title": "ReviewNewsArticle",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 6d7567eecede3e8272a2640c2c2081768cb48462 | 2020-05-02T11:06:50 | schemas/HobbyShop.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/HobbyShop",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Store.schema.json",
"description": "A retail good store."
}
],
"description": "A store that sells materials useful or necessary for various hobbies.",
"format": "http://schema.org/HobbyShop",
"title": "HobbyShop",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 9f4aa4feafda1370cd94ae4c2a70a86f1eb23fcb | 2020-05-23T01:54:36 | schemas/VideoGameSeries.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/VideoGameSeries",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "http://schema.org/CreativeWorkSeries",
"description": "A CreativeWorkSeries in schema.org is a group of related items, typically but not necessarily of the same kind. CreativeWorkSeries are usually organized into some order, often chronological. Unlike ItemList which is a general purpose data structure for lists of things, the emphasis with CreativeWorkSeries is on published materials (written e.g. books and periodicals, or media such as tv, radio and games).\n\nSpecific subtypes are available for describing TVSeries, RadioSeries, MovieSeries, BookSeries, Periodical and VideoGameSeries. In each case, the hasPart / isPartOf properties can be used to relate the CreativeWorkSeries to its parts. The general CreativeWorkSeries type serves largely just to organize these more specific and practical subtypes.\n\nIt is common for properties applicable to an item from the series to be usefully applied to the containing group. Schema.org attempts to anticipate some of these cases, but publishers should be free to apply properties of the series parts to the series as a whole wherever they seem appropriate."
}
],
"description": "A video game series.",
"format": "http://schema.org/VideoGameSeries",
"properties": {
"actor": {
"description": "An actor, e.g. in tv, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.",
"oneOf": [
{
"$ref": "http://schema.org/Person"
},
{
"items": {
"$ref": "http://schema.org/Person"
},
"type": "array"
}
]
},
"actors": {
"description": "An actor, e.g. in tv, radio, movie, video games etc. Actors can be associated with individual items or with a series, episode, clip.",
"oneOf": [
{
"$ref": "http://schema.org/Person"
},
{
"items": {
"$ref": "http://schema.org/Person"
},
"type": "array"
}
]
},
"characterAttribute": {
"description": "A piece of data that represents a particular aspect of a fictional character (skill, power, character points, advantage, disadvantage).",
"oneOf": [
{
"$ref": "http://schema.org/Thing"
},
{
"items": {
"$ref": "http://schema.org/Thing"
},
"type": "array"
}
]
},
"cheatCode": {
"description": "Cheat codes to the game.",
"oneOf": [
{
"$ref": "http://schema.org/CreativeWork"
},
{
"items": {
"$ref": "http://schema.org/CreativeWork"
},
"type": "array"
}
]
},
"containsSeason": {
"description": "A season that is part of the media series.",
"oneOf": [
{
"$ref": "http://schema.org/CreativeWorkSeason"
},
{
"items": {
"$ref": "http://schema.org/CreativeWorkSeason"
},
"type": "array"
}
]
},
"director": {
"$ref": "http://schema.org/Person",
"description": "A director of e.g. tv, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip."
},
"directors": {
"description": "A director of e.g. tv, radio, movie, video games etc. content. Directors can be associated with individual items or with a series, episode, clip.",
"oneOf": [
{
"$ref": "http://schema.org/Person"
},
{
"items": {
"$ref": "http://schema.org/Person"
},
"type": "array"
}
]
},
"episode": {
"description": "An episode of a tv, radio or game media within a series or season.",
"oneOf": [
{
"$ref": "http://schema.org/Episode"
},
{
"items": {
"$ref": "http://schema.org/Episode"
},
"type": "array"
}
]
},
"episodes": {
"description": "An episode of a TV/radio series or season.",
"oneOf": [
{
"$ref": "http://schema.org/Episode"
},
{
"items": {
"$ref": "http://schema.org/Episode"
},
"type": "array"
}
]
},
"gameItem": {
"description": "An item is an object within the game world that can be collected by a player or, occasionally, a non-player character.",
"oneOf": [
{
"$ref": "http://schema.org/Thing"
},
{
"items": {
"$ref": "http://schema.org/Thing"
},
"type": "array"
}
]
},
"gameLocation": {
"description": "Real or fictional location of the game (or part of game).",
"oneOf": [
{
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"$ref": "http://schema.org/Place"
},
{
"$ref": "http://schema.org/PostalAddress"
}
]
},
{
"items": {
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"$ref": "http://schema.org/Place"
},
{
"$ref": "http://schema.org/PostalAddress"
}
]
},
"type": "array"
}
]
},
"gamePlatform": {
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"type": "string"
},
{
"$ref": "http://schema.org/Thing"
}
],
"description": "The electronic systems used to play video games."
},
"musicBy": {
"anyOf": [
{
"$ref": "http://schema.org/MusicGroup"
},
{
"$ref": "http://schema.org/Person"
}
],
"description": "The composer of the soundtrack."
},
"numberOfEpisodes": {
"description": "The number of episodes in this season or series.",
"type": "integer"
},
"numberOfPlayers": {
"description": "Indicate how many people can play this game (minimum, maximum, or range).",
"oneOf": [
{
"$ref": "http://schema.org/QuantitativeValue"
},
{
"items": {
"$ref": "http://schema.org/QuantitativeValue"
},
"type": "array"
}
]
},
"numberOfSeasons": {
"description": "The number of seasons in this series.",
"type": "integer"
},
"playMode": {
"description": "Indicates whether this game is multi-player, co-op or single-player. The game can be marked as multi-player, co-op and single-player at the same time.",
"oneOf": [
{
"$ref": "http://schema.org/GamePlayMode"
},
{
"items": {
"$ref": "http://schema.org/GamePlayMode"
},
"type": "array"
}
]
},
"productionCompany": {
"$ref": "http://schema.org/Organization",
"description": "The production company or studio responsible for the item e.g. series, video game, episode etc."
},
"quest": {
"$ref": "http://schema.org/Thing",
"description": "The task that a player-controlled character, or group of characters may complete in order to gain a reward."
},
"season": {
"description": "A season in a media series.",
"oneOf": [
{
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"$ref": "http://schema.org/CreativeWorkSeason"
}
]
},
{
"items": {
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"$ref": "http://schema.org/CreativeWorkSeason"
}
]
},
"type": "array"
}
]
},
"seasons": {
"description": "A season in a media series.",
"oneOf": [
{
"$ref": "http://schema.org/CreativeWorkSeason"
},
{
"items": {
"$ref": "http://schema.org/CreativeWorkSeason"
},
"type": "array"
}
]
},
"trailer": {
"$ref": "http://schema.org/VideoObject",
"description": "The trailer of a movie or tv/radio series, season, episode, etc."
}
},
"title": "VideoGameSeries",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e24049d24a7bd3b639876aa7f9a9da997ce29114 | 2020-05-22T22:32:24 | schemas/GameServer.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/GameServer",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Intangible.schema.json",
"description": "A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc."
}
],
"description": "Server that provides game interaction in a multiplayer game.",
"format": "http://schema.org/GameServer",
"properties": {
"game": {
"description": "Video game which is played on this server.",
"oneOf": [
{
"$ref": "VideoGame.schema.json"
},
{
"items": {
"$ref": "VideoGame.schema.json"
},
"type": "array"
}
]
},
"playersOnline": {
"description": "Number of players on the server.",
"oneOf": [
{
"type": "integer"
},
{
"items": {
"type": "integer"
},
"type": "array"
}
]
},
"serverStatus": {
"description": "Status of a game server.",
"oneOf": [
{
"$ref": "GameServerStatus.schema.json"
},
{
"items": {
"$ref": "GameServerStatus.schema.json"
},
"type": "array"
}
]
}
},
"title": "GameServer",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 6d7567eecede3e8272a2640c2c2081768cb48462 | 2020-05-02T11:06:50 | schemas/Demand.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/Demand",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Intangible.schema.json",
"description": "A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc."
}
],
"description": "A demand entity represents the public, not necessarily binding, not necessarily exclusive, announcement by an organization or person to seek a certain type of goods or services. For describing demand using this type, the very same properties used for Offer apply.",
"format": "http://schema.org/Demand",
"properties": {
"acceptedPaymentMethod": {
"anyOf": [
{
"$ref": "LoanOrCredit.schema.json"
},
{
"$ref": "PaymentMethod.schema.json"
}
],
"description": "The payment method(s) accepted by seller for this offer."
},
"advanceBookingRequirement": {
"$ref": "QuantitativeValue.schema.json",
"description": "The amount of time that is required between accepting the offer and the actual usage of the resource or service."
},
"areaServed": {
"anyOf": [
{
"$ref": "AdministrativeArea.schema.json"
},
{
"$ref": "Place.schema.json"
},
{
"$ref": "GeoShape.schema.json"
}
],
"description": "The geographic area where a service or offered item is provided."
},
"availability": {
"$ref": "ItemAvailability.schema.json",
"description": "The availability of this item\u2014for example In stock, Out of stock, Pre-order, etc."
},
"availabilityEnds": {
"description": "The end of the availability of the product or service included in the offer.",
"format": "http://schema.org/Time"
},
"availabilityStarts": {
"description": "The beginning of the availability of the product or service included in the offer.",
"format": "http://schema.org/Date"
},
"availableAtOrFrom": {
"$ref": "Place.schema.json",
"description": "The place(s) from which the offer can be obtained (e.g. store locations)."
},
"availableDeliveryMethod": {
"$ref": "DeliveryMethod.schema.json",
"description": "The delivery method(s) available for this offer."
},
"businessFunction": {
"$ref": "BusinessFunction.schema.json",
"description": "The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell."
},
"deliveryLeadTime": {
"$ref": "QuantitativeValue.schema.json",
"description": "The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup."
},
"eligibleCustomerType": {
"$ref": "BusinessEntityType.schema.json",
"description": "The type(s) of customers for which the given offer is valid."
},
"eligibleDuration": {
"$ref": "QuantitativeValue.schema.json",
"description": "The duration for which the given offer is valid."
},
"eligibleQuantity": {
"$ref": "QuantitativeValue.schema.json",
"description": "The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity."
},
"eligibleRegion": {
"anyOf": [
{
"$ref": "Place.schema.json"
},
{
"$ref": "GeoShape.schema.json"
}
],
"description": "The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.\n\nSee also ineligibleRegion."
},
"eligibleTransactionVolume": {
"$ref": "PriceSpecification.schema.json",
"description": "The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount."
},
"gtin12": {
"description": "The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See GS1 GTIN Summary for more details.",
"format": "http://schema.org/Text"
},
"gtin13": {
"description": "The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceeding zero. See GS1 GTIN Summary for more details.",
"format": "http://schema.org/Text"
},
"gtin14": {
"description": "The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details.",
"format": "http://schema.org/Text"
},
"gtin8": {
"description": "The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See GS1 GTIN Summary for more details.",
"format": "http://schema.org/Text"
},
"includesObject": {
"description": "This links to a node or nodes indicating the exact quantity of the products included in the offer.",
"items": {
"$ref": "TypeAndQuantityNode.schema.json"
},
"type": "array"
},
"inventoryLevel": {
"$ref": "QuantitativeValue.schema.json",
"description": "The current approximate inventory level for the item or items."
},
"itemCondition": {
"description": "A predefined value from OfferItemCondition or a textual description of the condition of the product or service, or the products or services included in the offer.",
"items": {
"$ref": "OfferItemCondition.schema.json"
},
"type": "array"
},
"itemOffered": {
"anyOf": [
{
"$ref": "Trip.schema.json"
},
{
"$ref": "CreativeWork.schema.json"
},
{
"$ref": "AggregateOffer.schema.json"
},
{
"$ref": "Event.schema.json"
},
{
"$ref": "Service.schema.json"
},
{
"$ref": "MenuItem.schema.json"
},
{
"$ref": "Product.schema.json"
}
],
"description": "An item being offered (or demanded). The transactional nature of the offer or demand is documented using businessFunction, e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer."
},
"mpn": {
"description": "The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.",
"format": "http://schema.org/Text"
},
"priceSpecification": {
"description": "One or more detailed price specifications, indicating the unit price and delivery or payment charges.",
"items": {
"$ref": "PriceSpecification.schema.json"
},
"type": "array"
},
"seller": {
"anyOf": [
{
"$ref": "Person.schema.json"
},
{
"$ref": "Organization.schema.json"
}
],
"description": "An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider."
},
"serialNumber": {
"description": "The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer.",
"format": "http://schema.org/Text"
},
"sku": {
"description": "The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.",
"format": "http://schema.org/Text"
},
"validFrom": {
"description": "The date when the item becomes valid.",
"format": "http://schema.org/Date"
},
"validThrough": {
"description": "The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.",
"format": "http://schema.org/Date"
},
"warranty": {
"$ref": "WarrantyPromise.schema.json",
"description": "The warranty promise(s) included in the offer."
}
},
"title": "Demand",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 6d7567eecede3e8272a2640c2c2081768cb48462 | 2020-05-02T11:06:50 | schemas/EventReservation.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/EventReservation",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Reservation.schema.json",
"description": "Describes a reservation for travel, dining or an event. Some reservations require tickets. \n\nNote: This type is for information about actual reservations, e.g. in confirmation emails or HTML pages with individual confirmations of reservations. For offers of tickets, restaurant reservations, flights, or rental cars, use Offer."
}
],
"description": "A reservation for an event like a concert, sporting event, or lecture.\n\nNote: This type is for information about actual reservations, e.g. in confirmation emails or HTML pages with individual confirmations of reservations. For offers of tickets, use Offer.",
"format": "http://schema.org/EventReservation",
"title": "EventReservation",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 6d7567eecede3e8272a2640c2c2081768cb48462 | 2020-05-02T11:06:50 | schemas/GiveAction.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/GiveAction",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "TransferAction.schema.json",
"description": "The act of transferring/moving (abstract or concrete) animate or inanimate objects from one place to another."
}
],
"description": "The act of transferring ownership of an object to a destination. Reciprocal of TakeAction.\n\nRelated actions:\n\n\nTakeAction: Reciprocal of GiveAction.\nSendAction: Unlike SendAction, GiveAction implies that ownership is being transferred (e.g. I may send my laptop to you, but that doesn't mean I'm giving it to you).\n\n",
"format": "http://schema.org/GiveAction",
"properties": {
"recipient": {
"description": "A sub property of participant. The participant who is at the receiving end of the action.",
"items": {
"oneOf": [
{
"$ref": "Person.schema.json"
},
{
"$ref": "Organization.schema.json"
},
{
"$ref": "Audience.schema.json"
},
{
"$ref": "ContactPoint.schema.json"
}
]
},
"type": "array"
}
},
"title": "GiveAction",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | cf09e5607a380dfe3692839d5ca86c0dd9bd6e0c | 2020-05-22T20:06:45 | schemas/AnimalShelter.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/AnimalShelter",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "LocalBusiness.schema.json",
"description": "A particular physical business or branch of an organization. Examples of LocalBusiness include a restaurant, a particular branch of a restaurant chain, a branch of a bank, a medical practice, a club, a bowling alley, etc."
}
],
"description": "Animal shelter.",
"format": "http://schema.org/AnimalShelter",
"properties": {
"@context": {
"const": "https://schema.org"
},
"@type": {
"const": "AnimalShelter"
}
},
"required": [
"@type"
],
"title": "AnimalShelter",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e8b1f2cc6ffa01721896e87736f87654885d1475 | 2022-01-02T23:44:21 | schemas/DefinedTermSet.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "schema:DefinedTermSet",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "schema:CreativeWork",
"description": "The most generic kind of creative work, including books, movies, photographs, software programs, etc."
}
],
"description": "A set of defined terms for example a set of categories or a classification scheme, a glossary, dictionary or enumeration.",
"properties": {
"hasDefinedTerm": {
"description": "A Defined Term contained in this term set.",
"oneOf": [
{
"$ref": "schema:DefinedTerm"
},
{
"items": {
"$ref": "schema:DefinedTerm"
},
"type": "array"
}
]
}
},
"title": "DefinedTermSet",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e8b1f2cc6ffa01721896e87736f87654885d1475 | 2022-01-02T23:44:21 | schemas/ChildCare.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "schema:ChildCare",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "schema:LocalBusiness",
"description": "A particular physical business or branch of an organization. Examples of LocalBusiness include a restaurant, a particular branch of a restaurant chain, a branch of a bank, a medical practice, a club, a bowling alley, etc."
}
],
"description": "A Childcare center.",
"title": "ChildCare",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 6d7567eecede3e8272a2640c2c2081768cb48462 | 2020-05-02T11:06:50 | schemas/Suite.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/Suite",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Accommodation.schema.json",
"description": "An accommodation is a place that can accommodate human beings, e.g. a hotel room, a camping pitch, or a meeting room. Many accommodations are for overnight stays, but this is not a mandatory requirement.\nFor more specific types of accommodations not defined in schema.org, one can use additionalType with external vocabularies.\n\nSee also the dedicated document on the use of schema.org for marking up hotels and other forms of accommodations."
}
],
"description": "A suite in a hotel or other public accommodation, denotes a class of luxury accommodations, the key feature of which is multiple rooms (Source: Wikipedia, the free encyclopedia, see http://en.wikipedia.org/wiki/Suite_(hotel)).\n\nSee also the dedicated document on the use of schema.org for marking up hotels and other forms of accommodations.",
"format": "http://schema.org/Suite",
"properties": {
"bed": {
"anyOf": [
{
"$ref": "BedType.schema.json"
},
{
"$ref": "BedDetails.schema.json"
}
],
"description": "The type of bed or beds included in the accommodation. For the single case of just one bed of a certain type, you use bed directly with a text.\n If you want to indicate the quantity of a certain kind of bed, use an instance of BedDetails. For more detailed information, use the amenityFeature property."
},
"numberOfRooms": {
"$ref": "QuantitativeValue.schema.json",
"description": "The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business.\nTypical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue."
},
"occupancy": {
"$ref": "QuantitativeValue.schema.json",
"description": "The allowed total occupancy for the accommodation in persons (including infants etc). For individual accommodations, this is not necessarily the legal maximum but defines the permitted usage as per the contractual agreement (e.g. a double room used by a single person).\nTypical unit code(s): C62 for person"
}
},
"title": "Suite",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | dcbb428317ce07ab8dcff50247c907f15443fb2f | 2020-05-22T20:27:54 | schemas/Article.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/Article",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "CreativeWork.schema.json",
"description": "The most generic kind of creative work, including books, movies, photographs, software programs, etc."
}
],
"description": "An article, such as a news article or piece of investigative report. Newspapers and magazines have articles of many different types and this is intended to cover them all.\n\nSee also blog post.",
"format": "http://schema.org/Article",
"properties": {
"@context": {
"const": "https://schema.org"
},
"@type": {
"const": "Article"
},
"articleBody": {
"description": "The actual body of the article.",
"type": "string"
},
"articleSection": {
"description": "Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports, Lifestyle, etc.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"pageEnd": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "The page on which the work ends; for example \"138\" or \"xvi\"."
},
"pageStart": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "The page on which the work starts; for example \"135\" or \"xiii\"."
},
"pagination": {
"description": "Any description of pages that is not separated into pageStart and pageEnd; for example, \"1-6, 9, 55\" or \"10-12, 46-49\".",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"speakable": {
"description": "Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the 'speakable' property serves to indicate the parts most likely to be generally useful for speech.\n\nThe speakable property can be repeated an arbitrary number of times, with three kinds of possible 'content-locator' values:\n\n1.) id-value URL references - uses id-value of an element in the page being annotated. The simplest use of speakable has (potentially relative) URL values, referencing identified sections of the document concerned.\n\n2.) CSS Selectors - addresses content in the annotated page, eg. via class attribute. Use the cssSelector property.\n\n3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the xpath property.\n\nFor more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For this\nwe define a supporting type, SpeakableSpecification which is defined to be a possible value of the speakable property.",
"oneOf": [
{
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"$ref": "SpeakableSpecification.schema.json"
}
]
},
{
"items": {
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"$ref": "SpeakableSpecification.schema.json"
}
]
},
"type": "array"
}
]
},
"wordCount": {
"description": "The number of words in the text of the Article.",
"type": "integer"
}
},
"required": [
"@type"
],
"title": "Article",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | cf09e5607a380dfe3692839d5ca86c0dd9bd6e0c | 2020-05-22T20:06:45 | schemas/InviteAction.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/InviteAction",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "CommunicateAction.schema.json",
"description": "The act of conveying information to another person via a communication medium (instrument) such as speech, email, or telephone conversation."
}
],
"description": "The act of asking someone to attend an event. Reciprocal of RsvpAction.",
"format": "http://schema.org/InviteAction",
"properties": {
"@context": {
"const": "https://schema.org"
},
"@type": {
"const": "InviteAction"
},
"event": {
"description": "Upcoming or past event associated with this place, organization, or action.",
"items": {
"$ref": "Event.schema.json"
},
"type": "array"
}
},
"required": [
"@type"
],
"title": "InviteAction",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 804d52988c59583ea5a0208a0ccfa22b31c01f43 | 2020-05-23T02:30:56 | schemas/ProductModel.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/ProductModel",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "http://schema.org/Product",
"description": "Any offered product or service. For example: a pair of shoes; a concert ticket; the rental of a car; a haircut; or an episode of a TV show streamed online."
}
],
"description": "A datasheet or vendor specification of a product (in the sense of a prototypical description).",
"properties": {
"isVariantOf": {
"description": "A pointer to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive.",
"oneOf": [
{
"$ref": "http://schema.org/ProductModel"
},
{
"items": {
"$ref": "http://schema.org/ProductModel"
},
"type": "array"
}
]
},
"predecessorOf": {
"description": "A pointer from a previous, often discontinued variant of the product to its newer variant.",
"oneOf": [
{
"$ref": "http://schema.org/ProductModel"
},
{
"items": {
"$ref": "http://schema.org/ProductModel"
},
"type": "array"
}
]
},
"successorOf": {
"description": "A pointer from a newer variant of a product to its previous, often discontinued predecessor.",
"oneOf": [
{
"$ref": "http://schema.org/ProductModel"
},
{
"items": {
"$ref": "http://schema.org/ProductModel"
},
"type": "array"
}
]
}
},
"title": "ProductModel",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 9f4aa4feafda1370cd94ae4c2a70a86f1eb23fcb | 2020-05-23T01:54:36 | schemas/ReplaceAction.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/ReplaceAction",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "http://schema.org/UpdateAction",
"description": "The act of managing by changing/editing the state of the object."
}
],
"description": "The act of editing a recipient by replacing an old object with a new object.",
"format": "http://schema.org/ReplaceAction",
"properties": {
"replacee": {
"description": "A sub property of object. The object that is being replaced.",
"oneOf": [
{
"$ref": "http://schema.org/Thing"
},
{
"items": {
"$ref": "http://schema.org/Thing"
},
"type": "array"
}
]
},
"replacer": {
"description": "A sub property of object. The object that replaces.",
"oneOf": [
{
"$ref": "http://schema.org/Thing"
},
{
"items": {
"$ref": "http://schema.org/Thing"
},
"type": "array"
}
]
}
},
"title": "ReplaceAction",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e24049d24a7bd3b639876aa7f9a9da997ce29114 | 2020-05-22T22:32:24 | schemas/OrganizeAction.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/OrganizeAction",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Action.schema.json",
"description": "An action performed by a direct agent and indirect participants upon a direct object. Optionally happens at a location with the help of an inanimate instrument. The execution of the action may produce a result. Specific action sub-type documentation specifies the exact expectation of each argument/role.\n\nSee also blog post and Actions overview document."
}
],
"description": "The act of manipulating/administering/supervising/controlling one or more objects.",
"format": "http://schema.org/OrganizeAction",
"title": "OrganizeAction",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e24049d24a7bd3b639876aa7f9a9da997ce29114 | 2020-05-22T22:32:24 | schemas/VisualArtwork.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/VisualArtwork",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "CreativeWork.schema.json",
"description": "The most generic kind of creative work, including books, movies, photographs, software programs, etc."
}
],
"description": "A work of art that is primarily visual in character.",
"format": "http://schema.org/VisualArtwork",
"properties": {
"artEdition": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "The number of copies when multiple copies of a piece of artwork are produced - e.g. for a limited edition of 20 prints, 'artEdition' refers to the total number of copies (in this example \"20\")."
},
"artMedium": {
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"type": "string"
}
],
"description": "The material used. (e.g. Oil, Watercolour, Acrylic, Linoprint, Marble, Cyanotype, Digital, Lithograph, DryPoint, Intaglio, Pastel, Woodcut, Pencil, Mixed Media, etc.)"
},
"artform": {
"description": "e.g. Painting, Drawing, Sculpture, Print, Photograph, Assemblage, Collage, etc.",
"oneOf": [
{
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"type": "string"
}
]
},
{
"items": {
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"type": "string"
}
]
},
"type": "array"
}
]
},
"artworkSurface": {
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"type": "string"
}
],
"description": "The supporting materials for the artwork, e.g. Canvas, Paper, Wood, Board, etc."
},
"depth": {
"anyOf": [
{
"format": "https://schema.org/Distance",
"type": "string"
},
{
"$ref": "QuantitativeValue.schema.json"
}
],
"description": "The depth of the item."
},
"height": {
"anyOf": [
{
"format": "https://schema.org/Distance",
"type": "string"
},
{
"$ref": "QuantitativeValue.schema.json"
}
],
"description": "The height of the item."
},
"surface": {
"description": "A material used as a surface in some artwork, e.g. Canvas, Paper, Wood, Board, etc.",
"oneOf": [
{
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"type": "string"
}
]
},
{
"items": {
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"type": "string"
}
]
},
"type": "array"
}
]
},
"width": {
"anyOf": [
{
"format": "https://schema.org/Distance",
"type": "string"
},
{
"$ref": "QuantitativeValue.schema.json"
}
],
"description": "The width of the item."
}
},
"title": "VisualArtwork",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | cf09e5607a380dfe3692839d5ca86c0dd9bd6e0c | 2020-05-22T20:06:45 | schemas/HealthClub.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/HealthClub",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "HealthAndBeautyBusiness.schema.json",
"description": "Health and beauty."
},
{
"$ref": "SportsActivityLocation.schema.json",
"description": "A sports location, such as a playing field."
}
],
"description": "A health club.",
"format": "http://schema.org/HealthClub",
"properties": {
"@context": {
"const": "https://schema.org"
},
"@type": {
"const": "HealthClub"
}
},
"required": [
"@type"
],
"title": "HealthClub",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | b2e53fc058740940d51ae80a92d53c99f0b57ab0 | 2020-05-12T22:52:12 | schemas/Role.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/Role",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Intangible.schema.json",
"description": "A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc."
}
],
"description": "Represents additional information about a relationship or property. For example a Role can be used to say that a 'member' role linking some SportsTeam to a player occurred during a particular time period. Or that a Person's 'actor' role in a Movie was for some particular characterName. Such properties can be attached to a Role entity, which is then associated with the main entities using ordinary properties like 'member' or 'actor'.\n\nSee also blog post.",
"format": "http://schema.org/Role",
"properties": {
"endDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"format": "date",
"type": "string"
}
],
"description": "The end date and time of the item (in ISO 8601 date format)."
},
"namedPosition": {
"description": "A position played, performed or filled by a person or organization, as part of an organization. For example, an athlete in a SportsTeam might play in the position named 'Quarterback'.",
"items": {
"oneOf": [
{
"type": "string"
},
{
"format": "uri",
"type": "string"
}
]
},
"type": "array"
},
"roleName": {
"description": "A role played, performed or filled by a person or organization. For example, the team of creators for a comic book might fill the roles named 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might play in the position named 'Quarterback'.",
"items": {
"oneOf": [
{
"type": "string"
},
{
"format": "uri",
"type": "string"
}
]
},
"type": "array"
},
"startDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"format": "date",
"type": "string"
}
],
"description": "The start date and time of the item (in ISO 8601 date format)."
}
},
"title": "Role",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | d93f16a26bf98d23eb806d03ccce08d7cf15b99a | 2020-05-20T22:06:03 | schemas/FinancialService.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/FinancialService",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "LocalBusiness.schema.json",
"description": "A particular physical business or branch of an organization. Examples of LocalBusiness include a restaurant, a particular branch of a restaurant chain, a branch of a bank, a medical practice, a club, a bowling alley, etc."
}
],
"description": "Financial services business.",
"format": "http://schema.org/FinancialService",
"properties": {
"feesAndCommissionsSpecification": {
"description": "Description of fees, commissions, and other terms applied either to a class of financial product, or by a financial service organization.",
"items": {
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"type": "string"
}
]
},
"type": "array"
}
},
"title": "FinancialService",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 9f4aa4feafda1370cd94ae4c2a70a86f1eb23fcb | 2020-05-23T01:54:36 | schemas/BusReservation.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/BusReservation",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "http://schema.org/Reservation",
"description": "Describes a reservation for travel, dining or an event. Some reservations require tickets. \n\nNote: This type is for information about actual reservations, e.g. in confirmation emails or HTML pages with individual confirmations of reservations. For offers of tickets, restaurant reservations, flights, or rental cars, use Offer."
}
],
"description": "A reservation for bus travel. \n\nNote: This type is for information about actual reservations, e.g. in confirmation emails or HTML pages with individual confirmations of reservations. For offers of tickets, use Offer.",
"format": "http://schema.org/BusReservation",
"title": "BusReservation",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e8b1f2cc6ffa01721896e87736f87654885d1475 | 2022-01-02T23:44:21 | schemas/SkiResort.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "schema:SkiResort",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "schema:Resort",
"description": "A resort is a place used for relaxation or recreation, attracting visitors for holidays or vacations. Resorts are places, towns or sometimes commercial establishment operated by a single company (Source: Wikipedia, the free encyclopedia, see http://en.wikipedia.org/wiki/Resort).\n\nSee also the dedicated document on the use of schema.org for marking up hotels and other forms of accommodations.\n "
},
{
"$ref": "schema:SportsActivityLocation",
"description": "A sports location, such as a playing field."
}
],
"description": "A ski resort.",
"title": "SkiResort",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 9f4aa4feafda1370cd94ae4c2a70a86f1eb23fcb | 2020-05-23T01:54:36 | schemas/Hotel.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/Hotel",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "http://schema.org/LodgingBusiness",
"description": "A lodging business, such as a motel, hotel, or inn."
}
],
"description": "A hotel is an establishment that provides lodging paid on a short-term basis (Source: Wikipedia, the free encyclopedia, see http://en.wikipedia.org/wiki/Hotel).\n\nSee also the dedicated document on the use of schema.org for marking up hotels and other forms of accommodations.",
"format": "http://schema.org/Hotel",
"title": "Hotel",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 6d7567eecede3e8272a2640c2c2081768cb48462 | 2020-05-02T11:06:50 | schemas/WarrantyPromise.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/WarrantyPromise",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "StructuredValue.schema.json",
"description": "Structured values are used when the value of a property has a more complex structure than simply being a textual value or a reference to another thing."
}
],
"description": "A structured value representing the duration and scope of services that will be provided to a customer free of charge in case of a defect or malfunction of a product.",
"format": "http://schema.org/WarrantyPromise",
"properties": {
"durationOfWarranty": {
"$ref": "QuantitativeValue.schema.json",
"description": "The duration of the warranty promise. Common unitCode values are ANN for year, MON for months, or DAY for days."
},
"warrantyScope": {
"$ref": "WarrantyScope.schema.json",
"description": "The scope of the warranty promise."
}
},
"title": "WarrantyPromise",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 6d7567eecede3e8272a2640c2c2081768cb48462 | 2020-05-02T11:06:50 | schemas/BroadcastService.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/BroadcastService",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Service.schema.json",
"description": "A service provided by an organization, e.g. delivery service, print services, etc."
}
],
"description": "A delivery service through which content is provided via broadcast over the air or online.",
"format": "http://schema.org/BroadcastService",
"properties": {
"area": {
"$ref": "Place.schema.json",
"description": "The area within which users can expect to reach the broadcast service."
},
"broadcastAffiliateOf": {
"$ref": "Organization.schema.json",
"description": "The media network(s) whose content is broadcast on this station."
},
"broadcastDisplayName": {
"description": "The name displayed in the channel guide. For many US affiliates, it is the network name.",
"format": "http://schema.org/Text"
},
"broadcastFrequency": {
"$ref": "BroadcastFrequencySpecification.schema.json",
"description": "The frequency used for over-the-air broadcasts. Numeric values or simple ranges e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. \"87 FM\"."
},
"broadcastTimezone": {
"description": "The timezone in ISO 8601 format for which the service bases its broadcasts",
"format": "http://schema.org/Text"
},
"broadcaster": {
"$ref": "Organization.schema.json",
"description": "The organization owning or operating the broadcast service."
},
"hasBroadcastChannel": {
"description": "A broadcast channel of a broadcast service.",
"items": {
"$ref": "BroadcastChannel.schema.json"
},
"type": "array"
},
"inLanguage": {
"$ref": "Language.schema.json",
"description": "The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also availableLanguage."
},
"parentService": {
"description": "A broadcast service to which the broadcast service may belong to such as regional variations of a national channel.",
"items": {
"$ref": "BroadcastService.schema.json"
},
"type": "array"
},
"videoFormat": {
"description": "The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, etc.).",
"format": "http://schema.org/Text"
}
},
"title": "BroadcastService",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | cf09e5607a380dfe3692839d5ca86c0dd9bd6e0c | 2020-05-22T20:06:45 | schemas/FurnitureStore.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/FurnitureStore",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Store.schema.json",
"description": "A retail good store."
}
],
"description": "A furniture store.",
"format": "http://schema.org/FurnitureStore",
"properties": {
"@context": {
"const": "https://schema.org"
},
"@type": {
"const": "FurnitureStore"
}
},
"required": [
"@type"
],
"title": "FurnitureStore",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 804d52988c59583ea5a0208a0ccfa22b31c01f43 | 2020-05-23T02:30:56 | schemas/ListItem.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/ListItem",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "http://schema.org/Intangible",
"description": "A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc."
}
],
"description": "An list item, e.g. a step in a checklist or how-to description.",
"properties": {
"item": {
"description": "An entity represented by an entry in a list or data feed (e.g. an 'artist' in a list of 'artists')\u2019.",
"oneOf": [
{
"$ref": "http://schema.org/Thing"
},
{
"items": {
"$ref": "http://schema.org/Thing"
},
"type": "array"
}
]
},
"nextItem": {
"description": "A link to the ListItem that follows the current one.",
"oneOf": [
{
"$ref": "http://schema.org/ListItem"
},
{
"items": {
"$ref": "http://schema.org/ListItem"
},
"type": "array"
}
]
},
"position": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "The position of an item in a series or sequence of items."
},
"previousItem": {
"description": "A link to the ListItem that preceeds the current one.",
"oneOf": [
{
"$ref": "http://schema.org/ListItem"
},
{
"items": {
"$ref": "http://schema.org/ListItem"
},
"type": "array"
}
]
}
},
"title": "ListItem",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 804d52988c59583ea5a0208a0ccfa22b31c01f43 | 2020-05-23T02:30:56 | schemas/OwnershipInfo.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/OwnershipInfo",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "http://schema.org/StructuredValue",
"description": "Structured values are used when the value of a property has a more complex structure than simply being a textual value or a reference to another thing."
}
],
"description": "A structured value providing information about when a certain organization or person owned a certain product.",
"properties": {
"acquiredFrom": {
"anyOf": [
{
"$ref": "http://schema.org/Organization"
},
{
"$ref": "http://schema.org/Person"
}
],
"description": "The organization or person from which the product was acquired."
},
"ownedFrom": {
"description": "The date and time of obtaining the product.",
"format": "date-time",
"type": "string"
},
"ownedThrough": {
"description": "The date and time of giving up ownership on the product.",
"format": "date-time",
"type": "string"
},
"typeOfGood": {
"anyOf": [
{
"$ref": "http://schema.org/Product"
},
{
"$ref": "http://schema.org/Service"
}
],
"description": "The product that this structured value is referring to."
}
},
"title": "OwnershipInfo",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 804d52988c59583ea5a0208a0ccfa22b31c01f43 | 2020-05-23T02:30:56 | schemas/ViewAction.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/ViewAction",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "http://schema.org/ConsumeAction",
"description": "The act of ingesting information/resources/food."
}
],
"description": "The act of consuming static visual content.",
"title": "ViewAction",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e8b1f2cc6ffa01721896e87736f87654885d1475 | 2022-01-02T23:44:21 | schemas/State.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "schema:State",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "schema:AdministrativeArea",
"description": "A geographical region, typically under the jurisdiction of a particular government."
}
],
"description": "A state or province of a country.",
"title": "State",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | b2e53fc058740940d51ae80a92d53c99f0b57ab0 | 2020-05-12T22:52:12 | schemas/CommunicateAction.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/CommunicateAction",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "InteractAction.schema.json",
"description": "The act of interacting with another person or organization."
}
],
"description": "The act of conveying information to another person via a communication medium (instrument) such as speech, email, or telephone conversation.",
"format": "http://schema.org/CommunicateAction",
"properties": {
"about": {
"$ref": "Thing.schema.json",
"description": "The subject matter of the content."
},
"inLanguage": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "Language.schema.json"
}
],
"description": "The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also availableLanguage."
},
"language": {
"description": "A sub property of instrument. The language used on this action.",
"items": {
"$ref": "Language.schema.json"
},
"type": "array"
},
"recipient": {
"description": "A sub property of participant. The participant who is at the receiving end of the action.",
"items": {
"oneOf": [
{
"$ref": "Person.schema.json"
},
{
"$ref": "Organization.schema.json"
},
{
"$ref": "Audience.schema.json"
},
{
"$ref": "ContactPoint.schema.json"
}
]
},
"type": "array"
}
},
"title": "CommunicateAction",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 6d7567eecede3e8272a2640c2c2081768cb48462 | 2020-05-02T11:06:50 | schemas/Courthouse.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/Courthouse",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "GovernmentBuilding.schema.json",
"description": "A government building."
}
],
"description": "A courthouse.",
"format": "http://schema.org/Courthouse",
"title": "Courthouse",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e8b1f2cc6ffa01721896e87736f87654885d1475 | 2022-01-02T23:44:21 | schemas/SellAction.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "schema:SellAction",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "schema:TradeAction",
"description": "The act of participating in an exchange of goods and services for monetary compensation. An agent trades an object, product or service with a participant in exchange for a one time or periodic payment."
}
],
"description": "The act of taking money from a buyer in exchange for goods or services rendered. An agent sells an object, product, or service to a buyer for a price. Reciprocal of BuyAction.",
"properties": {
"buyer": {
"description": "A sub property of participant. The participant/person/organization that bought the object.",
"oneOf": [
{
"anyOf": [
{
"$ref": "schema:Organization"
},
{
"$ref": "schema:Person"
}
]
},
{
"items": {
"anyOf": [
{
"$ref": "schema:Organization"
},
{
"$ref": "schema:Person"
}
]
},
"type": "array"
}
]
},
"warrantyPromise": {
"$ref": "schema:WarrantyPromise",
"description": "The warranty promise(s) included in the offer."
}
},
"title": "SellAction",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e8b1f2cc6ffa01721896e87736f87654885d1475 | 2022-01-02T23:44:21 | schemas/AccountingService.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "schema:AccountingService",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "schema:FinancialService",
"description": "Financial services business."
}
],
"description": "Accountancy business.\\n\\nAs a [[LocalBusiness]] it can be described as a [[provider]] of one or more [[Service]]\\(s).\n ",
"title": "AccountingService",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e24049d24a7bd3b639876aa7f9a9da997ce29114 | 2020-05-22T22:32:24 | schemas/AggregateOffer.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/AggregateOffer",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Offer.schema.json",
"description": "An offer to transfer some rights to an item or to provide a service \u2014 for example, an offer to sell tickets to an event, to rent the DVD of a movie, to stream a TV show over the internet, to repair a motorcycle, or to loan a book.\n\nNote: As the businessFunction property, which identifies the form of offer (e.g. sell, lease, repair, dispose), defaults to http://purl.org/goodrelations/v1#Sell; an Offer without a defined businessFunction value can be assumed to be an offer to sell.\n\nFor GTIN-related fields, see Check Digit calculator and validation guide from GS1."
}
],
"description": "When a single product is associated with multiple offers (for example, the same pair of shoes is offered by different merchants), then AggregateOffer can be used.\n\nNote: AggregateOffers are normally expected to associate multiple offers that all share the same defined businessFunction value, or default to http://purl.org/goodrelations/v1#Sell if businessFunction is not explicitly defined.",
"format": "http://schema.org/AggregateOffer",
"properties": {
"highPrice": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"description": "The highest price of all offers available.\n\nUsage guidelines:\n\n\nUse values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.\nUse '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.\n\n"
},
"lowPrice": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"description": "The lowest price of all offers available.\n\nUsage guidelines:\n\n\nUse values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.\nUse '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.\n\n"
},
"offerCount": {
"description": "The number of offers for the product.",
"type": "integer"
},
"offers": {
"description": "An offer to provide this item\u2014for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use businessFunction to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a Demand. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.",
"oneOf": [
{
"anyOf": [
{
"$ref": "Demand.schema.json"
},
{
"$ref": "Offer.schema.json"
}
]
},
{
"items": {
"anyOf": [
{
"$ref": "Demand.schema.json"
},
{
"$ref": "Offer.schema.json"
}
]
},
"type": "array"
}
]
}
},
"title": "AggregateOffer",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | 804d52988c59583ea5a0208a0ccfa22b31c01f43 | 2020-05-23T02:30:56 | schemas/TheaterGroup.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/TheaterGroup",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "http://schema.org/PerformingGroup",
"description": "A performance group, such as a band, an orchestra, or a circus."
}
],
"description": "A theater group or company, for example, the Royal Shakespeare Company or Druid Theatre.",
"title": "TheaterGroup",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e24049d24a7bd3b639876aa7f9a9da997ce29114 | 2020-05-22T22:32:24 | schemas/Accommodation.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "http://schema.org/Accommodation",
"$schema": "http://json-schema.org/draft-07/schema#",
"allOf": [
{
"$ref": "Place.schema.json",
"description": "Entities that have a somewhat fixed, physical extension."
}
],
"description": "An accommodation is a place that can accommodate human beings, e.g. a hotel room, a camping pitch, or a meeting room. Many accommodations are for overnight stays, but this is not a mandatory requirement.\nFor more specific types of accommodations not defined in schema.org, one can use additionalType with external vocabularies.\n\nSee also the dedicated document on the use of schema.org for marking up hotels and other forms of accommodations.",
"format": "http://schema.org/Accommodation",
"properties": {
"amenityFeature": {
"description": "An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.",
"oneOf": [
{
"$ref": "LocationFeatureSpecification.schema.json"
},
{
"items": {
"$ref": "LocationFeatureSpecification.schema.json"
},
"type": "array"
}
]
},
"floorSize": {
"$ref": "QuantitativeValue.schema.json",
"description": "The size of the accommodation, e.g. in square meter or squarefoot.\nTypical unit code(s): MTK for square meter, FTK for square foot, or YDK for square yard"
},
"numberOfRooms": {
"anyOf": [
{
"type": "number"
},
{
"$ref": "QuantitativeValue.schema.json"
}
],
"description": "The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business.\nTypical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue."
},
"permittedUsage": {
"description": "Indications regarding the permitted usage of the accommodation.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"petsAllowed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string"
}
],
"description": "Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value."
}
},
"title": "Accommodation",
"type": "object"
} | Apache-2.0 | en |
charlestati/schema-org-json-schemas | e8b1f2cc6ffa01721896e87736f87654885d1475 | 2022-01-02T23:44:21 | schemas/Diet.schema.json | 25 | 2024-05-28T05:23:45.146893Z | {
"$id": "schema:Diet",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "schema:CreativeWork",
"description": "The most generic kind of creative work, including books, movies, photographs, software programs, etc."
},
{
"$ref": "schema:LifestyleModification",
"description": "A process of care involving exercise, changes to diet, fitness routines, and other lifestyle changes aimed at improving a health condition."
}
],
"description": "A strategy of regulating the intake of food to achieve or maintain a specific health-related goal.",
"properties": {
"dietFeatures": {
"description": "Nutritional information specific to the dietary plan. May include dietary recommendations on what foods to avoid, what foods to consume, and specific alterations/deviations from the USDA or other regulatory body's approved dietary guidelines.",
"type": "string"
},
"endorsers": {
"description": "People or organizations that endorse the plan.",
"oneOf": [
{
"anyOf": [
{
"$ref": "schema:Organization"
},
{
"$ref": "schema:Person"
}
]
},
{
"items": {
"anyOf": [
{
"$ref": "schema:Organization"
},
{
"$ref": "schema:Person"
}
]
},
"type": "array"
}
]
},
"expertConsiderations": {
"description": "Medical expert advice related to the plan.",
"type": "string"
},
"physiologicalBenefits": {
"description": "Specific physiologic benefits associated to the plan.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"risks": {
"description": "Specific physiologic risks associated to the diet plan.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"title": "Diet",
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | 4a42b2d942d3270b5c9ef385d2a09155be20027a | 2023-02-28T17:39:34 | sources/pagerduty-source/resources/schemas/services.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"alert_creation": {
"type": "string"
},
"alert_grouping_parameters": {
"properties": {
"type": {
"type": "string"
}
},
"type": "object"
},
"auto_pause_notifications_parameters": {
"properties": {
"enabled": {
"type": "boolean"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
},
"created_at": {
"type": "string"
},
"escalation_policy": {
"properties": {
"html_url": {
"type": "string"
},
"id": {
"type": "string"
},
"self": {
"type": "string"
},
"summary": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"html_url": {
"type": "string"
},
"id": {
"type": "string"
},
"incident_urgency_rule": {
"properties": {
"during_support_hours": {
"properties": {
"type": {
"type": "string"
},
"urgency": {
"type": "string"
}
},
"type": "object"
},
"outside_support_hours": {
"properties": {
"type": {
"type": "string"
},
"urgency": {
"type": "string"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"integrations": {
"items": {
"properties": {
"html_url": {
"type": "string"
},
"id": {
"type": "string"
},
"self": {
"type": "string"
},
"summary": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"scheduled_actions": {
"items": {
"properties": {
"at": {
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"to_urgency": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"self": {
"type": "string"
},
"status": {
"type": "string"
},
"summary": {
"type": "string"
},
"teams": {
"items": {
"properties": {
"html_url": {
"type": "string"
},
"id": {
"type": "string"
},
"self": {
"type": "string"
},
"summary": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"type": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | d95896495dad33a49058620a982cc8703433fe1e | 2023-01-23T18:49:22 | sources/clickup-source/resources/schemas/workspaces.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": true,
"properties": {
"avatar": {
"type": [
"string",
"null"
]
},
"color": {
"type": "string"
},
"id": {
"type": "string"
},
"members": {
"items": {
"properties": {
"user": {
"properties": {
"color": {
"type": "string"
},
"date_invited": {
"type": "string"
},
"date_joined": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "integer"
},
"initials": {
"type": "string"
},
"last_active": {
"type": "string"
},
"profilePicture": {
"type": "string"
},
"role": {
"type": "integer"
},
"username": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | 5815c1f25d36ec050c06108024d6265fcc90403b | 2023-05-23T15:56:28 | sources/statuspage-source/resources/schemas/component_groups.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"components": {
"items": {
"type": "string"
},
"type": "array"
},
"created_at": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"page_id": {
"type": "string"
},
"position": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | fb48bde582f661562f9c883f3be73364d91adf85 | 2023-01-23T22:01:23 | sources/clickup-source/resources/schemas/goals.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"archived": {
"type": "boolean"
},
"color": {
"type": "string"
},
"computedProperties": {
"properties": {
"workspace": {
"properties": {
"id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"creator": {
"type": "integer"
},
"date_created": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"folder_id": {
"type": [
"string",
"null"
]
},
"history": {
"items": {},
"type": "array"
},
"id": {
"type": "string"
},
"key_results": {
"items": {},
"type": "array"
},
"members": {
"items": {},
"type": "array"
},
"multiple_owners": {
"type": "boolean"
},
"name": {
"type": "string"
},
"owners": {
"items": {
"properties": {
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "integer"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": "string"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"percent_completed": {
"type": "number"
},
"pretty_id": {
"type": "string"
},
"pretty_url": {
"type": "string"
},
"private": {
"type": "boolean"
},
"start_date": {
"type": [
"string",
"null"
]
},
"team_id": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | 00c160534394e68df85c0484a3d48bd4885d6f4b | 2023-08-04T22:20:42 | sources/statuspage-source/resources/schemas/component_uptime.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"id": {
"type": "string"
},
"major_outage": {
"type": "integer"
},
"name": {
"type": "string"
},
"page_id": {
"type": "string"
},
"partial_outage": {
"type": "integer"
},
"range_end": {
"type": "string"
},
"range_start": {
"type": "string"
},
"related_events": {
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"uptime_percentage": {
"type": "number"
},
"warnings": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | 45ac794047afca3d2fade2bfeeff9905f611b1d0 | 2023-03-06T18:33:19 | sources/statuspage-source/resources/schemas/pages.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"activity_score": {
"type": "integer"
},
"allow_email_subscribers": {
"type": "boolean"
},
"allow_incident_subscribers": {
"type": "boolean"
},
"allow_page_subscribers": {
"type": "boolean"
},
"allow_rss_atom_feeds": {
"type": "boolean"
},
"allow_sms_subscribers": {
"type": "boolean"
},
"allow_webhook_subscribers": {
"type": "boolean"
},
"branding": {
"type": "string"
},
"city": {
"type": [
"null",
"string"
]
},
"country": {
"type": [
"null",
"string"
]
},
"created_at": {
"type": "string"
},
"css_blues": {
"type": "string"
},
"css_body_background_color": {
"type": "string"
},
"css_border_color": {
"type": "string"
},
"css_font_color": {
"type": "string"
},
"css_graph_color": {
"type": "string"
},
"css_greens": {
"type": "string"
},
"css_light_font_color": {
"type": "string"
},
"css_link_color": {
"type": "string"
},
"css_no_data": {
"type": "string"
},
"css_oranges": {
"type": "string"
},
"css_reds": {
"type": "string"
},
"css_yellows": {
"type": "string"
},
"domain": {
"type": [
"null",
"string"
]
},
"email_logo": {
"properties": {
"normal_url": {
"type": "string"
},
"original_url": {
"type": "string"
},
"retina_url": {
"type": "string"
},
"size": {
"type": [
"null",
"string"
]
},
"updated_at": {
"type": [
"null",
"string"
]
}
},
"type": "object"
},
"favicon_logo": {
"properties": {
"size": {
"type": [
"null",
"string"
]
},
"updated_at": {
"type": [
"null",
"string"
]
},
"url": {
"type": "string"
}
},
"type": "object"
},
"headline": {
"type": [
"null",
"string"
]
},
"hero_cover": {
"properties": {
"normal_url": {
"type": "string"
},
"original_url": {
"type": "string"
},
"retina_url": {
"type": "string"
},
"size": {
"type": [
"null",
"string"
]
},
"updated_at": {
"type": [
"null",
"string"
]
}
},
"type": "object"
},
"hidden_from_search": {
"type": "boolean"
},
"id": {
"type": "string"
},
"ip_restrictions": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
},
"notifications_email_footer": {
"type": "string"
},
"notifications_from_email": {
"type": [
"null",
"string"
]
},
"page_description": {
"type": [
"null",
"string"
]
},
"state": {
"type": [
"null",
"string"
]
},
"subdomain": {
"type": "string"
},
"support_url": {
"type": [
"null",
"string"
]
},
"time_zone": {
"type": "string"
},
"transactional_logo": {
"properties": {
"normal_url": {
"type": "string"
},
"original_url": {
"type": "string"
},
"retina_url": {
"type": "string"
},
"size": {
"type": [
"null",
"string"
]
},
"updated_at": {
"type": [
"null",
"string"
]
}
},
"type": "object"
},
"twitter_logo": {
"properties": {
"size": {
"type": [
"null",
"string"
]
},
"updated_at": {
"type": [
"null",
"string"
]
},
"url": {
"type": "string"
}
},
"type": "object"
},
"twitter_username": {
"type": [
"null",
"string"
]
},
"updated_at": {
"type": "string"
},
"url": {
"type": [
"null",
"string"
]
},
"viewers_must_be_team_members": {
"type": "boolean"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | d95896495dad33a49058620a982cc8703433fe1e | 2023-01-23T18:49:22 | sources/clickup-source/resources/schemas/goals.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"archived": {
"type": "boolean"
},
"color": {
"type": "string"
},
"computedProperties": {
"properties": {
"workspace": {
"properties": {
"id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"creator": {
"type": "integer"
},
"date_created": {
"type": "string"
},
"description": {
"type": "string"
},
"due_date": {
"type": [
"string",
"null"
]
},
"folder_id": {
"type": [
"string",
"null"
]
},
"history": {
"items": {},
"type": "array"
},
"id": {
"type": "string"
},
"key_results": {
"items": {},
"type": "array"
},
"members": {
"items": {},
"type": "array"
},
"multiple_owners": {
"type": "boolean"
},
"name": {
"type": "string"
},
"owners": {
"items": {
"properties": {
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "integer"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": "string"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"percent_completed": {
"type": "number"
},
"pretty_id": {
"type": "string"
},
"pretty_url": {
"type": "string"
},
"private": {
"type": "boolean"
},
"start_date": {
"type": [
"string",
"null"
]
},
"team_id": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | d95896495dad33a49058620a982cc8703433fe1e | 2023-01-23T18:49:22 | sources/clickup-source/resources/schemas/status_histories.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"computedProperties": {
"properties": {
"task": {
"properties": {
"archived": {
"type": "boolean"
},
"date_updated": {
"type": "string"
},
"id": {
"type": "string"
},
"list": {
"properties": {
"id": {
"type": "string"
}
},
"type": "object"
},
"workspace": {
"properties": {
"id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"current_status": {
"properties": {
"color": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"total_time": {
"properties": {
"by_minute": {
"type": "integer"
},
"since": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"status_history": {
"items": {
"properties": {
"color": {
"type": [
"string",
"null"
]
},
"orderindex": {
"type": "integer"
},
"status": {
"type": "string"
},
"total_time": {
"properties": {
"by_minute": {
"type": "integer"
},
"since": {
"type": "string"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | d95896495dad33a49058620a982cc8703433fe1e | 2023-01-23T18:49:22 | sources/clickup-source/resources/schemas/lists.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"archived": {
"type": "boolean"
},
"assignee": {
"type": [
"string",
"null"
]
},
"computedProperties": {
"properties": {
"workspace": {
"properties": {
"id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"content": {
"type": "string"
},
"due_date": {
"type": [
"string",
"null"
]
},
"folder": {
"properties": {
"access": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer"
},
"override_statuses": {
"type": [
"boolean",
"null"
]
},
"permission_level": {
"type": "string"
},
"priority": {
"properties": {
"color": {
"type": "string"
},
"priority": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"space": {
"properties": {
"access": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"start_date": {
"type": [
"string",
"null"
]
},
"status": {
"properties": {
"color": {
"type": "string"
},
"hide_label": {
"type": "boolean"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"task_count": {
"type": "integer"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | 5815c1f25d36ec050c06108024d6265fcc90403b | 2023-05-23T15:56:28 | sources/statuspage-source/resources/schemas/components.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"automation_email": {
"type": "string"
},
"created_at": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"group": {
"type": "boolean"
},
"group_id": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"only_show_if_degraded": {
"type": "boolean"
},
"page_id": {
"type": "string"
},
"position": {
"type": "integer"
},
"showcase": {
"type": "boolean"
},
"start_date": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | 2475fde98abd4294156759044835fc5ded0b08b8 | 2023-05-23T17:30:33 | sources/statuspage-source/resources/schemas/component_groups.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"components": {
"items": {
"type": "string"
},
"type": "array"
},
"created_at": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"page_id": {
"type": "string"
},
"position": {
"type": "number"
},
"updated_at": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
faros-ai/airbyte-connectors | d95896495dad33a49058620a982cc8703433fe1e | 2023-01-23T18:49:22 | sources/clickup-source/resources/schemas/tasks.json | 105 | 2024-05-28T04:58:55.35936Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"assignees": {
"items": {
"properties": {
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "integer"
},
"profilePicture": {
"type": "string"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"checklists": {
"items": {
"properties": {
"creator": {
"type": "integer"
},
"date_created": {
"type": "string"
},
"id": {
"type": "string"
},
"items": {
"items": {
"properties": {
"assignee": {
"type": "string"
},
"children": {
"type": "array"
},
"date_created": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer"
},
"parent": {
"type": "string"
},
"resolved": {
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer"
},
"resolved": {
"type": "integer"
},
"task_id": {
"type": "string"
},
"unresolved": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"computedProperties": {
"properties": {
"workspace": {
"properties": {
"id": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"creator": {
"properties": {
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "integer"
},
"profilePicture": {
"type": "string"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"custom_fields": {
"items": {
"properties": {
"date_created": {
"type": "string"
},
"hide_from_guests": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"type": "string"
},
"type_config": {
"properties": {},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"custom_id": {
"type": [
"string",
"null"
]
},
"date_closed": {
"type": [
"string",
"null"
]
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"dependencies": {
"items": {},
"type": "array"
},
"description": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"folder": {
"properties": {
"access": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"linked_tasks": {
"items": {},
"type": "array"
},
"list": {
"properties": {
"access": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "string"
},
"parent": {
"type": [
"string",
"null"
]
},
"permission_level": {
"type": "string"
},
"points": {
"type": [
"integer",
"null"
]
},
"priority": {
"properties": {
"color": {
"type": "string"
},
"id": {
"type": "string"
},
"orderindex": {
"type": "string"
},
"priority": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"project": {
"properties": {
"access": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"space": {
"properties": {
"id": {
"type": "string"
}
},
"type": "object"
},
"start_date": {
"type": [
"string",
"null"
]
},
"status": {
"properties": {
"color": {
"type": "string"
},
"orderindex": {
"type": "integer"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"tags": {
"items": {
"properties": {
"name": {
"type": "string"
},
"tag_bg": {
"type": "string"
},
"tag_fg": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"team_id": {
"type": "string"
},
"text_content": {
"type": [
"string",
"null"
]
},
"time_estimate": {
"type": [
"number",
"null"
]
},
"url": {
"type": "string"
},
"watchers": {
"items": {
"properties": {
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "integer"
},
"profilePicture": {
"type": "string"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
} | Apache-2.0 | en |
fminna/mycharts | f783e417b60d69290482af3a06f67105680071f8 | 2023-06-20T15:30:30 | nginx-ingress/values.schema.json | 16 | 2024-05-27T03:04:09.459234Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"controller": {
"affinity": {},
"appprotect": {
"enable": false,
"logLevel": "fatal"
},
"appprotectdos": {
"debug": false,
"enable": false,
"maxDaemons": 0,
"maxWorkers": 0,
"memory": 0
},
"config": {
"annotations": {},
"entries": {},
"name": ""
},
"customConfigMap": "",
"customPorts": [],
"defaultTLS": {
"cert": "",
"key": "",
"secret": ""
},
"disableIPV6": false,
"enableCertManager": false,
"enableCustomResources": true,
"enableExternalDNS": false,
"enableLatencyMetrics": false,
"enableOIDC": false,
"enablePreviewPolicies": false,
"enableSnippets": false,
"enableTLSPassthrough": false,
"env": [],
"extraContainers": [],
"globalConfiguration": {
"create": false,
"spec": {}
},
"healthStatus": false,
"healthStatusURI": "/nginx-health",
"hostNetwork": false,
"image": {
"digest": "",
"pullPolicy": "IfNotPresent",
"repository": "nginx/nginx-ingress",
"tag": "2.3.1"
},
"includeYear": false,
"ingressClass": "nginx",
"initContainers": [],
"kind": "deployment",
"lifecycle": {},
"logLevel": 1,
"minReadySeconds": 0,
"name": "",
"nginxDebug": false,
"nginxReloadTimeout": 60000,
"nginxStatus": {
"allowCidrs": "127.0.0.1",
"enable": true,
"port": 8080
},
"nginxplus": false,
"nodeSelector": {},
"pod": {
"annotations": {},
"extraLabels": {}
},
"podDisruptionBudget": {
"annotations": {},
"enabled": false,
"minAvailable": 0,
"minUnavailable": 0
},
"priorityClassName": "",
"readOnlyRootFilesystem": false,
"readyStatus": {
"enable": true,
"initialDelaySeconds": 0,
"port": 8081
},
"replicaCount": 1,
"reportIngressStatus": {
"annotations": {},
"enable": true,
"enableLeaderElection": true,
"externalService": "",
"ingressLink": "",
"leaderElectionLockName": ""
},
"resources": {
"requests": {
"cpu": "100m",
"memory": "128Mi"
}
},
"service": {
"allocateLoadBalancerNodePorts": false,
"annotations": {},
"create": true,
"customPorts": [],
"externalIPs": [],
"externalTrafficPolicy": "Local",
"extraLabels": {},
"httpPort": {
"enable": true,
"nodePort": "",
"port": 80,
"targetPort": 80
},
"httpsPort": {
"enable": true,
"nodePort": "",
"port": 443,
"targetPort": 443
},
"ipFamilies": [],
"ipFamilyPolicy": "",
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"type": "LoadBalancer"
},
"serviceAccount": {
"imagePullSecretName": "",
"name": ""
},
"serviceMonitor": {
"create": false,
"endpoints": {},
"labels": {},
"selectorMatchLabels": {}
},
"setAsDefaultIngress": false,
"strategy": {},
"terminationGracePeriodSeconds": 30,
"tolerations": [],
"topologySpreadConstraints": {},
"volumeMounts": [],
"volumes": [],
"watchNamespace": "",
"wildcardTLS": {
"cert": "",
"key": "",
"secret": ""
}
},
"nginxServiceMesh": {
"enable": false,
"enableEgress": false
},
"prometheus": {
"create": true,
"port": 9113,
"scheme": "http",
"secret": ""
},
"rbac": {
"create": true
},
"serviceInsight": {
"create": true,
"port": 9114,
"scheme": "http",
"secret": ""
}
}
],
"properties": {
"controller": {
"default": {},
"examples": [
{
"affinity": {},
"appprotect": {
"enable": false,
"logLevel": "fatal"
},
"appprotectdos": {
"debug": false,
"enable": false,
"maxDaemons": 0,
"maxWorkers": 0,
"memory": 0
},
"config": {
"annotations": {},
"entries": {},
"name": ""
},
"customConfigMap": "",
"customPorts": [],
"defaultTLS": {
"cert": "",
"key": "",
"secret": ""
},
"disableIPV6": false,
"enableCertManager": false,
"enableCustomResources": true,
"enableExternalDNS": false,
"enableLatencyMetrics": false,
"enableOIDC": false,
"enablePreviewPolicies": false,
"enableSnippets": false,
"enableTLSPassthrough": false,
"env": [],
"extraContainers": [],
"globalConfiguration": {
"create": false,
"spec": {}
},
"healthStatus": false,
"healthStatusURI": "/nginx-health",
"hostNetwork": false,
"image": {
"digest": "",
"pullPolicy": "IfNotPresent",
"repository": "nginx/nginx-ingress",
"tag": "2.3.1"
},
"includeYear": false,
"ingressClass": "nginx",
"initContainers": [],
"kind": "deployment",
"lifecycle": {},
"logLevel": 1,
"minReadySeconds": 0,
"name": "",
"nginxDebug": false,
"nginxReloadTimeout": 60000,
"nginxStatus": {
"allowCidrs": "127.0.0.1",
"enable": true,
"port": 8080
},
"nginxplus": false,
"nodeSelector": {},
"pod": {
"annotations": {},
"extraLabels": {}
},
"priorityClassName": "",
"readOnlyRootFilesystem": false,
"readyStatus": {
"enable": true,
"initialDelaySeconds": 0,
"port": 8081
},
"replicaCount": 1,
"reportIngressStatus": {
"annotations": {},
"enable": true,
"enableLeaderElection": true,
"externalService": "",
"ingressLink": "",
"leaderElectionLockName": ""
},
"resources": {
"requests": {
"cpu": "100m",
"memory": "128Mi"
}
},
"service": {
"allocateLoadBalancerNodePorts": false,
"annotations": {},
"create": true,
"customPorts": [],
"externalIPs": [],
"externalTrafficPolicy": "Local",
"extraLabels": {},
"httpPort": {
"enable": true,
"port": 80,
"targetPort": 80
},
"httpsPort": {
"enable": true,
"port": 443,
"targetPort": 443
},
"ipFamilies": [],
"ipFamilyPolicy": "",
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"type": "LoadBalancer"
},
"serviceAccount": {
"imagePullSecretName": "",
"name": ""
},
"serviceMonitor": {
"create": false,
"endpoints": {},
"labels": {},
"selectorMatchLabels": {}
},
"setAsDefaultIngress": false,
"strategy": {},
"terminationGracePeriodSeconds": 30,
"tolerations": [],
"topologySpreadConstraints": {},
"volumeMounts": [],
"volumes": [],
"watchNamespace": "",
"wildcardTLS": {
"cert": "",
"key": "",
"secret": ""
}
}
],
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity",
"default": {},
"title": "The affinity Schema",
"type": "object"
},
"annotations": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"appprotect": {
"default": {},
"examples": [
{
"enable": true,
"logLevel": "fatal"
}
],
"properties": {
"enable": {
"default": false,
"examples": [
false,
true
],
"title": "Enable the App Protect WAF module in the Ingress Controller",
"type": "boolean"
},
"logLevel": {
"default": "",
"enum": [
"fatal",
"error",
"warn",
"info",
"debug",
"trace"
],
"examples": [
"fatal",
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "The logLevel for App Protect WAF",
"type": "string"
}
},
"required": [
"enable"
],
"title": "The App Protect WAF Schema",
"type": "object"
},
"appprotectdos": {
"default": {},
"examples": [
{
"debug": false,
"enable": true,
"maxDaemons": 0,
"maxWorkers": 0,
"memory": 0
}
],
"properties": {
"debug": {
"default": false,
"examples": [
false,
true
],
"title": "debugging for App Protect DoS",
"type": "boolean"
},
"enable": {
"default": false,
"examples": [
false,
true
],
"title": "Enable the App Protect DoS module in the Ingress Controller",
"type": "boolean"
},
"maxDaemons": {
"default": 0,
"examples": [
0
],
"title": "Max number of ADMD instances",
"type": "integer"
},
"maxWorkers": {
"default": 0,
"examples": [
0
],
"title": "Max number of nginx processes to support",
"type": "integer"
},
"memory": {
"default": 0,
"examples": [
0
],
"title": "RAM memory size to consume in MB",
"type": "integer"
}
},
"required": [
"enable"
],
"title": "The App Protect DoS Schema",
"type": "object"
},
"config": {
"default": {},
"examples": [
{
"annotations": {},
"entries": {},
"name": ""
}
],
"properties": {
"annotations": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"entries": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The entries Schema",
"type": "object"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The config Schema",
"type": "object"
},
"customConfigMap": {
"default": "",
"examples": [
""
],
"title": "The customConfigMap Schema",
"type": "string"
},
"customPorts": {
"default": [],
"examples": [
[
{
"containerPort": 80,
"name": "http",
"protocol": "TCP"
},
{
"containerPort": 443,
"name": "https",
"protocol": "TCP"
}
]
],
"items": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort",
"type": "object"
},
"title": "The customPorts to expose on the NGINX Ingress Controller pod",
"type": "array"
},
"defaultTLS": {
"default": {},
"examples": [],
"properties": {
"cert": {
"default": "",
"examples": [],
"title": "The cert Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [],
"title": "The key Schema",
"type": "string"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
}
},
"required": [],
"title": "The defaultTLS Schema",
"type": "object"
},
"disableIPV6": {
"default": false,
"examples": [
false
],
"title": "The disableIPV6",
"type": "boolean"
},
"dnsPolicy": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy"
},
{
"enum": [
"ClusterFirstWithHostNet",
"ClusterFirst",
"Default",
"None"
]
}
],
"type": "string"
},
"enableCertManager": {
"default": false,
"examples": [
false
],
"title": "The enableCertManager",
"type": "boolean"
},
"enableCustomResources": {
"default": false,
"examples": [
true
],
"title": "The enableCustomResources",
"type": "boolean"
},
"enableExternalDNS": {
"default": false,
"examples": [
false
],
"title": "The enableExternalDNS",
"type": "boolean"
},
"enableLatencyMetrics": {
"default": false,
"examples": [
false
],
"title": "The enableLatencyMetrics",
"type": "boolean"
},
"enableOIDC": {
"default": false,
"examples": [
false
],
"title": "The enableOIDC",
"type": "boolean"
},
"enablePreviewPolicies": {
"default": false,
"examples": [
false
],
"title": "The enablePreviewPolicies",
"type": "boolean"
},
"enableSnippets": {
"default": false,
"examples": [
false
],
"title": "The enableSnippets",
"type": "boolean"
},
"enableTLSPassthrough": {
"default": false,
"examples": [
false
],
"title": "The enableTLSPassthrough",
"type": "boolean"
},
"env": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar",
"type": "object"
},
"title": "The env Schema",
"type": "array"
},
"extraContainers": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.Container",
"type": "object"
},
"title": "The extraContainers Schema",
"type": "array"
},
"globalConfiguration": {
"default": {},
"examples": [
{
"create": false,
"spec": {}
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"spec": {
"default": {},
"examples": [
{}
],
"properties": {
"listeners": {
"default": [],
"items": {
"default": {},
"properties": {
"name": {
"default": "",
"examples": [
"dns-tcp"
],
"title": "The name",
"type": "string"
},
"port": {
"default": 0,
"examples": [
5353
],
"title": "The port",
"type": "integer"
},
"protocol": {
"default": "",
"examples": [
"TCP"
],
"title": "The protocol",
"type": "string"
}
},
"type": "object"
},
"title": "The listeners Schema",
"type": "array"
}
},
"required": [],
"title": "The spec Schema",
"type": "object"
}
},
"required": [
"create",
"spec"
],
"title": "The globalConfiguration Schema",
"type": "object"
},
"healthStatus": {
"default": false,
"examples": [
false
],
"title": "The healthStatus",
"type": "boolean"
},
"healthStatusURI": {
"default": "/nginx-health",
"examples": [
"/nginx-health"
],
"format": "uri-reference",
"title": "The healthStatusURI Schema",
"type": "string"
},
"hostNetwork": {
"default": false,
"examples": [
false,
true
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"pullPolicy": "IfNotPresent",
"repository": "nginx/nginx-ingress",
"tag": "2.3.1"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572"
],
"title": "The digest of the Ingress Controller image",
"type": "string"
},
"pullPolicy": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy"
},
{
"enum": [
"Always",
"IfNotPresent",
"Never"
]
}
],
"default": "IfNotPresent",
"examples": [
"Always",
"IfNotPresent",
"Never"
],
"title": "The pullPolicy for the Ingress Controller image",
"type": "string"
},
"repository": {
"default": "nginx/nginx-ingress",
"examples": [
"nginx/nginx-ingress"
],
"title": "The repository of the Ingress Controller",
"type": "string"
},
"tag": {
"default": "2.3.1",
"examples": [
"2.3.1"
],
"title": "The tag of the Ingress Controller image",
"type": "string"
}
},
"required": [
"repository"
],
"title": "The image Schema",
"type": "object"
},
"includeYear": {
"default": false,
"examples": [
false
],
"title": "The includeYear",
"type": "boolean"
},
"ingressClass": {
"default": "",
"examples": [
"nginx"
],
"title": "The ingressClass",
"type": "string"
},
"initContainers": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.Container",
"type": "object"
},
"title": "The initContainers Schema",
"type": "array"
},
"kind": {
"default": "",
"enum": [
"deployment",
"daemonset"
],
"examples": [
"deployment",
"daemonset"
],
"title": "The kind of the Ingress Controller",
"type": "string"
},
"lifecycle": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle",
"default": {},
"title": "The lifecycle Schema",
"type": "object"
},
"logLevel": {
"default": 1,
"enum": [
0,
1,
2,
3
],
"examples": [
1
],
"title": "The logLevel of the Ingress Controller",
"type": "integer"
},
"minReadySeconds": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds",
"default": 0,
"title": "The minReadySeconds Schema",
"type": "integer"
},
"name": {
"default": "",
"examples": [
"controller"
],
"title": "The name of the Ingress Controller",
"type": "string"
},
"nginxDebug": {
"default": false,
"examples": [
false,
true
],
"title": "Enables debugging for NGINX",
"type": "boolean"
},
"nginxReloadTimeout": {
"default": 0,
"examples": [
60000
],
"title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start",
"type": "integer"
},
"nginxStatus": {
"default": {},
"examples": [
{
"allowCidrs": "127.0.0.1",
"enable": true,
"port": 8080
}
],
"properties": {
"allowCidrs": {
"default": "127.0.0.1",
"examples": [
"127.0.0.1"
],
"title": "The allowCidrs",
"type": "string"
},
"enable": {
"default": false,
"examples": [
true
],
"title": "The enable",
"type": "boolean"
},
"port": {
"default": 8080,
"examples": [
8080
],
"title": "The port",
"type": "integer"
}
},
"required": [],
"title": "The nginxStatus Schema",
"type": "object"
},
"nginxplus": {
"default": false,
"examples": [
false,
true
],
"title": "Deploys the Ingress Controller for NGINX Plus",
"type": "boolean"
},
"nodeSelector": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector",
"default": {},
"title": "The nodeSelector Schema",
"type": "object"
},
"pod": {
"default": {},
"examples": [
{
"annotations": {},
"extraLabels": {}
}
],
"properties": {
"annotations": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"extraLabels": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels",
"default": {},
"title": "The extraLabels Schema",
"type": "object"
}
},
"required": [],
"title": "The pod Schema",
"type": "object"
},
"podDisruptionBudget": {
"default": {},
"examples": [
{
"enable": true,
"minAvailable": 1
},
{
"enable": true,
"maxUnavailable": 1
}
],
"properties": {
"annotations": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxUnavailable": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/maxUnavailable"
},
"minAvailable": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.policy.v1.PodDisruptionBudgetSpec/properties/minAvailable"
}
},
"required": [
"enabled"
],
"title": "The podDisruptionBudget Schema",
"type": "object"
},
"priorityClassName": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName",
"default": "",
"title": "The priorityClassName",
"type": "string"
},
"readOnlyRootFilesystem": {
"default": false,
"examples": [
false
],
"title": "The readOnlyRootFilesystem",
"type": "boolean"
},
"readyStatus": {
"default": {},
"examples": [
{
"enable": true,
"initialDelaySeconds": 0,
"port": 8081
}
],
"properties": {
"enable": {
"default": false,
"examples": [
true
],
"title": "The enable",
"type": "boolean"
},
"initialDelaySeconds": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds",
"default": 0,
"type": "integer"
},
"port": {
"default": 0,
"examples": [
8081
],
"title": "The port",
"type": "integer"
}
},
"required": [],
"title": "The readyStatus",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "The replicaCount",
"type": "integer"
},
"reportIngressStatus": {
"default": {},
"examples": [
{
"annotations": {},
"enable": true,
"enableLeaderElection": true,
"externalService": "",
"ingressLink": "",
"leaderElectionLockName": ""
}
],
"properties": {
"annotations": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"enable": {
"default": false,
"examples": [
true
],
"title": "The enable",
"type": "boolean"
},
"enableLeaderElection": {
"default": false,
"examples": [
true
],
"title": "The enableLeaderElection",
"type": "boolean"
},
"externalService": {
"default": "",
"examples": [
""
],
"title": "The externalService",
"type": "string"
},
"ingressLink": {
"default": "",
"examples": [
""
],
"title": "The ingressLink",
"type": "string"
},
"leaderElectionLockName": {
"default": "",
"examples": [
""
],
"title": "The leaderElectionLockName",
"type": "string"
}
},
"required": [
"enable"
],
"title": "The reportIngressStatus Schema",
"type": "object"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"default": {},
"title": "The resources Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"allocateLoadBalancerNodePorts": false,
"annotations": {},
"create": true,
"customPorts": [],
"externalIPs": [],
"externalTrafficPolicy": "Local",
"extraLabels": {},
"httpPort": {
"enable": true,
"port": 80,
"targetPort": 80
},
"httpsPort": {
"enable": true,
"port": 443,
"targetPort": 443
},
"ipFamilies": [],
"ipFamilyPolicy": "",
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"name": "",
"type": "LoadBalancer"
}
],
"properties": {
"allocateLoadBalancerNodePorts": {
"default": false,
"ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts",
"title": "The allocateLoadBalancerNodePorts Schema",
"type": "boolean"
},
"annotations": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create",
"type": "boolean"
},
"customPorts": {
"default": [],
"items": {
"ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort",
"type": "object"
},
"title": "The customPorts",
"type": "array"
},
"externalIPs": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs",
"default": [],
"title": "The externalIPs",
"type": "array"
},
"externalTrafficPolicy": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy",
"default": "",
"title": "The externalTrafficPolicy",
"type": "string"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels",
"type": "object"
},
"httpPort": {
"default": {},
"examples": [
{
"enable": true,
"nodePort": "",
"port": 80,
"targetPort": 80
}
],
"properties": {
"enable": {
"default": false,
"examples": [
true
],
"title": "The enable",
"type": "boolean"
},
"nodePort": {
"default": 0,
"examples": [
443
],
"title": "The nodePort",
"type": "integer"
},
"port": {
"default": 0,
"examples": [
80
],
"title": "The port",
"type": "integer"
},
"targetPort": {
"default": 0,
"examples": [
80
],
"title": "The targetPort",
"type": "integer"
}
},
"required": [],
"title": "The httpPort",
"type": "object"
},
"httpsPort": {
"default": {},
"examples": [
{
"enable": true,
"nodePort": "",
"port": 443,
"targetPort": 443
}
],
"properties": {
"enable": {
"default": false,
"examples": [
true
],
"title": "The enable",
"type": "boolean"
},
"nodePort": {
"default": 0,
"examples": [
443
],
"title": "The nodePort",
"type": "integer"
},
"port": {
"default": 0,
"examples": [
443
],
"title": "The port",
"type": "integer"
},
"targetPort": {
"default": 0,
"examples": [
443
],
"title": "The targetPort",
"type": "integer"
}
},
"required": [],
"title": "The httpsPort",
"type": "object"
},
"ipFamilies": {
"default": [],
"ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies",
"title": "The ipFamilies Schema",
"type": "array"
},
"ipFamilyPolicy": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy",
"default": "",
"examples": [
""
],
"title": "The ipFamilyPolicy Schema",
"type": "string"
},
"loadBalancerIP": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP",
"default": "",
"title": "The loadBalancerIP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The loadBalancerSourceRanges",
"type": "array"
},
"type": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type",
"default": "",
"title": "The type",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"imagePullSecretName": "",
"name": ""
}
],
"properties": {
"annotations": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"imagePullSecretName": {
"default": "",
"examples": [
""
],
"title": "The imagePullSecretName",
"type": "string"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"create": false,
"endpoints": [],
"labels": {},
"selectorMatchLabels": {}
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create",
"type": "boolean"
},
"endpoints": {
"default": [],
"items": {},
"required": [],
"title": "The endpoints",
"type": "array"
},
"labels": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels",
"default": {},
"title": "The labels Schema",
"type": "object"
},
"selectorMatchLabels": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels",
"default": {},
"title": "The selectorMatchLabels Schema",
"type": "object"
}
},
"required": [],
"title": "The serviceMonitor Schema",
"type": "object"
},
"setAsDefaultIngress": {
"default": false,
"examples": [
false
],
"title": "The setAsDefaultIngress",
"type": "boolean"
},
"strategy": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy"
},
{
"properties": {
"type": {
"enum": [
"Recreate",
"RollingUpdate",
"OnDelete"
],
"type": "string"
}
}
}
],
"default": {},
"title": "The strategy Schema",
"type": "object"
},
"terminationGracePeriodSeconds": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds",
"default": 30,
"title": "The terminationGracePeriodSeconds Schema",
"type": "integer"
},
"tolerations": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration",
"type": "object"
},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/topologySpreadConstraints",
"default": {},
"title": "The topologySpreadConstraints Schema",
"type": "object"
},
"volumeMounts": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount",
"type": "object"
},
"title": "The volumeMounts Schema",
"type": "array"
},
"volumes": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/nginxinc/kubernetes-json-schema/master/v1.26.1/_definitions.json#/definitions/io.k8s.api.core.v1.Volume",
"type": "object"
},
"title": "The volumes Schema",
"type": "array"
},
"watchNamespace": {
"default": "",
"examples": [
""
],
"title": "The watchNamespace",
"type": "string"
},
"watchSecretNamespace": {
"default": "",
"examples": [
""
],
"title": "The watchSecretNamespace",
"type": "string"
},
"wildcardTLS": {
"default": {},
"examples": [],
"properties": {
"cert": {
"default": "",
"examples": [
""
],
"title": "The cert Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
}
},
"required": [],
"title": "The wildcardTLS Schema",
"type": "object"
}
},
"required": [
"name",
"kind",
"image"
],
"title": "The Ingress Controller Helm Schema",
"type": "object"
},
"nginxServiceMesh": {
"default": {},
"examples": [
{
"enable": false,
"enableEgress": false
}
],
"properties": {
"enable": {
"default": false,
"examples": [
false
],
"title": "The enable",
"type": "boolean"
},
"enableEgress": {
"default": false,
"examples": [
false
],
"title": "The enableEgress",
"type": "boolean"
}
},
"required": [
"enable"
],
"title": "The nginxServiceMesh Schema",
"type": "object"
},
"prometheus": {
"default": {},
"examples": [
{
"create": true,
"port": 9113,
"scheme": "http",
"secret": ""
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create",
"type": "boolean"
},
"port": {
"default": 9113,
"examples": [
9113
],
"title": "The port",
"type": "integer"
},
"scheme": {
"default": "http",
"examples": [
"http"
],
"title": "The scheme",
"type": "string"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret",
"type": "string"
}
},
"required": [
"create"
],
"title": "The prometheus Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The rbac Schema",
"type": "object"
},
"serviceInsight": {
"default": {},
"examples": [
{
"create": true,
"port": 9114,
"scheme": "http",
"secret": ""
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create",
"type": "boolean"
},
"port": {
"default": 9114,
"examples": [
9114
],
"title": "The port",
"type": "integer"
},
"scheme": {
"default": "http",
"examples": [
"http"
],
"title": "The scheme",
"type": "string"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret",
"type": "string"
}
},
"required": [
"create"
],
"title": "The Service Insight Schema",
"type": "object"
}
},
"required": [
"controller",
"rbac",
"prometheus",
"serviceInsight",
"nginxServiceMesh"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
fminna/mycharts | f783e417b60d69290482af3a06f67105680071f8 | 2023-06-20T15:30:30 | sonarqube/values.schema.json | 16 | 2024-05-27T03:04:09.459234Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"jvmCeOpts": {
"$comment": "(DEPRECATED) Please use SONAR_CE_JAVAOPTS or sonar.ce.javaOpts",
"deprecated": true,
"type": "string"
},
"jvmOpts": {
"$comment": "(DEPRECATED) Please use SONAR_WEB_JAVAOPTS or sonar.web.javaOpts",
"deprecated": true,
"type": "string"
},
"replicaCount": {
"enum": [
0,
1
],
"type": "integer"
}
},
"required": [
"replicaCount"
]
} | Apache-2.0 | en |
fminna/mycharts | f783e417b60d69290482af3a06f67105680071f8 | 2023-06-20T15:30:30 | metallb/values.schema.json | 16 | 2024-05-27T03:04:09.459234Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"controller": {
"allOf": [
{
"$ref": "#/definitions/component"
},
{
"description": "MetalLB Controller",
"properties": {
"command": {
"type": "string"
},
"strategy": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"webhookMode": {
"type": "string"
}
},
"type": "object"
}
]
},
"definitions": {
"component": {
"properties": {
"affinity": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"image": {
"properties": {
"pullPolicy": {
"anyOf": [
{
"type": "null"
},
{
"enum": [
"Always",
"IfNotPresent",
"Never"
],
"type": "string"
}
]
},
"repository": {
"type": "string"
},
"tag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"type": "object"
},
"livenessProbe": {
"$ref": "#/definitions/probe"
},
"logLevel": {
"enum": [
"all",
"debug",
"info",
"warn",
"error",
"none"
],
"type": "string"
},
"nodeSelector": {
"type": "object"
},
"podAnnotations": {
"type": "object"
},
"priorityClassName": {
"type": "string"
},
"readinessProbe": {
"$ref": "#/definitions/probe"
},
"resources": {
"type": "object"
},
"runtimeClassName": {
"type": "string"
},
"serviceAccount": {
"properties": {
"annotations": {
"type": "object"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"image",
"serviceAccount"
],
"type": "object"
},
"probe": {
"properties": {
"enabled": {
"type": "boolean"
},
"failureThreshold": {
"type": "integer"
},
"initialDelaySeconds": {
"type": "integer"
},
"periodSeconds": {
"type": "integer"
},
"successThreshold": {
"type": "integer"
},
"timeoutSeconds": {
"type": "integer"
}
},
"required": [
"failureThreshold",
"initialDelaySeconds",
"periodSeconds",
"successThreshold",
"timeoutSeconds"
],
"type": "object"
},
"prometheusAlert": {
"properties": {
"enabled": {
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"properties": {
"configInLine": {
"description": "MetalLB configuration",
"type": "object"
},
"crds": {
"description": "CRD configuration",
"properties": {
"enabled": {
"description": "Enable CRDs",
"type": "boolean"
},
"validationFailurePolicy": {
"description": "Failure policy to use with validating webhooks",
"enum": [
"Ignore",
"Fail"
],
"type": "string"
}
},
"type": "object"
},
"fullNameOverride": {
"description": "Override fully qualified app name",
"type": "string"
},
"imagePullSecrets": {
"description": "Secrets used for pulling images",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"loadBalancerClass": {
"type": "string"
},
"nameOverride": {
"description": "Override chart name",
"type": "string"
},
"prometheus": {
"description": "Prometheus monitoring config",
"properties": {
"metricsPort": {
"type": "integer"
},
"namespace": {
"type": "string"
},
"podMonitor": {
"description": "Prometheus Operator PodMonitors",
"properties": {
"additionalMonitors": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"interval": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"jobLabel": {
"type": "string"
},
"metricRelabelings": {
"items": {
"type": "object"
},
"type": "array"
},
"relabelings": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"prometheusRule": {
"description": "Prometheus Operator alertmanager alerts",
"properties": {
"additionalMonitors": {
"type": "object"
},
"addressPoolExhausted": {
"$ref": "#/definitions/prometheusAlert"
},
"addressPoolUsage": {
"properties": {
"enabled": {
"type": "boolean"
},
"thresholds": {
"items": {
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"required": [
"percent"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled"
],
"type": "object"
},
"bgpSessionDown": {
"$ref": "#/definitions/prometheusAlert"
},
"configNotLoaded": {
"$ref": "#/definitions/prometheusAlert"
},
"enabled": {
"type": "boolean"
},
"extraAlerts": {
"items": {
"type": "object"
},
"type": "array"
},
"staleConfig": {
"$ref": "#/definitions/prometheusAlert"
}
},
"required": [
"enabled",
"staleConfig",
"configNotLoaded",
"addressPoolExhausted",
"addressPoolUsage",
"bgpSessionDown"
],
"type": "object"
},
"rbacPrometheus": {
"type": "boolean"
},
"rbacProxy": {
"description": "kube-rbac-proxy configuration",
"properties": {
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"scrapeAnnotations": {
"type": "boolean"
},
"secureMetricsPort": {
"type": "integer"
},
"serviceAccount": {
"type": "string"
},
"serviceMonitor": {
"description": "Prometheus Operator ServiceMonitors",
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"jobLabel": {
"type": "string"
},
"metricRelabelings": {
"items": {
"type": "object"
},
"type": "array"
},
"relabelings": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"required": [
"podMonitor",
"prometheusRule"
],
"type": "object"
},
"rbac": {
"description": "RBAC configuration",
"properties": {
"create": {
"description": "Enable RBAC",
"type": "boolean"
}
},
"type": "object"
},
"speaker": {
"allOf": [
{
"$ref": "#/definitions/component"
},
{
"description": "MetalLB Speaker",
"properties": {
"command": {
"type": "string"
},
"excludeInterfaces": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"frr": {
"description": "Install FRR container in speaker deployment",
"properties": {
"enabled": {
"type": "boolean"
},
"image": {
"$ref": "#/definitions/component/properties/image"
},
"metricsPort": {
"type": "integer"
},
"resources:": {
"type": "object"
},
"secureMetricsPort": {
"type": "integer"
}
},
"required": [
"enabled"
],
"type": "object"
},
"frrMetrics": {
"properties": {
"resources": {
"type": "object"
}
},
"type": "object"
},
"memberlist": {
"properties": {
"enabled": {
"type": "boolean"
},
"mlBindPort": {
"type": "integer"
},
"mlSecretKeyPath": {
"type": "string"
}
},
"type": "object"
},
"reloader": {
"properties": {
"resources": {
"type": "object"
}
},
"type": "object"
},
"runtimeClassName": {
"type": "string"
},
"secretName": {
"type": "string"
},
"tolerateMaster": {
"type": "boolean"
},
"updateStrategy": {
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"tolerateMaster"
],
"type": "object"
}
]
}
},
"required": [
"controller",
"speaker"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
lucasvr/hdf5-udf | f7bcc85477cb83edb457cc4e66359e861a1a56b5 | 2021-04-19T16:40:16 | python-bindings/hdf5_udf_resources/hdf5_udf-schema.json | 21 | 2024-05-28T05:54:46.647561Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "**Schema**",
"properties": {
"datatype": {
"description": "**Data type**",
"enum": [
"int8",
"uint8",
"int16",
"uint16",
"int32",
"uint32",
"int64",
"uint64",
"float",
"double",
"string",
"compound"
],
"type": "string"
},
"members": {
"description": "**Compound members**",
"items": {
"properties": {
"datatype": {
"description": "**Compound member data type**",
"enum": [
"int8",
"uint8",
"int16",
"uint16",
"int32",
"uint32",
"int64",
"uint64",
"float",
"double",
"string"
],
"type": "string"
},
"name": {
"description": "**Compound member name**",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"name": {
"description": "**Dataset name**",
"type": "string"
},
"resolution": {
"description": "**Dataset dimensions**",
"items": {
"exclusiveMinimum": 0,
"type": "number"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"datatype",
"resolution"
],
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | ee33a9fdbe52683a666e517dd7b1a015b2472849 | 2023-04-10T13:14:38 | csbschema/data/CSB-schema-3_1_0-2023-03.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_1_0-2023-03.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"required": [
"type",
"name",
"length",
"IDType",
"IDNumber",
"soundSpeedDocumented",
"positionOffsetsDocumented",
"dataProcessed"
],
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"soundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 0950341f78a9151e6a64e7607a2065f842c68b3f | 2023-04-10T14:11:25 | csbschema/data/CSB-schema-3_1_0-2023-03.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_1_0-2023-03.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"required": [
"type",
"name",
"length",
"IDType",
"IDNumber",
"soundSpeedDocumented",
"positionOffsetsDocumented",
"dataProcessed"
],
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"soundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | cf817f4fbc8333b816308c32147ce8d8f20aef8b | 2024-04-19T14:44:53 | csbschema/data/XYZ-CSB-schema-3_1_0-2024-04.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/XYZ-CSB-schema-3_1_0-2023-08.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"required": [
"type",
"name",
"length",
"IDType",
"IDNumber",
"soundSpeedDocumented",
"positionOffsetsDocumented",
"dataProcessed"
],
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeStampInterpolation"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"XYZ GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata (to accompany separate XYZ data), version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 0950341f78a9151e6a64e7607a2065f842c68b3f | 2023-04-10T14:11:25 | csbschema/data/CSB-schema-3_2_0-BETA.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_2_0-BETA.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"observationCollection": {
"$ref": "#/definitions/ObservationCollection"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNodePlatform"
}
},
"required": [
"trustedNodePlatform"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"ObservationCollection": {
"properties": {
"platform": {
"$ref": "#/definitions/ObservationCollectionPlatform"
},
"processing": {
"$ref": "#/definitions/ObservationCollectionProcessing"
},
"trustedNode": {
"$ref": "#/definitions/ObservationCollectionTrustedNode"
}
},
"type": "object"
},
"ObservationCollectionPlatform": {
"properties": {
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
}
},
"type": "object"
},
"ObservationCollectionProcessing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ObservationCollectionTrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.2"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"type": "object"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"soundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNodePlatform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID"
],
"type": "object"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.2.0-BETA",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 6c605034f622efeef7faf50fbabf3af4593be54c | 2024-04-26T18:03:56 | csbschema/data/CSB-schema-3_1_0-2024-04.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_1_0-2023-08.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
},
"uncertainty": {
"description": "3-tuple composed of: horizontal X (i.e. east-to-west) uncertainty, horizontal Y (i.e. north-to-south) uncertainty, and vertical Z uncertainty (i.e. depth uncertainty)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeStampInterpolation"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"algorithm": {
"description": "Algorithm used to reduce raw data to a vertical reference system.",
"type": "string"
},
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to reduce raw data to a vertical reference system.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 0d6781ad625e7bc4d597ae51460d7f3675e8b3f1 | 2024-04-26T17:46:42 | csbschema/data/XYZ-CSB-schema-3_1_0-2024-04.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/XYZ-CSB-schema-3_1_0-2023-08.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeStampInterpolation"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"XYZ GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata (to accompany separate XYZ data), version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 3856331fce8f720a13af8ec28c615402f47f6476 | 2024-05-14T13:16:10 | csbschema/data/XYZ-CSB-schema-3_1_0-2024-04.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/XYZ-CSB-schema-3_1_0-2024-04.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeStampInterpolation"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"algorithm": {
"description": "Algorithm used to reduce raw data to a vertical reference system.",
"type": "string"
},
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to reduce raw data to a vertical reference system.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"XYZ GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata (to accompany separate XYZ data), version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 9b01d83849b490bec81264930dff119e2fa77407 | 2023-08-01T19:30:58 | csbschema/data/CSB-schema-3_1_0-2023-08.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_1_0-2023-08.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
},
"uncertainty": {
"description": "3-tuple composed of: horizontal X (i.e. east-to-west) uncertainty, horizontal Y (i.e. north-to-south) uncertainty, and vertical Z uncertainty (i.e. depth uncertainty)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"required": [
"type",
"name",
"length",
"IDType",
"IDNumber",
"soundSpeedDocumented",
"positionOffsetsDocumented",
"dataProcessed"
],
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"soundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 6c605034f622efeef7faf50fbabf3af4593be54c | 2024-04-26T18:03:56 | csbschema/data/XYZ-CSB-schema-3_1_0-2024-04.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/XYZ-CSB-schema-3_1_0-2023-08.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeStampInterpolation"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"algorithm": {
"description": "Algorithm used to reduce raw data to a vertical reference system.",
"type": "string"
},
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to reduce raw data to a vertical reference system.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"XYZ GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata (to accompany separate XYZ data), version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 3856331fce8f720a13af8ec28c615402f47f6476 | 2024-05-14T13:16:10 | csbschema/data/CSB-schema-3_1_0-2024-04.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_1_0-2024-04.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
},
"uncertainty": {
"description": "3-tuple composed of: horizontal X (i.e. east-to-west) uncertainty, horizontal Y (i.e. north-to-south) uncertainty, and vertical Z uncertainty (i.e. depth uncertainty)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeStampInterpolation"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"algorithm": {
"description": "Algorithm used to reduce raw data to a vertical reference system.",
"type": "string"
},
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to reduce raw data to a vertical reference system.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 65d3f9de077fef27c509f73213a9136f6b6d5af7 | 2023-08-04T20:12:37 | csbschema/data/XYZ-CSB-schema-3_1_0-2023-08.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/XYZ-CSB-schema-3_1_0-2023-08.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"required": [
"type",
"name",
"length",
"IDType",
"IDNumber",
"soundSpeedDocumented",
"positionOffsetsDocumented",
"dataProcessed"
],
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"soundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"XYZ GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata (to accompany separate XYZ data), version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 0950341f78a9151e6a64e7607a2065f842c68b3f | 2023-04-10T14:11:25 | csbschema/data/XYZ-CSB-schema-3_0_0-2023-03.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/XYZ-CSB-schema-3_0_0-2023-03.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Algorithms": {
"description": "Array of algorithms applied to the data.",
"items": {
"required": [
"name",
"params"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"Convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"XYZ CSB 3.0"
],
"type": "string"
},
"Correctors": {
"properties": {
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"draftApplied": {
"description": "Describes whether vessel draft has been corrected for.",
"type": "boolean"
},
"motionOffsetsApplied": {
"description": "Describes whether vessel motion has been corrected for.",
"type": "boolean"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"positionReferencePoint": {
"enum": [
"GNSS"
],
"type": "string"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
}
},
"required": [
"positionReferencePoint"
],
"type": "object"
},
"DataLicense": {
"description": "The license under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n",
"type": "string"
},
"EPSG_Number": {
"maximum": 32767,
"minimum": 1024,
"type": "integer"
},
"IDNumber_IMO": {
"maximum": 9999999,
"minimum": 1000000,
"type": "integer"
},
"IDNumber_MMSI": {
"maximum": 999999999,
"minimum": 100000000,
"type": "integer"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "integer"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"correctors": {
"$ref": "#/definitions/Correctors"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"required": [
"uniqueID",
"correctors"
],
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCRSTransformation"
},
{
"$ref": "#/definitions/ProcessingCRS"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs.",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing.",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": "string"
}
},
"required": [
"name",
"parameters",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"algorithm"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingCRS": {
"description": "Processing that transformed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"type": {
"enum": [
"EPSG"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/EPSG_Number"
}
},
"required": [
"type",
"value",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRS"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingCRSTransformation": {
"description": "Processing that transformed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"detail": {
"properties": {
"destination": {
"$ref": "#/definitions/CRS_Name"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"origin": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"origin",
"destination",
"method"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSTransformation"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"detail": {
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing, e.g., RTKLib | CSRS-PPP | ...",
"type": "string"
},
"comment": {
"description": "Comments regarding the algorithm used for GNSS processing.",
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algorithm method used.",
"type": "string"
}
},
"required": [
"algorithm",
"version",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSSProcessing"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"detail": {
"properties": {
"algorithm": {
"description": "Algorithm for sound speed correction, e.g., CIDCO-Ocean | Raytraced | ...",
"type": "string"
},
"comment": {
"description": "Comments regarding the algorithm used for sound speed correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings, e.g., Model | Profile | GeometricMean | Fixed | CarterTable | MatthewTable | WOA13 |...",
"type": "string"
},
"version": {
"description": "Version of sound speed algorithm method used.",
"type": "string"
}
},
"required": [
"source",
"algorithm",
"version",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeedCorrection"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding the source and method of time interpolation.",
"type": "string"
},
"method": {
"description": "The method of time interpolation, e.g., Midway | ElapsedTime | DataSource | NTP | PTP | ...",
"type": "string"
},
"source": {
"description": "The source of the time interpolation, e.g., SystemTime | ZDA | RMC | ...",
"type": "string"
}
},
"required": [
"source",
"method",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeInterpolation"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding the vertical reduction.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system, e.g., ObservedWL | PredictedWL | ModelledWL | EllipsoidReduction | ...",
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system, e.g., CANNORTH2016v1HyVSEP_NAD83v6_CD | StationReference | VDatum | VORF | ...",
"type": "string"
},
"reference": {
"description": "Vertical reference system, e.g., Chart Datum, MSL, ellipsoid, water level, etc.",
"type": "string"
}
},
"required": [
"reference",
"method",
"model",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProviderContactPoint": {
"properties": {
"email": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"logger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"loggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"orgName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
}
},
"required": [
"orgName",
"email",
"logger",
"loggerVersion"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]?$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"MotionSensor"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"transducer": {
"description": "Transducer used with echo sounder",
"type": "string"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^([0-9a-zA-Z]{2,}(-[0-9a-zA-Z]{2,})+)$",
"type": "string"
}
},
"properties": {
"algorithms": {
"$ref": "#/definitions/Algorithms"
},
"convention": {
"$ref": "#/definitions/Convention"
},
"crs": {
"properties": {
"horizontal": {
"properties": {
"type": {
"enum": [
"EPSG"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/EPSG_Number"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"vertical": {
"enum": [
"Transducer"
],
"type": "string"
}
},
"required": [
"horizontal",
"vertical"
],
"type": "object"
},
"dataLicense": {
"$ref": "#/definitions/DataLicense"
},
"lineage": {
"$ref": "#/definitions/Processing"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"providerContactPoint": {
"$ref": "#/definitions/ProviderContactPoint"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"crs",
"providerContactPoint",
"convention",
"dataLicense",
"platform"
],
"title": "Schema for Crowdsourced Bathymetry metadata (to accompany separate XYZ data), version 3.0.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 0d6781ad625e7bc4d597ae51460d7f3675e8b3f1 | 2024-04-26T17:46:42 | csbschema/data/CSB-schema-3_1_0-2024-04.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_1_0-2023-08.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
},
"uncertainty": {
"description": "3-tuple composed of: horizontal X (i.e. east-to-west) uncertainty, horizontal Y (i.e. north-to-south) uncertainty, and vertical Z uncertainty (i.e. depth uncertainty)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeStampInterpolation"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | cf817f4fbc8333b816308c32147ce8d8f20aef8b | 2024-04-19T14:44:53 | csbschema/data/CSB-schema-3_1_0-2024-04.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_1_0-2023-08.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"platform": {
"$ref": "#/definitions/Platform"
},
"processing": {
"$ref": "#/definitions/Processing"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNode"
}
},
"required": [
"trustedNode"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
},
"uncertainty": {
"description": "3-tuple composed of: horizontal X (i.e. east-to-west) uncertainty, horizontal Y (i.e. north-to-south) uncertainty, and vertical Z uncertainty (i.e. depth uncertainty)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"required": [
"type",
"name",
"length",
"IDType",
"IDNumber",
"soundSpeedDocumented",
"positionOffsetsDocumented",
"dataProcessed"
],
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeStampInterpolation"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.1"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"uniqueVesselID": {
"$ref": "#/definitions/UniqueVesselID"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Waterline",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID",
"convention",
"dataLicense",
"providerLogger",
"providerLoggerVersion",
"navigationCRS",
"verticalReferenceOfDepth",
"vesselPositionReferencePoint"
],
"type": "object"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.1.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | cf817f4fbc8333b816308c32147ce8d8f20aef8b | 2024-04-19T14:44:53 | csbschema/data/CSB-schema-3_2_0-BETA.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_2_0-BETA.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"observationCollection": {
"$ref": "#/definitions/ObservationCollection"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNodePlatform"
}
},
"required": [
"trustedNodePlatform"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"ObservationCollection": {
"properties": {
"platform": {
"$ref": "#/definitions/ObservationCollectionPlatform"
},
"processing": {
"$ref": "#/definitions/ObservationCollectionProcessing"
},
"trustedNode": {
"$ref": "#/definitions/ObservationCollectionTrustedNode"
}
},
"type": "object"
},
"ObservationCollectionPlatform": {
"properties": {
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
}
},
"type": "object"
},
"ObservationCollectionProcessing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ObservationCollectionTrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.2"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"type": "object"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeStampInterpolation"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNodePlatform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID"
],
"type": "object"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.2.0-BETA",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | ee33a9fdbe52683a666e517dd7b1a015b2472849 | 2023-04-10T13:14:38 | csbschema/data/CSB-schema-3_2_0-BETA.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_2_0-BETA.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"observationCollection": {
"$ref": "#/definitions/ObservationCollection"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNodePlatform"
}
},
"required": [
"trustedNodePlatform"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"ObservationCollection": {
"properties": {
"platform": {
"$ref": "#/definitions/ObservationCollectionPlatform"
},
"processing": {
"$ref": "#/definitions/ObservationCollectionProcessing"
},
"trustedNode": {
"$ref": "#/definitions/ObservationCollectionTrustedNode"
}
},
"type": "object"
},
"ObservationCollectionPlatform": {
"properties": {
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
}
},
"type": "object"
},
"ObservationCollectionProcessing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ObservationCollectionTrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.2"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"type": "object"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"soundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNodePlatform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID"
],
"type": "object"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.2.0-BETA",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 9b01d83849b490bec81264930dff119e2fa77407 | 2023-08-01T19:30:58 | csbschema/data/XYZ-CSB-schema-3_0_0-2023-08.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/XYZ-CSB-schema-3_0_0-2023-08.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Algorithms": {
"description": "Array of algorithms applied to the data.",
"items": {
"required": [
"name",
"params"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"Convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"XYZ CSB 3.0"
],
"type": "string"
},
"Correctors": {
"properties": {
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"draftApplied": {
"description": "Describes whether vessel draft has been corrected for.",
"type": "boolean"
},
"motionOffsetsApplied": {
"description": "Describes whether vessel motion has been corrected for.",
"type": "boolean"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"positionReferencePoint": {
"enum": [
"GNSS"
],
"type": "string"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
}
},
"required": [
"positionReferencePoint"
],
"type": "object"
},
"DataLicense": {
"description": "The license under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n",
"type": "string"
},
"EPSG_Number": {
"maximum": 32767,
"minimum": 1024,
"type": "integer"
},
"IDNumber_IMO": {
"maximum": 9999999,
"minimum": 1000000,
"type": "integer"
},
"IDNumber_MMSI": {
"maximum": 999999999,
"minimum": 100000000,
"type": "integer"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "integer"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"correctors": {
"$ref": "#/definitions/Correctors"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"required": [
"uniqueID",
"correctors"
],
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCRSTransformation"
},
{
"$ref": "#/definitions/ProcessingCRS"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs.",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing.",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": "string"
}
},
"required": [
"name",
"parameters",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"algorithm"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingCRS": {
"description": "Processing that transformed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"type": {
"enum": [
"EPSG"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/EPSG_Number"
}
},
"required": [
"type",
"value",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRS"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingCRSTransformation": {
"description": "Processing that transformed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"detail": {
"properties": {
"destination": {
"$ref": "#/definitions/CRS_Name"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"origin": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"origin",
"destination",
"method"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSTransformation"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"detail": {
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing, e.g., RTKLib | CSRS-PPP | ...",
"type": "string"
},
"comment": {
"description": "Comments regarding the algorithm used for GNSS processing.",
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algorithm method used.",
"type": "string"
}
},
"required": [
"algorithm",
"version",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSSProcessing"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"detail": {
"properties": {
"algorithm": {
"description": "Algorithm for sound speed correction, e.g., CIDCO-Ocean | Raytraced | ...",
"type": "string"
},
"comment": {
"description": "Comments regarding the algorithm used for sound speed correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings, e.g., Model | Profile | GeometricMean | Fixed | CarterTable | MatthewTable | WOA13 |...",
"type": "string"
},
"version": {
"description": "Version of sound speed algorithm method used.",
"type": "string"
}
},
"required": [
"source",
"algorithm",
"version",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeedCorrection"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding the source and method of time interpolation.",
"type": "string"
},
"method": {
"description": "The method of time interpolation, e.g., Midway | ElapsedTime | DataSource | NTP | PTP | ...",
"type": "string"
},
"source": {
"description": "The source of the time interpolation, e.g., SystemTime | ZDA | RMC | ...",
"type": "string"
}
},
"required": [
"source",
"method",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeInterpolation"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "string"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"detail": {
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"name",
"version",
"offsets"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding the vertical reduction.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system, e.g., ObservedWL | PredictedWL | ModelledWL | EllipsoidReduction | ...",
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system, e.g., CANNORTH2016v1HyVSEP_NAD83v6_CD | StationReference | VDatum | VORF | ...",
"type": "string"
},
"reference": {
"description": "Vertical reference system, e.g., Chart Datum, MSL, ellipsoid, water level, etc.",
"type": "string"
}
},
"required": [
"reference",
"method",
"model",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProviderContactPoint": {
"properties": {
"email": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"logger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"loggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"orgName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
}
},
"required": [
"orgName",
"email",
"logger",
"loggerVersion"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]?$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"MotionSensor"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"transducer": {
"description": "Transducer used with echo sounder",
"type": "string"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^([0-9a-zA-Z]{2,}(-[0-9a-zA-Z]{2,})+)$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"algorithms": {
"$ref": "#/definitions/Algorithms"
},
"convention": {
"$ref": "#/definitions/Convention"
},
"crs": {
"properties": {
"horizontal": {
"properties": {
"type": {
"enum": [
"EPSG"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/EPSG_Number"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"vertical": {
"enum": [
"Transducer"
],
"type": "string"
}
},
"required": [
"horizontal",
"vertical"
],
"type": "object"
},
"dataLicense": {
"$ref": "#/definitions/DataLicense"
},
"lineage": {
"$ref": "#/definitions/Processing"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"providerContactPoint": {
"$ref": "#/definitions/ProviderContactPoint"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"crs",
"providerContactPoint",
"convention",
"dataLicense",
"platform"
],
"title": "Schema for Crowdsourced Bathymetry metadata (to accompany separate XYZ data), version 3.0.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 9b01d83849b490bec81264930dff119e2fa77407 | 2023-08-01T19:30:58 | csbschema/data/CSB-schema-3_2_0-BETA.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_2_0-BETA.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"B12_Metadata": {
"properties": {
"observationCollection": {
"$ref": "#/definitions/ObservationCollection"
},
"trustedNode": {
"$ref": "#/definitions/TrustedNodePlatform"
}
},
"required": [
"trustedNodePlatform"
],
"type": "object"
},
"CRS": {
"properties": {
"properties": {
"properties": {
"name": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"name"
],
"type": "object"
}
},
"required": [
"properties"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"pattern": "^IMO\\d{7}$",
"type": "string"
},
"IDNumber_MMSI": {
"pattern": "^\\d{9}$",
"type": "string"
},
"ObservationCollection": {
"properties": {
"platform": {
"$ref": "#/definitions/ObservationCollectionPlatform"
},
"processing": {
"$ref": "#/definitions/ObservationCollectionProcessing"
},
"trustedNode": {
"$ref": "#/definitions/ObservationCollectionTrustedNode"
}
},
"type": "object"
},
"ObservationCollectionPlatform": {
"properties": {
"contributorComments": {
"description": "If the contributor believes there were any problems or events that may have degraded the quality of the position or depth measurements, they can enter that information in this free-text field.",
"type": "string"
},
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
}
},
"type": "object"
},
"ObservationCollectionProcessing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCoordinateReferenceChange"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ObservationCollectionTrustedNode": {
"properties": {
"convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.2"
],
"type": "string"
},
"dataLicense": {
"description": "The Creative Commons public domain\n dedication under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n ",
"type": "string"
},
"navigationCRS": {
"$ref": "#/definitions/CRS_Name",
"description": "The EPSG code referring to the Coordinate Reference System (CRS) of the navigation data"
},
"providerLogger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"providerLoggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"verticalReferenceOfDepth": {
"description": "The vertical reference of the depth. The vertical reference will most likely be the transducer (ex: NMEA DBT string) or the waterline (ex: NMEA DPT string).",
"enum": [
"Transducer",
"Unknown"
],
"type": "string"
},
"vesselPositionReferencePoint": {
"description": "Position Reference Point (PRP) is the reference point where the navigation data is output. Most likely the reference point will be the location of the GNSS antenna.",
"enum": [
"GNSS",
"Transducer",
"ReferencePlace"
],
"type": "string"
}
},
"type": "object"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": [
"null",
"object"
]
},
"source": {
"description": "Source (e.g., project, library) of the algorithm applied",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Algorithm"
],
"type": "string"
},
"version": {
"description": "Version of algorithm used to triage data.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name"
],
"type": "object"
},
"ProcessingCoordinateReferenceChange": {
"description": "Processing that changed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"destination": {
"description": "Coordinate reference system to which data were transformed (e.g., EPSG:8252).",
"type": "string"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"original": {
"description": "Original coordinate reference system of the data (e.g., EPSG:4326).",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSChange"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"original",
"destination"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing",
"enum": [
"RTKLib",
"CSRS-PPP"
],
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algoritm method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"algorithm"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"method": {
"description": "Method of sounding correction.",
"type": "string"
},
"source": {
"description": "Source of correction to soundings.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of sounding correction method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"source",
"method"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"algorithm": {
"description": "Algorithm used to interpolate timestamps.",
"type": "string"
},
"method": {
"description": "Name of timestamp interpolation method.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"soundSpeed"
],
"type": "string"
},
"version": {
"description": "Version of timestamp interpolation method used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"method"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "object"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"type",
"timestamp",
"name",
"version",
"offsets"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"datum": {
"description": "Datum of vertical reference system.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system.",
"enum": [
"EllipsoidReduction",
"Observed Waterlevel",
"Predicted Waterlevel"
],
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system",
"type": "string"
},
"reference": {
"description": "Vertical reference system (e.g., Chart Datum, MSL, ellipsoid, water level, etc.)",
"type": "string"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"reference",
"datum",
"method"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"antennaModel": {
"description": "Model of GNSS antenna",
"type": "string"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"IMU"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"draftUncert": {
"description": "Uncertainty in vessel draft",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"pulseLength": {
"description": "Pulse length of echo sounder",
"type": "number"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"TrustedNodePlatform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "string"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"providerEmail": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"providerOrganizationName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^[a-zA-Z][a-zA-Z0-9]*-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string"
}
},
"required": [
"providerOrganizationName",
"providerEmail",
"uniqueVesselID"
],
"type": "object"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"crs": {
"$ref": "#/definitions/CRS"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.2.0-BETA",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 0950341f78a9151e6a64e7607a2065f842c68b3f | 2023-04-10T14:11:25 | csbschema/data/CSB-schema-3_0_0-2023-03.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_0_0-2023-03.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Algorithms": {
"description": "Array of algorithms applied to the data.",
"items": {
"required": [
"name",
"Params"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"B12_Metadata": {
"properties": {
"algorithms": {
"$ref": "#/definitions/Algorithms"
},
"convention": {
"$ref": "#/definitions/Convention"
},
"dataLicense": {
"$ref": "#/definitions/DataLicense"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"providerContactPoint": {
"$ref": "#/definitions/ProviderContactPoint"
}
},
"required": [
"providerContactPoint",
"convention",
"dataLicense",
"platform"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"Convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.0"
],
"type": "string"
},
"Correctors": {
"properties": {
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"draftApplied": {
"description": "Describes whether vessel draft has been corrected for.",
"type": "boolean"
},
"motionOffsetsApplied": {
"description": "Describes whether vessel motion has been corrected for.",
"type": "boolean"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"positionReferencePoint": {
"enum": [
"GNSS"
],
"type": "string"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
}
},
"required": [
"positionReferencePoint"
],
"type": "object"
},
"DataLicense": {
"description": "The license under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n",
"type": "string"
},
"EPSG_Number": {
"maximum": 32767,
"minimum": 1024,
"type": "integer"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"maximum": 9999999,
"minimum": 1000000,
"type": "integer"
},
"IDNumber_MMSI": {
"maximum": 999999999,
"minimum": 100000000,
"type": "integer"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "integer"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"correctors": {
"$ref": "#/definitions/Correctors"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"required": [
"uniqueID",
"correctors"
],
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCRSTransformation"
},
{
"$ref": "#/definitions/ProcessingCRS"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs.",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing.",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": "string"
}
},
"required": [
"name",
"parameters",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"algorithm"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingCRS": {
"description": "Processing that transformed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"type": {
"enum": [
"EPSG"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/EPSG_Number"
}
},
"required": [
"type",
"value",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRS"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingCRSTransformation": {
"description": "Processing that transformed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"detail": {
"properties": {
"destination": {
"$ref": "#/definitions/CRS_Name"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"origin": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"origin",
"destination",
"method"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSTransformation"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"detail": {
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing, e.g., RTKLib | CSRS-PPP | ...",
"type": "string"
},
"comment": {
"description": "Comments regarding the algorithm used for GNSS processing.",
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algorithm method used.",
"type": "string"
}
},
"required": [
"algorithm",
"version",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSSProcessing"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"detail": {
"properties": {
"Source": {
"description": "Source of correction to soundings, e.g., Model | Profile | GeometricMean | Fixed | CarterTable | MatthewTable | WOA13 |...",
"type": "string"
},
"algorithm": {
"description": "Algorithm for sound speed correction, e.g., CIDCO-Ocean | Raytraced | ...",
"type": "string"
},
"comment": {
"description": "Comments regarding the algorithm used for sound speed correction.",
"type": "string"
},
"version": {
"description": "Version of sound speed algorithm method used.",
"type": "string"
}
},
"required": [
"Source",
"algorithm",
"version",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeedCorrection"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding the source and method of time interpolation.",
"type": "string"
},
"method": {
"description": "The method of time interpolation, e.g., Midway | ElapsedTime | DataSource | NTP | PTP | ...",
"type": "string"
},
"source": {
"description": "The source of the time interpolation, e.g., SystemTime | ZDA | RMC | ...",
"type": "string"
}
},
"required": [
"source",
"method",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeInterpolation"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding the vertical reduction.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system, e.g., ObservedWL | PredictedWL | ModelledWL | EllipsoidReduction | ...",
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system, e.g., CANNORTH2016v1HyVSEP_NAD83v6_CD | StationReference | VDatum | VORF | ...",
"type": "string"
},
"reference": {
"description": "Vertical reference system, e.g., Chart Datum, MSL, ellipsoid, water level, etc.",
"type": "string"
}
},
"required": [
"reference",
"method",
"model",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProviderContactPoint": {
"properties": {
"email": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"logger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"loggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"orgName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
}
},
"required": [
"orgName",
"email",
"logger",
"loggerVersion"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]?$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"MotionSensor"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"transducer": {
"description": "Transducer used with echo sounder",
"type": "string"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^([0-9a-zA-Z]{2,}(-[0-9a-zA-Z]{2,})+)$",
"type": "string"
}
},
"properties": {
"crs": {
"properties": {
"horizontal": {
"properties": {
"type": {
"enum": [
"EPSG"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/EPSG_Number"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"vertical": {
"enum": [
"Transducer"
],
"type": "string"
}
},
"required": [
"horizontal",
"vertical"
],
"type": "object"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"lineage": {
"$ref": "#/definitions/Processing"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.0.0",
"type": "object"
} | MIT | en |
CCOMJHC/csbschema | 9b01d83849b490bec81264930dff119e2fa77407 | 2023-08-01T19:30:58 | csbschema/data/CSB-schema-3_0_0-2023-08.json | 5 | 2024-05-27T07:23:31.400129Z | {
"$id": "https://raw.githubusercontent.com/CCOMJHC/csbschema/main/csbschema/data/CSB-schema-3_0_0-2023-08.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Algorithms": {
"description": "Array of algorithms applied to the data.",
"items": {
"required": [
"name",
"Params"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"B12_Metadata": {
"properties": {
"algorithms": {
"$ref": "#/definitions/Algorithms"
},
"convention": {
"$ref": "#/definitions/Convention"
},
"dataLicense": {
"$ref": "#/definitions/DataLicense"
},
"platform": {
"$ref": "#/definitions/Platform"
},
"providerContactPoint": {
"$ref": "#/definitions/ProviderContactPoint"
}
},
"required": [
"providerContactPoint",
"convention",
"dataLicense",
"platform"
],
"type": "object"
},
"CRS_Name": {
"description": "CRS name as an EPSG string.",
"pattern": "^EPSG:(3276[0-7]$|327[0-5]\\d$|32[0-6]\\d\\d$|3[0-1]\\d\\d\\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)",
"type": "string"
},
"CSBDatum": {
"properties": {
"depth": {
"description": "The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.",
"type": "number"
},
"time": {
"$ref": "#/definitions/RFC3339_time",
"description": "The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format."
}
},
"required": [
"depth",
"time"
],
"type": "object"
},
"Convention": {
"description": "This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.",
"enum": [
"GeoJSON CSB 3.0"
],
"type": "string"
},
"Correctors": {
"properties": {
"dataProcessed": {
"description": "Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (\u2018True\u2019) or not (\u2018False\u2019). If \u2018True\u2019, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If \u2018False\u2019, information in section 3.3.4 is not needed.",
"type": "boolean"
},
"draftApplied": {
"description": "Describes whether vessel draft has been corrected for.",
"type": "boolean"
},
"motionOffsetsApplied": {
"description": "Describes whether vessel motion has been corrected for.",
"type": "boolean"
},
"positionOffsetsDocumented": {
"description": "Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (\u201cTrue\u201d), or if they were not (\u201cFalse\u201d). If \u201cTrue\u201d, the position element of the sensor description field in Table 3 should be populated.",
"type": "boolean"
},
"positionReferencePoint": {
"enum": [
"GNSS"
],
"type": "string"
},
"soundSpeedDocumented": {
"description": "Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (\u201cTrue\u201d), it is strongly recommended that the \u2018Sound Speed Correction\u2019 field in Table 4 be populated. If \u201cFalse\u201d, no information about how sound speed was applied has been recorded.",
"type": "boolean"
}
},
"required": [
"positionReferencePoint"
],
"type": "object"
},
"DataLicense": {
"description": "The license under which the Trusted Node is\n providing CSB data to the IHO DCDB.\n",
"type": "string"
},
"EPSG_Number": {
"maximum": 32767,
"minimum": 1024,
"type": "integer"
},
"GeoJSONFeature": {
"properties": {
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"minItems": 4,
"type": "array"
},
"coordinates": {
"items": {
"type": "number"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
}
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"$ref": "#/definitions/CSBDatum"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"properties",
"geometry"
],
"title": "GeoJSON Feature",
"type": "object"
},
"IDNumber_IMO": {
"maximum": 9999999,
"minimum": 1000000,
"type": "integer"
},
"IDNumber_MMSI": {
"maximum": 999999999,
"minimum": 100000000,
"type": "integer"
},
"Platform": {
"properties": {
"IDNumber": {
"description": "The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters \u201cIMO,\u201d followed by a seven-digit number.",
"oneOf": [
{
"$ref": "#/definitions/IDNumber_MMSI"
},
{
"$ref": "#/definitions/IDNumber_IMO"
}
],
"type": "integer"
},
"IDType": {
"description": "ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.",
"enum": [
"MMSI",
"IMO"
],
"type": "string"
},
"correctors": {
"$ref": "#/definitions/Correctors"
},
"length": {
"description": "The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the vessel, in open string format.",
"type": "string"
},
"sensors": {
"description": "Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"oneOf": [
{
"$ref": "#/definitions/SensorDescriptionSounder"
},
{
"$ref": "#/definitions/SensorDescriptionIMU"
},
{
"$ref": "#/definitions/SensorDescriptionGNSS"
}
]
},
"minItems": 1,
"type": "array"
},
"type": {
"description": "The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,\nresearch vessel, etc.",
"type": "string"
},
"uniqueID": {
"$ref": "#/definitions/UniqueVesselID"
}
},
"required": [
"uniqueID",
"correctors"
],
"type": "object"
},
"Processing": {
"description": "List of processing steps recorded for the data",
"items": {
"oneOf": [
{
"$ref": "#/definitions/ProcessingTimeStampInterpolation"
},
{
"$ref": "#/definitions/ProcessingCRSTransformation"
},
{
"$ref": "#/definitions/ProcessingCRS"
},
{
"$ref": "#/definitions/ProcessingVerticalReduction"
},
{
"$ref": "#/definitions/ProcessingGNSS"
},
{
"$ref": "#/definitions/ProcessingSoundSpeedCorrection"
},
{
"$ref": "#/definitions/ProcessingUncertainty"
},
{
"$ref": "#/definitions/ProcessingVerticalOffsetAnalysis"
},
{
"$ref": "#/definitions/ProcessingAlgorithm"
}
]
},
"minItems": 1,
"type": "array"
},
"ProcessingAlgorithm": {
"description": "General algorithm used to triage data",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Explanatory text related to algorithm or its outputs.",
"type": "string"
},
"name": {
"description": "Examples: deduplicate, uncertainty estimation, manual editing.",
"type": "string"
},
"parameters": {
"description": "Parameters used in data processing.",
"type": "string"
}
},
"required": [
"name",
"parameters",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"algorithm"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingCRS": {
"description": "Processing that transformed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"type": {
"enum": [
"EPSG"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/EPSG_Number"
}
},
"required": [
"type",
"value",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRS"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingCRSTransformation": {
"description": "Processing that transformed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.",
"properties": {
"detail": {
"properties": {
"destination": {
"$ref": "#/definitions/CRS_Name"
},
"method": {
"description": "Method used to change coordinates (e.g., GeoTrans).",
"type": "string"
},
"origin": {
"$ref": "#/definitions/CRS_Name"
}
},
"required": [
"origin",
"destination",
"method"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"CRSTransformation"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingGNSS": {
"description": "Steps taken to post-process or improve horizontal and vertical positioning.",
"properties": {
"detail": {
"properties": {
"algorithm": {
"description": "Algorithm used for GNSS post-processing, e.g., RTKLib | CSRS-PPP | ...",
"type": "string"
},
"comment": {
"description": "Comments regarding the algorithm used for GNSS processing.",
"type": "string"
},
"version": {
"description": "Version of GNSS post-processing algorithm method used.",
"type": "string"
}
},
"required": [
"algorithm",
"version",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"GNSSProcessing"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingSoundSpeedCorrection": {
"description": "Correction to soundings for sound speed in the water.",
"properties": {
"detail": {
"properties": {
"Source": {
"description": "Source of correction to soundings, e.g., Model | Profile | GeometricMean | Fixed | CarterTable | MatthewTable | WOA13 |...",
"type": "string"
},
"algorithm": {
"description": "Algorithm for sound speed correction, e.g., CIDCO-Ocean | Raytraced | ...",
"type": "string"
},
"comment": {
"description": "Comments regarding the algorithm used for sound speed correction.",
"type": "string"
},
"version": {
"description": "Version of sound speed algorithm method used.",
"type": "string"
}
},
"required": [
"Source",
"algorithm",
"version",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"SoundSpeedCorrection"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingTimeStampInterpolation": {
"description": "Method by which times are assigned to data being recorded.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding the source and method of time interpolation.",
"type": "string"
},
"method": {
"description": "The method of time interpolation, e.g., Midway | ElapsedTime | DataSource | NTP | PTP | ...",
"type": "string"
},
"source": {
"description": "The source of the time interpolation, e.g., SystemTime | ZDA | RMC | ...",
"type": "string"
}
},
"required": [
"source",
"method",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"TimeInterpolation"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingUncertainty": {
"description": "Algorithm for estimating horizontal and vertical uncertainty of soundings.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Explanatory text related to uncertainty estimation algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of uncertainty estimation algorithm",
"type": "string"
},
"parameters": {
"description": "Parameters used in application of uncertainty estimation algorithm.",
"type": "string"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"version": {
"description": "Version of uncertainty estimation algorithm used.",
"type": "string"
}
},
"required": [
"name",
"parameters",
"version",
"comment",
"reference"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"Uncertainty"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingVerticalOffsetAnalysis": {
"description": "Analysis of vertical offsets of soundings recorded by intersecting track lines.",
"properties": {
"detail": {
"properties": {
"analysis": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisAnalysisMeta"
},
"minItems": 1,
"type": "array"
},
"comment": {
"description": "Explanatory text related to vertical offset analysis algorithm or its inputs/outputs",
"type": "string"
},
"name": {
"description": "Name of vertical offset analysis algorithm.",
"type": "string"
},
"offsets": {
"items": {
"$ref": "#/definitions/VerticalOffsetAnalysisOffset"
},
"minItems": 1,
"type": "array"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
},
"version": {
"description": "Version of vertical offset analysis algorithm used.",
"type": "string"
}
},
"required": [
"name",
"version",
"offsets"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalOffsetAnalysis"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProcessingVerticalReduction": {
"description": "Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.",
"properties": {
"detail": {
"properties": {
"comment": {
"description": "Comments regarding the vertical reduction.",
"type": "string"
},
"method": {
"description": "Method used to reduce raw data to vertical reference system, e.g., ObservedWL | PredictedWL | ModelledWL | EllipsoidReduction | ...",
"type": "string"
},
"model": {
"description": "Model used for reduction of raw data to vertical reference system, e.g., CANNORTH2016v1HyVSEP_NAD83v6_CD | StationReference | VDatum | VORF | ...",
"type": "string"
},
"reference": {
"description": "Vertical reference system, e.g., Chart Datum, MSL, ellipsoid, water level, etc.",
"type": "string"
}
},
"required": [
"reference",
"method",
"model",
"comment"
],
"type": "object"
},
"timestamp": {
"$ref": "#/definitions/RFC3339_time"
},
"type": {
"enum": [
"VerticalReduction"
],
"type": "string"
}
},
"required": [
"type",
"timestamp",
"detail"
],
"type": "object"
},
"ProviderContactPoint": {
"properties": {
"email": {
"description": "A free-text field for the Trusted Node\u2019s email address, so that data users can contact the Trusted Node with questions about the data.",
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,6}$",
"type": "string"
},
"logger": {
"description": "The software program or hardware logger used to log the data.",
"type": "string"
},
"loggerVersion": {
"description": "The software or hardware logger version.",
"type": "string"
},
"orgName": {
"description": "The Trusted Node\u2019s name, in free-text format.",
"type": "string"
}
},
"required": [
"orgName",
"email",
"logger",
"loggerVersion"
],
"type": "object"
},
"RFC3339_time": {
"description": "RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).",
"pattern": "^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]?$",
"type": "string"
},
"SensorDescriptionGNSS": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"GNSS"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model"
],
"type": "object"
},
"SensorDescriptionIMU": {
"properties": {
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"type": {
"enum": [
"MotionSensor"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorDescriptionSounder": {
"properties": {
"draft": {
"description": "Draft of vessel",
"type": "number"
},
"frequency": {
"description": "Frequency of echo sounder",
"type": "number"
},
"make": {
"$ref": "#/definitions/SensorMake"
},
"model": {
"$ref": "#/definitions/SensorModel"
},
"position": {
"$ref": "#/definitions/SensorPosition"
},
"transducer": {
"description": "Transducer used with echo sounder",
"type": "string"
},
"type": {
"enum": [
"Sounder"
],
"type": "string"
}
},
"required": [
"type",
"make",
"model",
"position"
],
"type": "object"
},
"SensorMake": {
"description": "Sensor manufacturer",
"type": "string"
},
"SensorModel": {
"description": "Sensor model",
"type": "string"
},
"SensorPosition": {
"description": "Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)",
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"UniqueVesselID": {
"description": "Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel\u2019s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.",
"pattern": "^([0-9a-zA-Z]{2,}(-[0-9a-zA-Z]{2,})+)$",
"type": "string"
},
"VerticalOffsetAnalysisAnalysisMeta": {
"properties": {
"comment": {
"description": "Explanatory text related to analysis or its inputs/outputs",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "object"
},
"pass": {
"type": "boolean"
},
"reference": {
"description": "Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.",
"type": "string"
}
},
"required": [
"name",
"pass",
"parameters"
],
"type": "object"
},
"VerticalOffsetAnalysisOffset": {
"properties": {
"delta": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"delta"
],
"type": "object"
}
},
"properties": {
"crs": {
"properties": {
"horizontal": {
"properties": {
"type": {
"enum": [
"EPSG"
],
"type": "string"
},
"value": {
"$ref": "#/definitions/EPSG_Number"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"vertical": {
"enum": [
"Transducer"
],
"type": "string"
}
},
"required": [
"horizontal",
"vertical"
],
"type": "object"
},
"features": {
"items": {
"$ref": "#/definitions/GeoJSONFeature"
},
"type": "array"
},
"lineage": {
"$ref": "#/definitions/Processing"
},
"properties": {
"$ref": "#/definitions/B12_Metadata"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"crs",
"properties",
"features"
],
"title": "Schema for Crowdsourced Bathymetry data and metadata, version 3.0.0",
"type": "object"
} | MIT | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/link.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"Link": {
"additionalProperties": false,
"properties": {
"byproducts": {
"$ref": "#/$defs/Struct"
},
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"environment": {
"$ref": "#/$defs/Struct"
},
"materials": {
"items": {
"$ref": "#/$defs/ResourceDescriptor"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"ResourceDescriptor": {
"additionalProperties": false,
"properties": {
"annotations": {
"$ref": "#/$defs/Struct"
},
"content": {
"contentEncoding": "base64",
"type": "string"
},
"digest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"download_location": {
"type": "string"
},
"media_type": {
"type": "string"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"Struct": {
"additionalProperties": false,
"properties": {
"fields": {
"additionalProperties": {
"$ref": "#/$defs/Value"
},
"type": "object"
}
},
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"Kind": true
},
"required": [
"Kind"
],
"type": "object"
}
},
"$id": "https://github.com/in-toto/attestation/go/predicates/link/v0/link",
"$ref": "#/$defs/Link",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/gitlab.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"ciconfigpath": {
"type": "string"
},
"cihost": {
"type": "string"
},
"ciserverurl": {
"type": "string"
},
"jobid": {
"type": "string"
},
"jobimage": {
"type": "string"
},
"jobname": {
"type": "string"
},
"jobstage": {
"type": "string"
},
"joburl": {
"type": "string"
},
"jwt": {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"claims": {
"type": "object"
},
"verifiedBy": {
"$ref": "#/$defs/VerificationInfo"
}
},
"required": [
"claims"
],
"type": "object"
},
"AttributeTypeAndValue": {
"additionalProperties": false,
"properties": {
"Type": {
"$ref": "#/$defs/ObjectIdentifier"
},
"Value": true
},
"required": [
"Type",
"Value"
],
"type": "object"
},
"Certificate": {
"additionalProperties": false,
"properties": {
"AuthorityKeyId": {
"contentEncoding": "base64",
"type": "string"
},
"BasicConstraintsValid": {
"type": "boolean"
},
"CRLDistributionPoints": {
"items": {
"type": "string"
},
"type": "array"
},
"DNSNames": {
"items": {
"type": "string"
},
"type": "array"
},
"EmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedDNSDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedEmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedIPRanges": {
"items": {
"$ref": "#/$defs/IPNet"
},
"type": "array"
},
"ExcludedURIDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"ExtKeyUsage": {
"items": {
"type": "integer"
},
"type": "array"
},
"Extensions": {
"items": {
"$ref": "#/$defs/Extension"
},
"type": "array"
},
"ExtraExtensions": {
"items": {
"$ref": "#/$defs/Extension"
},
"type": "array"
},
"IPAddresses": {
"items": {
"format": "ipv4",
"type": "string"
},
"type": "array"
},
"IsCA": {
"type": "boolean"
},
"Issuer": {
"$ref": "#/$defs/Name"
},
"IssuingCertificateURL": {
"items": {
"type": "string"
},
"type": "array"
},
"KeyUsage": {
"type": "integer"
},
"MaxPathLen": {
"type": "integer"
},
"MaxPathLenZero": {
"type": "boolean"
},
"NotAfter": {
"format": "date-time",
"type": "string"
},
"NotBefore": {
"format": "date-time",
"type": "string"
},
"OCSPServer": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedDNSDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedDNSDomainsCritical": {
"type": "boolean"
},
"PermittedEmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedIPRanges": {
"items": {
"$ref": "#/$defs/IPNet"
},
"type": "array"
},
"PermittedURIDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"Policies": {
"items": {
"$ref": "#/$defs/OID"
},
"type": "array"
},
"PolicyIdentifiers": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"PublicKey": true,
"PublicKeyAlgorithm": {
"type": "integer"
},
"Raw": {
"contentEncoding": "base64",
"type": "string"
},
"RawIssuer": {
"contentEncoding": "base64",
"type": "string"
},
"RawSubject": {
"contentEncoding": "base64",
"type": "string"
},
"RawSubjectPublicKeyInfo": {
"contentEncoding": "base64",
"type": "string"
},
"RawTBSCertificate": {
"contentEncoding": "base64",
"type": "string"
},
"SerialNumber": {
"$ref": "#/$defs/Int"
},
"Signature": {
"contentEncoding": "base64",
"type": "string"
},
"SignatureAlgorithm": {
"type": "integer"
},
"Subject": {
"$ref": "#/$defs/Name"
},
"SubjectKeyId": {
"contentEncoding": "base64",
"type": "string"
},
"URIs": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"UnhandledCriticalExtensions": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"UnknownExtKeyUsage": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"Version": {
"type": "integer"
}
},
"required": [
"Raw",
"RawTBSCertificate",
"RawSubjectPublicKeyInfo",
"RawSubject",
"RawIssuer",
"Signature",
"SignatureAlgorithm",
"PublicKeyAlgorithm",
"PublicKey",
"Version",
"SerialNumber",
"Issuer",
"Subject",
"NotBefore",
"NotAfter",
"KeyUsage",
"Extensions",
"ExtraExtensions",
"UnhandledCriticalExtensions",
"ExtKeyUsage",
"UnknownExtKeyUsage",
"BasicConstraintsValid",
"IsCA",
"MaxPathLen",
"MaxPathLenZero",
"SubjectKeyId",
"AuthorityKeyId",
"OCSPServer",
"IssuingCertificateURL",
"DNSNames",
"EmailAddresses",
"IPAddresses",
"URIs",
"PermittedDNSDomainsCritical",
"PermittedDNSDomains",
"ExcludedDNSDomains",
"PermittedIPRanges",
"ExcludedIPRanges",
"PermittedEmailAddresses",
"ExcludedEmailAddresses",
"PermittedURIDomains",
"ExcludedURIDomains",
"CRLDistributionPoints",
"PolicyIdentifiers",
"Policies"
],
"type": "object"
},
"Extension": {
"additionalProperties": false,
"properties": {
"Critical": {
"type": "boolean"
},
"Id": {
"$ref": "#/$defs/ObjectIdentifier"
},
"Value": {
"contentEncoding": "base64",
"type": "string"
}
},
"required": [
"Id",
"Critical",
"Value"
],
"type": "object"
},
"IPMask": {
"contentEncoding": "base64",
"type": "string"
},
"IPNet": {
"additionalProperties": false,
"properties": {
"IP": {
"format": "ipv4",
"type": "string"
},
"Mask": {
"$ref": "#/$defs/IPMask"
}
},
"required": [
"IP",
"Mask"
],
"type": "object"
},
"Int": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"JSONWebKey": {
"additionalProperties": false,
"properties": {
"Algorithm": {
"type": "string"
},
"CertificateThumbprintSHA1": {
"contentEncoding": "base64",
"type": "string"
},
"CertificateThumbprintSHA256": {
"contentEncoding": "base64",
"type": "string"
},
"Certificates": {
"items": {
"$ref": "#/$defs/Certificate"
},
"type": "array"
},
"CertificatesURL": {
"format": "uri",
"type": "string"
},
"Key": true,
"KeyID": {
"type": "string"
},
"Use": {
"type": "string"
}
},
"required": [
"Key",
"KeyID",
"Algorithm",
"Use",
"Certificates",
"CertificatesURL",
"CertificateThumbprintSHA1",
"CertificateThumbprintSHA256"
],
"type": "object"
},
"Name": {
"additionalProperties": false,
"properties": {
"CommonName": {
"type": "string"
},
"Country": {
"items": {
"type": "string"
},
"type": "array"
},
"ExtraNames": {
"items": {
"$ref": "#/$defs/AttributeTypeAndValue"
},
"type": "array"
},
"Locality": {
"items": {
"type": "string"
},
"type": "array"
},
"Names": {
"items": {
"$ref": "#/$defs/AttributeTypeAndValue"
},
"type": "array"
},
"Organization": {
"items": {
"type": "string"
},
"type": "array"
},
"OrganizationalUnit": {
"items": {
"type": "string"
},
"type": "array"
},
"PostalCode": {
"items": {
"type": "string"
},
"type": "array"
},
"Province": {
"items": {
"type": "string"
},
"type": "array"
},
"SerialNumber": {
"type": "string"
},
"StreetAddress": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Country",
"Organization",
"OrganizationalUnit",
"Locality",
"Province",
"StreetAddress",
"PostalCode",
"SerialNumber",
"CommonName",
"Names",
"ExtraNames"
],
"type": "object"
},
"OID": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"ObjectIdentifier": {
"items": {
"type": "integer"
},
"type": "array"
},
"VerificationInfo": {
"additionalProperties": false,
"properties": {
"jwk": {
"$ref": "#/$defs/JSONWebKey"
},
"jwksUrl": {
"type": "string"
}
},
"required": [
"jwksUrl",
"jwk"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"pipelineid": {
"type": "string"
},
"pipelineurl": {
"type": "string"
},
"projectid": {
"type": "string"
},
"projecturl": {
"type": "string"
},
"runnerid": {
"type": "string"
}
},
"required": [
"ciconfigpath",
"jobid",
"jobimage",
"jobname",
"jobstage",
"joburl",
"pipelineid",
"pipelineurl",
"projectid",
"projecturl",
"runnerid",
"cihost",
"ciserverurl"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/sarif.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"Address": {
"additionalProperties": false,
"properties": {
"absoluteAddress": {
"type": "integer"
},
"fullyQualifiedName": {
"type": "string"
},
"index": {
"type": "integer"
},
"kind": {
"type": "string"
},
"length": {
"type": "integer"
},
"name": {
"type": "string"
},
"offsetFromParent": {
"type": "integer"
},
"parentIndex": {
"type": "integer"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"relativeAddress": {
"type": "integer"
}
},
"type": "object"
},
"Artifact": {
"additionalProperties": false,
"properties": {
"contents": {
"$ref": "#/$defs/ArtifactContent"
},
"description": {
"$ref": "#/$defs/Message"
},
"encoding": {
"type": "string"
},
"hashes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"lastModifiedTimeUtc": {
"type": "string"
},
"length": {
"type": "integer"
},
"location": {
"$ref": "#/$defs/ArtifactLocation"
},
"mimeType": {
"type": "string"
},
"offset": {
"type": "integer"
},
"parentIndex": {
"type": "integer"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"roles": {
"items": {
"type": "string"
},
"type": "array"
},
"sourceLanguage": {
"type": "string"
}
},
"required": [
"length"
],
"type": "object"
},
"ArtifactChange": {
"additionalProperties": false,
"properties": {
"artifactLocation": {
"$ref": "#/$defs/ArtifactLocation"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"replacements": {
"items": {
"$ref": "#/$defs/Replacement"
},
"type": "array"
}
},
"required": [
"artifactLocation",
"replacements"
],
"type": "object"
},
"ArtifactContent": {
"additionalProperties": false,
"properties": {
"binary": {
"type": "string"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"rendered": {
"$ref": "#/$defs/MultiformatMessageString"
},
"text": {
"type": "string"
}
},
"type": "object"
},
"ArtifactLocation": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/$defs/Message"
},
"index": {
"type": "integer"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"uri": {
"type": "string"
},
"uriBaseId": {
"type": "string"
}
},
"type": "object"
},
"Attestor": {
"additionalProperties": false,
"properties": {
"report": {
"$ref": "#/$defs/Report"
},
"reportDigestSet": {
"$ref": "#/$defs/DigestSet"
},
"reportFileName": {
"type": "string"
}
},
"required": [
"report",
"reportFileName",
"reportDigestSet"
],
"type": "object"
},
"DigestSet": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Fix": {
"additionalProperties": false,
"properties": {
"artifactChanges": {
"items": {
"$ref": "#/$defs/ArtifactChange"
},
"type": "array"
},
"description": {
"$ref": "#/$defs/Message"
},
"properties": {
"$ref": "#/$defs/Properties"
}
},
"required": [
"artifactChanges"
],
"type": "object"
},
"Invocation": {
"additionalProperties": false,
"properties": {
"endTimeUtc": {
"format": "date-time",
"type": "string"
},
"executionSuccessful": {
"type": "boolean"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"startTimeUtc": {
"format": "date-time",
"type": "string"
},
"workingDirectory": {
"$ref": "#/$defs/ArtifactLocation"
}
},
"required": [
"executionSuccessful"
],
"type": "object"
},
"Location": {
"additionalProperties": false,
"properties": {
"annotations": {
"items": {
"$ref": "#/$defs/Region"
},
"type": "array"
},
"id": {
"type": "integer"
},
"logicalLocations": {
"items": {
"$ref": "#/$defs/LogicalLocation"
},
"type": "array"
},
"message": {
"$ref": "#/$defs/Message"
},
"physicalLocation": {
"$ref": "#/$defs/PhysicalLocation"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"relationships": {
"items": {
"$ref": "#/$defs/LocationRelationship"
},
"type": "array"
}
},
"type": "object"
},
"LocationRelationship": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/$defs/Message"
},
"kinds": {
"items": {
"type": "string"
},
"type": "array"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"target": {
"type": "integer"
}
},
"required": [
"target"
],
"type": "object"
},
"LogicalLocation": {
"additionalProperties": false,
"properties": {
"decoratedName": {
"type": "string"
},
"fullyQualifiedName": {
"type": "string"
},
"index": {
"type": "integer"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"parentIndex": {
"type": "integer"
},
"properties": {
"$ref": "#/$defs/Properties"
}
},
"type": "object"
},
"Message": {
"additionalProperties": false,
"properties": {
"arguments": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"markdown": {
"type": "string"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"text": {
"type": "string"
}
},
"type": "object"
},
"MultiformatMessageString": {
"additionalProperties": false,
"properties": {
"markdown": {
"type": "string"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"text": {
"type": "string"
}
},
"type": "object"
},
"PhysicalLocation": {
"additionalProperties": false,
"properties": {
"address": {
"$ref": "#/$defs/Address"
},
"artifactLocation": {
"$ref": "#/$defs/ArtifactLocation"
},
"contextRegion": {
"$ref": "#/$defs/Region"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"region": {
"$ref": "#/$defs/Region"
}
},
"type": "object"
},
"Properties": {
"type": "object"
},
"PropertyBag": {
"additionalProperties": false,
"properties": {
"properties": {
"$ref": "#/$defs/Properties"
}
},
"type": "object"
},
"Region": {
"additionalProperties": false,
"properties": {
"byteLength": {
"type": "integer"
},
"byteOffset": {
"type": "integer"
},
"charLength": {
"type": "integer"
},
"charOffset": {
"type": "integer"
},
"endColumn": {
"type": "integer"
},
"endLine": {
"type": "integer"
},
"message": {
"$ref": "#/$defs/Message"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"snippet": {
"$ref": "#/$defs/ArtifactContent"
},
"sourceLanguage": {
"type": "string"
},
"startColumn": {
"type": "integer"
},
"startLine": {
"type": "integer"
}
},
"type": "object"
},
"Replacement": {
"additionalProperties": false,
"properties": {
"deletedRegion": {
"$ref": "#/$defs/Region"
},
"insertedContent": {
"$ref": "#/$defs/ArtifactContent"
},
"properties": {
"$ref": "#/$defs/Properties"
}
},
"required": [
"deletedRegion"
],
"type": "object"
},
"Report": {
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"runs": {
"items": {
"$ref": "#/$defs/Run"
},
"type": "array"
},
"version": {
"type": "string"
}
},
"required": [
"version",
"$schema",
"runs"
],
"type": "object"
},
"ReportingConfiguration": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"level": true,
"parameters": {
"$ref": "#/$defs/PropertyBag"
},
"properties": {
"$ref": "#/$defs/PropertyBag"
},
"rank": {
"type": "number"
}
},
"type": "object"
},
"ReportingDescriptor": {
"additionalProperties": false,
"properties": {
"defaultConfiguration": {
"$ref": "#/$defs/ReportingConfiguration"
},
"fullDescription": {
"$ref": "#/$defs/MultiformatMessageString"
},
"help": {
"$ref": "#/$defs/MultiformatMessageString"
},
"helpUri": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"shortDescription": {
"$ref": "#/$defs/MultiformatMessageString"
}
},
"required": [
"id",
"shortDescription"
],
"type": "object"
},
"ReportingDescriptorReference": {
"additionalProperties": false,
"properties": {
"guid": {
"type": "string"
},
"id": {
"type": "string"
},
"index": {
"type": "integer"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"toolComponent": {
"$ref": "#/$defs/ToolComponentReference"
}
},
"type": "object"
},
"Result": {
"additionalProperties": false,
"properties": {
"analysisTarget": {
"$ref": "#/$defs/ArtifactLocation"
},
"baselineState": {
"type": "string"
},
"correlationGuid": {
"type": "string"
},
"fingerprints": {
"type": "object"
},
"fixes": {
"items": {
"$ref": "#/$defs/Fix"
},
"type": "array"
},
"guid": {
"type": "string"
},
"hostedViewerUri": {
"type": "string"
},
"kind": {
"type": "string"
},
"level": {
"type": "string"
},
"locations": {
"items": {
"$ref": "#/$defs/Location"
},
"type": "array"
},
"message": {
"$ref": "#/$defs/Message"
},
"occurrenceCount": {
"type": "integer"
},
"partialFingerprints": {
"type": "object"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"rank": {
"type": "number"
},
"relatedLocations": {
"items": {
"$ref": "#/$defs/Location"
},
"type": "array"
},
"rule": {
"$ref": "#/$defs/ReportingDescriptorReference"
},
"ruleId": {
"type": "string"
},
"ruleIndex": {
"type": "integer"
},
"suppressions": {
"items": {
"$ref": "#/$defs/Suppression"
},
"type": "array"
},
"taxa": {
"items": {
"$ref": "#/$defs/ReportingDescriptorReference"
},
"type": "array"
},
"workItemUris": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"message"
],
"type": "object"
},
"Run": {
"additionalProperties": false,
"properties": {
"artifacts": {
"items": {
"$ref": "#/$defs/Artifact"
},
"type": "array"
},
"invocations": {
"items": {
"$ref": "#/$defs/Invocation"
},
"type": "array"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"results": {
"items": {
"$ref": "#/$defs/Result"
},
"type": "array"
},
"tool": {
"$ref": "#/$defs/Tool"
}
},
"required": [
"tool",
"results"
],
"type": "object"
},
"Suppression": {
"additionalProperties": false,
"properties": {
"guid": {
"type": "string"
},
"justification": {
"type": "string"
},
"kind": {
"type": "string"
},
"location": {
"$ref": "#/$defs/Location"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"status": {
"type": "string"
}
},
"required": [
"kind",
"status",
"location",
"guid",
"justification"
],
"type": "object"
},
"Tool": {
"additionalProperties": false,
"properties": {
"driver": {
"$ref": "#/$defs/ToolComponent"
},
"properties": {
"$ref": "#/$defs/Properties"
}
},
"required": [
"driver"
],
"type": "object"
},
"ToolComponent": {
"additionalProperties": false,
"properties": {
"informationUri": {
"type": "string"
},
"name": {
"type": "string"
},
"notifications": {
"items": {
"$ref": "#/$defs/ReportingDescriptor"
},
"type": "array"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"rules": {
"items": {
"$ref": "#/$defs/ReportingDescriptor"
},
"type": "array"
},
"taxa": {
"items": {
"$ref": "#/$defs/ReportingDescriptor"
},
"type": "array"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"informationUri"
],
"type": "object"
},
"ToolComponentReference": {
"additionalProperties": false,
"properties": {
"guid": {
"type": "string"
},
"index": {
"type": "integer"
},
"name": {
"type": "string"
},
"properties": {
"$ref": "#/$defs/Properties"
}
},
"required": [
"name",
"index",
"guid"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/product.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"DigestSet": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Product": {
"additionalProperties": false,
"properties": {
"digest": {
"$ref": "#/$defs/DigestSet"
},
"mime_type": {
"type": "string"
}
},
"required": [
"mime_type",
"digest"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"Products": {
"additionalProperties": {
"$ref": "#/$defs/Product"
},
"type": "object"
}
},
"required": [
"Products"
],
"type": "object"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/git.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"author": {
"type": "string"
},
"authoremail": {
"type": "string"
},
"commitdate": {
"type": "string"
},
"commitdigest": {
"$ref": "#/$defs/DigestSet"
},
"commithash": {
"type": "string"
},
"commitmessage": {
"type": "string"
},
"committeremail": {
"type": "string"
},
"committername": {
"type": "string"
},
"parenthashes": {
"items": {
"type": "string"
},
"type": "array"
},
"refs": {
"items": {
"type": "string"
},
"type": "array"
},
"remotes": {
"items": {
"type": "string"
},
"type": "array"
},
"signature": {
"type": "string"
},
"status": {
"additionalProperties": {
"$ref": "#/$defs/Status"
},
"type": "object"
},
"tags": {
"items": {
"$ref": "#/$defs/Tag"
},
"type": "array"
},
"treehash": {
"type": "string"
}
},
"required": [
"commithash",
"author",
"authoremail",
"committername",
"committeremail",
"commitdate",
"commitmessage"
],
"type": "object"
},
"DigestSet": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Status": {
"additionalProperties": false,
"properties": {
"staging": {
"type": "string"
},
"worktree": {
"type": "string"
}
},
"type": "object"
},
"Tag": {
"additionalProperties": false,
"properties": {
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"pgpsignature": {
"type": "string"
},
"taggeremail": {
"type": "string"
},
"taggername": {
"type": "string"
},
"when": {
"type": "string"
}
},
"required": [
"name",
"taggername",
"taggeremail",
"when",
"pgpsignature",
"message"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/aws.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"accountId": {
"type": "string"
},
"architecture": {
"type": "string"
},
"availabilityZone": {
"type": "string"
},
"billingProducts": {
"items": {
"type": "string"
},
"type": "array"
},
"devpayProductCodes": {
"items": {
"type": "string"
},
"type": "array"
},
"imageId": {
"type": "string"
},
"instanceId": {
"type": "string"
},
"instanceType": {
"type": "string"
},
"kernelId": {
"type": "string"
},
"marketplaceProductCodes": {
"items": {
"type": "string"
},
"type": "array"
},
"pendingTime": {
"format": "date-time",
"type": "string"
},
"privateIp": {
"type": "string"
},
"publickey": {
"type": "string"
},
"ramdiskId": {
"type": "string"
},
"rawiid": {
"type": "string"
},
"rawsig": {
"type": "string"
},
"region": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"devpayProductCodes",
"marketplaceProductCodes",
"availabilityZone",
"privateIp",
"version",
"region",
"instanceId",
"billingProducts",
"instanceType",
"accountId",
"pendingTime",
"imageId",
"kernelId",
"ramdiskId",
"architecture",
"rawiid",
"rawsig",
"publickey"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/maven.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"artifactid": {
"type": "string"
},
"dependencies": {
"items": {
"$ref": "#/$defs/MavenDependency"
},
"type": "array"
},
"groupid": {
"type": "string"
},
"projectname": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"groupid",
"artifactid",
"version",
"projectname",
"dependencies"
],
"type": "object"
},
"MavenDependency": {
"additionalProperties": false,
"properties": {
"artifactid": {
"type": "string"
},
"groupid": {
"type": "string"
},
"scope": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"groupid",
"artifactid",
"version",
"scope"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/oci.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"diffids": {
"items": {
"$ref": "#/$defs/DigestSet"
},
"type": "array"
},
"imageid": {
"$ref": "#/$defs/DigestSet"
},
"imagetags": {
"items": {
"type": "string"
},
"type": "array"
},
"manifest": {
"items": {
"$ref": "#/$defs/Manifest"
},
"type": "array"
},
"manifestdigest": {
"$ref": "#/$defs/DigestSet"
},
"manifestraw": {
"contentEncoding": "base64",
"type": "string"
},
"tardigest": {
"$ref": "#/$defs/DigestSet"
}
},
"required": [
"tardigest",
"manifest",
"imagetags",
"diffids",
"imageid",
"manifestraw",
"manifestdigest"
],
"type": "object"
},
"DigestSet": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Manifest": {
"additionalProperties": false,
"properties": {
"Config": {
"type": "string"
},
"Layers": {
"items": {
"type": "string"
},
"type": "array"
},
"RepoTags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Config",
"RepoTags",
"Layers"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/slsa.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"BuildDefinition": {
"additionalProperties": false,
"properties": {
"build_type": {
"type": "string"
},
"external_parameters": {
"$ref": "#/$defs/Struct"
},
"internal_parameters": {
"$ref": "#/$defs/Struct"
},
"resolved_dependencies": {
"items": {
"$ref": "#/$defs/ResourceDescriptor"
},
"type": "array"
}
},
"type": "object"
},
"BuildMetadata": {
"additionalProperties": false,
"properties": {
"finished_on": {
"$ref": "#/$defs/Timestamp"
},
"invocation_id": {
"type": "string"
},
"started_on": {
"$ref": "#/$defs/Timestamp"
}
},
"type": "object"
},
"Builder": {
"additionalProperties": false,
"properties": {
"builder_dependencies": {
"items": {
"$ref": "#/$defs/ResourceDescriptor"
},
"type": "array"
},
"id": {
"type": "string"
},
"version": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"Provenance": {
"additionalProperties": false,
"properties": {
"build_definition": {
"$ref": "#/$defs/BuildDefinition"
},
"run_details": {
"$ref": "#/$defs/RunDetails"
}
},
"type": "object"
},
"ResourceDescriptor": {
"additionalProperties": false,
"properties": {
"annotations": {
"$ref": "#/$defs/Struct"
},
"content": {
"contentEncoding": "base64",
"type": "string"
},
"digest": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"download_location": {
"type": "string"
},
"media_type": {
"type": "string"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"RunDetails": {
"additionalProperties": false,
"properties": {
"builder": {
"$ref": "#/$defs/Builder"
},
"byproducts": {
"items": {
"$ref": "#/$defs/ResourceDescriptor"
},
"type": "array"
},
"metadata": {
"$ref": "#/$defs/BuildMetadata"
}
},
"type": "object"
},
"Struct": {
"additionalProperties": false,
"properties": {
"fields": {
"additionalProperties": {
"$ref": "#/$defs/Value"
},
"type": "object"
}
},
"type": "object"
},
"Timestamp": {
"additionalProperties": false,
"properties": {
"nanos": {
"type": "integer"
},
"seconds": {
"type": "integer"
}
},
"type": "object"
},
"Value": {
"additionalProperties": false,
"properties": {
"Kind": true
},
"required": [
"Kind"
],
"type": "object"
}
},
"$id": "https://github.com/in-toto/attestation/go/predicates/provenance/v1/provenance",
"$ref": "#/$defs/Provenance",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/github.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"ciconfigpath": {
"type": "string"
},
"cihost": {
"type": "string"
},
"ciserverurl": {
"type": "string"
},
"jwt": {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"claims": {
"type": "object"
},
"verifiedBy": {
"$ref": "#/$defs/VerificationInfo"
}
},
"required": [
"claims"
],
"type": "object"
},
"AttributeTypeAndValue": {
"additionalProperties": false,
"properties": {
"Type": {
"$ref": "#/$defs/ObjectIdentifier"
},
"Value": true
},
"required": [
"Type",
"Value"
],
"type": "object"
},
"Certificate": {
"additionalProperties": false,
"properties": {
"AuthorityKeyId": {
"contentEncoding": "base64",
"type": "string"
},
"BasicConstraintsValid": {
"type": "boolean"
},
"CRLDistributionPoints": {
"items": {
"type": "string"
},
"type": "array"
},
"DNSNames": {
"items": {
"type": "string"
},
"type": "array"
},
"EmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedDNSDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedEmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedIPRanges": {
"items": {
"$ref": "#/$defs/IPNet"
},
"type": "array"
},
"ExcludedURIDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"ExtKeyUsage": {
"items": {
"type": "integer"
},
"type": "array"
},
"Extensions": {
"items": {
"$ref": "#/$defs/Extension"
},
"type": "array"
},
"ExtraExtensions": {
"items": {
"$ref": "#/$defs/Extension"
},
"type": "array"
},
"IPAddresses": {
"items": {
"format": "ipv4",
"type": "string"
},
"type": "array"
},
"IsCA": {
"type": "boolean"
},
"Issuer": {
"$ref": "#/$defs/Name"
},
"IssuingCertificateURL": {
"items": {
"type": "string"
},
"type": "array"
},
"KeyUsage": {
"type": "integer"
},
"MaxPathLen": {
"type": "integer"
},
"MaxPathLenZero": {
"type": "boolean"
},
"NotAfter": {
"format": "date-time",
"type": "string"
},
"NotBefore": {
"format": "date-time",
"type": "string"
},
"OCSPServer": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedDNSDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedDNSDomainsCritical": {
"type": "boolean"
},
"PermittedEmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedIPRanges": {
"items": {
"$ref": "#/$defs/IPNet"
},
"type": "array"
},
"PermittedURIDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"Policies": {
"items": {
"$ref": "#/$defs/OID"
},
"type": "array"
},
"PolicyIdentifiers": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"PublicKey": true,
"PublicKeyAlgorithm": {
"type": "integer"
},
"Raw": {
"contentEncoding": "base64",
"type": "string"
},
"RawIssuer": {
"contentEncoding": "base64",
"type": "string"
},
"RawSubject": {
"contentEncoding": "base64",
"type": "string"
},
"RawSubjectPublicKeyInfo": {
"contentEncoding": "base64",
"type": "string"
},
"RawTBSCertificate": {
"contentEncoding": "base64",
"type": "string"
},
"SerialNumber": {
"$ref": "#/$defs/Int"
},
"Signature": {
"contentEncoding": "base64",
"type": "string"
},
"SignatureAlgorithm": {
"type": "integer"
},
"Subject": {
"$ref": "#/$defs/Name"
},
"SubjectKeyId": {
"contentEncoding": "base64",
"type": "string"
},
"URIs": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"UnhandledCriticalExtensions": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"UnknownExtKeyUsage": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"Version": {
"type": "integer"
}
},
"required": [
"Raw",
"RawTBSCertificate",
"RawSubjectPublicKeyInfo",
"RawSubject",
"RawIssuer",
"Signature",
"SignatureAlgorithm",
"PublicKeyAlgorithm",
"PublicKey",
"Version",
"SerialNumber",
"Issuer",
"Subject",
"NotBefore",
"NotAfter",
"KeyUsage",
"Extensions",
"ExtraExtensions",
"UnhandledCriticalExtensions",
"ExtKeyUsage",
"UnknownExtKeyUsage",
"BasicConstraintsValid",
"IsCA",
"MaxPathLen",
"MaxPathLenZero",
"SubjectKeyId",
"AuthorityKeyId",
"OCSPServer",
"IssuingCertificateURL",
"DNSNames",
"EmailAddresses",
"IPAddresses",
"URIs",
"PermittedDNSDomainsCritical",
"PermittedDNSDomains",
"ExcludedDNSDomains",
"PermittedIPRanges",
"ExcludedIPRanges",
"PermittedEmailAddresses",
"ExcludedEmailAddresses",
"PermittedURIDomains",
"ExcludedURIDomains",
"CRLDistributionPoints",
"PolicyIdentifiers",
"Policies"
],
"type": "object"
},
"Extension": {
"additionalProperties": false,
"properties": {
"Critical": {
"type": "boolean"
},
"Id": {
"$ref": "#/$defs/ObjectIdentifier"
},
"Value": {
"contentEncoding": "base64",
"type": "string"
}
},
"required": [
"Id",
"Critical",
"Value"
],
"type": "object"
},
"IPMask": {
"contentEncoding": "base64",
"type": "string"
},
"IPNet": {
"additionalProperties": false,
"properties": {
"IP": {
"format": "ipv4",
"type": "string"
},
"Mask": {
"$ref": "#/$defs/IPMask"
}
},
"required": [
"IP",
"Mask"
],
"type": "object"
},
"Int": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"JSONWebKey": {
"additionalProperties": false,
"properties": {
"Algorithm": {
"type": "string"
},
"CertificateThumbprintSHA1": {
"contentEncoding": "base64",
"type": "string"
},
"CertificateThumbprintSHA256": {
"contentEncoding": "base64",
"type": "string"
},
"Certificates": {
"items": {
"$ref": "#/$defs/Certificate"
},
"type": "array"
},
"CertificatesURL": {
"format": "uri",
"type": "string"
},
"Key": true,
"KeyID": {
"type": "string"
},
"Use": {
"type": "string"
}
},
"required": [
"Key",
"KeyID",
"Algorithm",
"Use",
"Certificates",
"CertificatesURL",
"CertificateThumbprintSHA1",
"CertificateThumbprintSHA256"
],
"type": "object"
},
"Name": {
"additionalProperties": false,
"properties": {
"CommonName": {
"type": "string"
},
"Country": {
"items": {
"type": "string"
},
"type": "array"
},
"ExtraNames": {
"items": {
"$ref": "#/$defs/AttributeTypeAndValue"
},
"type": "array"
},
"Locality": {
"items": {
"type": "string"
},
"type": "array"
},
"Names": {
"items": {
"$ref": "#/$defs/AttributeTypeAndValue"
},
"type": "array"
},
"Organization": {
"items": {
"type": "string"
},
"type": "array"
},
"OrganizationalUnit": {
"items": {
"type": "string"
},
"type": "array"
},
"PostalCode": {
"items": {
"type": "string"
},
"type": "array"
},
"Province": {
"items": {
"type": "string"
},
"type": "array"
},
"SerialNumber": {
"type": "string"
},
"StreetAddress": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Country",
"Organization",
"OrganizationalUnit",
"Locality",
"Province",
"StreetAddress",
"PostalCode",
"SerialNumber",
"CommonName",
"Names",
"ExtraNames"
],
"type": "object"
},
"OID": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"ObjectIdentifier": {
"items": {
"type": "integer"
},
"type": "array"
},
"VerificationInfo": {
"additionalProperties": false,
"properties": {
"jwk": {
"$ref": "#/$defs/JSONWebKey"
},
"jwksUrl": {
"type": "string"
}
},
"required": [
"jwksUrl",
"jwk"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"pipelineid": {
"type": "string"
},
"pipelinename": {
"type": "string"
},
"pipelineurl": {
"type": "string"
},
"projecturl": {
"type": "string"
},
"runnerarch": {
"type": "string"
},
"runnerid": {
"type": "string"
},
"runneros": {
"type": "string"
}
},
"required": [
"ciconfigpath",
"pipelineid",
"pipelinename",
"pipelineurl",
"projecturl",
"runnerid",
"cihost",
"ciserverurl",
"runnerarch",
"runneros"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/jwt.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"claims": {
"type": "object"
},
"verifiedBy": {
"$ref": "#/$defs/VerificationInfo"
}
},
"required": [
"claims"
],
"type": "object"
},
"AttributeTypeAndValue": {
"additionalProperties": false,
"properties": {
"Type": {
"$ref": "#/$defs/ObjectIdentifier"
},
"Value": true
},
"required": [
"Type",
"Value"
],
"type": "object"
},
"Certificate": {
"additionalProperties": false,
"properties": {
"AuthorityKeyId": {
"contentEncoding": "base64",
"type": "string"
},
"BasicConstraintsValid": {
"type": "boolean"
},
"CRLDistributionPoints": {
"items": {
"type": "string"
},
"type": "array"
},
"DNSNames": {
"items": {
"type": "string"
},
"type": "array"
},
"EmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedDNSDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedEmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedIPRanges": {
"items": {
"$ref": "#/$defs/IPNet"
},
"type": "array"
},
"ExcludedURIDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"ExtKeyUsage": {
"items": {
"type": "integer"
},
"type": "array"
},
"Extensions": {
"items": {
"$ref": "#/$defs/Extension"
},
"type": "array"
},
"ExtraExtensions": {
"items": {
"$ref": "#/$defs/Extension"
},
"type": "array"
},
"IPAddresses": {
"items": {
"format": "ipv4",
"type": "string"
},
"type": "array"
},
"IsCA": {
"type": "boolean"
},
"Issuer": {
"$ref": "#/$defs/Name"
},
"IssuingCertificateURL": {
"items": {
"type": "string"
},
"type": "array"
},
"KeyUsage": {
"type": "integer"
},
"MaxPathLen": {
"type": "integer"
},
"MaxPathLenZero": {
"type": "boolean"
},
"NotAfter": {
"format": "date-time",
"type": "string"
},
"NotBefore": {
"format": "date-time",
"type": "string"
},
"OCSPServer": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedDNSDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedDNSDomainsCritical": {
"type": "boolean"
},
"PermittedEmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedIPRanges": {
"items": {
"$ref": "#/$defs/IPNet"
},
"type": "array"
},
"PermittedURIDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"Policies": {
"items": {
"$ref": "#/$defs/OID"
},
"type": "array"
},
"PolicyIdentifiers": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"PublicKey": true,
"PublicKeyAlgorithm": {
"type": "integer"
},
"Raw": {
"contentEncoding": "base64",
"type": "string"
},
"RawIssuer": {
"contentEncoding": "base64",
"type": "string"
},
"RawSubject": {
"contentEncoding": "base64",
"type": "string"
},
"RawSubjectPublicKeyInfo": {
"contentEncoding": "base64",
"type": "string"
},
"RawTBSCertificate": {
"contentEncoding": "base64",
"type": "string"
},
"SerialNumber": {
"$ref": "#/$defs/Int"
},
"Signature": {
"contentEncoding": "base64",
"type": "string"
},
"SignatureAlgorithm": {
"type": "integer"
},
"Subject": {
"$ref": "#/$defs/Name"
},
"SubjectKeyId": {
"contentEncoding": "base64",
"type": "string"
},
"URIs": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"UnhandledCriticalExtensions": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"UnknownExtKeyUsage": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"Version": {
"type": "integer"
}
},
"required": [
"Raw",
"RawTBSCertificate",
"RawSubjectPublicKeyInfo",
"RawSubject",
"RawIssuer",
"Signature",
"SignatureAlgorithm",
"PublicKeyAlgorithm",
"PublicKey",
"Version",
"SerialNumber",
"Issuer",
"Subject",
"NotBefore",
"NotAfter",
"KeyUsage",
"Extensions",
"ExtraExtensions",
"UnhandledCriticalExtensions",
"ExtKeyUsage",
"UnknownExtKeyUsage",
"BasicConstraintsValid",
"IsCA",
"MaxPathLen",
"MaxPathLenZero",
"SubjectKeyId",
"AuthorityKeyId",
"OCSPServer",
"IssuingCertificateURL",
"DNSNames",
"EmailAddresses",
"IPAddresses",
"URIs",
"PermittedDNSDomainsCritical",
"PermittedDNSDomains",
"ExcludedDNSDomains",
"PermittedIPRanges",
"ExcludedIPRanges",
"PermittedEmailAddresses",
"ExcludedEmailAddresses",
"PermittedURIDomains",
"ExcludedURIDomains",
"CRLDistributionPoints",
"PolicyIdentifiers",
"Policies"
],
"type": "object"
},
"Extension": {
"additionalProperties": false,
"properties": {
"Critical": {
"type": "boolean"
},
"Id": {
"$ref": "#/$defs/ObjectIdentifier"
},
"Value": {
"contentEncoding": "base64",
"type": "string"
}
},
"required": [
"Id",
"Critical",
"Value"
],
"type": "object"
},
"IPMask": {
"contentEncoding": "base64",
"type": "string"
},
"IPNet": {
"additionalProperties": false,
"properties": {
"IP": {
"format": "ipv4",
"type": "string"
},
"Mask": {
"$ref": "#/$defs/IPMask"
}
},
"required": [
"IP",
"Mask"
],
"type": "object"
},
"Int": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"JSONWebKey": {
"additionalProperties": false,
"properties": {
"Algorithm": {
"type": "string"
},
"CertificateThumbprintSHA1": {
"contentEncoding": "base64",
"type": "string"
},
"CertificateThumbprintSHA256": {
"contentEncoding": "base64",
"type": "string"
},
"Certificates": {
"items": {
"$ref": "#/$defs/Certificate"
},
"type": "array"
},
"CertificatesURL": {
"format": "uri",
"type": "string"
},
"Key": true,
"KeyID": {
"type": "string"
},
"Use": {
"type": "string"
}
},
"required": [
"Key",
"KeyID",
"Algorithm",
"Use",
"Certificates",
"CertificatesURL",
"CertificateThumbprintSHA1",
"CertificateThumbprintSHA256"
],
"type": "object"
},
"Name": {
"additionalProperties": false,
"properties": {
"CommonName": {
"type": "string"
},
"Country": {
"items": {
"type": "string"
},
"type": "array"
},
"ExtraNames": {
"items": {
"$ref": "#/$defs/AttributeTypeAndValue"
},
"type": "array"
},
"Locality": {
"items": {
"type": "string"
},
"type": "array"
},
"Names": {
"items": {
"$ref": "#/$defs/AttributeTypeAndValue"
},
"type": "array"
},
"Organization": {
"items": {
"type": "string"
},
"type": "array"
},
"OrganizationalUnit": {
"items": {
"type": "string"
},
"type": "array"
},
"PostalCode": {
"items": {
"type": "string"
},
"type": "array"
},
"Province": {
"items": {
"type": "string"
},
"type": "array"
},
"SerialNumber": {
"type": "string"
},
"StreetAddress": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Country",
"Organization",
"OrganizationalUnit",
"Locality",
"Province",
"StreetAddress",
"PostalCode",
"SerialNumber",
"CommonName",
"Names",
"ExtraNames"
],
"type": "object"
},
"OID": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"ObjectIdentifier": {
"items": {
"type": "integer"
},
"type": "array"
},
"VerificationInfo": {
"additionalProperties": false,
"properties": {
"jwk": {
"$ref": "#/$defs/JSONWebKey"
},
"jwksUrl": {
"type": "string"
}
},
"required": [
"jwksUrl",
"jwk"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/material.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"DigestSet": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"Materials": {
"additionalProperties": {
"$ref": "#/$defs/DigestSet"
},
"type": "object"
}
},
"required": [
"Materials"
],
"type": "object"
} | Apache-2.0 | en |
in-toto/witness | 8e1f2fcda22c93870c6c578c35d7acd7c96f36c9 | 2024-05-13T17:59:35 | docs/attestors/gcp-iit.json | 365 | 2024-05-27T08:32:45.673472Z | {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"cluster_location": {
"type": "string"
},
"cluster_name": {
"type": "string"
},
"cluster_uid": {
"type": "string"
},
"instance_confidentiality": {
"type": "string"
},
"instance_creation_timestamp": {
"type": "string"
},
"instance_hostname": {
"type": "string"
},
"instance_id": {
"type": "string"
},
"jwt": {
"$defs": {
"Attestor": {
"additionalProperties": false,
"properties": {
"claims": {
"type": "object"
},
"verifiedBy": {
"$ref": "#/$defs/VerificationInfo"
}
},
"required": [
"claims"
],
"type": "object"
},
"AttributeTypeAndValue": {
"additionalProperties": false,
"properties": {
"Type": {
"$ref": "#/$defs/ObjectIdentifier"
},
"Value": true
},
"required": [
"Type",
"Value"
],
"type": "object"
},
"Certificate": {
"additionalProperties": false,
"properties": {
"AuthorityKeyId": {
"contentEncoding": "base64",
"type": "string"
},
"BasicConstraintsValid": {
"type": "boolean"
},
"CRLDistributionPoints": {
"items": {
"type": "string"
},
"type": "array"
},
"DNSNames": {
"items": {
"type": "string"
},
"type": "array"
},
"EmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedDNSDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedEmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"ExcludedIPRanges": {
"items": {
"$ref": "#/$defs/IPNet"
},
"type": "array"
},
"ExcludedURIDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"ExtKeyUsage": {
"items": {
"type": "integer"
},
"type": "array"
},
"Extensions": {
"items": {
"$ref": "#/$defs/Extension"
},
"type": "array"
},
"ExtraExtensions": {
"items": {
"$ref": "#/$defs/Extension"
},
"type": "array"
},
"IPAddresses": {
"items": {
"format": "ipv4",
"type": "string"
},
"type": "array"
},
"IsCA": {
"type": "boolean"
},
"Issuer": {
"$ref": "#/$defs/Name"
},
"IssuingCertificateURL": {
"items": {
"type": "string"
},
"type": "array"
},
"KeyUsage": {
"type": "integer"
},
"MaxPathLen": {
"type": "integer"
},
"MaxPathLenZero": {
"type": "boolean"
},
"NotAfter": {
"format": "date-time",
"type": "string"
},
"NotBefore": {
"format": "date-time",
"type": "string"
},
"OCSPServer": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedDNSDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedDNSDomainsCritical": {
"type": "boolean"
},
"PermittedEmailAddresses": {
"items": {
"type": "string"
},
"type": "array"
},
"PermittedIPRanges": {
"items": {
"$ref": "#/$defs/IPNet"
},
"type": "array"
},
"PermittedURIDomains": {
"items": {
"type": "string"
},
"type": "array"
},
"Policies": {
"items": {
"$ref": "#/$defs/OID"
},
"type": "array"
},
"PolicyIdentifiers": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"PublicKey": true,
"PublicKeyAlgorithm": {
"type": "integer"
},
"Raw": {
"contentEncoding": "base64",
"type": "string"
},
"RawIssuer": {
"contentEncoding": "base64",
"type": "string"
},
"RawSubject": {
"contentEncoding": "base64",
"type": "string"
},
"RawSubjectPublicKeyInfo": {
"contentEncoding": "base64",
"type": "string"
},
"RawTBSCertificate": {
"contentEncoding": "base64",
"type": "string"
},
"SerialNumber": {
"$ref": "#/$defs/Int"
},
"Signature": {
"contentEncoding": "base64",
"type": "string"
},
"SignatureAlgorithm": {
"type": "integer"
},
"Subject": {
"$ref": "#/$defs/Name"
},
"SubjectKeyId": {
"contentEncoding": "base64",
"type": "string"
},
"URIs": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"UnhandledCriticalExtensions": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"UnknownExtKeyUsage": {
"items": {
"$ref": "#/$defs/ObjectIdentifier"
},
"type": "array"
},
"Version": {
"type": "integer"
}
},
"required": [
"Raw",
"RawTBSCertificate",
"RawSubjectPublicKeyInfo",
"RawSubject",
"RawIssuer",
"Signature",
"SignatureAlgorithm",
"PublicKeyAlgorithm",
"PublicKey",
"Version",
"SerialNumber",
"Issuer",
"Subject",
"NotBefore",
"NotAfter",
"KeyUsage",
"Extensions",
"ExtraExtensions",
"UnhandledCriticalExtensions",
"ExtKeyUsage",
"UnknownExtKeyUsage",
"BasicConstraintsValid",
"IsCA",
"MaxPathLen",
"MaxPathLenZero",
"SubjectKeyId",
"AuthorityKeyId",
"OCSPServer",
"IssuingCertificateURL",
"DNSNames",
"EmailAddresses",
"IPAddresses",
"URIs",
"PermittedDNSDomainsCritical",
"PermittedDNSDomains",
"ExcludedDNSDomains",
"PermittedIPRanges",
"ExcludedIPRanges",
"PermittedEmailAddresses",
"ExcludedEmailAddresses",
"PermittedURIDomains",
"ExcludedURIDomains",
"CRLDistributionPoints",
"PolicyIdentifiers",
"Policies"
],
"type": "object"
},
"Extension": {
"additionalProperties": false,
"properties": {
"Critical": {
"type": "boolean"
},
"Id": {
"$ref": "#/$defs/ObjectIdentifier"
},
"Value": {
"contentEncoding": "base64",
"type": "string"
}
},
"required": [
"Id",
"Critical",
"Value"
],
"type": "object"
},
"IPMask": {
"contentEncoding": "base64",
"type": "string"
},
"IPNet": {
"additionalProperties": false,
"properties": {
"IP": {
"format": "ipv4",
"type": "string"
},
"Mask": {
"$ref": "#/$defs/IPMask"
}
},
"required": [
"IP",
"Mask"
],
"type": "object"
},
"Int": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"JSONWebKey": {
"additionalProperties": false,
"properties": {
"Algorithm": {
"type": "string"
},
"CertificateThumbprintSHA1": {
"contentEncoding": "base64",
"type": "string"
},
"CertificateThumbprintSHA256": {
"contentEncoding": "base64",
"type": "string"
},
"Certificates": {
"items": {
"$ref": "#/$defs/Certificate"
},
"type": "array"
},
"CertificatesURL": {
"format": "uri",
"type": "string"
},
"Key": true,
"KeyID": {
"type": "string"
},
"Use": {
"type": "string"
}
},
"required": [
"Key",
"KeyID",
"Algorithm",
"Use",
"Certificates",
"CertificatesURL",
"CertificateThumbprintSHA1",
"CertificateThumbprintSHA256"
],
"type": "object"
},
"Name": {
"additionalProperties": false,
"properties": {
"CommonName": {
"type": "string"
},
"Country": {
"items": {
"type": "string"
},
"type": "array"
},
"ExtraNames": {
"items": {
"$ref": "#/$defs/AttributeTypeAndValue"
},
"type": "array"
},
"Locality": {
"items": {
"type": "string"
},
"type": "array"
},
"Names": {
"items": {
"$ref": "#/$defs/AttributeTypeAndValue"
},
"type": "array"
},
"Organization": {
"items": {
"type": "string"
},
"type": "array"
},
"OrganizationalUnit": {
"items": {
"type": "string"
},
"type": "array"
},
"PostalCode": {
"items": {
"type": "string"
},
"type": "array"
},
"Province": {
"items": {
"type": "string"
},
"type": "array"
},
"SerialNumber": {
"type": "string"
},
"StreetAddress": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Country",
"Organization",
"OrganizationalUnit",
"Locality",
"Province",
"StreetAddress",
"PostalCode",
"SerialNumber",
"CommonName",
"Names",
"ExtraNames"
],
"type": "object"
},
"OID": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"ObjectIdentifier": {
"items": {
"type": "integer"
},
"type": "array"
},
"VerificationInfo": {
"additionalProperties": false,
"properties": {
"jwk": {
"$ref": "#/$defs/JSONWebKey"
},
"jwksUrl": {
"type": "string"
}
},
"required": [
"jwksUrl",
"jwk"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"licence_id": {
"items": {
"type": "string"
},
"type": "array"
},
"project_id": {
"type": "string"
},
"project_number": {
"type": "string"
},
"zone": {
"type": "string"
}
},
"required": [
"jwt",
"project_id",
"project_number",
"zone",
"instance_id",
"instance_hostname",
"instance_creation_timestamp",
"instance_confidentiality",
"licence_id",
"cluster_name",
"cluster_uid",
"cluster_location"
],
"type": "object"
}
},
"$ref": "#/$defs/Attestor",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flomesh-io/traffic-guru | 978da4df8cb9eaaf0106639920bc3db6c3ec814b | 2022-12-22T01:23:07 | charts/flomesh-console/values.schema.json | 19 | 2024-05-27T07:42:04.487752Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"console": {
"env": {},
"imageName": "flomesh-console-ubi8",
"resources": {},
"tag": "0.70.0-25"
},
"database": {
"db": "flomesh",
"host": "mysql.flomesh-console.svc",
"password": "",
"port": 3306,
"type": "default",
"username": "flomesh"
},
"fullnameOverride": "flomesh-console",
"image": {
"pullPolicy": "IfNotPresent",
"repository": "quay.io/flomesh"
},
"imagePullSecrets": [],
"ingress": {
"annotations": {},
"className": "",
"enabled": false,
"host": "flomesh-console.local",
"paths": [
{
"path": "/",
"pathType": "ImplementationSpecific"
}
],
"tls": []
},
"nameOverride": "flomesh-console",
"nodeSelector": {},
"pipyRepo": {
"imageName": "pipy-repo-ubi8",
"resources": {},
"tag": "0.70.0-46"
},
"podAnnotations": {},
"podSecurityContext": {},
"securityContext": {},
"service": {
"nodePort": 30000,
"port": 8080,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": "flomesh-console"
},
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"database": {
"default": {},
"examples": [
{
"db": "flomesh",
"host": "mysql.flomesh-console.svc",
"password": "",
"port": 3306,
"type": "default",
"username": "flomesh"
}
],
"properties": {
"db": {
"default": "",
"examples": [
"flomesh"
],
"title": "The db Schema",
"type": "string"
},
"host": {
"default": "",
"examples": [
"mysql.flomesh-console.svc"
],
"title": "The host Schema",
"type": "string"
},
"password": {
"default": "",
"examples": [
""
],
"title": "The password Schema",
"type": "string"
},
"port": {
"default": 0,
"examples": [
3306
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"default"
],
"title": "The type Schema",
"type": "string"
},
"username": {
"default": "",
"examples": [
"flomesh"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"host",
"port",
"db",
"username",
"password",
"type"
],
"title": "The database Schema",
"type": "object"
},
"fullnameOverride": {
"default": "",
"examples": [
"flomesh-console"
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"gui": {
"default": {},
"examples": [
{
"env": {},
"imageName": "flomesh-console-ubi8",
"resources": {},
"tag": "0.70.0-25"
}
],
"properties": {
"env": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The env Schema",
"type": "object"
},
"imageName": {
"default": "",
"examples": [
"flomesh-console-ubi8"
],
"title": "The imageName Schema",
"type": "string"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"tag": {
"default": "",
"examples": [
"0.70.0-25"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"imageName",
"resources",
"env"
],
"title": "The console Schema",
"type": "object"
},
"image": {
"default": {},
"examples": [
{
"pullPolicy": "IfNotPresent",
"repository": "quay.io/flomesh"
}
],
"properties": {
"pullPolicy": {
"default": "",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "",
"examples": [
"quay.io/flomesh"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"pullPolicy"
],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"ingress": {
"default": {},
"examples": [
{
"annotations": {},
"className": "",
"enabled": false,
"host": "flomesh-console.local",
"paths": [
{
"path": "/",
"pathType": "ImplementationSpecific"
}
],
"tls": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"className": {
"default": "",
"examples": [
""
],
"title": "The className Schema",
"type": "string"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"flomesh-console.local"
],
"title": "The host Schema",
"type": "string"
},
"paths": {
"default": [],
"examples": [
[
{
"path": "/",
"pathType": "ImplementationSpecific"
}
]
],
"items": {
"default": {},
"examples": [
{
"path": "/",
"pathType": "ImplementationSpecific"
}
],
"properties": {
"path": {
"default": "",
"examples": [
"/"
],
"title": "The path Schema",
"type": "string"
},
"pathType": {
"default": "",
"examples": [
"ImplementationSpecific"
],
"title": "The pathType Schema",
"type": "string"
}
},
"required": [
"path",
"pathType"
],
"title": "A Schema",
"type": "object"
},
"title": "The paths Schema",
"type": "array"
},
"tls": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tls Schema",
"type": "array"
}
},
"required": [
"enabled",
"className",
"annotations",
"host",
"paths",
"tls"
],
"title": "The ingress Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
"flomesh-console"
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pipyRepo": {
"default": {},
"examples": [
{
"imageName": "pipy-repo-ubi8",
"resources": {},
"tag": "0.70.0-46"
}
],
"properties": {
"imageName": {
"default": "",
"examples": [
"pipy-repo-ubi8"
],
"title": "The imageName Schema",
"type": "string"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"tag": {
"default": "",
"examples": [
"0.70.0-46"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"imageName",
"tag",
"resources"
],
"title": "The pipyRepo Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"nodePort": 30000,
"port": 8080,
"type": "ClusterIP"
}
],
"properties": {
"nodePort": {
"default": 0,
"examples": [
30000
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 0,
"examples": [
8080
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"port",
"nodePort"
],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": "flomesh-console"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
"flomesh-console"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"create",
"annotations",
"name"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"image",
"imagePullSecrets",
"nameOverride",
"fullnameOverride",
"gui",
"pipyRepo",
"database",
"serviceAccount",
"podAnnotations",
"podSecurityContext",
"securityContext",
"service",
"ingress",
"nodeSelector",
"tolerations",
"affinity"
],
"title": "Root Schema",
"type": "object"
} | MIT | en |
flomesh-io/traffic-guru | 978da4df8cb9eaaf0106639920bc3db6c3ec814b | 2022-12-22T01:23:07 | charts/traffic-guru/values.schema.json | 19 | 2024-05-27T07:42:04.487752Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"database": {
"db": "flomesh",
"host": "mysql.traffic-guru.svc",
"password": "",
"port": 3306,
"type": "default",
"username": "flomesh"
},
"fullnameOverride": "traffic-guru",
"gui": {
"env": {},
"imageName": "traffic-guru",
"resources": {},
"tag": "0.70.0-25"
},
"image": {
"pullPolicy": "IfNotPresent",
"repository": "flomesh"
},
"imagePullSecrets": [],
"ingress": {
"annotations": {},
"className": "",
"enabled": false,
"host": "traffic-guru.local",
"paths": [
{
"path": "/",
"pathType": "ImplementationSpecific"
}
],
"tls": []
},
"nameOverride": "traffic-guru",
"nodeSelector": {},
"pipyRepo": {
"imageName": "pipy-repo-ubi8",
"resources": {},
"tag": "0.70.0-46"
},
"podAnnotations": {},
"podSecurityContext": {},
"securityContext": {},
"service": {
"nodePort": 30000,
"port": 8080,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": "traffic-guru"
},
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"database": {
"default": {},
"examples": [
{
"db": "flomesh",
"host": "mysql.traffic-guru.svc",
"password": "",
"port": 3306,
"type": "default",
"username": "flomesh"
}
],
"properties": {
"db": {
"default": "",
"examples": [
"flomesh"
],
"title": "The db Schema",
"type": "string"
},
"host": {
"default": "",
"examples": [
"mysql.traffic-guru.svc"
],
"title": "The host Schema",
"type": "string"
},
"password": {
"default": "",
"examples": [
""
],
"title": "The password Schema",
"type": "string"
},
"port": {
"default": 0,
"examples": [
3306
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"default"
],
"title": "The type Schema",
"type": "string"
},
"username": {
"default": "",
"examples": [
"flomesh"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"host",
"port",
"db",
"username",
"password",
"type"
],
"title": "The database Schema",
"type": "object"
},
"fullnameOverride": {
"default": "",
"examples": [
"traffic-guru"
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"gui": {
"default": {},
"examples": [
{
"env": {},
"imageName": "traffic-guru-ubi8",
"resources": {},
"tag": "0.70.0-25"
}
],
"properties": {
"env": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The env Schema",
"type": "object"
},
"imageName": {
"default": "",
"examples": [
"traffic-guru-ubi8"
],
"title": "The imageName Schema",
"type": "string"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"tag": {
"default": "",
"examples": [
"0.70.0-25"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"imageName",
"resources",
"env"
],
"title": "The gui Schema",
"type": "object"
},
"image": {
"default": {},
"examples": [
{
"pullPolicy": "IfNotPresent",
"repository": "flomesh"
}
],
"properties": {
"pullPolicy": {
"default": "",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "",
"examples": [
"flomesh"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"pullPolicy"
],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"ingress": {
"default": {},
"examples": [
{
"annotations": {},
"className": "",
"enabled": false,
"host": "traffic-guru.local",
"paths": [
{
"path": "/",
"pathType": "ImplementationSpecific"
}
],
"tls": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"className": {
"default": "",
"examples": [
""
],
"title": "The className Schema",
"type": "string"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"traffic-guru.local"
],
"title": "The host Schema",
"type": "string"
},
"paths": {
"default": [],
"examples": [
[
{
"path": "/",
"pathType": "ImplementationSpecific"
}
]
],
"items": {
"default": {},
"examples": [
{
"path": "/",
"pathType": "ImplementationSpecific"
}
],
"properties": {
"path": {
"default": "",
"examples": [
"/"
],
"title": "The path Schema",
"type": "string"
},
"pathType": {
"default": "",
"examples": [
"ImplementationSpecific"
],
"title": "The pathType Schema",
"type": "string"
}
},
"required": [
"path",
"pathType"
],
"title": "A Schema",
"type": "object"
},
"title": "The paths Schema",
"type": "array"
},
"tls": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tls Schema",
"type": "array"
}
},
"required": [
"enabled",
"className",
"annotations",
"host",
"paths",
"tls"
],
"title": "The ingress Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
"traffic-guru"
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pipyRepo": {
"default": {},
"examples": [
{
"imageName": "pipy-repo-ubi8",
"resources": {},
"tag": "0.70.0-46"
}
],
"properties": {
"imageName": {
"default": "",
"examples": [
"pipy-repo-ubi8"
],
"title": "The imageName Schema",
"type": "string"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"tag": {
"default": "",
"examples": [
"0.70.0-46"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"imageName",
"tag",
"resources"
],
"title": "The pipyRepo Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"nodePort": 30000,
"port": 8080,
"type": "ClusterIP"
}
],
"properties": {
"nodePort": {
"default": 0,
"examples": [
30000
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 0,
"examples": [
8080
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"port",
"nodePort"
],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": "traffic-guru"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
"traffic-guru"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"create",
"annotations",
"name"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"image",
"imagePullSecrets",
"nameOverride",
"fullnameOverride",
"gui",
"pipyRepo",
"database",
"serviceAccount",
"podAnnotations",
"podSecurityContext",
"securityContext",
"service",
"ingress",
"nodeSelector",
"tolerations",
"affinity"
],
"title": "Root Schema",
"type": "object"
} | MIT | en |
flomesh-io/traffic-guru | 653fd776c091c2e3546a7293f41181af00268004 | 2023-03-02T06:29:53 | charts/traffic-guru/values.schema.json | 19 | 2024-05-27T07:42:04.487752Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"affinity": {},
"clickhouse": {
"auth": {
"password": "password",
"username": "flomesh"
},
"enabled": true,
"replicaCount": 1,
"serviceAccount": {
"name": "click-house"
},
"shards": 1,
"zookeeper": {
"enabled": false
}
},
"database": {
"type": "mysql"
},
"externalDatabase": {
"database": "flomesh",
"existingSecret": "",
"host": "localhost",
"password": "Flomesh1234",
"port": 3306,
"username": "flomesh"
},
"externalPrometheus": {
"host": "localhost",
"port": 7070
},
"fullnameOverride": "traffic-guru",
"gui": {
"env": {},
"imageName": "traffic-guru",
"resources": {},
"tag": ""
},
"image": {
"pullPolicy": "IfNotPresent",
"repository": "flomesh"
},
"imagePullSecrets": [],
"ingress": {
"annotations": {},
"className": "",
"enabled": false,
"host": "traffic-guru.local",
"paths": [
{
"path": "/",
"pathType": "ImplementationSpecific"
}
],
"tls": []
},
"mariadb": {
"architecture": "standalone",
"auth": {
"database": "flomesh",
"password": "Flomesh1234",
"rootPassword": "root",
"username": "flomesh"
},
"enabled": true,
"primary": {
"persistence": {
"accessModes": [
"ReadWriteOnce"
],
"enabled": true,
"size": "8Gi",
"storageClass": ""
}
}
},
"nameOverride": "traffic-guru",
"nodeSelector": {},
"pipyRepo": {
"imageName": "pipy-repo",
"resources": {},
"tag": "0.90.0-18"
},
"podAnnotations": {},
"podSecurityContext": {},
"prometheus": {
"affinity": {
"nodeAffinity": {
"requiredDuringSchedulingIgnoredDuringExecution": {
"nodeSelectorTerms": [
{
"matchExpressions": [
{
"key": "kubernetes.io/os",
"operator": "In",
"values": [
"linux"
]
},
{
"key": "kubernetes.io/arch",
"operator": "In",
"values": [
"amd64",
"arm64",
"arm",
"ppc64le",
"s390x"
]
}
]
}
]
}
}
},
"enabled": true,
"image": "prom/prometheus:v2.34.0",
"nodeSelector": {},
"port": 7070,
"resources": {
"limits": {
"cpu": "1",
"memory": "2G"
},
"requests": {
"cpu": "0.5",
"memory": "512M"
}
},
"retention": {
"time": "15d"
},
"tolerations": []
},
"securityContext": {},
"service": {
"nodePort": 30000,
"port": 8080,
"type": "ClusterIP"
},
"serviceAccount": {
"annotations": {},
"create": true,
"name": "traffic-guru"
},
"tolerations": []
}
],
"properties": {
"affinity": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The affinity Schema",
"type": "object"
},
"database": {
"default": {},
"examples": [
{
"type": "mysql"
}
],
"properties": {
"type": {
"default": "",
"examples": [
"mysql"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type"
],
"title": "The database Schema",
"type": "object"
},
"fullnameOverride": {
"default": "",
"examples": [
"traffic-guru"
],
"title": "The fullnameOverride Schema",
"type": "string"
},
"gui": {
"default": {},
"examples": [
{
"env": {},
"imageName": "traffic-guru",
"resources": {},
"tag": ""
}
],
"properties": {
"env": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The env Schema",
"type": "object"
},
"imageName": {
"default": "",
"examples": [
"traffic-guru"
],
"title": "The imageName Schema",
"type": "string"
},
"resources": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"imageName",
"resources",
"env"
],
"title": "The gui Schema",
"type": "object"
},
"image": {
"default": {},
"examples": [
{
"pullPolicy": "IfNotPresent",
"repository": "flomesh"
}
],
"properties": {
"pullPolicy": {
"default": "",
"examples": [
"IfNotPresent"
],
"title": "The pullPolicy Schema",
"type": "string"
},
"repository": {
"default": "",
"examples": [
"flomesh"
],
"title": "The repository Schema",
"type": "string"
}
},
"required": [
"repository",
"pullPolicy"
],
"title": "The image Schema",
"type": "object"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The imagePullSecrets Schema",
"type": "array"
},
"ingress": {
"default": {},
"examples": [
{
"annotations": {},
"className": "",
"enabled": false,
"host": "traffic-guru.local",
"paths": [
{
"path": "/",
"pathType": "ImplementationSpecific"
}
],
"tls": []
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"className": {
"default": "",
"examples": [
""
],
"title": "The className Schema",
"type": "string"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "The enabled Schema",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"traffic-guru.local"
],
"title": "The host Schema",
"type": "string"
},
"paths": {
"default": [],
"examples": [
[
{
"path": "/",
"pathType": "ImplementationSpecific"
}
]
],
"items": {
"default": {},
"examples": [
{
"path": "/",
"pathType": "ImplementationSpecific"
}
],
"properties": {
"path": {
"default": "",
"examples": [
"/"
],
"title": "The path Schema",
"type": "string"
},
"pathType": {
"default": "",
"examples": [
"ImplementationSpecific"
],
"title": "The pathType Schema",
"type": "string"
}
},
"required": [
"path",
"pathType"
],
"title": "A Schema",
"type": "object"
},
"title": "The paths Schema",
"type": "array"
},
"tls": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tls Schema",
"type": "array"
}
},
"required": [
"enabled",
"className",
"annotations",
"host",
"paths",
"tls"
],
"title": "The ingress Schema",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
"traffic-guru"
],
"title": "The nameOverride Schema",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The nodeSelector Schema",
"type": "object"
},
"pipyRepo": {
"default": {},
"examples": [
{
"imageName": "pipy-repo-ubi8",
"resources": {},
"tag": "0.70.0-46"
}
],
"properties": {
"imageName": {
"default": "",
"examples": [
"pipy-repo"
],
"title": "The imageName Schema",
"type": "string"
},
"resources": {
"default": {},
"examples": [
7070
],
"properties": {},
"required": [],
"title": "The resources Schema",
"type": "object"
},
"tag": {
"default": "",
"examples": [
"0.90.0-18"
],
"title": "The tag Schema",
"type": "string"
}
},
"required": [
"imageName",
"tag",
"resources"
],
"title": "The pipyRepo Schema",
"type": "object"
},
"podAnnotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podAnnotations Schema",
"type": "object"
},
"podSecurityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The podSecurityContext Schema",
"type": "object"
},
"securityContext": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The securityContext Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"nodePort": 30000,
"port": 8080,
"type": "ClusterIP"
}
],
"properties": {
"nodePort": {
"default": 0,
"examples": [
30000
],
"title": "The nodePort Schema",
"type": "integer"
},
"port": {
"default": 0,
"examples": [
8080
],
"title": "The port Schema",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "The type Schema",
"type": "string"
}
},
"required": [
"type",
"port",
"nodePort"
],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"annotations": {},
"create": true,
"name": "traffic-guru"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The annotations Schema",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
"traffic-guru"
],
"title": "The name Schema",
"type": "string"
}
},
"required": [
"create",
"annotations",
"name"
],
"title": "The serviceAccount Schema",
"type": "object"
},
"tolerations": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The tolerations Schema",
"type": "array"
}
},
"required": [
"image",
"imagePullSecrets",
"nameOverride",
"fullnameOverride",
"gui",
"pipyRepo",
"serviceAccount",
"podAnnotations",
"podSecurityContext",
"securityContext",
"service",
"ingress",
"nodeSelector",
"tolerations",
"affinity"
],
"title": "Root Schema",
"type": "object"
} | MIT | en |
MPEGGroup/FileFormatConformance | 21fd7f0a1cef9cc8e052718da443b1ce1d380829 | 2023-10-03T01:07:57 | data/schemas/standard.schema.json | 10 | 2024-05-27T05:19:24.925322Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"description": {
"description": "Description of the type of entries in this file. For example, 'Boxes are the basic unit of data in the ISO Base Media File Format.'",
"type": "string"
},
"entries": {
"items": {
"properties": {
"containers": {
"description": "All the possible containers for this entry. If the element is a string then it is treated as fourcc or type. Otherwise if an object is provided then the only key in it will be treated as type and the items in that array will be treated as fourccs. The latter form will be used to differentiate between different types of containers that have the same fourcc.",
"items": {
"anyOf": [
{
"description": "fourcc or type",
"type": "string"
},
{
"additionalProperties": false,
"maxProperties": 1,
"patternProperties": {
"^.*$": {
"description": "type",
"items": {
"description": "fourcc",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"minItems": 1,
"type": "array"
},
"description": {
"type": "string"
},
"flags": {
"items": {
"oneOf": [
{
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"pattern": "^0x[0-9A-F]+$",
"type": "string"
}
},
"required": [
"name",
"value",
"description"
],
"type": "object"
},
{
"properties": {
"wildcard": {
"oneOf": [
{
"enum": [
"any"
]
}
],
"type": "string"
}
},
"required": [
"wildcard"
],
"type": "object"
}
]
},
"type": "array"
},
"fourcc": {
"type": "string"
},
"syntax": {
"description": "The full syntax of this entry, as specified in the standard.",
"oneOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"type": "string"
},
"versions": {
"items": {
"type": "integer"
},
"type": "array"
}
},
"required": [
"fourcc",
"description",
"type",
"containers",
"syntax"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"name": {
"description": "Name of the type of entries in this file. For example, 'Boxes' or 'Sample Groups'.",
"type": "string"
}
},
"required": [
"name",
"description",
"entries"
],
"title": "Schema for standard JSON format",
"type": "object"
} | BSD-3-Clause-Clear | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.