Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adapt IATI Publisher to use new data registration API #1594

Open
1 of 2 tasks
robredpath opened this issue Oct 28, 2024 · 4 comments
Open
1 of 2 tasks

Adapt IATI Publisher to use new data registration API #1594

robredpath opened this issue Oct 28, 2024 · 4 comments
Labels
Maintenance Upkeep or maintenance-related tasks ODS Issue initiated by ODS

Comments

@robredpath
Copy link
Collaborator

robredpath commented Oct 28, 2024

Alongside the work to change how users register and sign in to IATI products (tracked in #1486, details to be supplied when we've worked them out), we're also changing how people manage the URLs of their data on the IATI Registry. We're doing this through a new API which will sit in front of the Registry and integrate the registration/update process with the wider approach to managing information about individuals and organisations within the Secretariat.

We don't have any specific details about this yet, but we will share them as soon as we can.

Checklist

  • Document the different ways that IATI Publisher currently interacts with the IATI Registry (to better understand dependencies)
  • List all API calls and fields currently used by IATI Publisher, including what each is used for
@emmajclegg emmajclegg added ODS Issue initiated by ODS Maintenance Upkeep or maintenance-related tasks labels Oct 29, 2024
@emmajclegg
Copy link
Collaborator

@robredpath - we spoke about documenting IATI Publisher's current Registry interactions as a first step on this work for next year.

This is a document I drafted earlier in the year about this: IATI Publisher- interaction with the Registry

I've added some questions for YI in the comments. Before we ask their team to add to and check this document, is there any other information we're specifically interested in do you think? e.g. specific API calls and Registry permission levels used, etc.

@robredpath
Copy link
Collaborator Author

That document is great, thank you! If that document is accurate and we can get the exact API calls used then I think that gives us everything we need.

The other thing we could use knowing is which fields are used from the responses, and what they're used for.

I'm also unclear on how org fields work in Publisher and the Registry - is the org's name used for both the org file and the Registry? If it changes do both get updated?

Registry permissions are quite basic and YI use a superuser API token so I don't there's much anyone could tell us about which permission level is being used; we can figure that out from the query and the fields in the response that are used.

@emmajclegg
Copy link
Collaborator

emmajclegg commented Jan 8, 2025

Thanks for looking through @robredpath. I'll add the API response fields to the questions in the document.

On organisation fields - the organisation name entered during IATI Publisher registration (for an organisation not yet registered with IATI) is used to create the Registry publisher account and to pre-populate iati-organisation/name and reporting-org/narrative. However, any of these names can then be edited by the end user, without the others being kept in sync.

I believe AidStream includes a refresh button, which the user can use to automatically update AidStream organisation info to match the Registry publisher account. We probably want something similar for Publisher in future to avoid organisation info being out of sync.

@emmajclegg
Copy link
Collaborator

@BibhaT @PG-Momik - for info, I'm sharing this document on IATI Publisher- interaction with the Registry as it relates to upcoming work this year (we can discuss on our next call).

As a first step to understanding IATI Publisher's current dependencies on the IATI Registry, it would be great if YI:

  • can check the section "Current interactions with the IATI Registry" in that document for accuracy
  • provide a list of the Registry API calls and response fields currently used by IATI Publisher

This shouldn't derail other work this month - I'm just sharing ahead of upcoming conversations about 2025 work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance Upkeep or maintenance-related tasks ODS Issue initiated by ODS
Projects
None yet
Development

No branches or pull requests

2 participants