{{- $data := index hugo.Data "api-reference" -}} {{- if not $data }} {{ errorf "API reference data missing: regenerate data/api-reference.json with ./hack/api-docs/run.sh generate" }} {{ end -}} {{- if ne (int $data.modelVersion) 1 }} {{ errorf "Unsupported API presentation model version" }} {{ end -}} {{- .AddPage (dict "path" "." "kind" "section" "title" "Docker APIs" "linkTitle" "API reference" "description" "Explore Docker HTTP APIs, connection requirements, and versioned references." "layout" "api-docs" "params" (dict "view" "catalog" "keywords" (slice "API" "HTTP" "OpenAPI"))) -}} {{- range $api := $data.apis -}} {{- $path := strings.TrimPrefix "/reference/api/" $api.url | strings.TrimSuffix "/" -}} {{- $aliases := slice -}} {{- if eq $api.id "dvp" }} {{ $aliases = slice "/reference/api/hub/dvp/" }} {{ end -}} {{- if eq $api.id "ai-governance" }} {{ $aliases = slice "/reference/api/ai-governance/" "/ai/sandboxes/governance/api/" }} {{ end -}} {{- if eq $api.id "sandboxes" }} {{ $aliases = slice "/reference/api/sandboxes/" }} {{ end -}} {{- $.AddPage (dict "linkTitle" "Latest" "path" $path "url" $api.url "aliases" $aliases "kind" "section" "title" (printf "%s API %v" $api.title $api.version) "description" (printf "%s HTTP API reference, version %v." $api.title $api.version) "layout" "api-docs" "weight" 1 "params" (dict "view" "overview" "apiID" $api.id "keywords" (slice "API" $api.product))) -}} {{- range $op := $api.operations -}} {{- $.AddPage (dict "path" (printf "%s/operations/%s" $path (crypto.SHA256 $op.id)) "url" $op.url "title" $op.summary "description" (printf "%s %s — %s API %v." $op.method $op.path $api.title $api.version) "layout" "api-docs" "params" (dict "view" "operation" "apiID" $api.id "operationID" $op.id "keywords" (slice $op.method $op.path $op.id))) -}} {{- end -}} {{- range $schema := $api.schemas -}} {{- $.AddPage (dict "path" (printf "%s/schemas/%s" $path (crypto.SHA256 $schema.name)) "url" $schema.url "title" $schema.name "description" (printf "%s schema in %s API %v." $schema.name $api.title $api.version) "layout" "api-docs" "params" (dict "view" "schema" "apiID" $api.id "schemaName" $schema.name "keywords" (slice "schema" $schema.name))) -}} {{- end -}} {{- end -}}