OBJECT

Query

The top level of Proskomma queries

link GraphQL Schema definition

  • type Query {
  • # The id of the processor, which is different for each Proskomma instance
  • id: String!
  • # A string describing the processor class
  • processor: String!
  • # The NPM package version
  • packageVersion: String!
  • # The selectors used to define docSets
  • selectors: [selectorSpec!]!
  • # The number of docSets
  • nDocSets: Int!
  • # The docSets in the processor
  • #
  • # Arguments
  • # ids: A whitelist of ids of docSets to include
  • # withSelectors: Only return docSets that match the list of
  • # selector values
  • # withBook: Only return docSets containing a document with the
  • # specified bookCode
  • # withTags: Only return docSets with all the specified tags
  • # withoutTags: Only return docSets with none of the specified
  • # tags
  • docSets(
  • ids: [String!],
  • withSelectors: [InputKeyValue!],
  • withBook: String,
  • withTags: [String!],
  • withoutTags: [String!]
  • ): [DocSet!]!
  • # The docSet with the specified id
  • #
  • # Arguments
  • # id: The id of the docSet
  • docSet(id: String!): DocSet
  • # The number of documents in the processor
  • nDocuments: Int!
  • # The documents in the processor
  • #
  • # Arguments
  • # ids: A whitelist of ids of documents to include
  • # withBook: Only return documents with the specified bookCode
  • # withHeaderValues: Only return documents with the specified
  • # header key/values
  • # withTags: Only return documents with all the specified tags
  • # withoutTags: Only return documents with none of the specified
  • # tags
  • # sortedBy: Sort returned documents by the designated method
  • # (currently ${Object.keys(bookCodeCompareFunctions).join(', ')})
  • documents(
  • ids: [String!],
  • withBook: String,
  • withHeaderValues: [InputKeyValue!],
  • withTags: [String!],
  • withoutTags: [String!],
  • sortedBy: String
  • ): [Document!]!
  • # The document with the specified id, or the specified docSet and withBook
  • #
  • # Arguments
  • # id: The id of the document
  • # docSetId: The docSet of the document (use with withBook)
  • # withBook: The book of the document (use with docSetId)
  • document(id: String, docSetId: String, withBook: String): Document
  • # Compare two documents
  • #
  • # Arguments
  • # document1: The id of the first document
  • # document2: The id of the second document
  • # mode: compare 'words' or 'tokens'
  • diff(document1: String!, document2: String!, mode: String!): [diffRecord!]!
  • }

link Require by

This element is not required by anyone