Skip to content

[V] $lib

const $lib: TypeSpecLibrary<{
"content-type-ignored": {
default: "`Content-Type` header ignored because there is no body.";
};
"content-type-string": {
default: "contentType parameter must be a string literal or union of string literals";
};
"deprecated-implicit-optionality": {
default: "The implicitOptionality option is deprecated. To preserve previous behavior, use an explicit patch model with optional properties. For actual merge-patch semantics, use MergePatchUpdate<T> for the @body type.";
};
"double-slash": {
default: CallableMessage<["paramName"]>;
optionalSet: CallableMessage<["paramName"]>;
optionalUnset: CallableMessage<["paramName"]>;
};
"duplicate-body": {
bodyAndUnannotated: "Operation has a @body and an unannotated parameter. There can only be one representing the body";
default: "Operation has multiple @body parameters declared";
duplicateUnannotated: "Operation has multiple unannotated parameters. There can only be one representing the body";
};
"duplicate-operation": {
default: CallableMessage<["operationName", "verb", "path"]>;
};
"duplicate-route-decorator": {
namespace: "@route was defined twice on this namespace and has different values.";
};
"formdata-no-part-name": {
default: "Part used in multipart/form-data must have a name.";
};
"http-file-content-type-not-string": {
default: CallableMessage<["type"]>;
};
"http-file-contents-not-scalar": {
default: CallableMessage<["type"]>;
};
"http-file-disallowed-metadata": {
default: CallableMessage<["metadataType", "propName"]>;
};
"http-file-extra-property": {
default: CallableMessage<["propName"]>;
};
"http-file-structured": {
default: CallableMessage<["contentTypes"]>;
union: "An HTTP File in a union is serialized as a structured model instead of being treated as the contents of a file. Declare a separate operation using `@sharedRoute` that has only the File model as the body type to treat it as a file, or suppress this warning if you intend to serialize the File as a model.";
};
"http-verb-duplicate": {
default: CallableMessage<["entityName"]>;
};
"incompatible-uri-param": {
default: CallableMessage<["param", "uriKind", "annotationKind"]>;
};
"invalid-type-for-auth": {
default: CallableMessage<["kind"]>;
};
"merge-patch-contains-metadata": {
default: CallableMessage<["metadataType", "propertyName"]>;
};
"merge-patch-contains-null": {
default: "Cannot convert model to a merge-patch compatible shape because it contains the 'null' intrinsic type.";
};
"merge-patch-content-type": {
default: CallableMessage<["contentType"]>;
};
"metadata-ignored": {
default: CallableMessage<["kind"]>;
};
"missing-server-param": {
default: CallableMessage<["param"]>;
};
"missing-uri-param": {
default: CallableMessage<["param"]>;
};
"multipart-invalid-content-type": {
default: CallableMessage<["contentType", "supportedContentTypes"]>;
};
"multipart-model": {
default: "Multipart request body must be a model or a tuple of http parts.";
};
"multipart-nested": {
default: "Cannot use @multipartBody inside of an HttpPart";
};
"multipart-part": {
default: "Expect item to be an HttpPart model.";
};
"multiple-status-codes": {
default: "Multiple `@statusCode` decorators defined for this operation response.";
};
"no-implicit-multipart": {
default: "Using multipart payloads requires the use of @multipartBody and HttpPart<T> models.";
};
"no-service-found": {
default: CallableMessage<["namespace"]>;
};
"operation-param-duplicate-type": {
default: CallableMessage<["paramName", "types"]>;
};
"response-cookie-not-supported": {
default: CallableMessage<["propName"]>;
};
"shared-inconsistency": {
default: CallableMessage<["verb", "path"]>;
};
"status-code-invalid": {
default: "statusCode value must be a numeric or string literal or union of numeric or string literals";
value: "statusCode value must be a three digit code between 100 and 599";
};
"use-uri-template": {
default: CallableMessage<["param"]>;
};
}, Record<string, any>,
| "path"
| "authentication"
| "header"
| "cookie"
| "query"
| "body"
| "bodyRoot"
| "bodyIgnore"
| "multipartBody"
| "statusCode"
| "verbs"
| "patchOptions"
| "servers"
| "includeInapplicableMetadataInPayload"
| "externalInterfaces"
| "routeProducer"
| "routes"
| "sharedRoutes"
| "routeOptions"
| "file"
| "httpPart"
| "mergePatchModel"
| "mergePatchProperty"
| "mergePatchPropertyOptions">;

HTTP library definition providing diagnostic messages and program-state keys to the compiler.