search

unfoldingWord-dev / uwadmin

Code for uW Admin site
MIT License
1 stars 1 forks source link

Dynamic API: Verse Search #44

Closed jag3773 closed 9 years ago

jag3773 commented 9 years ago

From @jag3773 on June 23, 2015 22:15

We need a dynamic API endpoint that returns Scripture. Endpoint should accept verses or verse ranges as well as language and/or version requests.

Copied from original issue: unfoldingWord-dev/Door43#68

jag3773 commented 9 years ago

This should be processing content from the unfoldingWord API. The catalog to process is https://api.unfoldingword.org/ts/txt/2/catalog.json.

Requests and responses should all be JSON. Options to accept are at least:

Once written this will be hosted on the api.unfoldingWord.org domain.

The code base for this issue and #69 should be the same, and we probably need a new Github repository for it.

Any other thoughts @richmahn ?

jag3773 commented 9 years ago

From @Aarontse on July 11, 2015 0:23

Please confirm if this is correct or not:
1.The system should let the user to input parameter as listed as Options to accept are at least. with one extra: the need TEXT. 2.The system located the need files from the the catalog -> lang_catalog -> notes & source. 3.The system start to search for the needed TEXT in those files. 4.Feedback result when search completed.

IS there any doc on the definition of tag usage in the used JSON file?

jag3773 commented 9 years ago

From @Aarontse on July 13, 2015 23:32

Hi Jesse,

I have drop some comment on #68 and #69 in GifHub, did you got it OK?

Aaron

On Fri, Jul 10, 2015 at 4:27 AM, Jesse Griffin notifications@github.com wrote:

This should be processing content from the unfoldingWord API. The catalog to process is https://api.unfoldingword.org/ts/txt/2/catalog.json.

Requests and responses should all be JSON. Options to accept are at least:

  • Language (using IETF language codes)
  • Version slug (ulb or udb for English)
  • Book name (also variant book names and abbreviated names (Romans, Rom, Rm). This needs to be localizable, so that references can be given in any language in the world (for example, Romanos for Spanish).
  • Verse or verse range (for example 8:1, or 8:2-9:15)

Once written this will be hosted on the api.unfoldingWord.org domain.

The code base for this issue and #69 https://github.com/unfoldingWord-dev/Door43/issues/69 should be the same, and we probably need a new Github repository for it.

Any other thoughts @richmahn https://github.com/richmahn ?

— Reply to this email directly or view it on GitHub https://github.com/unfoldingWord-dev/Door43/issues/68#issuecomment-120136076 .

jag3773 commented 9 years ago

From @richmahn on July 14, 2015 2:43

@Aarontse Hi Aaron, I am the Tech Lead for Door43 and will be seeing you through this feature. I saw your comment from 3 days ago. I'll be looking this over tomorrow (I'm in USA, so evening here now) to make sure I understand your process correctly and what you are asking. Hope we can talk then.

jag3773 commented 9 years ago

This issue was moved to unfoldingWord-dev/translationDatabaseWeb#75