@typespec/http 0.47.0-dev.1 → 0.47.0-dev.3

package/lib/http-decorators.tsp

@@ -7,7 +7,7 @@ using TypeSpec.Reflection;
  */
 model HeaderOptions {
   /**
-   * Name of the header when sent over http.
+   * Name of the header when sent over HTTP.
    */
   name?: string;
 
@@ -18,23 +18,23 @@ model HeaderOptions {
 }
 
 /**
- * Specify this property is to be sent or received as an http header.
+ * Specify this property is to be sent or received as an HTTP header.
  *
- * @param headerNameOrOptions Optional name of the header when sent over http or header options.
- *  By default the header name will be the property name converted from camelCase to camel-case. (e.g. `eTag` -> `e-tag`)
+ * @param headerNameOrOptions Optional name of the header when sent over HTTP or header options.
+ *  By default the header name will be the property name converted from camelCase to kebab-case. (e.g. `contentType` -> `content-type`)
  *
  * @example
  *
  * ```typespec
- * op read(@header accept: string): {@header("E-Tag") eTag: string};
+ * op read(@header accept: string): {@header("ETag") eTag: string};
  * op create(@header({name: "X-Color", format: "csv"}) colors: string[]): void;
  * ```
  *
  * @example Implicit header name
  *
  * ```typespec
- * op read(): {@header eTag: string}; // headerName: e-tag
  * op read(): {@header contentType: string}; // headerName: content-type
+ * op update(@header ifMatch: string): void; // headerName: if-match
  * ```
  */
 extern dec header(target: ModelProperty, headerNameOrOptions?: string | HeaderOptions);
@@ -107,7 +107,7 @@ extern dec body(target: ModelProperty);
 extern dec statusCode(target: ModelProperty);
 
 /**
- * Specify the http verb for the target operation to be `GET`.
+ * Specify the HTTP verb for the target operation to be `GET`.
  *
  * @example
  *
@@ -118,7 +118,7 @@ extern dec statusCode(target: ModelProperty);
 extern dec get(target: Operation);
 
 /**
- * Specify the http verb for the target operation to be `PUT`.
+ * Specify the HTTP verb for the target operation to be `PUT`.
  *
  * @example
  *
@@ -129,7 +129,7 @@ extern dec get(target: Operation);
 extern dec put(target: Operation);
 
 /**
- * Specify the http verb for the target operation to be `POST`.
+ * Specify the HTTP verb for the target operation to be `POST`.
  *
  * @example
  *
@@ -140,7 +140,7 @@ extern dec put(target: Operation);
 extern dec post(target: Operation);
 
 /**
- * Specify the http verb for the target operation to be `PATCH`.
+ * Specify the HTTP verb for the target operation to be `PATCH`.
  *
  * @example
  *
@@ -151,7 +151,7 @@ extern dec post(target: Operation);
 extern dec patch(target: Operation);
 
 /**
- * Specify the http verb for the target operation to be `DELETE`.
+ * Specify the HTTP verb for the target operation to be `DELETE`.
  *
  * @example
  *
@@ -162,7 +162,7 @@ extern dec patch(target: Operation);
 extern dec delete(target: Operation);
 
 /**
- * Specify the http verb for the target operation to be `HEAD`.
+ * Specify the HTTP verb for the target operation to be `HEAD`.
  * @example
  *
  * ```typespec

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http",
-  "version": "0.47.0-dev.1",
+  "version": "0.47.0-dev.3",
   "author": "Microsoft Corporation",
   "description": "TypeSpec HTTP protocol binding",
   "homepage": "https://github.com/microsoft/typespec",
@@ -51,6 +51,7 @@
     "@typespec/eslint-config-typespec": "~0.46.0 || >=0.47.0-dev <0.47.0",
     "@typespec/library-linter": "~0.46.0 || >=0.47.0-dev <0.47.0",
     "@typespec/eslint-plugin": "~0.46.0 || >=0.47.0-dev <0.47.0",
+    "@typespec/tspd": "~0.46.0 || >=0.47.0-dev <0.47.0",
     "eslint": "^8.42.0",
     "mocha": "~10.2.0",
     "mocha-junit-reporter": "~2.2.0",
@@ -68,6 +69,7 @@
     "test": "mocha",
     "test-official": "c8 mocha --forbid-only --reporter mocha-multi-reporters",
     "lint": "eslint . --ext .ts --max-warnings=0",
-    "lint:fix": "eslint . --fix --ext .ts"
+    "lint:fix": "eslint . --fix --ext .ts",
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/standard-library/http/reference"
   }
 }