ids-specification icon indicating copy to clipboard operation
ids-specification copied to clipboard

Hotfix: Schema, Example, and Context Fixes

Open sebbader-sap opened this issue 9 months ago • 4 comments

sebbader-sap avatar May 02 '24 12:05 sebbader-sap

@mkollenstart I need help to push the files into the releases folder. We have an Action for it, don't we?

sebbader-sap avatar May 17 '24 04:05 sebbader-sap

No there isn't an action to create the release folder structure, since it also should be pushed in the repository.

So to create the release folder you need to execute the following commands and then push again:

rsync -Rav --prune-empty-dirs --exclude="releases/**" --include="*/" --include="**/*.json" --exclude="**" ./ ./releases/2024-1/
rsync -Rav --prune-empty-dirs --exclude="releases/**" --include="*/" --include="**/*.ttl" --exclude="**" ./ ./releases/2024-1/

But since this will overwrite the existing release folder, you have to remove the existing 2024-1 folder in releases before executing the rsync commands.

An other issue that will come up is the "Prevent Changes to Release Files" check that is executed, since this one will fail if files are modified in the releases folder. I'm not sure how we tackled that in the previous hotfix.

mkollenstart avatar May 17 '24 08:05 mkollenstart

So to create the release folder you need to execute the following commands and then push again:

Just did so

sebbader-sap avatar May 21 '24 12:05 sebbader-sap

An other issue that will come up is the "Prevent Changes to Release Files" check that is executed, since this one will fail if files are modified in the releases folder. I'm not sure how we tackled that in the previous hotfix.

I just opened #266 . Let's see if that "opens the door".

sebbader-sap avatar May 21 '24 12:05 sebbader-sap

Nice work. Still some small remarks, catalog and dataset have same ids (catalog.json and dataset.json, in example folder), and in catalog.json, dataset.id = policy.id Could we use, for some future documentation, ids like urn:uuid:catalog_id_uuid, urn:uuid:dataset_id_uuid, and such? Hoping this will not confuse readers to replace catalog_id_uuid with generated UUID. This way, we could use symbolic values for ids and reference them where needed.

2.1 Contract Request Message

Sent by Consumer
Resulting state REQUESTED, TERMINATED
Response ACK or ERROR
Schema TTL Shape, JSON Schema
Example Initiating Message, Message <---- THIS ONE here, offer
Message still points to contract offer message.

I will double check once again official version of documentation.

IgorBalog-Eng avatar Jun 20 '24 09:06 IgorBalog-Eng