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

Full text API #2086

Closed
sjDCC opened this issue Apr 16, 2019 · 3 comments
Closed

Full text API #2086

sjDCC opened this issue Apr 16, 2019 · 3 comments
Assignees
Labels
API use cases user group suggestions made at user group meetings

Comments

@sjDCC
Copy link
Contributor

sjDCC commented Apr 16, 2019

Extend the current plans API for authorised admins to harvest the full text of plans from their org.

@sjDCC sjDCC added API use cases user group suggestions made at user group meetings labels Apr 16, 2019
@xsrust
Copy link
Contributor

xsrust commented Apr 16, 2019

Adding this as a new index endpoint for the plans-api.

Using Sidekiq for background-job processing:
https://github.com/mperham/sidekiq
Sidekiq adds an additional dependancy on Redis, but will enable us down-the-line to support thinks like weekly email reports, notification batching, etc.

I'm implimenting directly via sidekiq instead of using it as an activejob adapter since documentation shows that this is much faster.

Planning on running through once per night (for specified orgs) to generate this JSON object and save it out to either disk or S3. [Rails 5.2 and ActiveStorage would make this configuration easier]

Then fetch this and send to the user via the API-endpoint.
IF the file does not exist, I'll get it to kick-off the process of generating one, and reply with 201.
Then when they check back, they will get the JSON object. (assuming processing is complete)

@sjDCC
Copy link
Contributor Author

sjDCC commented May 31, 2019

I'm not best placed to UAT this, but since it's been out on -dev and flagged to a couple of unis I assume all is ok. Do you know if they trialled it?

@xsrust
Copy link
Contributor

xsrust commented Aug 23, 2019

Closing this as API Implimented.
Will add other issues for additional API features

@xsrust xsrust closed this as completed Aug 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API use cases user group suggestions made at user group meetings
Projects
None yet
Development

No branches or pull requests

2 participants