Releases: folio-org/edge-oai-pmh
v2.2.1
This release includes minor bug fixes for edge-oai-pmh module (Q2/2020).
https://issues.folio.org/browse/EDGOAIPMH-49
v2.2.0
This release includes transfer of the business logic to the corresponding business module cause edge is a proxy between clients and pmh (Q2/2020).
Stories
-
EDGOAIPMH-131 - Move all request validations from edge module to oai-pmh module & remove interactions with mod-configuration.
-
MODOAIPMH-86 - add support of text/xml headers.
v2.1.2
This is a bugfix release for potential inclusion in Edelweiss (Q4/2019).
Stories
- EDGOAIPMH-39 - Replace the Accept header when proxying requests to mod-oai-pmh
v2.1.1
This is a bugfix release for inclusion in Edelweiss (Q4/2019).
The only change is to update the dependency version of the 'oai-pmh' interface
v2.1.0
This release includes tuning environment settings
Stories
- EDGOAIPMH-34 - Use JVM features to manage container memory
- FOLIO-2235 - Add LaunchDescriptor settings to each backend non-core module repository
v2.0.1
The only change in this release was to upgrade to latest login interface 6.0
v2.0.0
The main focus of this release was to upgrade login interface and edge-common dependency to actual versions.
Stories
- EDGOAIPMH-26: login 5.0 interface has been added to the required interfaces in the module descriptor.
- EDGOAIPMH-28: the edge-common dependency upgraded to version 2.0.0 in order to leverage the new API key structure.
v1.0.0
- Initial commit (EDGOAIPMH-2)
- Module/Deployment Descriptors added in scope of EDGOAIPMH-5
- In scope of EDGOAIPMH-4 added:
- RAML file
- OAI-PMH Schema: OAI-PMH.xsd (please refer to OAI-PMH specification for more details)
- POJO binding generation of OAI-PMH.xsd added in scope of EDGOAIPMH-7
- Initial implementation
- To access the OAI-PMH repository the apiKey is required which might be provided as part of the URI path,
apikey
parameter orAuthorization
header. Please refer to Security section of the the edge-common documentation for the details. - The endpoint depends on authorization mechanism chosen.
GET
orPOST
requests are supported. Please refer to edge-oai-pmh.raml for more details. - Once the request is received, the flow is following:
- The request is being validated if it valid according to OAI-PMH specification. If some parameters are missing or invalid, the OAI-PMH response with errors is sent back to harvester with
400
http status code. - The
apiKey
is being validated. In case it is missing or invalid, the response with error and401
http status code is sent back to caller. If the apiKey of valid structure, the service tries to login to FOLIO system. If something is wrong, the response with error is sent back to caller with403
or408
http status code. - The request is sent to repository business logic. If something is wrong, the response with error is sent back to caller with
408
or500
http status code. If all is okay, the OAI-PMH response is being sent to caller with200
,400
,404
or422
http status code.
- The request is being validated if it valid according to OAI-PMH specification. If some parameters are missing or invalid, the OAI-PMH response with errors is sent back to harvester with
- To access the OAI-PMH repository the apiKey is required which might be provided as part of the URI path,
- In scope of the EDGCOMMON-8 support of the compression is added. By default it is disabled and can be activated by corresponding VM option. The
gzip
anddeflate
compressions supported. - EDGOAIPMH-24: added the ability to specify the API key on the path, e.g.
GET /oai/<apiKey>?verb=...
andPOST /oai/<apiKey>?verb=...
. This will allow testing of incomplete responses/resumptionTokens via the marcEdit OAI-PMH harvester. You can also specify the API Key via the Authorization header or theapikey
(case sensitive) query argument. See Edge-Common for details.