@valueflows/vf-graphql
Version:
Reference GraphQL implementation of the ValueFlows spec
91 lines (70 loc) • 1.95 kB
JavaScript
// Generated by scripts/build.js - edit the *.gql file instead!
module.exports = `
##
#
# Agreement module
#
# Simple module to manage shared agreements between agents in order for such
# agreements to be referenced in actual commitments made.
#
# Often referenced by file upload functionality or similar for attaching
# legal documents or more detailed information.
#
# @package vf-graphql
# @since 2019-02-11
#
##
"""
Any type of agreement among economic agents.
"""
type Agreement {
id: ID!
revisionId: ID!
"An informal or formal textual identifier for an agreement. Does not imply uniqueness."
name: String
"The date and time the agreement was created."
created: DateTime
"A textual description or comment."
note: String
}
##
# API input and output types
##
input AgreementCreateParams { # implements AgreementParams
"An informal or formal textual identifier for an agreement. Does not imply uniqueness."
name: String
"The date and time the agreement was created."
created: DateTime
"A textual description or comment."
note: String
}
input AgreementUpdateParams { # implements UpdateParams & AgreementParams
revisionId: ID!
"An informal or formal textual identifier for an agreement. Does not imply uniqueness."
name: String
"The date and time the agreement was created."
created: DateTime
"A textual description or comment."
note: String
}
type AgreementResponse {
agreement: Agreement!
}
type AgreementConnection {
edges: [AgreementEdge!]!
pageInfo: PageInfo!
}
type AgreementEdge {
node: Agreement!
cursor: String!
}
type Query {
agreement(id: ID!): Agreement
agreements(first: Int, after: String, last: Int, before: String): AgreementConnection!
}
type Mutation {
createAgreement(agreement: AgreementCreateParams): AgreementResponse!
updateAgreement(agreement: AgreementUpdateParams): AgreementResponse!
deleteAgreement(revisionId: ID!): Boolean!
}
`