search

co-cddo / ukgov-metadata-exchange-model

A metadata model for describing data assets for exchanging between UK government organisations.
https://co-cddo.github.io/ukgov-metadata-exchange-model/
Other
13 stars 1 forks source link

contactPoint definition is the same as email definition #71

Open richclarke-ho opened 10 months ago

richclarke-ho commented 10 months ago

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 commented 10 months ago

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 commented 3 months ago

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

AlasdairGray commented 3 months ago

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 commented 3 months ago

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

AlasdairGray commented 3 months ago

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.