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

Fix documentation in JSON schema #12

Open
2 tasks
AFoletti opened this issue Jan 17, 2025 · 2 comments
Open
2 tasks

Fix documentation in JSON schema #12

AFoletti opened this issue Jan 17, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@AFoletti
Copy link
Member

  • Every attribute has a "title" without spaces
  • Every attribute has a meaningful "description"
@AFoletti AFoletti mentioned this issue Jan 17, 2025
Closed
@Damian-Oswald
Copy link
Member

@AFoletti in the description, anchored content that points to external documentation is allowed. Also: Any array needs to have a title for the items themselves as well.

@Damian-Oswald Damian-Oswald changed the title Fix dosumentation in JSON schema Fix documentation in JSON schema Jan 28, 2025
@Damian-Oswald Damian-Oswald added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 28, 2025
@Damian-Oswald
Copy link
Member

@AFoletti

Every attribute has a meaningful "description"

Definition of meaningful: Needs to be meaningful to the user which is expected to have no idea whatsoever about DCAT. That would allow re-using descriptions in the forms directly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@AFoletti @Damian-Oswald