starred/pkl
1
0
Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-04-05 08:27:08 +02:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

Improve message passing api docs (#1127)

Browse Source 
1. Change `Binary` to `Bytes` (new type representing binary data)
2. Add documentation for `http.rewrites` option
This commit is contained in:
Daniel Chao
2025-07-17 07:57:48 -07:00
committed by GitHub
parent 99020bb79d
commit decb4ea66e
1 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/modules/bindings-specification/pages/message-passing-api.adoc
View File

@@ -199,12 +199,17 @@ class Http {
/// PEM format certificates to trust when making HTTP requests. /// PEM format certificates to trust when making HTTP requests.
/// ///
/// If [null], Pkl will trust its own built-in certificates. /// If [null], Pkl will trust its own built-in certificates.
caCertificates: Binary? caCertificates: Bytes? // <1>
/// Configuration of the HTTP proxy to use. /// Configuration of the HTTP proxy to use.
/// ///
/// If [null], uses the operating system's proxy configuration. /// If [null], uses the operating system's proxy configuration.
proxy: Proxy? proxy: Proxy?
/// HTTP rewrites, from source prefix to target prefix.
///
/// Each rewrite must start with `http://` or `https://`, and must end with `/`.
rewrites: Mapping<String, String>?
} }
/// Settings that control how Pkl talks to HTTP proxies. /// Settings that control how Pkl talks to HTTP proxies.
@@ -246,10 +251,8 @@ class Proxy {
/// ``` /// ```
noProxy: Listing<String>(isDistinct) noProxy: Listing<String>(isDistinct)
} }
typealias Binary = Any // <1>
---- ----
<1> link:{uri-messagepack-bin}[bin format] (not expressable in Pkl) <1> link:{uri-messagepack-bin}[bin format]
Example: Example:
[source,json5] [source,json5]
@@ -347,14 +350,12 @@ requestId: Int
evaluatorId: Int evaluatorId: Int
/// The evaluation contents, if successful. /// The evaluation contents, if successful.
result: Binary? // <1> result: Bytes? // <1>
/// A message detailing why evaluation failed. /// A message detailing why evaluation failed.
error: String? error: String?
typealias Binary = Any // <1>
---- ----
<1> xref:binary-encoding.adoc[Pkl Binary Encoding] in link:{uri-messagepack-bin}[bin format] (not expressable in Pkl) <1> xref:binary-encoding.adoc[Pkl Binary Encoding] in link:{uri-messagepack-bin}[bin format]
[[log]] [[log]]
=== Log === Log
@@ -425,14 +426,12 @@ requestId: Int
evaluatorId: Int evaluatorId: Int
/// The contents of the resource. /// The contents of the resource.
contents: Binary? // <1> contents: Bytes? // <1>
/// The description of the error that occurred when reading this resource. /// The description of the error that occurred when reading this resource.
error: String? error: String?
typealias Binary = Any // <1>
---- ----
<1> MessagePack's link:https://github.com/msgpack/msgpack/blob/master/spec.md#bin-format-family[bin format family] (not expressable in Pkl) <1> MessagePack's link:https://github.com/msgpack/msgpack/blob/master/spec.md#bin-format-family[bin format family]
[[read-module-request]] [[read-module-request]]
=== Read Module Request === Read Module Request