Skip to content

Latest commit

 

History

History
158 lines (79 loc) · 7.5 KB

REQUIREMENTS.md

File metadata and controls

158 lines (79 loc) · 7.5 KB

Requirements Summary

default

As an API user, I want to know the unique values for a specific API field. (#284)

This requirement is not impacted by the current version

As an API user, I want an average query response time of 1 second for q=* queries (#69)

This requirement is not impacted by the current version

As an API user, I want to handle long-running queries that take >10 seconds. (#68)

This requirement is not impacted by the current version

As an operator, I want to have a wrapper script for starting up the API service (#67)

This requirement is not impacted by the current version

As a user, I want to know why my query syntax is invalid (#66)

This requirement is not impacted by the current version

As a user, I want specific end points for products which are not collections or bundles (#65)

This requirement is not impacted by the current version

As a user, I want the /products end point to work for any class of products (#64)

This requirement is not impacted by the current version

As a user, I want the end-point /api to redirect to the API documentation (#63)

This requirement is not impacted by the current version

As a user, I want to have a complete default fields (for now at least) (#155)

This requirement is not impacted by the current version

As a client developer, I want to facet on 1 or more fields in the registry (#283)

This requirement is not impacted by the current version

As a user, I want to have singular urls when I should only expect a single element in the response (#61)

This requirement is not impacted by the current version

As a user, I want to see the version of the API specification in the URL of the service (#59)

This requirement is not impacted by the current version

As a user, I want to see the version of the API specification in the URL of the service (#8)

This requirement is not impacted by the current version

As a user, I want the /products end point to work for any class of products (#11)

This requirement is not impacted by the current version

As a user, I want to query for products from any PDS4 product type (#12)

This requirement is not impacted by the current version

As a user, I want to know why my query syntax is invalid (#13)

This requirement is not impacted by the current version

As an operator, I want to have a wrapper script for starting up the API service (#14)

This requirement is not impacted by the current version

As an API user, I want to handle long-running queries that take >10 seconds. (#15)

This requirement is not impacted by the current version

As an API user, I want an average query response time of 1 second for q=* queries (#16)

This requirement is not impacted by the current version

As an API caller(user) I want to specify fields for endpoints given a lidvid (#80)

This requirement is not impacted by the current version

the default proposed mime type in swagger-ui.html should be 'application/json' (#88)

This requirement is not impacted by the current version

As a user, I want to have an administrator contact when I am getting an error 500 from the server (#109)

This requirement is not impacted by the current version

As a user I want consistent /type/lidvlid/{child,parent}/{latest,all} (#126)

This requirement is not impacted by the current version

As a user, I want to get the product identifiers in a application/kvp+json format (#132)

This requirement is not impacted by the current version

As a user, I want to be able to paginate over any number of results returned from a query. (#176)

This requirement is not impacted by the current version

As a user, I want to flush the API cache after archive status has been changed (#228)

This requirement is not impacted by the current version

As a web client developer, I want to be able to access the API without having to ask for authorization (#192)

This requirement is not impacted by the current version

As a registry-tool/registry-user I want to ensure leading multiple forward-slashes in request paths are stripped out (#208)

This requirement is not impacted by the current version

As a user, I want the API to support redundant / in the url (#212)

This requirement is not impacted by the current version

As a user, I want to know the members of a bundle product (#223)

This requirement is not impacted by the current version

As a user, I want to know the unit or nilReason for an attribute. (#307)

This requirement is not impacted by the current version

As a user, I want to search by any metadata attribute (#282)

This requirement is not impacted by the current version

Suggest: Return Content-Type application/json by default (#248)

This requirement is not impacted by the current version

As a user, I want to see available query params in the swagger documentation (#249)

This requirement is not impacted by the current version

As a user, I want to be informed if some of the members of bundle or collection where not retrieve or are not visible yet for me (#270)

This requirement is not impacted by the current version

As a EN Operator, I want to the registry API to be fault tolerant (#297)

This requirement is not impacted by the current version

As a user, I want to query-filter products by collection- and/or bundle- membership (#298)

This requirement is not impacted by the current version

Remove provenance --reset option (#310)

This requirement is not impacted by the current version