sul-dlss/dor_indexing_app

Name: dor_indexing_app

Owner: Stanford University Digital Library

Description: An API for providing reindexing endpoints for Stanford's Digital Object Repository

Created: 2016-01-21 00:43:53.0

Updated: 2018-04-27 19:42:19.0

Pushed: 2018-04-27 19:42:48.0

Homepage:

Size: 132

Language: Ruby

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

|

Dor Indexing App

The dor_indexing_app is the primary API for indexing DOR objects into the DOR Index in the Solr cloud.

Developer setup

In order to run dor_indexing_app on your laptop (e.g. while running Argo), you need to

• Create the directory config/certs and (preferably) create symbolic links to dor_indexing_app's shared_configs certs.
• Create a symbolic link to development.local.yml within config/settings/ (also found in shared_configs).

Reindexing API

POST /dor/reindex/:pid Summary

Reindexing route

Description

The /dor/reindex/:pid endpoint is a synchronous request to update the Solr index for the given DOR Object matching :pid. Logs to log/indexer.log.

Parameters

Name | Located In | Description | Required | Schema | Default —- | ———- | ———– | ——– | —— | ——- pid | route | the unique identifier for the DOR object (e.g., druid:aa111bb2222) | Yes | string | None commitWithin | query | uses the given commitWithin parameter for the Solr update (in milliseconds). If none is provided, then a Solr commit is done on each request. | No | numeric | None

Example Response

The responses are always in plain text. There are 2 possible responses:

essfully updated index for druid:aa111bb2222

or

ct does not exist in Fedora.

Response Status Codes

• 200 OK
• 404 Not Found: pid does not match an object in DOR
• 500 Server Error (from an unexpected exception)

POST /dor/delete_from_index/:pid Summary

Reindexing route for deleted objects

Description

This endpoint is a request to remove the given DOR Object from the Solr index.

Parameters

Name | Located In | Description | Required | Schema | Default —- | ———- | ———– | ——– | —— | ——- pid | route | the unique identifier for the DOR object (e.g., druid:aa111bb2222) | Yes | string | None commitWithin | query | uses the given commitWithin parameter for the Solr update (in milliseconds). If none is provided, then a Solr commit is done on each request. | No | numeric | None

Example Response

The responses are always in plain text and it's simply an echo of the :pid

d:aa111bb2222

Response Status Codes

• 200 OK
• 500 Server Error (from an unexpected exception)

GET /dor/queue_size Summary

Length of queue for incoming jobs.

Description

This endpoint retrieve the queue size for the backlog nu

Parameters

None

Example Response

The responses are always in JSON and it holds a single value of integer for the queue size.

alue": 123

Response Status Codes

• 200 OK
• 500 Server Error (from an unexpected exception)