Versions Compared

Key

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

This page documents the patterns and other commonalities that have been extracted from the API Extension Architecture use cases.

Guidelines

The common patterns should be identified and described on this page, and then related (e.g. a matrix of use cases and pattern names) to the use cases.  Any clarifying questions (and answers) regarding a use case should be posed in the comments section for the individual use case.

...

We also decided to get this wiki page into a stable form by Friday September 4th, so that we can use the week of September 6th to think about how the patterns fit with the design proposal.  We would be prepared to discuss the patterns as they relate to the design on our next call, Friday September 11.

Patterns

...

Name

Pattern Description

Related Use Cases

(Any other fields that would be useful to record for these patterns ....)

 

...

Mediated Ingest
DescriptionThis pattern exposes an object-based resource endpoint for complex ingest requests
Use cases 
... 
NameMediated Retrieval
DescriptionThis pattern exposes an object-based resource endpoint for complex retrieval requests
Use cases 
... 
NameWorkflow Monitoring
DescriptionThis pattern exposes a service for monitoring the state/progress of API-Extension Architecture workflows
Use cases 
... 
NameDeployment/Configuration
DescriptionThis pattern involves the mechanics of extension deployment, configuration, and sharing
Use cases 
...