OBJECT

DocSet

A collection of documents that share the same set of selector values

link GraphQL Schema definition

  • type DocSet {
  • # The id of the docSet, which is formed by concatenating the docSet's selector
  • # values
  • id: String!
  • # The selectors of the docSet
  • selectors: [KeyValue!]!
  • # A selector for this docSet
  • #
  • # Arguments
  • # id: The id of the selector
  • selector(id: String!): String!
  • # A list of the tags of this docSet
  • tags: [String!]!
  • # A list of the tags of this docSet as key/value tuples
  • tagsKv: [KeyValue!]!
  • # Whether or not the docSet has the specified tag
  • #
  • # Arguments
  • # tagName: The tag
  • hasTag(tagName: String!): Boolean!
  • # The documents in the docSet
  • #
  • # Arguments
  • # ids: A whitelist of ids of documents to include
  • # withChars: A whitelist of ids of documents to include
  • # withMatchingChars: Return documents whose main sequence
  • # contains a token whose payload is an exact match to one of the specified strings
  • # allChars: If true, documents where all search terms match will
  • # be included
  • # withScopes: Only return documents where the list of scopes is
  • # used
  • # allScopes: If true, documents where all scopes are found will
  • # be included
  • # 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 paratext, alpha, alpha2)`
  • documents(
  • ids: [String!],
  • withChars: [String!],
  • withMatchingChars: [String!],
  • allChars: Boolean,
  • withScopes: [String!],
  • allScopes: Boolean,
  • withHeaderValues: [InputKeyValue!],
  • withTags: [String!],
  • withoutTags: [String!],
  • sortedBy: String
  • ): [Document!]!
  • # The number of documents in the docSet
  • nDocuments: Int!
  • # The book code of the required document
  • #
  • # Arguments
  • # bookCode: The book code of the required document
  • document(bookCode: String!): Document
  • # Whether the docSet has versification information loaded
  • hasMapping: Boolean!
  • # The internal index number corresponding to a string in a given docSet enum
  • #
  • # Arguments
  • # enumType: The enum to be searched
  • # searchString: The string to match
  • enumIndexForString(enumType: String!, searchString: String!): Int!
  • # Information about internal indexes matching the case-insensitive regex in a
  • # given docSet enum
  • #
  • # Arguments
  • # enumType: The enum to be searched
  • # searchRegex: The regex to match
  • enumRegexIndexesForString(
  • enumType: String!,
  • searchRegex: String!
  • ): [regexIndex!]!
  • # A list of wordLike token strings in the docSet
  • #
  • # Arguments
  • # coerceCase: Whether to coerce the strings
  • # (toLower|toUpper|none)
  • wordLikes(coerceCase: String): [String!]!
  • # A list of unique characters in the docSet
  • uniqueChars: [String!]!
  • # A string containing the unique characters in the docSet
  • uniqueCharsString: String!
  • }