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
- : String!
- # The selectors of the docSet
- : [KeyValue!]!
- # A selector for this docSet
- #
- # Arguments
- # id: The id of the selector
- (: String!): String!
- # A list of the tags of this docSet
- : [String!]!
- # Whether or not the docSet has the specified tag
- #
- # Arguments
- # tagName: The tag
- (: String!): Boolean!
- # The documents in the docSet
- #
- # Arguments
- # ids: A whitelist of ids of documents to include
- # withChars: Return documents whose main sequence contains a
- # token whose payload is an exact match to one of the specified strings
- # withMatchingChars: Return documents whose main sequence
- # contains a token whose payload matches the specified regexes
- # 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)
- (
- : [String!],
- : [String!],
- : [String!],
- : Boolean,
- : [String!],
- : Boolean,
- : [InputKeyValue!],
- : [String!],
- : [String!],
- : String
- ): [Document!]!
- # The number documents in the docSet
- : Int!
- # The document with the specified book code
- #
- # Arguments
- # bookCode: The book code of the required document
- (: String!): Document
- : 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
- (: String!, : 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
- (
- : String!,
- : String!
- ): [regexIndex!]!
- # A list of wordLike token strings in the docSet
- #
- # Arguments
- # coerceCase: Whether to coerce the strings
- # (toLower|toUpper|none)
- (: String): [String!]!
- }