Openaire suggestions (publication claim) rest contracts #192

LucaGiamminonni · 2022-05-04T13:21:46Z

Rest contract for suggestion (publication claim) rest repositories related to https://www.openaire.eu/open-call-winner-phase-1-4science
Detailed documentation about the aims of the project, the implementation and the configuration options is available at https://4science.github.io/oaire-eld/#/publication-claim

paulo-graca

This mechanism, to me, in what you are proposing is very similar to what we already have regarding external sources and authority. I think we should bring this specification close to what is already defined for those mechanisms.

For instance, if we compare how the ID is defined here:
"id": "reciter:gf3d657-9d6d-4a87-b905-fef0f8cae26:24694772",

and how is defined in:
https://github.com/DSpace/RestContract/blob/main/external-authority-sources.md#single-entry
"id": "0000-0002-4271-0436",

Having the self HAL links as:
"https://dspace7.4science.cloud/server/api/integration/externalsources/orcid/entryValues/0000-0002-4271-0436"

I think the source could also be part of the endpoint in the model you are proposing.

…t7Contract into CST-11299

…9_suggestion

tdonohue

@frabacche or @LucaGiamminonni : I've reviewed this today compared to the implementation PR at DSpace/DSpace#8280. This contract looks good overall, but I've found a few minor mistakes compared to the implementation. See inline comments below. Once these are fixed, I'm +1 this PR.

tdonohue · 2024-02-14T20:26:39Z

suggestiontargets.md

+
+Exposed links:
+* target: link to the items that represent the person to whom the suggestions are proposed
+* suggestions: link to the suggestions entries


I currently don't see the suggestions link in the implementation at DSpace/DSpace#8280

When I view the responses from this endpoint, I'm not able to find a way to trigger a "suggestions" link. Is this not yet implemented, or maybe I'm overlooking it? If it's not yet implemented, then we should remove it from here & from the JSON example in this section.

My feedback here was accidentally overlooked. I don't see the suggestions link for suggestiontargets. I don't believe this exists yet? So, we should remove it from this line & also from the JSON example in this section.

tdonohue · 2024-02-14T20:28:26Z

suggestiontargets.md

+        "type": "suggestiontarget",
+        "_links": {
+          "target": {
+            "href": "https://dspace7.4science.cloud/server/api/core/items/gf3d657-9d6d-4a87-b905-fef0f8cae26"


Could we replace all of the "https://dspace7.4science.cloud/" URLs with "https://demo.dspace.org/"? We need to make sure that URL examples in our REST Contract are not pointing to institution/service provider specific URLs.

tdonohue · 2024-02-14T20:31:05Z

suggestionsources.md

+* the *total* attribute is the number of target with suggestions. It can be 0 if there are no target with suggestions
+
+Exposed links:
+* suggestiontargets: link to the suggestion targets entries


I currently don't see this suggestiontargets link in the implementation. When I call this endpoint directly, it's also missing. Is this not yet implemented? If it's not yet implemented we should remove it from here & from the JSON example in this section

tdonohue · 2024-02-14T20:32:38Z

suggestions.md

+```json
+{
+  "_embedded": {
+    "reciterSourceEntries": [


This should say "suggestions" not "reciterSourceEntries", as that is what the implementation returns.

tdonohue · 2024-02-14T20:33:11Z

suggestions.md

+        "id": "24694772",
+        "display": "publication one",
+        "source": "reciter",
+        "external-source-uri": "https://dspace7.4science.cloud/server/api/integration/reciterSourcesEntry/pubmed/entryValues/24694772",


In the implementation this property is named externalSourceUri not external-source-uri

tdonohue · 2024-02-14T20:34:42Z

suggestions.md

+        "source": "reciter",
+        "external-source-uri": "https://dspace7.4science.cloud/server/api/integration/reciterSourcesEntry/pubmed/entryValues/24694772",
+        "evidences": {
+          "acceptedRejectedEvidence": {


All of the evidences listed in this example are not currently in DSpace. The only two that I can find are these:

"AuthorNamesScorer" : { "score" : "100.00", "notes" : "some notes, empty or null" }, "DateScorer" : { "score" : "0.00", "notes" : "some notes, empty or null" }

Can we update this example to only list the AuthorNamesScorer and DateScorer?

Evidences shown here in the contract are currently customizable in every bean of class org.dspace.app.suggestion.openaire.PublicationLoader on its property called pipeline . We chose to show all these evidences as examples. On the dspace/config/spring/api/suggestions.xml file we already set the bean called OpenairePublicationLoader with a pipeline attribue having the AuthorNameScorer and the DateScorer.

@frabacche : I understand they are configurable. However, the REST Contract is supposed to provide examples that are realistic based on DSpace's current features. I feel listing a large number of evidences that don't exist in DSpace is misleading. This list should at least be updated to show the few that currently exist and then maybe have one example of how it might look if extended.

tdonohue · 2024-02-14T20:36:15Z

suggestions.md

+    "score": "62.7",
+    "external-source-uri": "https://dspace7.4science.cloud/server/api/integration/reciterSourcesEntry/pubmed/entryValues/24694772",
+    "evidences": {
+      "acceptedRejectedEvidence": {


Same as other comment. We should change this list to only include AuthorNamesScorer and DateScorer.

As I noted in my later reply, I think we need to keep the list of "evidences" realistic, otherwise developers will be confused if they cannot find these in DSpace.

I'm OK with providing one example of a custom evidence. But, currently this REST Contract PR has a list of 9 evidences all of which do not exist in DSpace. I propose we update this to say something like:

"AuthorNamesScorer" : { "score" : "100.00", "notes" : "some notes, empty or null" }, "DateScorer" : { "score" : "0.00", "notes" : "some notes, empty or null" }, "customEvidence": { "score" : "23.7", "notes" : "some notes, empty or null" },

@frabacche : Could you update the list of evidences in this section of suggestions.md the same way that you updated them below? This section still has the list of invalid "evidences"

For example:

"AuthorNamesScorer" : { "score" : "100.00", "notes" : "some notes, empty or null" }, "DateScorer" : { "score" : "0.00", "notes" : "some notes, empty or null" }, "customEvidence": { "score" : "23.7", "notes" : "some notes, empty or null" },

tdonohue · 2024-02-14T20:36:37Z

suggestions.md

+    "display": "publication one",
+    "source": "reciter",
+    "score": "62.7",
+    "external-source-uri": "https://dspace7.4science.cloud/server/api/integration/reciterSourcesEntry/pubmed/entryValues/24694772",


Same as other comment. Should be named externalSourceUri

suggestions.md

tdonohue

@frabacche : Thanks for the updates to this REST Contract. I've re-reviewed your changes, but it appears you accidentally overlooked a few requests. I'd also appreciate it if we can provide a list of "evidences" that is realistic (see comment below). Our REST Contract should not list a lot of unimplemented features (in this case evidences). We need to ensure it is accurate based on what currently exists in DSpace.

Once these final changes are made, this PR should be ready to merge. Thanks!

suggestions.md

tdonohue · 2024-02-15T16:50:25Z

suggestions.md

+    "score": "62.7",
+    "external-source-uri": "https://dspace7.4science.cloud/server/api/integration/reciterSourcesEntry/pubmed/entryValues/24694772",
+    "evidences": {
+      "acceptedRejectedEvidence": {


As I noted in my later reply, I think we need to keep the list of "evidences" realistic, otherwise developers will be confused if they cannot find these in DSpace.

I'm OK with providing one example of a custom evidence. But, currently this REST Contract PR has a list of 9 evidences all of which do not exist in DSpace. I propose we update this to say something like:

"AuthorNamesScorer" : { "score" : "100.00", "notes" : "some notes, empty or null" }, "DateScorer" : { "score" : "0.00", "notes" : "some notes, empty or null" }, "customEvidence": { "score" : "23.7", "notes" : "some notes, empty or null" },

tdonohue · 2024-02-15T16:52:26Z

suggestiontargets.md

+
+Exposed links:
+* target: link to the items that represent the person to whom the suggestions are proposed
+* suggestions: link to the suggestions entries


My feedback here was accidentally overlooked. I don't see the suggestions link for suggestiontargets. I don't believe this exists yet? So, we should remove it from this line & also from the JSON example in this section.

…xamples

tdonohue

@frabacche : Thanks for the updates! There's one update you still overlooked though. This appears to be the last change that was missing. See comment below.

tdonohue · 2024-02-16T16:46:44Z

suggestions.md

+    "score": "62.7",
+    "external-source-uri": "https://dspace7.4science.cloud/server/api/integration/reciterSourcesEntry/pubmed/entryValues/24694772",
+    "evidences": {
+      "acceptedRejectedEvidence": {


@frabacche : Could you update the list of evidences in this section of suggestions.md the same way that you updated them below? This section still has the list of invalid "evidences"

For example:

"AuthorNamesScorer" : { "score" : "100.00", "notes" : "some notes, empty or null" }, "DateScorer" : { "score" : "0.00", "notes" : "some notes, empty or null" }, "customEvidence": { "score" : "23.7", "notes" : "some notes, empty or null" },

tdonohue

👍 Thank you @frabacche and @LucaGiamminonni ! This looks good to me now!

[CST-5249] Added suggestions rest contracts

6ade120

This was referenced May 4, 2022

Openaire suggestions (publication claim) DSpace/DSpace#8280

Merged

Openaire suggestions (publication claim) DSpace/dspace-angular#1638

Merged

paulo-graca self-requested a review May 5, 2022 14:15

tdonohue added the low priority label May 5, 2022

tdonohue assigned LucaGiamminonni May 5, 2022

paulo-graca reviewed Jul 12, 2022

View reviewed changes

tdonohue requested review from tdonohue and removed request for paulo-graca July 14, 2022 14:41

tdonohue mentioned this pull request Aug 2, 2022

Rest contracts for qaevents, qatopics and qasources endpoints #181

Merged

abollini mentioned this pull request Jan 19, 2023

Enrich local data via the OpenAIRE Graph #156

Closed

Merge branch 'CST-5249_suggestion' of https://github.com/4Science/Res…

a728beb

…t7Contract into CST-11299

tdonohue assigned tdonohue and frabacche and unassigned tdonohue Sep 5, 2023

tdonohue added high priority and removed low priority labels Nov 15, 2023

Merge branch 'main' of github.com:4Science/Rest7Contract into CST-524…

351c6d8

…9_suggestion

tdonohue requested changes Feb 14, 2024

View reviewed changes

tdonohue added this to the 8.0 milestone Feb 14, 2024

CST-5249_suggestion alignment to the backend implementation

c189f70

tdonohue changed the title ~~Added suggestions rest contracts~~ Openaire suggestions (publication claim) rest contracts Feb 15, 2024

tdonohue requested changes Feb 15, 2024

View reviewed changes

CST-5249_suggestion alignment with backend implementations and real e…

88eeb94

…xamples

frabacche requested a review from tdonohue February 16, 2024 09:01

tdonohue requested changes Feb 16, 2024

View reviewed changes

fix suggestions GET response example

c63bf54

frabacche requested a review from tdonohue February 19, 2024 08:35

tdonohue added integration: QA Notifications Related to QA (Quality Assurance) notifications from external sources integration: OpenAIRE Related to integration with OpenAIRE labels Feb 20, 2024

tdonohue approved these changes Feb 20, 2024

View reviewed changes

tdonohue merged commit 7906b33 into DSpace:main Feb 20, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Openaire suggestions (publication claim) rest contracts #192

Openaire suggestions (publication claim) rest contracts #192

LucaGiamminonni commented May 4, 2022

paulo-graca left a comment

tdonohue left a comment

tdonohue Feb 14, 2024 •

edited

Loading

tdonohue Feb 15, 2024

tdonohue Feb 14, 2024

tdonohue Feb 14, 2024 •

edited

Loading

tdonohue Feb 14, 2024

tdonohue Feb 14, 2024

tdonohue Feb 14, 2024

frabacche Feb 15, 2024

tdonohue Feb 15, 2024

tdonohue Feb 14, 2024

frabacche Feb 15, 2024

tdonohue Feb 15, 2024

tdonohue Feb 16, 2024 •

edited

Loading

tdonohue Feb 14, 2024

tdonohue left a comment

tdonohue Feb 15, 2024

tdonohue Feb 15, 2024

tdonohue left a comment

tdonohue Feb 16, 2024 •

edited

Loading

tdonohue left a comment

Openaire suggestions (publication claim) rest contracts #192

Openaire suggestions (publication claim) rest contracts #192

Conversation

LucaGiamminonni commented May 4, 2022

paulo-graca left a comment

Choose a reason for hiding this comment

tdonohue left a comment

Choose a reason for hiding this comment

tdonohue Feb 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdonohue Feb 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdonohue Feb 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdonohue left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdonohue left a comment

Choose a reason for hiding this comment

tdonohue Feb 16, 2024 • edited Loading

Choose a reason for hiding this comment

tdonohue left a comment

Choose a reason for hiding this comment

tdonohue Feb 14, 2024 •

edited

Loading

tdonohue Feb 14, 2024 •

edited

Loading

tdonohue Feb 16, 2024 •

edited

Loading

tdonohue Feb 16, 2024 •

edited

Loading