Add shortcuts through graph

mvahowe / proskomma-js

A JS Implementation of the Proskomma Scripture Processing Model

MIT License

11 stars 8 forks source link

Add shortcuts through graph #122

Closed mvahowe closed 3 years ago

mvahowe commented 3 years ago

[x] mainBlocks (document)
[x] mainText (document)
[x] mainBlocksText (document)
[x] mainBlocksTokens, mainBlocksItems (document)
[x] blocksTokens, blocksItems, blocksText (sequence)
[x] require id or (docSet plus bookCode) for top-level document (root)

jdejoode commented 3 years ago

What about letting docSets and documents default to all? So for instance, if you do { mainSequence { blocks { text } } } you get the entire text of all the docSets? Just a thought

jdejoode commented 3 years ago

Some arguments could be implicit. So even blocks could be implicit (and be left out).

jdejoode commented 3 years ago

That's easy because we can tell a user: this shortcut is shorthand for X. And you can still link them back to the full query.

mvahowe commented 3 years ago

@jdejoode I like the mainSequence idea. I'm not sure about leaving out blocks because it's not the only route through the graph.

mvahowe commented 3 years ago

@jdejoode The problem with the mainSequences proposal is that you'd have no way to tell which sequence went with which docSet. (It's the 'you have to specify every field' thing.) The other endpoints work, although in some cases the output seems quite opaque, ie nested arrays with no labels to tell you which array is which.