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

contactPoint definition is the same as email definition #71

Open
richclarke-ho opened this issue Nov 22, 2023 · 5 comments
Open

contactPoint definition is the same as email definition #71

richclarke-ho opened this issue Nov 22, 2023 · 5 comments

Comments

@richclarke-ho
Copy link
Contributor

Describe the bug
The definition for Property: contactPoint is the same as the definition for Property: email, but email is a child property of Class: ContactPoint
https://co-cddo.github.io/ukgov-metadata-exchange-model/contactPoint/

Note capitalisation contactPoint vs ContactPoint

To Reproduce
Steps to reproduce the behaviour:

  1. view https://co-cddo.github.io/ukgov-metadata-exchange-model/contactPoint/
  2. definition is "The e-mail address to be used to contact the organisational contact for the resource as listed in the Contact Name."
  3. in 'Obligation and Cardinality' click ContactPoint in the table
  4. Land on https://co-cddo.github.io/ukgov-metadata-exchange-model/ContactPoint/
  5. in Properties > Mandatory Properties, click email
  6. land on https://co-cddo.github.io/ukgov-metadata-exchange-model/email/
  7. definition is The e-mail address to be used to contact the organisational contact for the resource as listed in the contact name.

Expected behaviour
email is a property of contactPoint, not the whole thing.
contactPoint definition should describe a person with 4 properties (contactName, email, address, telephone)

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
It's a bit confusing to have contactPoint (lowerCamelCase) as well as ContactPoint (UpperCamelCase).

https://co-cddo.github.io/ukgov-metadata-exchange-model/contactPoint/ - Property
https://co-cddo.github.io/ukgov-metadata-exchange-model/ContactPoint/ - Class

@richclarke-ho
Copy link
Contributor Author

The definition on https://co-cddo.github.io/ukgov-metadata-exchange-model/contactName/ is

The organisational contact to obtain further information or provide feedback about an information resource.

Seems like this should be the definition for contactPoint
Then contactName definition could be 'The name of the organisational contact for the resource.'

@richclarke-ho
Copy link
Contributor Author

@AlasdairGray could you take a look at this one please...

@AlasdairGray
Copy link
Contributor

Agree that the definition text for contactPoint is incorrect. It should be something about connecting to the contact information for the identified point of contact.

@richclarke-ho
Copy link
Contributor Author

thanks for confirming @AlasdairGray . What is the process for updating the wording. Shall I attempt a pull request?

@AlasdairGray
Copy link
Contributor

You would need to edit line 230 in src/model/uk_cross_government_metadata_exchange_model.yaml and create a pull request. Once all the tests have passed, @cyberdudeuk or @RobNicholsGDS would be able to approve the pull request.

richclarke-ho added a commit to richclarke-ho/ukgov-metadata-exchange-model that referenced this issue Jul 9, 2024
cyberdudeuk added a commit that referenced this issue Jul 18, 2024
Changes to contactPoint definition for Issue #71
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants