@compforge/harness-common 0.5.13 → 0.5.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -1
- package/dist/access/endpoint.d.ts +7 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -217,7 +217,12 @@ usage protection and reclamation belong to consumers. See [the shared contract](
|
|
|
217
217
|
`Endpoint` describes a network access address: optional lowercase `scheme`, `host`, explicit
|
|
218
218
|
`port`, and optional `secure`. It is independent of the Service, DataSource or resource behind
|
|
219
219
|
that address. IPv6 hosts are unbracketed. Credentials, paths, query parameters, execution
|
|
220
|
-
|
|
220
|
+
adapters and timeouts are not part of this contract.
|
|
221
|
+
|
|
222
|
+
Optional `id` and `description` identify and describe the dependency within its consumer.
|
|
223
|
+
Optional `workload` names the consumer Workload from which the address is accessed, not the
|
|
224
|
+
remote Service. Consumers resolve and validate that reference; a declaration does not discover
|
|
225
|
+
instances or grant access. Protocol probing can consume the address fields alone.
|
|
221
226
|
|
|
222
227
|
`secure: true` requires encrypted transport; the protocol determines whether it uses direct
|
|
223
228
|
TLS or protocol-specific negotiation. Omission makes no encryption requirement. HTTPS/WSS/TLS
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* A network access address, independent of the Service, DataSource or resource behind it.
|
|
3
|
-
* @spec Endpoint contains no credentials, resource path, query or execution
|
|
3
|
+
* @spec Endpoint contains no credentials, resource path, query or execution adapter.
|
|
4
4
|
* @spec secure requires encrypted transport; the scheme determines how it is established.
|
|
5
5
|
* It does not assert reachability, trust-policy approval or application authorization.
|
|
6
6
|
*/
|
|
7
7
|
export interface Endpoint {
|
|
8
|
+
/** Optional identity within the declaring consumer; not a network address. */
|
|
9
|
+
readonly id?: string;
|
|
10
|
+
/** Human-readable description; never credentials or a signed resource URL. */
|
|
11
|
+
readonly description?: string;
|
|
12
|
+
/** Canonical consumer Workload name, not the remote Service or destination workload. */
|
|
13
|
+
readonly workload?: string;
|
|
8
14
|
/** Lowercase URI scheme without a colon; protocol metadata, not a health assertion. */
|
|
9
15
|
readonly scheme?: string;
|
|
10
16
|
/** Hostname or IP literal; IPv6 literals have no surrounding brackets. */
|