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.

Sign up for GitHub

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

Jump to bottom

Additional fields: Report examples and child fields (add quotes to string values, copy-edits) #20

Open
duncandewhurst opened this issue Nov 3, 2022 · 7 comments
Open

Additional fields: Report examples and child fields (add quotes to string values, copy-edits) #20

duncandewhurst opened this issue Nov 3, 2022 · 7 comments
Labels
interface quick Issues that shouldn't take long to resolve

Comments

@duncandewhurst
Copy link
Contributor

The OCDS DRT reports examples for each additional field and has a modal pop-up to show children of additional fields. Please can we add these features to OFDS CoVE?

Example
image
@duncandewhurst
Copy link
Contributor Author

duncandewhurst commented Nov 3, 2022 •
edited
Loading

Related to Open-Telecoms-Data/lib-cove-ofds#4

Also:

  • Use the following text for the introductory paragraph:

Your data contains additional fields that are not part of the OFDS schema. You should:

  • Check that additional fields are not the result of typos in field names or other errors in your mapping or data pipeline.
  • Check whether the data in these fields could be provided by using a field in the OFDS schema
  • Document the structure, format and meaning of additional fields in your data user guide.
  • Colour the additional fields box yellow, not red.
  • Replace 'Usage Count' with 'Occurences'

@duncandewhurst duncandewhurst mentioned this issue Nov 3, 2022
Open
@duncandewhurst
Copy link
Contributor Author

The first two checklist items are done in 536a951

@duncandewhurst duncandewhurst mentioned this issue Nov 8, 2022
Closed
odscjames added a commit that referenced this issue Nov 17, 2022
@odscjames
libcoveweb2: Change label in template
ae72139 
#20
odscjames added a commit that referenced this issue Nov 18, 2022
@odscjames
libcoveweb2: Change label in template
4e71f02 
#20
odscjames added a commit to Open-Telecoms-Data/lib-cove-ofds that referenced this issue Nov 22, 2022
@odscjames
additionalfields: return more information, in different structure
1ed6521 
Open-Telecoms-Data/cove-ofds#20
@odscjames
Copy link
Collaborator

Last commit adds more info - when available, need to update template in cove in line with https://github.com/OpenDataServices/lib-cove-web/blob/bd849fcd6845b746a80b37d57675e468cdeefefc/cove/templates/additional_fields_table_all.html#L41

odscjames added a commit that referenced this issue Nov 29, 2022
@odscjames
libcoveweb2: additional_fields: Add more info to table & popup for ch…
8ac7b02 
…ild fields

#20
@odscjames
Copy link
Collaborator

Ready for testing on live

@duncandewhurst
Copy link
Contributor Author

duncandewhurst commented Dec 1, 2022 •
edited
Loading

Looks good, thanks!

Just a couple of minor things:

  • Additional fields table: 'Occurences' -> 'Occurrences'
  • Child fields table: 'Usage Count' -> 'Occurrences'
  • Add quotes around string values (examples). Otherwise, it looks like there is no example when in fact the field's value is an empty string:

Image

Edit: I've renamed the issue to reflect the outstanding tasks.

@duncandewhurst duncandewhurst changed the title Additional fields: Report examples and child fields Additional fields: Report examples and child fields (add quotes to string values, copy-edits) Dec 7, 2022
@duncandewhurst duncandewhurst added the quick Issues that shouldn't take long to resolve label Dec 7, 2022
odscjames added a commit that referenced this issue Dec 15, 2022
@odscjames
libcoveweb2: additional_fields: Change label in template
3724818 
#20
odscjames added a commit that referenced this issue Dec 15, 2022
@odscjames
libcoveweb2: additional_fields: additional_checks: jsonschema_validat…
6b079fc 
…ion: Print JSON values nicer

* quote strings
* print lists as lists, with longer ones collapsed by default

#20
#13
#22
@odscjames odscjames mentioned this issue Dec 15, 2022
Merged
odscjames added a commit that referenced this issue Dec 16, 2022
@odscjames
libcoveweb2: additional_fields: Change label in template
d4011be 
#20
@odscjames
Copy link
Collaborator

Additional fields table: 'Occurences' -> 'Occurrences'
Child fields table: 'Usage Count' -> 'Occurrences'

Ready for testing on live.

odscjames added a commit that referenced this issue Dec 20, 2022
@odscjames
libcoveweb2: additional_fields: additional_checks: jsonschema_validat…
ba98bb3 
…ion: Print JSON values nicer

* quote strings
* print lists as lists, with longer ones collapsed by default

#20
#13
#22
@duncandewhurst
Copy link
Contributor Author

Looks good. Thanks!

odscjames added a commit that referenced this issue Dec 21, 2022
@odscjames
libcoveweb2: additional_fields: additional_checks: jsonschema_validat…
a1af12c 
…ion: Print JSON values nicer

* quote strings

#20
#13
odscjames added a commit that referenced this issue Jan 3, 2023
@odscjames
libcoveweb2: additional_fields: additional_checks: jsonschema_validat…
1b37e22 
…ion: Print JSON values nicer

* quote strings

#20
#13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
interface quick Issues that shouldn't take long to resolve
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@duncandewhurst @odscjames