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

chore(blog): the reference rabbit hole #461

Merged
merged 32 commits into from
Nov 30, 2021
Merged
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
f0b7287
Added new post
jonaslagoni Nov 15, 2021
db6c6e0
Added missing #
jonaslagoni Nov 15, 2021
1100233
Updated cover image and text
jonaslagoni Nov 15, 2021
32a5c86
changes
jonaslagoni Nov 15, 2021
afc1d6d
Small edits
jonaslagoni Nov 15, 2021
6133ee5
Small edits
jonaslagoni Nov 15, 2021
dca4012
Apply suggestions from code review
jonaslagoni Nov 16, 2021
625b6a9
Update pages/blog/the-reference-rabbit-hole.md
jonaslagoni Nov 16, 2021
22b9d19
Merge branch 'master' into feature/reference_rabbithole
jonaslagoni Nov 17, 2021
7da1254
Merge branch 'master' into feature/reference_rabbithole
jonaslagoni Nov 18, 2021
74579c2
Changed setup
jonaslagoni Nov 18, 2021
62b2b84
Changed a few things
jonaslagoni Nov 18, 2021
46e2520
Few changes
jonaslagoni Nov 18, 2021
0b643e3
small changed
jonaslagoni Nov 18, 2021
47f71eb
few changed
jonaslagoni Nov 18, 2021
e0675fd
Few changes
jonaslagoni Nov 18, 2021
003ddd0
Merge branch 'master' into feature/reference_rabbithole
jonaslagoni Nov 18, 2021
a06a5f1
Apply suggestions from code review
jonaslagoni Nov 19, 2021
2f61635
Fixed example and clarification of schemaFormat
jonaslagoni Nov 19, 2021
192c81f
Changed example
jonaslagoni Nov 19, 2021
a4f6100
Small change
jonaslagoni Nov 19, 2021
2ad2275
Mention discussion
jonaslagoni Nov 19, 2021
25c89fd
Update pages/blog/the-reference-rabbit-hole.md
jonaslagoni Nov 19, 2021
eea07af
Merge branch 'master' into feature/reference_rabbithole
Nov 19, 2021
96b8610
Merge branch 'master' into feature/reference_rabbithole
Nov 24, 2021
86601ef
Merge branch 'master' into feature/reference_rabbithole
Nov 26, 2021
8e8f098
Apply suggestions from code review
jonaslagoni Nov 29, 2021
8863a5b
Update pages/blog/the-reference-rabbit-hole.md
jonaslagoni Nov 29, 2021
2eab8fd
Merge branch 'master' into feature/reference_rabbithole
Nov 29, 2021
a77862a
set date
derberg Nov 30, 2021
5e3a894
Merge branch 'master' into feature/reference_rabbithole
jonaslagoni Nov 30, 2021
8afcb41
Fixed link
jonaslagoni Nov 30, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
few changed
jonaslagoni committed Nov 18, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 47f71eba0bd9706b54c5dee62de2eae2a6a849f7
5 changes: 3 additions & 2 deletions pages/blog/the-reference-rabbit-hole.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "The Reference Rabbit Hole"
date: 2021-11-15T12:00:00+01:00
date: 2021-11-18T12:00:00+01:00
featured: true
type: Engineering
tags:
- Specification
@@ -247,7 +248,7 @@ This leaves us with one huge deficit, that there are so many different behaviors

One of the most used tooling for dereferencing stuff in JS, and the one we are using is from [APIDevTools called json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser). We actually use this tool to ensure **ANY** encounters of `$ref` are dereferenced, so the tool has direct access to the schema, without it having to look elsewhere for it.

However, the tool starting out building build **ONLY** for dereferencing `$ref` based on the [JSON Reference specification and the JSON Pointer specification](https://github.com/APIDevTools/json-schema-ref-parser/issues/22#issuecomment-231783185). At least it was, now it's not easy to figure it out what it is for, as [it allows extra properties](https://github.com/APIDevTools/json-schema-ref-parser/issues/232) and [$id is not taken into account](https://github.com/APIDevTools/json-schema-ref-parser/issues/136).
However, the tool starting out being build **ONLY** for dereferencing `$ref` based on the [JSON Reference specification and the JSON Pointer specification](https://github.com/APIDevTools/json-schema-ref-parser/issues/22#issuecomment-231783185). At least it was, now it's not easy to figure it out what it is for, as [it allows extra properties](https://github.com/APIDevTools/json-schema-ref-parser/issues/232) and [$id is not taken into account](https://github.com/APIDevTools/json-schema-ref-parser/issues/136).

This leaves us in a big of a struggle, as [there are not many alternatives](https://json-schema.org/implementations.html#general-processing), for JS [@hyperjump/json-schema-core](https://github.com/jdesrosiers/json-schema-core) looks promising, but there are no tooling that our [Go parser](https://github.com/asyncapi/parser-go) can use.