Skip to content

Latest commit

 

History

History
323 lines (216 loc) · 22.1 KB

CHANGELOG.md

File metadata and controls

323 lines (216 loc) · 22.1 KB
Raw

Changelog

v2.1.3-dev (2022-02-01)

Full Changelog

Other closed issues:

  • Develop script to sync SBN DOIs with DOI Service #312

v2.1.2 (2022-01-13)

Full Changelog

Requirements:

  • As a PDS Operator, I want to perform a bulk update of a specific field across many DOI records #257
  • As an operator, I want one place to go for all DOI Service / API / UI documentation #202
  • As an operator, I want to know how to deploy and use the API from the Sphinx documentation #201

Improvements:

  • Update all past DOIs for consistent metadata #294
  • Improve upon application security for write access #231

Defects:

  • Document need to be update after adding the update argument #313
  • --no-review argument has potential to be confused with -n (node ID) argument #305 [s.low]
  • identifiers vs alternateIdentifiers appear disconnected from current DataCite schema #303 [s.high]

Other closed issues:

  • Develop DOI documentation for PDS Operator #256

v2.1.1 (2021-12-07)

Full Changelog

Requirements:

  • Update default values to sync with SBN documentation #295
  • As a user, I want to search dois without case sensitiveness #223

Improvements:

  • As a user, I want to obtain json label format from a list command query #289

Defects:

  • DOI Service does not assign adequate permissions to transaction database/history #299 [s.low]
  • Spreadsheet parsers do not handle blank rows gracefully #291 [s.low]
  • Default keywords/subjects are not always added to DOI records #273 [s.medium]

v2.1.0 (2021-11-03)

Full Changelog

Requirements:

  • As a user, I want a simplified DOI lifecycle workflow #286
  • As a user, I want to update the bundle/collection metadata associated with a DOI for accumulating data sets #279
  • As a user, I want to update the LIDVID associated with a DOI #278

Improvements:

  • Improved parsing support for DataCite JSON format #274
  • Add new alternateIdentifier to match SBN schema #102

Defects:

Other closed issues:

  • Test out and document how to upgrade the service #255
  • Remove Versioneer #250

v2.0.1 (2021-10-11)

Full Changelog

Improvements:

  • Improve spreadsheet parser error handling #260

Defects:

  • DOI Service does not properly handle input files with UTF-8 BOM #267
  • DOI Service should be generating landing page URL when none is provided #266
  • Release action does not check for assigned DOI before submission to DataCite #262
  • Query to DataCite does not properly support pagination #261
  • Spreadsheet parser does not validate/sanitize format of expected header row #259 [s.medium]
  • Spreadsheet parser does not validate parsed contents of rows #258 [s.medium]
  • Remove test and other transaction log data from public pypi distro #214 [s.medium]

Other closed issues:

v2.0.0 (2021-09-27)

Full Changelog

Requirements:

  • As the PDS, I want to mint DOIs through DataCite #103

Improvements:

  • Port from pystache to jinja2 #242
  • As a user, I want to see the PDS3 ids as they originally are #229
  • review the full doi workflow and make it smooth for eng operators/users #145

Defects:

  • Fix test failure with flask_testing module #247 [s.medium]

Other closed issues:

  • As an operator, I want to sync our local database with DataCite metadata #239
  • As an Administrator, I want to toggle the DOI service provider via the INI config #237
  • Create Validator class for DataCite JSON Labels #236
  • Deploy point build of DOI service and UI #90
  • Dev beta testing with API #87

v0.3.1 (2021-08-04)

Full Changelog

Requirements:

  • As an admistrator of the application, I want to restrict access to API by specific referrer #228
  • As a user, I want to use the API with ids containing a slash (/) #198
  • As a SA, I want the operational deployment of the service to be secure #187
  • As an operator, I want to update DOI metadata through DataCite #175
  • As an operator, I want to release a DOI through DataCite #174
  • As an operator, I want query for one or more minted DOIs from DataCite #172
  • As an operator, I want to reserve a DOI through DataCite #171

Improvements:

  • Update DOI service for handling existing DOIs acceptance criteria per #175 #227

Defects:

  • CI does not work on main branch for dev release #220
  • pytest does not work #219 [s.high]
  • Release OSTI command line does not work in one case #218 [s.high]
  • The issue #140 does not work as expected #208 [s.low]
  • When installing the pds-doi-service from scratch I had an error with Flask version compatibility #199 [s.high]

Other closed issues:

  • Refactoring to have OSTI as a "module" #204
  • Retrofit pds-doi-service to use pds python template #209

v1.1.1 (2021-05-27)

Full Changelog

Requirements:

  • As a user, I want the application to support the history of PDS's DOIs, especially the one created for PDS3 products #192
  • As an API user, I want to always have an update date for the DOIs #184
  • As a user of the API, I want to see the DOI's title when I go GET /dois request #183
  • As an API user I want to filter on PDS3 Data Set IDs with wildcards #180

Improvements:

  • Dockerize API Service #163

Defects:

  • API accepts Reserve submissions with invalid LIDVIDs #191 [s.medium]
  • As a user, I want to make sure I can not override existing DOI with new LIDVID #188 [s.medium]

Other closed issues:

  • As a product owner, I want to test the service with historical PDS DOIs #189

v1.1.0 (2021-04-13)

Full Changelog

Requirements:

  • As an API user I want to filter on lidvids with wildcards #177
  • As a user, I want to see the lidvid of my DOIs in the email report #167

Improvements:

  • Add service to API for update of the status of records with OSTI (check sub command) #165
  • Implement Application Server to wrap Flask service #162
  • When a pds4 label or osti can not be parsed generate error 400 in API #157
  • API POST /dois should accept DOI OSTI format in payload #148
  • enable filter by status in sub-action 'pds-doi-cmd list' #144
  • Update submission to OSTI to handle the removal of a field from the OSTI metadata #140
  • Update API to deactivate 'release' end point, create a 'submit' end-point #135
  • Update draft action with new option --lidvid to change from review to draft the status of a DOI #134
  • Update status management in code with Enumeration #132
  • Update DOI UI and Service with new workflow for operational deployment #125
  • Develop User Access / Management Strategy #91
  • validate the submitted OSTI record against a schema #56
  • API Implementation for DOI Service #52

Defects:

  • site_url error when we submit on OSTI test server #168
  • The url /dois/{lidvid} should still return XML in the record attribute #159 [s.critical]
  • draft OSTI label #154 [s.high]
  • when doing draft with warnings (e.g. duplicated title) the -f option does not help #150 [s.high]
  • when release command keywords are broken with encoded characters #143 [s.high]
  • api does not ignore '/' at the end of url #141 [s.low]
  • xlsx file extension for reserve not supported #138 [s.high]
  • 'pds-doi-cmd draft' chokes on a legit Product_Document #129 [s.medium]
  • command pds-doi-cmd list returns update date in timestamp instead of iso8601 #128 [s.high]
  • update_date management #127 [s.medium]
  • get /dois/{lidvid} #126 [s.medium]
  • the sqllite database should be created at the same location, whereever the command are launched from #122 [s.high]
  • Raise a specific exception when the OSTI server is not reachable #119 [s.medium]

Other closed issues:

  • Analyze/Test the dataCite API for dataCite #170
  • Update release action with --no-review option, make 'with review' default behavior #133
  • Document the security requirements for operational installation of DOI Service #124

v1.0.1 (2020-11-24)

Full Changelog

Improvements:

  • Extraction of the OSTI XML in /dois?... GET requests #116
  • Draft action: read the doi from the pds4 label #114
  • Be explicit in the install documentation about the test/prod osti server configuration #98

Defects:

  • GET /dois must support empty vid field #121 [s.high]
  • configuration files are not well deployed #115
  • Be more specific about the supported python version or extend tests #92

Other closed issues:

  • Add force argument to the /dois POST function #113
  • allow to post PDS4 labels in the payload (for draft) #107
  • Add exception name in the error messages #106
  • Complete get DOIS criterias with the arguments proposed in command line #105
  • Add GET DOI to the API #100
  • Develop API specification in SwaggerHub #80
  • Add Release DOI function to API #79
  • Add POST Reserve xslx/csv DOI function to API #78
  • Add POST PDS4 or OSTI DOI label to API #77
  • Mock web UI for DOI management #67
  • Add Status / Query component to API #38

1.0.0 (2020-10-13)

Full Changelog

Improvements:

  • Update to use pds round-up github action #94
  • Write procedure documentation #83
  • End to end behave test #82
  • initialize production deployment with pre-existing dois #71
  • add check to ensure landing page is online prior to DOI release #70
  • Revise DOI Service Requirements #65
  • Add configuration documentation #60
  • create full_name when first/last name cannot be parsed #58
  • Perform benchmark tests between original prototype software and new system #44
  • Update documentation for operational installation and usage #42
  • Develop simple regression test suite for deployment #41
  • Develop DOI metadata automated validation component #18

Defects:

  • node is not provided as contributor in the reserve records #72
  • Update default DOI metadata according to changes in requirements #55

Other closed issues:

  • Revise requirements to ensure scope is being met #64
  • Develop DOI Service Scope #63
  • Develop operational documentation and test suite #40

0.0.3 (2020-07-31)

Full Changelog

0.0.2 (2020-07-31)

Full Changelog

Improvements:

  • Implement the command line and parser to release a doi #46
  • Develop Pending DOI Handler component for iteratively querying OSTI for DOI status until status change #33
  • Develop Status / Query capability for querying database and return JSON #32
  • Develop maintain internal database of DOI requests #31
  • Develop ability to maintain a transaction log database #29
  • Re-organize and clean-up code to meet coding standards #28
  • Develop DOI Status / Query component #27
  • Implement initial DOI database and management #26
  • DOI Batch Processing capability #25
  • Update Released DOI capability #24
  • Release DOI capability #22
  • Reserve a DOI capability #21
  • Develop draft PDS Policy for Assigning DOIs #20
  • Design REST API and JSON response #19
  • Develop Status / Query API and component for OSTI status of a DOI #4
  • Create / Draft a DOI object capability #2

Other closed issues:

  • document requirements and tests #3
  • Develop initial requirements and design for DOI Service #1

* This Changelog was automatically generated by github_changelog_generator