Skip to content

Commit

Permalink
Update requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
@pdsen-ci
pdsen-ci committed Nov 14, 2023
1 parent 61fa4aa commit bcee318
Showing 1 changed file with 254 additions and 0 deletions.
254 changes: 254 additions & 0 deletions docs/requirements/v2.5.0-dev/REQUIREMENTS.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,254 @@

Requirements Summary
====================

# DOI management

## The software shall be capable of accepting a request to create a draft DOI. ([#5](https://github.com/NASA-PDS/doi-service/issues/5))


This requirement is not impacted by the current version
## The software shall be capable of accepting a request to reserve a DOI. ([#6](https://github.com/NASA-PDS/doi-service/issues/6))


This requirement is not impacted by the current version
## The software shall release a DOI (making it findable). ([#7](https://github.com/NASA-PDS/doi-service/issues/7))


This requirement is not impacted by the current version
## The software shall be capable of accepting a request to deactivate a DOI. ([#8](https://github.com/NASA-PDS/doi-service/issues/8))


This requirement is not impacted by the current version
## The software shall be capable of accepting a request to update DOI metadata. ([#9](https://github.com/NASA-PDS/doi-service/issues/9))


This requirement is not impacted by the current version
## The software shall be capable of batch processing >1 DOI requests. ([#10](https://github.com/NASA-PDS/doi-service/issues/10))


This requirement is not impacted by the current version
# DOI metadata

## The software shall be capable of autonomously generating the minimum set of DOI metadata from PDS4 Collection, Bundle, Document products. ([#11](https://github.com/NASA-PDS/doi-service/issues/11))


This requirement is not impacted by the current version
## The software shall validate a minimum set of metadata is provided when reserving, releasing, or updating a DOI. This minimum set of metadata will be defined by the PDS DOI Working Group. ([#12](https://github.com/NASA-PDS/doi-service/issues/12))


This requirement is not impacted by the current version
## The software shall validate the DOI metadata when reserving, releasing, or updating a DOI. ([#13](https://github.com/NASA-PDS/doi-service/issues/13))


This requirement is not impacted by the current version
# DOI interface support

## The software shall maintain a database of PDS DOIs and their current state. ([#14](https://github.com/NASA-PDS/doi-service/issues/14))


This requirement is not impacted by the current version
## The software shall maintain the ability to manage DOIs through OSTI ([#15](https://github.com/NASA-PDS/doi-service/issues/15))


This requirement is not impacted by the current version
## The software shall maintain the ability to manage DOIs through DataCite. ([#16](https://github.com/NASA-PDS/doi-service/issues/16))


This requirement is not impacted by the current version
# DOI-management

## The software shall provide a Status capability that will allow a user to query for the current status of a DOI ([#30](https://github.com/NASA-PDS/doi-service/issues/30))


This requirement is not impacted by the current version
## The software shall provide the capability of producing a DOI Status Report based upon a user-specified query ([#35](https://github.com/NASA-PDS/doi-service/issues/35))


This requirement is not impacted by the current version
# default

## As a node operator, I want to include a DOI as a related identifier in the DOI metadata for parent PDS4 products. ([#69](https://github.com/NASA-PDS/doi-service/issues/69))


This requirement is not impacted by the current version
## As a user, I want the DOI metadata for a product to be automatically updated when I have a new version of an accumulating bundle / collection. ([#97](https://github.com/NASA-PDS/doi-service/issues/97))


This requirement is not impacted by the current version
## As the PDS, I want to mint DOIs through DataCite ([#103](https://github.com/NASA-PDS/doi-service/issues/103))


This requirement is not impacted by the current version
## As a user, I want to see the lidvid of my DOIs in the email report ([#167](https://github.com/NASA-PDS/doi-service/issues/167))


This requirement is not impacted by the current version
## As an operator, I want to reserve a DOI through DataCite ([#171](https://github.com/NASA-PDS/doi-service/issues/171))


This requirement is not impacted by the current version
## As an operator, I want query for one or more minted DOIs from DataCite ([#172](https://github.com/NASA-PDS/doi-service/issues/172))


This requirement is not impacted by the current version
## As an operator, I want to query for a DOI's change history through DataCite ([#173](https://github.com/NASA-PDS/doi-service/issues/173))


This requirement is not impacted by the current version
## As an operator, I want to release a DOI through DataCite ([#174](https://github.com/NASA-PDS/doi-service/issues/174))


This requirement is not impacted by the current version
## As an operator, I want to update DOI metadata through DataCite ([#175](https://github.com/NASA-PDS/doi-service/issues/175))


This requirement is not impacted by the current version
## As an API user, I want to have pagination that is consistent with the PDS API. ([#176](https://github.com/NASA-PDS/doi-service/issues/176))


This requirement is not impacted by the current version
## As an API user I want to filter on lidvids with wildcards ([#177](https://github.com/NASA-PDS/doi-service/issues/177))


This requirement is not impacted by the current version
## As an API user I want to filter on PDS3 Data Set IDs with wildcards ([#180](https://github.com/NASA-PDS/doi-service/issues/180))


This requirement is not impacted by the current version
## As a user of the API, I want to see the DOI's title when I go GET /dois request ([#183](https://github.com/NASA-PDS/doi-service/issues/183))


This requirement is not impacted by the current version
## As an API user, I want to always have an update date for the DOIs ([#184](https://github.com/NASA-PDS/doi-service/issues/184))


This requirement is not impacted by the current version
## As a SA, I want the operational deployment of the service to be secure ([#187](https://github.com/NASA-PDS/doi-service/issues/187))


This requirement is not impacted by the current version
## As a user, I want the application to support the history of PDS's DOIs, especially the one created for PDS3 products ([#192](https://github.com/NASA-PDS/doi-service/issues/192))


This requirement is not impacted by the current version
## As a system administrator, I want to be able to deploy pds_doi_service with python 3.6 ([#197](https://github.com/NASA-PDS/doi-service/issues/197))


This requirement is not impacted by the current version
## As a user, I want to use the API with ids containing a slash (/) ([#198](https://github.com/NASA-PDS/doi-service/issues/198))


This requirement is not impacted by the current version
## As an operator, I want to know what version of the software I am running ([#200](https://github.com/NASA-PDS/doi-service/issues/200))


This requirement is not impacted by the current version
## As an operator, I want to know how to deploy and use the API from the Sphinx documentation ([#201](https://github.com/NASA-PDS/doi-service/issues/201))


This requirement is not impacted by the current version
## As an operator, I want one place to go for all DOI Service / API / UI documentation ([#202](https://github.com/NASA-PDS/doi-service/issues/202))


This requirement is not impacted by the current version
## As a user of the command line, I don't want to see all the log info in the stdout ([#206](https://github.com/NASA-PDS/doi-service/issues/206))


This requirement is not impacted by the current version
## As a command-line user, I want to be suggested to use -f option when a Warning exception is raised ([#207](https://github.com/NASA-PDS/doi-service/issues/207))


This requirement is not impacted by the current version
## As a user, I want to run the commandline on windows ([#212](https://github.com/NASA-PDS/doi-service/issues/212))


This requirement is not impacted by the current version
## As a user, I want to search dois without case sensitiveness ([#223](https://github.com/NASA-PDS/doi-service/issues/223))


This requirement is not impacted by the current version
## As a DOI user, I would like to know the licensing information PDS data ([#224](https://github.com/NASA-PDS/doi-service/issues/224))


This requirement is not impacted by the current version
## As an admistrator of the application, I want to restrict access to API by specific referrer ([#228](https://github.com/NASA-PDS/doi-service/issues/228))


This requirement is not impacted by the current version
## As a user, I want to include related DOIs in DOI metadata ([#232](https://github.com/NASA-PDS/doi-service/issues/232))


This requirement is not impacted by the current version
## As a PDS Operator, I want to perform a bulk update of a specific field across many DOI records ([#257](https://github.com/NASA-PDS/doi-service/issues/257))


This requirement is not impacted by the current version
## As a user, I want to search for ids without case sensitiviy ([#271](https://github.com/NASA-PDS/doi-service/issues/271))


This requirement is not impacted by the current version
## As a user, I want to update the LIDVID associated with a DOI ([#278](https://github.com/NASA-PDS/doi-service/issues/278))


This requirement is not impacted by the current version
## As a user, I want to update the bundle/collection metadata associated with a DOI for accumulating data sets ([#279](https://github.com/NASA-PDS/doi-service/issues/279))


This requirement is not impacted by the current version
## As an API user, I want to know the status value which can be expected ([#280](https://github.com/NASA-PDS/doi-service/issues/280))


This requirement is not impacted by the current version
## As a publisher, I want to be notified when a new DOI has been minted or significant update to the metadata ([#283](https://github.com/NASA-PDS/doi-service/issues/283))


This requirement is not impacted by the current version
## As a user, I want a simplified DOI lifecycle workflow ([#286](https://github.com/NASA-PDS/doi-service/issues/286))


This requirement is not impacted by the current version
## Update default values to sync with SBN documentation ([#295](https://github.com/NASA-PDS/doi-service/issues/295))


This requirement is not impacted by the current version
## As a user, I want to sort by DOI, title, or identifier. ([#306](https://github.com/NASA-PDS/doi-service/issues/306))


This requirement is not impacted by the current version
## Add Radio Science to set of possible nodes ([#317](https://github.com/NASA-PDS/doi-service/issues/317))


This requirement is not impacted by the current version
## As an administrator, I would like to synchronize my database with server which is not configured in the current deployment ([#330](https://github.com/NASA-PDS/doi-service/issues/330))


This requirement is not impacted by the current version
## As a DOI user, I would like to know the copyright for PDS data ([#335](https://github.com/NASA-PDS/doi-service/issues/335))


This requirement is not impacted by the current version
## As a DOI user, I want to know when this data set was made available ([#343](https://github.com/NASA-PDS/doi-service/issues/343))


This requirement is not impacted by the current version
## As a user, I want to release a DOI with a label that does not contain the DOI ([#344](https://github.com/NASA-PDS/doi-service/issues/344))


This requirement is not impacted by the current version
## As a node user, I want to get an email when my DOI is released ([#351](https://github.com/NASA-PDS/doi-service/issues/351))


This requirement is not impacted by the current version
## As a DOI User, I want to know the public available date for the initial release of a data set ([#400](https://github.com/NASA-PDS/doi-service/issues/400))


This requirement is not impacted by the current version
## As a user, I want to mint a DOI for a Product_External ([#410](https://github.com/NASA-PDS/doi-service/issues/410))


This requirement is not impacted by the current version
## As a system administrator, I want to deploy the doi-service as micro-service on ECS ([#414](https://github.com/NASA-PDS/doi-service/issues/414))


This requirement is not impacted by the current version

0 comments on commit bcee318

Please sign in to comment.