Skip to content

Fix URL fragment in references documentation#221

Open
FriedrichBu wants to merge 1 commit intobitol-io:mainfrom
FriedrichBu:patch-2
Open

Fix URL fragment in references documentation#221
FriedrichBu wants to merge 1 commit intobitol-io:mainfrom
FriedrichBu:patch-2

Conversation

@FriedrichBu
Copy link
Copy Markdown

Missing / in reference 'to'

Missing `/` in reference 'to'
@FriedrichBu FriedrichBu requested a review from a team as a code owner December 17, 2025 12:00
@pflooky
Copy link
Copy Markdown
Contributor

pflooky commented Dec 18, 2025

Thanks for raising this as well @FriedrichBu . Is this correct @dccakes ? I tried to check against the documentation but couldn't 100% verify: https://bitol-io.github.io/open-data-contract-standard/latest/references/
I also tried checking via the pattern defined in our JSON schema and couldn't get an answer either.

@dccakes
Copy link
Copy Markdown
Contributor

dccakes commented Dec 18, 2025

Great question @FriedrichBu -> this is a nuance. The example is using dot notation - which implies that we are using shorthand notation. The shorthand notation follows a <table.column> notation. Since we are using the shorthand notation and not the fully qualified reference - we dont need the '/' in front of it. Just having the anchor # lets us know we are entering the schema/ referencing an item within the contract.

shorthand: https://example.com/data-contract-v1.yaml#profiles_tbl.user_id
full_reference https://example.com/data-contract-v1.yaml#/schema/profiles_tbl/properties/user_id

@FriedrichBu
Copy link
Copy Markdown
Author

Thanks for your responses, @pflooky & @dccakes!
Especially for your example @dccakes ; now the nuance makes sense.

@iliev01 iliev01 reopened this Mar 1, 2026
@jgperrin
Copy link
Copy Markdown
Contributor

Can we merge or close this one?

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.

5 participants