search

Bridgeconn / vachan-api

The backend server that hosts all the API logic for the Vachan Engine.
Other
7 stars 20 forks source link

Video API Reference structure #476

Open RevantCI opened 1 year ago

RevantCI commented 1 year ago

This is in reference to the discussion in todays Vachan API call about the Video API calls Just putting the doubts I had here asked here. Get Put Post Swagger links for reference

  1. It would be better to keep consistent names Video Get, Put &Post calls for the reference json Some differences I noted book→bookCode, verseNumber→verseStart, verseNumberEnd→verseEnd
  2. Is chapter and verse data required in other apps? Answer - to make it searachable However this makes putting things like Full Bible, NewTestament, Old Testament a bit more verbose, ie adding one for every chapter, Is there a way to make this more concise? Say for example if in row chapter =0 it is full book
    book = 0 it is full bible book = -1 for NT and book --2 for OT? Just a a suggestion
  3. Is bible field required in get videos call , see response schema Get
  4. Why is book optional in get videos call and chapter and verseNumber mandatory in the Put & Post calls? Based on vachan data it should be book or bookCode which should be mandatory I think. There is currently no chapter and verse level data but that can come in the future. But it can be set as optional for now I feel and book be mandatory for the . Again just a suggestion.
kavitharaju commented 1 year ago

In the API refactor coming up we are planning to remove the bible videos table and bring in a parascriptural. These suggestions are valuable and could be used for cross checking our new implementations

shimilgithub commented 1 year ago

This is in reference to the discussion in todays Vachan API call about the Video API calls Just putting the doubts I had here asked here. Get Put Post Swagger links for reference

  1. It would be better to keep consistent names Video Get, Put &Post calls for the reference json Some differences I noted book→bookCode, verseNumber→verseStart, verseNumberEnd→verseEnd
  2. Is chapter and verse data required in other apps? Answer - to make it searachable However this makes putting things like Full Bible, NewTestament, Old Testament a bit more verbose, ie adding one for every chapter, Is there a way to make this more concise? Say for example if in row chapter =0 it is full book book = 0 it is full bible book = -1 for NT and book --2 for OT? Just a a suggestion
  3. Is bible field required in get videos call , see response schema Get
  4. Why is book optional in get videos call and chapter and verseNumber mandatory in the Put & Post calls? Based on vachan data it should be book or bookCode which should be mandatory I think. There is currently no chapter and verse level data but that can come in the future. But it can be set as optional for now I feel and book be mandatory for the . Again just a suggestion.

Point 4. In new resource type parascripturals , the reference field which deals with book,chapter and verse level information is kept as optional.