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

Update code descriptions in referenceRelationType codelist #128

Open
odscjames opened this issue Oct 7, 2022 · 5 comments
Open

Update code descriptions in referenceRelationType codelist #128

odscjames opened this issue Oct 7, 2022 · 5 comments

Comments

@odscjames
Copy link
Collaborator

I was expecting it to be the same name.

Also generally links to "referenceRelationType codelist." are broken - they go to the correct page but not the correct heading.

(For discussion: that code list being open not closed might cause problems for automatic tools later, what if someone decides to add a "tag:opentelecomdata.net,2022:organisationsFile" option but the tool doesn't know to get it and look for orgs there?)

@duncandewhurst
Copy link
Collaborator

Yes, that is the intended name of both the field and the codelist. What were you expecting it to be the same as?

#129 fixes the broken link. Thanks for flagging!

I'll leave this issue open to discuss whether the codelist should be open or closed.

@duncandewhurst duncandewhurst added this to the Beta milestone Oct 17, 2022
@lgs85 lgs85 changed the title Is the name for "relatedResources/0/rel" meant to be "Reference relation type"? Should the referenceRelationType codelist be open or closed? Oct 17, 2022
@lgs85
Copy link
Contributor

lgs85 commented Oct 17, 2022

I've updated the title to reflect the issue we need to consider for Beta

@odscjames
Copy link
Collaborator Author

I was expecting "relatedResources/0/rel" to point to a codelist called "Related Resource codelist" - "Reference relation codelist" is just different enough that it caused me to stop and think "eh, is that difference important and meant to be telling me something?" Maybe if the link hadn't also been broken it wouldn't have caused me problems.

@duncandewhurst
Copy link
Collaborator

Ah, I see. I think that this will become clearer once relatedResources is renamed to links in #83. We can also reword the code descriptions so they read more like relation types than resource types. Most codes in https://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 start with "Refers to..."

@duncandewhurst duncandewhurst changed the title Should the referenceRelationType codelist be open or closed? Update code descriptions in referenceRelationType codelist Oct 19, 2022
@duncandewhurst
Copy link
Collaborator

I've split out the open/closed question into a separate issue.

@duncandewhurst duncandewhurst removed this from the 0.3.0 milestone Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants