Skip to content

Latest commit

 

History

History
168 lines (129 loc) · 14.2 KB

CHANGELOG.md

File metadata and controls

168 lines (129 loc) · 14.2 KB

Changelog

«unknown» (2024-12-16)

Full Changelog

Other closed issues:

  • Update documentation for API version 1.5.0 released in production #289
  • Add downtime notification to top of API documentation #284

v14.0.0 (2024-02-26)

Full Changelog

Other closed issues:

  • Publish documentation of PDS-API 14.0 when registry-api is deployed #277
  • Add intro presentation to online API documentation #267
  • Add /properties in the quickstart documentation of the the PDS API #265

v13.1.0 (2023-05-11)

Full Changelog

Requirements:

  • As a user, I want to monitor the availability of the APIs in production #225
  • As a user, I want query responses for empty results to be clearly documented #198
  • As a user, I want to know how to query observational data only #175

Defects:

  • PDS API is not respecting the sort field #262
  • PDS API documents are unclear wrt quoting in queries #260
  • API search returns 500 for anything besides simple queries #259
  • Search API documentation seems outdated? #257 [s.medium]
  • link to registry-api documentation from registry page is incorrect #251 [s.low]
  • API Client cannot connect to current deployed API #240 [s.high]
  • Past versions are being returned by API, by default #220 [s.high]
  • hits appears to be showing the current page count, not the overall number of its #199 [s.medium]
  • API performance degradation from B12.1 release #200 [s.high]
  • Swagger API page does not show the expected deployed API version #196 [s.low]

Other closed issues:

  • make the swagger api work behind a reverse proxy #253
  • integrate logo on official release registry-api and publish it #234
  • Add documentation for web UI developers #226

v1.1.0 (2022-10-13)

Full Changelog

Requirements:

  • As a user, I want to get directions whenever I arrive on an API URL #191
  • As a user, I want to have a PDS Search API user guide #169
  • As a user, I want to see API stable release specifications #139
  • As a developer, I want a continuous deployment of the API available for testing #51

Improvements:

  • Update user guide to use new API endpoints #217
  • Complete refactoring per API WG discussion on end-point redesign #202
  • Develop NASA/PDS Skin for Search API Swagger interface #194
  • Update README to reflect best practices of other PDS repositories #189 [s.high]
  • Upgrade documentation to present version 1.0 of the search API #188
  • Create a cookbook page on the content negotiation for the PDS Search API #183
  • Replace summary-only=true by limit=0 #173
  • Create user guide for the search api #172
  • Refactor meta section of pds4+json and pds4+xml to use ops namespace #154
  • Remove the x-total-count header from the API specification #145
  • flesh out the registry repository #142
  • Merge unnecessary individual repository #140
  • As a user, I want to have a detailed description of the API q parameter syntax #137
  • Revise the pds-api README so that it gives a perspective on non search api (e.g. doi) from pds #136
  • clarify what keyword parameter is for #133
  • As an API client user, I want to consistently and robustly start local servers for development and testing #112
  • Extend application/pds4+json support to all endpoints #110
  • Update API endpoints to use identifier instead of lidvid #108
  • Improve linkages from Registry App Docs to API Docs #158

Defects:

  • is "bites" a typo for "bytes" or "bits"? #216 [s.low]
  • vnd.nasa.pds.pds4+xml format does not return information #215 [s.medium]
  • vnd.nasa.pds.pds4+json format does return information #214 [s.medium]
  • Accept header of text/csv returns blank lines #213 [s.medium]
  • wildcards do not work as expected for all fields #210 [s.medium]
  • fix broken link in API docs #206 [s.low]
  • version number invalid according to PEP validation in CI #164 [s.critical]
  • products/{identifier} missing properties object in application/json response #155 [s.high]
  • pds api not able to search using URL parameters #130 [s.low]
  • Changes to API per last tagged release not in SwaggerHub #124 [s.critical]
  • Deployed API + Registry does not contain product metadata for pds4+json response #121 [s.high]

Other closed issues:

  • PDS API documentation needs to be scrubbed #203
  • Present the updated API specification to the API WG #197
  • Update Specifications documentation to only include latest with link to page with past versions #167
  • Check for typos in OpenAPI spec #161
  • document the server - specification - client #157
  • Disable automated github pages deployment with v1.0 #156
  • Update fields parameter definition to note that it does not apply to pds4+json and pds4+xml response formats #151
  • Update the swagger web tool from the specification #150
  • Update for */{identifier}/bundles and */{identifier}/collections endpoints documentation #146
  • Update API documentation to have consistent descriptions for the query parameter #143
  • create a super registry+api repository #123
  • analysis of current workflow, ideas for improvment #122
  • [pds-api] B12.1 Improve API query handling #116
  • Expand API to include latest/all for all endpoints #115
  • Identify and ingest bundle containing collections and products with multiple versions into dev registry #97

0.4.0 (2021-10-01)

Full Changelog

Requirements:

  • As an API user, I want to know in the response how many hits are returned for an API query. #68
  • As an API user, I want to access supplemental metadata from Product_Metadata_Supplemental. #67

Improvements:

  • Disable XML and HTML responses from current registry-api-service implementation #91
  • Get investigation area/targets/instruments from external ids #52
  • initiate a proposal for the API WG and ENG team #49
  • develop a jupyter notebook demo where a user can browse PDS archive from bundle to product data file #47
  • Implement content negotiation #43
  • Manage field preselection in queries #41
  • add lexer to registry api #40
  • Initial Federated API implementation #35
  • Deploy PDS API v0 (alpha) for beta testing #34
  • Define initial structure for response format conventions and parameter definition #17
  • Define initial set of intra-discipline (product-level) search scope #14
  • Deploy PDS API v0 (alpha) on pds-gamma test server #13
  • Initial Query Syntax Lexer Implementation #12
  • Streamline testing of API server implementation #31
  • Identify a framework to generate python api client from a swagger file #11
  • Propose an initial server stub based on swagger output #10
  • Design and elicit requirements for PDS API Spec #8
  • Assign and iterate over applicable API spec sections with API WG #6
  • Define collection-level search parameters #5
  • Convert PDS API Spec to Open API #4
  • Design initial collection-level search API #1

Defects:

  • As a n00b paginator, there might be an off-by-1 error in the limit parameter #73 [s.medium]

Other closed issues:

  • Update Swagger OpenAPI with new hits and took fields #87
  • Propose an acceptable syntax for PDS4 Xpath in json object #39
  • Standardize management of empty attributes #38
  • Update public PDS API Spec in Github #33
  • Deploy PDS API v0 (beta) on pds-gamma test server #32
  • Document basic adaptation capabilities from pds-api-service #26
  • Define required response fields #20
  • Define default response fields #19
  • Refine format conventions defined by the API WG #18
  • Perform trade study on various query language parsers to meet needs of proposed API Spec #9

* This Changelog was automatically generated by github_changelog_generator