Create manual github example workflow to validate OpenAIRE SKG-IF API live endpoint

[rduyme]

We have one main implementation of the SKG-IF OpenAPI done by OpenAIRE. But at the moment the OpenAIRE is not fully aligned with the SKG-IF API.

It would be great to have a manual workflow to validate the OpenAIRE endpoint

2 operations are available 2025/10/31

• https://api.openaire.eu/graph/skg-if/v1/products?filter=cf.search.title_abstract:ocean
• https://api.openaire.eu/graph/skg-if/v1/products/doi_dedup___::ab77dd9b474e8fc8ad57712cadae4a84

The workflow should be executed manually (not at commit or push) and validated against the latest current version of the API.
https://skg-if.github.io/api/openapi/ver/current/skg-if-openapi.yaml

Note : the https://github.com/skg-if/api/ repo is maybe not the final place for such workflow related to the specific OpenAIRE endpoint only. But we need to provide a simple workflow to be copied by implementers to their repo. This workflow can serve as template (for github at least)

[rduyme]

@vicding-mi do you have time to create this manual github workflow ?

cc @menzowindhouwer

[vicding-mi]

@rduyme Can you please assign me to this ticket?
Since it's a manual workflow, how should it be triggered? in the clone on user's computer? Can I assume that use run a script locally to validate json files?
If it has to run on GitHub, be it in this repo or in user's repo, it has to hook up to some activity like commit, push, tag and so on. Any of those I can use as trigger?

[rduyme]

Hi Vic. I never tested, but I think you can create a manual workfow with 'workflow_dispatch' (without hook to commit, push, tag). ( you can do that on gitlab with when: manual on all jobs, chained with extends ) https://docs.github.com/en/actions/how-tos/manage-workflow-runs/manually-run-a-workflow

I suppose that OpenAIRE will copy this worflow and run it auto in their repo. ( with hook commit ,push, tag) after deploy action to a live server ).
The requirement here is to provide an example on how such validation can be setup by implementers in their own repo and to test a live deployed server.

[vicding-mi]

the dispatcher is as easy as adding a single line to create. However, please take a look at these 2 tickets stoplightio/spectral-action#679 & stoplightio/spectral-action#680 . There is this bug which prevents spectral from failing yaml test. and throws a missing property error when triggered manually.

In short according to the spectral code, they require either push or pull request to work. See the line here.

I tried to mock a pull_request action, that did not work either. see the updated action with mock here, and error here.

[vicding-mi]

TODO: document the how to "run the GitHub action in your own repo" in the implementer's doc