diff --git a/layouts/partials/events/example.html b/layouts/partials/events/example.html
index 181de88f5..90752fbd9 100644
--- a/layouts/partials/events/example.html
+++ b/layouts/partials/events/example.html
@@ -1,13 +1,18 @@
{{/*
- Renders an event example. Resolves `$ref`s, serializes as JSON, and ensures
+ Renders an event example. Resolves `$ref`s, serializes as JSON, and ensures
that it can be included in HTML.
- This partial is called with the example event object as its context.
+ Parameters:
+
+ * `schema`: the schema of the example
+ * `name`: the name of the example
*/}}
-{{ $example_content := partial "json-schema/resolve-refs" (dict "schema" . "path" "event-schemas/examples") }}
+{{ $path := delimit (slice "event-schemas/examples" .name) "/" }}
+
+{{ $example_content := partial "json-schema/resolve-refs" (dict "schema" .schema "path" $path) }}
{{ $example_json := jsonify (dict "indent" " ") $example_content }}
{{ $example_json = replace $example_json "\\u003c" "<" }}
{{ $example_json = replace $example_json "\\u003e" ">" | safeHTML }}
diff --git a/layouts/partials/events/render-event.html b/layouts/partials/events/render-event.html
index 70752721c..71ba60bd0 100644
--- a/layouts/partials/events/render-event.html
+++ b/layouts/partials/events/render-event.html
@@ -77,7 +77,7 @@ Examples
*/}}
{{ if $desired_example_name }}
{{ if eq $example_name $desired_example_name }}
- {{ partial "events/example" $example }}
+ {{ partial "events/example" (dict "schema" $example "name" $example_name) }}
{{ end }}
{{/*
If `$desired_example_name` is not given, we will include any
@@ -86,7 +86,7 @@ Examples
the event name includes a "$".
*/}}
{{ else if eq $event_name $example_name }}
- {{ partial "events/example" $example }}
+ {{ partial "events/example" (dict "schema" $example "name" $example_name) }}
{{/*
If `$desired_example_name` is not given, we will include any
examples whose first part (before "$") matches the event name
@@ -96,7 +96,7 @@ Examples
{{ $pieces := split $example_name "$" }}
{{ $example_base_name := index $pieces 0 }}
{{ if eq $event_name $example_base_name }}
- {{ partial "events/example" $example }}
+ {{ partial "events/example" (dict "schema" $example "name" $example_name) }}
{{ end }}
{{ end }}
{{ end }}
diff --git a/layouts/partials/json-schema/resolve-refs.html b/layouts/partials/json-schema/resolve-refs.html
index 1d99201db..9a36e4136 100644
--- a/layouts/partials/json-schema/resolve-refs.html
+++ b/layouts/partials/json-schema/resolve-refs.html
@@ -1,7 +1,10 @@
{{/*
Resolves the `$ref` JSON schema keyword, by recursively replacing
- it with the object it points to.
+ it with the object it points to, given:
+
+ * `schema`: the schema where the references should be resolved
+ * `path`: the path of the file containing the schema
This template uses [`Scratch`](https://gohugo.io/functions/scratch/)
rather than a normal `dict` because with `dict` you can't replace key values:
@@ -20,8 +23,12 @@
{{ $scratch.Set "result_map" dict }}
{{ $ref_value := index $schema "$ref"}}
- {{ if $ref_value}}
- {{ $full_path := path.Join $path $ref_value }}
+ {{ if $ref_value }}
+ {{ $uri := urls.Parse $path }}
+ {{ $ref_uri := urls.Parse $ref_value }}
+ {{ $full_uri := $uri.ResolveReference $ref_uri }}
+
+ {{ $full_path := strings.TrimPrefix "/" $full_uri.Path }}
{{/*
Apparently Hugo doesn't give us a nice way to split the extension off a filename.
*/}}
@@ -30,11 +37,18 @@
{{ $ref := index site.Data $pieces }}
+ {{/* If there is a fragment, follow the JSON Pointer */}}
+ {{ if $full_uri.Fragment }}
+ {{ $fragment := strings.TrimPrefix "/" $full_uri.Fragment }}
+ {{ $pieces := split $fragment "/" }}
+ {{ $ref = index $ref $pieces }}
+ {{ end }}
+
{{ $new_path := (path.Split $full_path).Dir}}
{{ $result_map := partial "json-schema/resolve-refs" (dict "schema" $ref "path" $new_path)}}
{{ if $result_map}}
{{ $scratch.Set "result_map" $result_map }}
- {{end }}
+ {{ end }}
{{ end }}
diff --git a/layouts/partials/openapi/render-parameters.html b/layouts/partials/openapi/render-parameters.html
index 925b01979..ecabfc05a 100644
--- a/layouts/partials/openapi/render-parameters.html
+++ b/layouts/partials/openapi/render-parameters.html
@@ -5,6 +5,7 @@
* `parameters`: OpenAPI data specifying the parameters
* `type`: the type of parameters to render: "header, ""path", "query"
* `caption`: caption to use for the table
+ * `path`: the path where this definition was found, to enable us to resolve "$ref"
This template renders a single table containing parameters of the given type.
@@ -13,7 +14,9 @@
{{ $parameters := .parameters }}
{{ $type := .type }}
{{ $caption := .caption }}
+{{ $path := .path }}
+{{ $parameters = partial "json-schema/resolve-refs" (dict "schema" $parameters "path" $path) }}
{{ $parameters_of_type := where $parameters "in" $type }}
{{ with $parameters_of_type }}
@@ -32,5 +35,4 @@
{{/* and render the parameters */}}
{{ partial "openapi/render-object-table" (dict "title" $caption "properties" $param_dict) }}
-
{{ end }}
diff --git a/layouts/partials/openapi/render-request.html b/layouts/partials/openapi/render-request.html
index 3d4b0381b..5ef55c64e 100644
--- a/layouts/partials/openapi/render-request.html
+++ b/layouts/partials/openapi/render-request.html
@@ -26,9 +26,9 @@ Request
{{ if $parameters }}
Request parameters
- {{ partial "openapi/render-parameters" (dict "parameters" $parameters "type" "header" "caption" "header parameters") }}
- {{ partial "openapi/render-parameters" (dict "parameters" $parameters "type" "path" "caption" "path parameters") }}
- {{ partial "openapi/render-parameters" (dict "parameters" $parameters "type" "query" "caption" "query parameters") }}
+ {{ partial "openapi/render-parameters" (dict "parameters" $parameters "type" "header" "caption" "header parameters" "path" .path) }}
+ {{ partial "openapi/render-parameters" (dict "parameters" $parameters "type" "path" "caption" "path parameters" "path" .path) }}
+ {{ partial "openapi/render-parameters" (dict "parameters" $parameters "type" "query" "caption" "query parameters" "path" .path) }}
{{ end }}
diff --git a/layouts/partials/openapi/render-responses.html b/layouts/partials/openapi/render-responses.html
index 99662ad0f..82c2f9547 100644
--- a/layouts/partials/openapi/render-responses.html
+++ b/layouts/partials/openapi/render-responses.html
@@ -26,6 +26,8 @@ Responses
Description |
+{{ $responses = partial "json-schema/resolve-refs" (dict "schema" $responses "path" $path) }}
+
{{ range $code, $response := $responses }}
@@ -49,8 +51,7 @@ {{$code}} response
Display the JSON schemas
*/}}
- {{ $schema := partial "json-schema/resolve-refs" (dict "schema" $json_body.schema "path" $path) }}
- {{ $schema := partial "json-schema/resolve-allof" $schema }}
+ {{ $schema := partial "json-schema/resolve-allof" $json_body.schema }}
{{/*
All this is to work out how to express the content of the response
diff --git a/layouts/shortcodes/definition.html b/layouts/shortcodes/definition.html
index 0699ff7b2..23461878c 100644
--- a/layouts/shortcodes/definition.html
+++ b/layouts/shortcodes/definition.html
@@ -22,10 +22,6 @@
{{ errorf "site data %s not found" $path }}
{{ end }}
-{{/* The base path, which we use to resolve $ref, omits the last component */}}
-{{ $pieces = first (sub (len $pieces) 1) $pieces}}
-{{ $path = delimit $pieces "/" }}
-
{{/* Resolve $ref and allOf */}}
{{ $definition = partial "json-schema/resolve-refs" (dict "schema" $definition "path" $path) }}
{{ $definition = partial "json-schema/resolve-allof" $definition }}
diff --git a/layouts/shortcodes/event.html b/layouts/shortcodes/event.html
index a9838542f..c671318a5 100644
--- a/layouts/shortcodes/event.html
+++ b/layouts/shortcodes/event.html
@@ -25,7 +25,7 @@
*/}}
{{ $event_data := index .Site.Data "event-schemas" "schema" .Params.event }}
-{{ $path := "event-schemas/schema" }}
+{{ $path := delimit (slice "event-schemas/schema" .Params.event) "/" }}
{{ $event_data = partial "json-schema/resolve-refs" (dict "schema" $event_data "path" $path) }}
{{ $event_data := partial "json-schema/resolve-allof" $event_data }}
diff --git a/layouts/shortcodes/http-api.html b/layouts/shortcodes/http-api.html
index a3b706db6..43d08b9e5 100644
--- a/layouts/shortcodes/http-api.html
+++ b/layouts/shortcodes/http-api.html
@@ -21,6 +21,6 @@
{{ $api_data := index .Site.Data.api .Params.spec .Params.api }}
{{ $base_url := (index $api_data.servers 0).variables.basePath.default }}
-{{ $path := delimit (slice "api" $spec) "/" }}
+{{ $path := delimit (slice "api" $spec $api) "/" }}
{{ partial "openapi/render-api" (dict "api_data" $api_data "base_url" $base_url "path" $path) }}
diff --git a/layouts/shortcodes/msgtypes.html b/layouts/shortcodes/msgtypes.html
index ba7311115..1ab28aae9 100644
--- a/layouts/shortcodes/msgtypes.html
+++ b/layouts/shortcodes/msgtypes.html
@@ -6,7 +6,6 @@
*/}}
-{{ $path := "event-schemas/schema" }}
{{ $compact := false }}
{{/*
@@ -40,6 +39,7 @@
{{ range $msgtypes }}
{{ $event_data := index $site_data "event-schemas" "schema" . }}
+ {{ $path := delimit (slice "event-schemas/schema" .) "/" }}
{{ $event_data = partial "json-schema/resolve-refs" (dict "schema" $event_data "path" $path) }}
{{ $event_data := partial "json-schema/resolve-allof" $event_data }}