Skip to content

Commit

Permalink
copy old json-schemas, obvious updates
Browse files Browse the repository at this point in the history
  • Loading branch information
fosterlynn committed Apr 16, 2019
1 parent 39b4ca4 commit 81e4eb8
Show file tree
Hide file tree
Showing 6 changed files with 258 additions and 0 deletions.
39 changes: 39 additions & 0 deletions schemas/Agent.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Agent.json",
"title": "Agent",
"description": "A person or group or organization with economic agency.",
"type": "object",
"properties": {
"name": {
"description": "An informal or formal textual identifier for an object. Does not imply uniqueness.",
"type": "string"
},
"image": {
"type": "string",
"format": "uri"
},
"url": {
"type": "string",
"format": "uri"
},
"primaryLocation": {
"description": "The main place an agent is located, often an address where activities occur and mail can be sent. This is usually a mappable geographic location. It also could be a website address, as in the case of agents who have no physical location.",
"type": "object"
},
"note": {
"description": "A textual comment or description.",
"type": "string"
},
"relationships": {
"description": "Relationships with other agents.",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/AgentRelationship.json"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": ["name"]
}
22 changes: 22 additions & 0 deletions schemas/AgentRelationship.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/AgentRelationship.json",
"title": "AgentRelationship",
"description": "An ongoing voluntary association between 2 Agents of any kind.",
"type": "object",
"properties": {
"subject": {
"description": "The subject of a relationship between 2 agents.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Agent.json"
},
"relationship": {
"description": "A kind of relationship that exists between 2 agents.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/AgentRelationshipRole.json"
},
"object": {
"description": "The object of a relationship between 2 agents.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Agent.json"
}
},
"required": ["subject", "relationship", "object"]
}
71 changes: 71 additions & 0 deletions schemas/EconomicEvent.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/EconomicEvent.json",
"title": "EconomicEvent",
"description": "An inflow or outflow of an economic resource in relation to a process and/or exchange.",
"type": "object",
"properties": {
"action": {
"description": "Relates a process input or output to a verb, such as consume, produce, work, improve, etc.",
"type": "string"
},
"quantifiedAs": {
"description": "The quantity and unit of the event. This is the quantity that could be used to increment or decrement a resource, depending on the type of resource and type of event.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/QuantityValue.json"
},
"resourceInventoriedAs": {
"description": "The economic resource that is decremented or incremented by the economic event, or just what the economic event is about.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/EconomicResource.json"
},
"provider": {
"description": "The economic agent from whom the economic event is initiated.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Agent.json"
},
"receiver": {
"description": "The economic agent whom the economic event is for.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Agent.json"
},
"hasBeginning": {
"description": "The starting date and optionally time of the economic event.",
"type": "string",
"format": "date-time"
},
"hasEnd": {
"description": "The ending date and optionally time of the economic event.",
"type": "string",
"format": "date-time"
},
"hasPointInTime": {
"description": "The economic event occurs at this date/time instant.",
"type": "string",
"format": "date-time"
},
"before": {
"description": "The economic event occurs before this date/time.",
"type": "string",
"format": "date-time"
},
"after": {
"description": "The economic event occurs after this date/time.",
"type": "string",
"format": "date-time"
},
"note": {
"description": "A textual comment or description.",
"type": "string"
},
"inputOf": {
"description": "The process for which this economic event describes an input.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Process.json"
},
"outputOf": {
"description": "The process for which this economic event describes an output.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Process.json"
},
"under": {
"description": "Reference to an agreement between agents which specifies the rules or policies which govern this event.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Agreement.json"
}
},
"required": ["action", "quantifiedAs" ]
}
42 changes: 42 additions & 0 deletions schemas/EconomicResource.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/EconomicResource.json",
"title": "EconomicResource",
"description": "A resource which is useful to people or the ecosystem.",
"type": "object",
"properties": {
"name": {
"description": "An informal or formal textual identifier for an object. Does not imply uniqueness.",
"type": "string"
},
"currentQuantity": {
"description": "The current amount and unit of the economic resource.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/QuantityValue.json"
},
"resourceClassifiedAs": {
"description": "A resource's primary classification, as part of describing that resource.",
"type": "string"
},
"trackingIdentifier": {
"description": "Sometimes called lot number, used for trackable batched resources. Sometimes called serial number, used when each item must have a trackable identifier (like a computer). Could also be used for other unique tracking identifiers needed for resources.",
"type": "string"
},
"currentLocation": {
"description": "The current place an economic resource is located. Could be at any level of granularity, from a town to an address to a warehouse location. Should be mappable.",
"type": "string"
},
"note": {
"description": "A textual comment or description.",
"type": "string"
},
"containeds": {
"description": "Used when a stock economic resource contains items also defined as economic resources.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/EconomicResource.json"
},
"underlyingResource": {
"description": "A more concrete resource upon which a resource is based.",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/EconomicResource.json"
}
},
"required": ["resourceClassifiedAs", "quantity" ]
}
66 changes: 66 additions & 0 deletions schemas/Process.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Process.json",
"title": "Process",
"description": "An activity that changes inputs into outputs. It could transform or transport economic resource(s), as well as simply issuing a resource so that it is available.",
"type": "object",
"properties": {
"name": {
"description": "An informal or formal textual identifier for an object. Does not imply uniqueness.",
"type": "string"
},
"hasDuration": {
"description": "The planned or estimated duration of the process.",
"type": "object"
},
"processClassifiedAs": {
"description": "The primary classification that describes a process, at any level of granularity.",
"type": "object",
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/ProcessClassification.json"
},
"finished": {
"type": "boolean"
},
"note": {
"description": "A textual comment or description.",
"type": "string"
},
"inputs": {
"description": "Economic events that bring tangible or intangible resources into the process.",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/EconomicEvent.json"
},
"minItems": 1,
"uniqueItems": true
},
"outputs": {
"description": "Economic events that produce or change or move tangible or intangible resources.",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/EconomicEvent.json"
},
"minItems": 1,
"uniqueItems": true
},
"committedInputs": {
"description": "Planned commitments that bring tangible or intangible resources into the process.",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Commitment.json"
},
"minItems": 1,
"uniqueItems": true
},
"committedOutputs": {
"description": "Planned commitments that produce or change or move tangible or intangible resources.",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/Commitment.json"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": ["name"]
}
18 changes: 18 additions & 0 deletions schemas/QuantityValue.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "https://raw.githubusercontent.com/valueflows/vf-json-schema/master/schemas/QuantityValue.json",
"title": "QuantityValue",
"description": "A numeric value with a unit of measure.",
"type": "object",
"properties": {
"numericValue": {
"description": "A numeric value.",
"type": "number"
},
"unit": {
"description": "A unit of measure.",
"type": "string"
}
},
"required": ["numericValue", "unit"]
}

0 comments on commit 81e4eb8

Please sign in to comment.