Skip to content
This repository has been archived by the owner on Aug 18, 2020. It is now read-only.
/ pdx Public archive

Top level container for the various PCDM specific Islandora CLAW microservices.

License

Notifications You must be signed in to change notification settings

islandora-deprecated/pdx

Repository files navigation

PDX PDX

Latest Stable Version Minimum PHP Version Downloads Build Status Contribution Guidelines LICENSE codecov

This is a top level container for the various PCDM related Islandora CLAW microservices. It allows you to mount the various endpoints at one port on one machine and makes a development vagrant/docker configuration easier to produce.

Requirements

Installation

You will need to copy the configuration file example.settings.yml to either settings.yml or settings.dev.yml (if $app['debug'] = TRUE) and change any required settings.

You can run just this service using PHP by executing

php -S localhost:<some port> -t src/ src/index.php

from this directory to start it running.

Services

This mounts all the various individual microservices under the /islandora URL, so you currently have access to

  • CollectionService at /islandora/collection

See the individual services for more information on their endpoints.

CollectionService

This an Islandora PHP Microservice to create PCDM:Collections and add/remove PCDM:Objects to a PCDM:Collection.

Services

The CollectionService provides the following endpoints for HTTP requests.

Note: The UUID is of the form 18c67794-366c-a6d9-af13-b3464a1fb9b5

  1. POST to /collection

    for creating a new PCDM:Collection at the root level

  2. POST to /collection/{uuid}

    for creating a new PCDM:Collection as a child of resource {uuid}

  3. POST to /collection/{uuid}/member/{member}

    for adding the resource identifier by the UUID {member} to the collection identified by the UUID {uuid}

  4. DELETE to /collection/{uuid}/member/{member}

    for removing the resource identifier by the UUID {member} from the collection identified by the UUID {uuid}

Sponsors

  • UPEI
  • discoverygarden inc.
  • LYRASIS
  • McMaster University
  • University of Limerick
  • York University
  • University of Manitoba
  • Simon Fraser University
  • PALS
  • American Philosophical Society
  • common media inc.

Maintainers

License

MIT

About

Top level container for the various PCDM specific Islandora CLAW microservices.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages