search

unfoldingWord / dcs

Door43 Content Service
https://git.door43.org
MIT License
0 stars 6 forks source link

Expand Subjects in JSON Schema #313

Open jag3773 opened 4 years ago

jag3773 commented 4 years ago

We need to add the following subject options to the JSON Schema's enum:

History

Robert The manifest file for https://git.door43.org/unfoldingWord/en_sq is marked as Invalid but I don't know why. Can you tell me what prevents it from loading?

Larry Hover your mouse over the Invalid label and it tells you. The subject field must currently be one of these (with spaces instead of underscores).

Larry : Robert It is "none of the above." We need categories for Bible Study Notes and Bible Study Questions added. I assume that is quite a process, and I just need to ignore it for now, correct?

RobH123 commented 3 years ago

Currently I see:

  1. "https://api.door43.org/v3/subjects/Bible.json"
  2. "https://api.door43.org/v3/subjects/Aligned_Bible.json"
  3. "https://api.door43.org/v3/subjects/Translation_Words.json"
  4. "https://api.door43.org/v3/subjects/TSV_Translation_Notes.json"
  5. "https://api.door43.org/v3/subjects/Translation_Academy.json"
  6. "https://api.door43.org/v3/subjects/Translation_Questions.json"
  7. "https://api.door43.org/v3/subjects/Open_Bible_Stories.json"
  8. "https://api.door43.org/v3/subjects/OBS_Translation_Questions.json"
  9. "https://api.door43.org/v3/subjects/Translation_Notes.json"
  10. "https://api.door43.org/v3/subjects/OBS_Translation_Notes.json"
  11. "https://api.door43.org/v3/subjects/OBS_Study_Notes.json"
  12. "https://api.door43.org/v3/subjects/OBS_Study_Questions.json"
  13. "https://api.door43.org/v3/subjects/Greek_New_Testament.json"
  14. "https://api.door43.org/v3/subjects/Hebrew_Old_Testament.json"

So @jag3773 @birchamp do we actually need to add three new ones (since sadly, we've started building the format into the resource name with TSV_Translation_Notes)?

Seems that some categories start with Bible and some don't. (See _TranslationNotes, vs _Bible_TranslationNotes.) Or is _Bible_StudyNotes really _BibleStudyNotes, cf. _BibleStudyNotes???

Oh, and do we need to add these as well???

After a final decision, @richmahn will need to add them to his manifest schema built into DCS (and copied by me into the Content Validation checks).

jag3773 commented 3 years ago

@RobH123 and @richmahn Note that in the YAML they are spaced names, "Greek New Testament" becomes "Greek_New_Testament" in the catalog.

The categories are meant to be helpful for tools to get a list of a certain type of material, what needs added is up to the devs based on what they need.

Generally, yes, I agree that we should have new categories for new types/formats of content. For example, the current tC probably uses "Translation Notes" but a future tC would probably hit "TSV Translation Notes".