Skip to content
This repository has been archived by the owner on Oct 28, 2024. It is now read-only.

Promote "Metadata in Table Schema" recipe to the specs. #63

Closed
wants to merge 1,120 commits into from

Conversation

pierrecamilleri
Copy link

@pierrecamilleri pierrecamilleri commented Apr 25, 2024

Context and related issue :
fix #899

Details 

I tried to be as clear as possible in the constraints associated to the different metadata.

I chose to make a specific section for these properties, as they specifically refer to the schema and not to the data the schema describes, contrary to the other top schema properties. One may argue that the "$schema" property can also be seen as metadata, and could be moved into this section. What do you think ?

I see two points worth mentioning, as they differ from what was in the recipe :

  • The proposal adds more constraints on the version field and impose semantic versioning (with or without "v" prefix)
  • The proposal is more restrictive in the name property, and disallows the underscore "_" character. This is aiming at a more URL-friendly name. The current implementation of frictionless allows this character, but as the property was to my knowledge not in the specs, I don't think this can be considered a breaking change.

I'm happy to listen to any requests for modifications.

roll and others added 30 commits November 1, 2019 18:15
Add uniqueNulls property to unique constraints pattern - refs #593.
allow FK references to different data packages (fix #653)
Remove pattern constraint from number/integer/yearmonth schemes
[yml][s]: CI build and deploy specs #412.
… JSON schema definition for `dialect` to allow object and string not just object.

Data Resource JSON schema definition for `dialect` seems to contradict specification
…pears at the start - refs #254.

Merge pull request #662 from chrispomeroyhale/registery/commentChar.
Merge pull request #668 from AntoineAugusti/patch-1
Also move specs folders up from specs to base directory and standardize frontmatter.
@peterdesmet
Copy link
Member

peterdesmet commented Jun 26, 2024

Hmm, git is all out of wack it seems. The repository has moved and the access rights have changed. Let's wait until the v2 dust has settled. Still to do on this PR:

  • Move table schema to /standards/table-schema.md (cf. main)
  • Move changelog to /overview/changelog.md (cf. main)
  • Update wording so it aligns with Data Package (my pending PR)
  • Update some links
  • Fix invalid json example
  • Clarify if examples are borrowing title and path from Data Resource (I think they are, included in my PR) or if this is something completely separate.

@peterdesmet
Copy link
Member

Thanks for your patience @pierrecamilleri 😄

roll and others added 4 commits June 26, 2024 16:11
* Added the announcement

* Update content/docs/index.mdx

Co-authored-by: Peter Desmet <[email protected]>

* Update content/docs/index.mdx

Co-authored-by: Peter Desmet <[email protected]>

* Added a release blog post

* Fixed linting

---------

Co-authored-by: Peter Desmet <[email protected]>
* Added seo descriptions

* Added back-to-top

* Removed react

* Removed unused comments
@roll
Copy link
Member

roll commented Jun 27, 2024

@@pierrecamilleri
Thanks!
Unfortunately, we must migrate this to the merged spec/datapackage site - https://github.com/frictionlessdata/datapackage. I can assist but it will be great to keep author credits

@pierrecamilleri
Copy link
Author

I rebased this PR on the datapackage repo (see link right above). Only conflict I had was the moved changelog, hope nothing else has broken.

I also moved the checklist in the pull request description.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Promote "Metadata in Table Schema" recipe to the specs