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

Fmd 348 metadata spec #356

Merged
merged 1 commit into from
May 23, 2024
Merged

Fmd 348 metadata spec #356

merged 1 commit into from
May 23, 2024

Conversation

murdo-moj
Copy link
Contributor

@murdo-moj murdo-moj commented May 21, 2024

  • Added a page to display the metadata spec formed from the pydantic classes
  • The page is dynamically created, but could be statically compiled as it won't change within a version.
  • Missing at the moment is an indication as to which fields are filled in by the service user. There is not a concept of this in Pydantic. This can be left out of this page for now.
  • The dataset registration page would make it clear which fields the user supplies.
  • Loads of examples for Pydantic classes have been added. As Entity subclasses have different URNs I have overloaded the urn attribute on subclasses eg the Chart class to display a chart urn example.
  • Something to consider: should fields with types that are classes eg Entity.Domain have examples or should the example be a link to the Domain class?
  • Fixed a bug in get_table_details where urn isn't passed to Table()
  • How can text wrapping on examples work better?

@murdo-moj
Copy link
Contributor Author

#348

@murdo-moj murdo-moj marked this pull request as ready for review May 21, 2024 10:55
@murdo-moj
Copy link
Contributor Author

image

@MatMoore
Copy link
Contributor

Regarding the text wrapping, I think you can solve it with some css changes:

  1. add a max-width to the column so it doesn't expand indefinitely
  2. apply overflow:auto to the table so it is allowed to scroll horizontally

(Let me know if you want a hand with this)

MatMoore
MatMoore previously approved these changes May 23, 2024
MatMoore
MatMoore previously approved these changes May 23, 2024
@murdo-moj murdo-moj merged commit bcbc85a into main May 23, 2024
3 of 4 checks passed
@murdo-moj murdo-moj deleted the fmd-348-metadata-spec branch May 23, 2024 15:58
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

Successfully merging this pull request may close these issues.

2 participants