aas-specs icon indicating copy to clipboard operation
aas-specs copied to clipboard

Permalink to chapter JSON Mapping Rules in `schemas/json/README.md`

Open BirgitBoss opened this issue 2 years ago • 6 comments

https://github.com/admin-shell-io/aas-specs/tree/master/schemas/json#json-mapping-rules does not link to chapter JSON Mapping rule but is identical to https://github.com/admin-shell-io/aas-specs/tree/master/schemas/json

Used in Spec Part 1 for referencing to mapping rules

BirgitBoss avatar Nov 23 '22 14:11 BirgitBoss

I think the link you were looking for, to link the the chapter Mapping Rules in the JSON-Readme is this: https://github.com/admin-shell-io/aas-specs/blob/master/schemas/json/README.md#mapping-rules

s-heppner avatar Apr 05 '23 09:04 s-heppner

Considering, that the file behind the link will get upgraded with the new versions and you might want to actually permanentally link to the File released in https://github.com/admin-shell-io/aas-specs/releases/tag/v3.0.6, I'd suggest using this link: https://github.com/admin-shell-io/aas-specs/blob/37e4492a82c37040a395923ad4c74901835bb3c6/schemas/json/README.md#mapping-rules, since it will permanentally link to the state of the file at the time of the Release.

s-heppner avatar Apr 05 '23 09:04 s-heppner

Even better, because shorter: https://github.com/admin-shell-io/aas-specs/blob/v3.0.6/schemas/json/README.md#mapping-rules

s-heppner avatar Apr 06 '23 07:04 s-heppner

I'm actually not sure what needs to be done here. It seems like originally, there's a link somewhere that reads: https://github.com/admin-shell-io/aas-specs/tree/master/schemas/json#json-mapping-rules but does not link to the relevant section of the JSON Readme (as it was probably renamed at some point).

I've provided suggestions for links:

If you want to always link to the most up to date one, I'd use: https://github.com/admin-shell-io/aas-specs/tree/master/schemas/json#mapping-rules

If you want to reference the rules as they were at a specific release: https://github.com/admin-shell-io/aas-specs/blob/v3.0.6/schemas/json/README.md#mapping-rules (where v3.0.6 is the respective release tag)

Sadly, I do not know where that false link is located, so I'm unable to do anything else.

s-heppner avatar Sep 08 '24 07:09 s-heppner

It is an important part of the specification and thus must be part of the release.

The file to be changed is mentioned in the title

BirgitBoss avatar Sep 11 '24 19:09 BirgitBoss

Could you please provide a link to the location to be changed? I've searched in the file: https://github.com/admin-shell-io/aas-specs/blob/master/schemas/json/README.md

and I'm unable to find the link https://github.com/admin-shell-io/aas-specs/tree/master/schemas/json#json-mapping-rules there.

s-heppner avatar Sep 12 '24 06:09 s-heppner