Versions Compared

Old Version 8

changes.mady.by.user Aaron Birkland

Saved on

compared with

New Version 9

changes.mady.by.user Aaron Birkland

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The API-X codebase has matured to the point of producing this milestone, but should not be mistaken as production ready just yet. In particular, very little importance attention has been paid to optimization.  We would appreciate if you let us know of any issues or suggestions encountered performing the tasks, especially if they would prevent you deploying API-X in production.  Furthermore, the topology of the services distributed in the milestone shouldn't be taken as an endorsement of any particular deployment strategy.  

...

  • Do any aspects of API-X seem particularly useful or not useful for your own use cases?
  • Was any step particularly difficult or burdensome, or surprisingly easy?  Do you have any suggestions for improvement?
  • Do you feel any particular topic should be explored in greater depth in a future milestone demo/evaluation?
  • Do you have any unanswered questions?

 

Evaluation Tasks

To participate in the demo, please:

  • Install the requirements (e.g. Docker and curl) if not already present
  • Read the getting started guide for using docker-compose to start Fedora, API-X and surrounding services
  • Verify that the demo has started successfully
  • Read running the evaluation before you start for some helpful information to make the process go smoothly.

Once everything is up and running, you can start working through the evaluation tasks.  Most We have created a number of evaluation tasks to guide evaluators through the API-X demo.  Most (but not all) current API-X features are encountered in one form or another in the demo tasks.  The tasks do not have to be done linearly, and they do not have to be done all at once.  The tasks are described in detail by following the links in the below outline.  Please read running the evaluation before you start for some helpful information to make the process go smoothly.

  1. Resources, URIs, and Proxies
    1. Look at a Fedora object via direct and proxy URIs in order to compare and contrast representations
    2. Look at proxied binary resources
  2. Service Documents
    1. Retrieve and analyze a service document
    2. Look for a specific service
  3. Interacting with exposed services
    1. A passive resource-scoped service (i.e. just use a GET on a service endpoint to get FITS-extracted metadata)
    2. Links within exposed services
    3. Query parameters (explore a fascinating image manipulation extension based on ImageMagick)
  4. Loading and deploying extensions
    1. A tour of the service registry
    2. The loader extension
    3. Loading an extension manually
    4. Auto-loading extensions (see how services can self-register themselves and the extensions they implement)
  5. Ontologies and Binding
    1. Simple binding by rdf:type
    2. Binding by inference
    3. Extensions as ontologies
    4. The ontology registry

...