Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Subject Endpoint #52

Closed
jag3773 opened this issue Aug 9, 2018 · 1 comment
Closed

Subject Endpoint #52

jag3773 opened this issue Aug 9, 2018 · 1 comment
Assignees

Comments

@jag3773
Copy link
Contributor

jag3773 commented Aug 9, 2018

Story

As a tC developer, I want to be able to get a list of content for a particular subject type instead of having to read the entire catalog.json.

Notes

The d43-catalog needs to start outputting a JSON file that only lists the resources that are in the catalog.json endpoint by subject.

This process should happen whenever the main catalog.json file is updated. An S3 file modification trigger will launch the Lambda function to post process the catalog.

The format of the JSON files should be the same as the catalog.json, excepting the catalogs array. Hence, only languages should be seen as a top level array in the output files.

Spaces that are in the subject field should be converted to underscores in the path names.

Acceptance Criteria

  • This should be a lambda function that is triggered via S3 trigger any time the catalog.json file is updated
  • Every unique resource in catalog.json has a corresponding endpoint at /v3/resources/{subject}.json, for example:
    • A list of aligned Bible resources are found at /v3/subject/Aligned_Bible.json
    • A list of Greek New Testament resources are found at /v3/subject/Greek_New_Testament.json
  • Documentation is updated at http://api-info.readthedocs.io/en/latest/door43.html .
@jag3773 jag3773 changed the title Specify Vocabulary for subject field Subject Endpoint Aug 9, 2018
@jag3773
Copy link
Contributor Author

jag3773 commented Aug 21, 2018

@RoyalSix Can you create a PR against http://api-info.readthedocs.io/en/latest/door43.html with documentation about this new subjects endpoint?

@jag3773 jag3773 closed this as completed Oct 5, 2018
This was referenced Oct 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants