@valueflows/vf-graphql
Version:
Reference GraphQL implementation of the ValueFlows spec
205 lines (146 loc) • 6.3 kB
JavaScript
// Generated by scripts/build.js - edit the *.gql file instead!
module.exports = `
##
# Intent module
#
# @depends action.gql
# @depends measurement.gql
# @package vf-graphql
# @since 2019-02-11
#
##
"""
A planned economic flow which has not been committed to, which can lead to economic events (sometimes through commitments).
"""
type Intent {
id: ID!
revisionId: ID!
"An informal or formal textual identifier for an intent. Does not imply uniqueness."
name: String
"Relates an intent to a verb, such as consume, produce, work, improve, etc."
action: Action!
"References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping."
resourceClassifiedAs: [URI!]
"The amount and unit of the economic resource counted or inventoried. This is the quantity that could be used to increment or decrement a resource, depending on the type of resource and resource effect of action."
resourceQuantity: Measure
"The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness."
effortQuantity: Measure
"The total quantity of the offered resource available."
availableQuantity: Measure
"Minimum quantity of the offered resource available."
minimumQuantity: Measure
"The planned beginning of the intent."
hasBeginning: DateTime
"The planned end of the intent."
hasEnd: DateTime
"The planned date/time for the intent. Can be used instead of beginning and end."
hasPointInTime: DateTime
"The time something is expected to be complete."
due: DateTime
"The intent is complete or not. This is irrespective of if the original goal has been met, and indicates that no more will be done."
finished: Boolean
"The uri to an image relevant to the intent, such as a photo."
image: URI
"URI addresses to images relevant to the intent."
imageList: [URI!]
"A textual description or comment."
note: String
"Reference to an agreement between agents which specifies the rules or policies or calculations which govern this intent."
agreedIn: URI
"The intent can be safely deleted, has no dependent information."
deletable: Boolean
}
##
# API input and output types
##
input IntentCreateParams {
"(\`Action\`) Relates an intent to a verb, such as consume, produce, work, improve, etc."
action: ID!
"An informal or formal textual identifier for an intent. Does not imply uniqueness."
name: String
"References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping."
resourceClassifiedAs: [URI!]
"The amount and unit of the economic resource counted or inventoried. This is the quantity that could be used to increment or decrement a resource, depending on the type of resource and resource effect of action."
resourceQuantity: IMeasure
"The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness."
effortQuantity: IMeasure
"The total quantity of the offered resource available."
availableQuantity: IMeasure
"The planned beginning of the intent."
hasBeginning: DateTime
"The planned end of the intent."
hasEnd: DateTime
"The planned date/time for the intent. Can be used instead of beginning and end."
hasPointInTime: DateTime
"The time something is expected to be complete."
due: DateTime
"The uri to an image relevant to the intent, such as a photo."
image: URI
"URI addresses to images relevant to the intent."
imageList: [URI!]
"A textual description or comment."
note: String
"Reference to an agreement between agents which specifies the rules or policies or calculations which govern this intent."
agreedIn: URI
"The intent is complete or not. This is irrespective of if the original goal has been met, and indicates that no more will be done."
finished: Boolean
}
input IntentUpdateParams {
revisionId: ID!
"An informal or formal textual identifier for an intent. Does not imply uniqueness."
name: String
"(\`Action\`) Relates an intent to a verb, such as consume, produce, work, improve, etc."
action: ID
"References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping."
resourceClassifiedAs: [URI!]
"The amount and unit of the economic resource counted or inventoried. This is the quantity that could be used to increment or decrement a resource, depending on the type of resource and resource effect of action."
resourceQuantity: IMeasure
"The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness."
effortQuantity: IMeasure
"The total quantity of the offered resource available."
availableQuantity: IMeasure
"The planned beginning of the intent."
hasBeginning: DateTime
"The planned end of the intent."
hasEnd: DateTime
"The planned date/time for the intent. Can be used instead of beginning and end."
hasPointInTime: DateTime
"The time something is expected to be complete."
due: DateTime
"The uri to an image relevant to the intent, such as a photo."
image: URI
"URI addresses to images relevant to the intent."
imageList: [URI!]
"The intent is complete or not. This is irrespective of if the original goal has been met, and indicates that no more will be done."
finished: Boolean
"A textual description or comment."
note: String
"Reference to an agreement between agents which specifies the rules or policies or calculations which govern this intent."
agreedIn: URI
}
type IntentResponse {
intent: Intent!
}
type IntentConnection {
edges: [IntentEdge!]!
pageInfo: PageInfo!
}
type IntentEdge {
node: Intent!
cursor: String!
}
type Query {
intent(id: ID!): Intent
intents(
first: Int
after: String
last: Int
before: String
): IntentConnection!
}
type Mutation {
createIntent(intent: IntentCreateParams!): IntentResponse!
updateIntent(intent: IntentUpdateParams!): IntentResponse!
deleteIntent(revisionId: ID!): Boolean!
}
`