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

Resources Endpoint #45

Closed
jag3773 opened this issue Apr 20, 2018 · 4 comments
Closed

Resources Endpoint #45

jag3773 opened this issue Apr 20, 2018 · 4 comments

Comments

@jag3773
Copy link
Contributor

jag3773 commented Apr 20, 2018

Story

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

As a user, I don't want to wait a long time for the https://openbiblestories.squarespace.com/library/ page to load.

Notes

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

This process should happen whenever the main catalog.json file is updated.

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.

Acceptance Criteria

  • This should be a lambda function that is triggered via S3 anytime the catalog.json file is updated
  • Every unique resource in catalog.json has a corresponding endpoint at /v3/resources/{identifier}.json, for example:
    • A list of OBS resources are found at /v3/resources/obs.json
    • A list of tN resources are found at /v3/resources/tn.json
    • A list of tA resources are found at /v3/resources/ta.json
    • A list of BLV resources are found at /v3/resources/blv.json
  • Documentation is updated at http://api-info.readthedocs.io/en/latest/door43.html .
@jag3773 jag3773 changed the title Identifier Endpoint Resources Endpoint Apr 20, 2018
@phillip-hopper
Copy link
Contributor

@jag3773: Just minifying the file shrunk it about 94 KB, from 998,586 bytes to 904,434.

@jag3773
Copy link
Contributor Author

jag3773 commented Apr 23, 2018

In particular, you mean removing the spaces, right @phillip-hopper (line breaks are not present in the current version)?

@phillip-hopper
Copy link
Contributor

Yes, @jag3773. I actually just ran it through https://www.cleancss.com/json-minify/.

@jag3773
Copy link
Contributor Author

jag3773 commented Oct 5, 2018

This issue was solved in a slightly different manner in #52.

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

No branches or pull requests

3 participants