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

Mismatch for required and optional fields compared to defintions from main website #502

Closed
troygNZ opened this issue Dec 23, 2024 · 3 comments

Comments

@troygNZ
Copy link
Contributor

troygNZ commented Dec 23, 2024

Firstly, a great effort in making this OSS and available.
Section 4.2.1 of https://www.icar.org/Guidelines/15-Procedure-4-Reproduction-Data.pdf specifies that heat detection method is mandatory for heat events. Looking at the JSON/OpenAPI specification for the heat events it does not make it required.

This means auto-generated clients on null-aware languages will not generate fully descriptive DTOs, and tools like SwaggerEditor don't document all finer details on what's required.

Secondarily: The list of enumerations also seems to have grown relative to the website. Should the website be updated, or reference this stuff directly?

image
image

@cookeac
Copy link
Collaborator

cookeac commented Dec 23, 2024

Thanks @troygNZ . Unfortunately the section 15 ADE guideline PDF files from the main ICAR web site are hopelessly out of date (they are 5-6 years old). The Animal Data Exchange working group has been asking ICAR to remove these for some time.

The correct location for the specifications is this GitHub repository, and the JSON Schema specifications are the definitive specification.

@troygNZ
Copy link
Contributor Author

troygNZ commented Dec 24, 2024

Thanks @cookeac, that clears that up

@cookeac
Copy link
Collaborator

cookeac commented Jan 14, 2025

Closing this in favour of #507

@cookeac cookeac closed this as completed Jan 14, 2025
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