@typespec/rest 0.44.0-dev.6 → 0.44.0

package/lib/resource.tsp

@@ -59,6 +59,10 @@ model ResourceCollectionParameters<TResource extends object> {
 @Private.validateHasKey(TResource)
 @Private.validateIsError(TError)
 interface ResourceRead<TResource extends object, TError> {
+  /**
+   * Gets an instance of the resource.
+   * @template TResource The resource model.
+   */
   @autoRoute
   @doc("Gets an instance of the resource.")
   @readsResource(TResource)
@@ -81,8 +85,13 @@ model ResourceCreatedResponse<T> {
  * @template TError The error response.
  */
 interface ResourceCreateOrReplace<TResource extends object, TError> {
+  /**
+   * Creates or replaces a instance of the resource.
+   * @template TResource The resource model to create or replace.
+   * @template TError The error response.
+   */
   @autoRoute
-  @doc("Creates or replaces a instance of the resource.")
+  @doc("Creates or replaces an instance of the resource.")
   @createsOrReplacesResource(TResource)
   createOrReplace(
     ...ResourceParameters<TResource>,
@@ -104,8 +113,13 @@ model ResourceCreateOrUpdateModel<TResource extends object>
  * @template TError The error response.
  */
 interface ResourceCreateOrUpdate<TResource extends object, TError> {
+  /**
+   * Creates or update an instance of the resource.
+   * @template TResource The resource model to create or update.
+   * @template TError The error response.
+   */
   @autoRoute
-  @doc("Creates or update a instance of the resource.")
+  @doc("Creates or update an instance of the resource.")
   @createsOrUpdatesResource(TResource)
   createOrUpdate(
     ...ResourceParameters<TResource>,
@@ -127,6 +141,11 @@ model ResourceCreateModel<TResource extends object>
  * @template TError The error response.
  */
 interface ResourceCreate<TResource extends object, TError> {
+  /**
+   * Creates a new instance of the resource.
+   * @template TResource The resource model to create.
+   * @template TError The error response.
+   */
   @autoRoute
   @doc("Creates a new instance of the resource.")
   @createsResource(TResource)
@@ -144,6 +163,11 @@ interface ResourceCreate<TResource extends object, TError> {
 @Private.validateHasKey(TResource)
 @Private.validateIsError(TError)
 interface ResourceUpdate<TResource extends object, TError> {
+  /**
+   * Updates an existing instance of the resource.
+   * @template TResource The resource model to update.
+   * @template TError The error response.
+   */
   @autoRoute
   @doc("Updates an existing instance of the resource.")
   @updatesResource(TResource)
@@ -168,6 +192,11 @@ model ResourceDeletedResponse {
 @Private.validateHasKey(TResource)
 @Private.validateIsError(TError)
 interface ResourceDelete<TResource extends object, TError> {
+  /**
+   * Deletes an existing instance of the resource.
+   * @template TResource The resource model to delete.
+   * @template TError The error response.
+   */
   @autoRoute
   @doc("Deletes an existing instance of the resource.")
   @deletesResource(TResource)
@@ -196,6 +225,11 @@ model CollectionWithNextLink<T extends object> {
  * @template TError The error response.
  */
 interface ResourceList<TResource extends object, TError> {
+  /**
+   * Lists all instances of the resource.
+   * @template TResource The resource model to list.
+   * @template TError The error response.
+   */
   @autoRoute
   @doc("Lists all instances of the resource.")
   @listsResource(TResource)
@@ -245,11 +279,16 @@ interface ResourceOperations<TResource extends object, TError>
 @Private.validateHasKey(TResource)
 @Private.validateIsError(TError)
 interface SingletonResourceRead<TSingleton extends object, TResource extends object, TError> {
+  /**
+   * Gets the singleton resource.
+   * @template TSingleton The singleton resource model.
+   * @template TResource The resource model.
+   */
   @autoRoute
   @doc("Gets the singleton resource.")
   @segmentOf(TSingleton)
   @readsResource(TSingleton)
-  Get(...ResourceParameters<TResource>): TSingleton | TError;
+  get(...ResourceParameters<TResource>): TSingleton | TError;
 }
 
 /**
@@ -261,11 +300,16 @@ interface SingletonResourceRead<TSingleton extends object, TResource extends obj
 @Private.validateHasKey(TResource)
 @Private.validateIsError(TError)
 interface SingletonResourceUpdate<TSingleton extends object, TResource extends object, TError> {
+  /**
+   * Updates the singleton resource.
+   * @template TSingleton The singleton resource model.
+   * @template TResource The resource model.
+   */
   @autoRoute
   @doc("Updates the singleton resource.")
   @segmentOf(TSingleton)
   @updatesResource(TSingleton)
-  Update(
+  update(
     ...ResourceParameters<TResource>,
 
     @body
@@ -292,10 +336,15 @@ interface SingletonResourceOperations<TSingleton extends object, TResource exten
 @Private.validateHasKey(TResource)
 @Private.validateIsError(TError)
 interface ExtensionResourceRead<TExtension extends object, TResource extends object, TError> {
+  /**
+   * Gets an instance of the extension resource.
+   * @template TExtension The extension resource model.
+   * @template TResource The resource model.
+   */
   @autoRoute
   @doc("Gets an instance of the extension resource.")
   @readsResource(TExtension)
-  Get(...ResourceParameters<TResource>, ...ResourceParameters<TExtension>): TExtension | TError;
+  get(...ResourceParameters<TResource>, ...ResourceParameters<TExtension>): TExtension | TError;
 }
 
 /**
@@ -309,10 +358,15 @@ interface ExtensionResourceCreateOrUpdate<
   TResource extends object,
   TError
 > {
+  /**
+   * Creates or update an instance of the extension resource.
+   * @template TExtension The extension resource model.
+   * @template TResource The resource model.
+   */
   @autoRoute
-  @doc("Creates or update a instance of the extension resource.")
+  @doc("Creates or update an instance of the extension resource.")
   @createsOrUpdatesResource(TExtension)
-  CreateOrUpdate(
+  createOrUpdate(
     ...ResourceParameters<TResource>,
     ...ResourceParameters<TExtension>,
     @body resource: ResourceCreateOrUpdateModel<TExtension>
@@ -326,10 +380,15 @@ interface ExtensionResourceCreateOrUpdate<
  * @template TError The error response.
  */
 interface ExtensionResourceCreate<TExtension extends object, TResource extends object, TError> {
+  /**
+   * Creates a new instance of the extension resource.
+   * @template TExtension The extension resource model.
+   * @template TResource The resource model.
+   */
   @autoRoute
   @doc("Creates a new instance of the extension resource.")
   @createsResource(TExtension)
-  Create(
+  create(
     ...ResourceParameters<TResource>,
     @body resource: ResourceCreateModel<TExtension>
   ): TExtension | ResourceCreatedResponse<TExtension> | TError;
@@ -342,10 +401,15 @@ interface ExtensionResourceCreate<TExtension extends object, TResource extends o
  * @template TError The error response.
  */
 interface ExtensionResourceUpdate<TExtension extends object, TResource extends object, TError> {
+  /**
+   * Updates an existing instance of the extension resource.
+   * @template TExtension The extension resource model.
+   * @template TResource The resource model.
+   */
   @autoRoute
   @doc("Updates an existing instance of the extension resource.")
   @updatesResource(TExtension)
-  Update(
+  update(
     ...ResourceParameters<TResource>,
     ...ResourceParameters<TExtension>,
 
@@ -361,10 +425,15 @@ interface ExtensionResourceUpdate<TExtension extends object, TResource extends o
  * @template TError The error response.
  */
 interface ExtensionResourceDelete<TExtension extends object, TResource extends object, TError> {
+  /**
+   * Deletes an existing instance of the extension resource.
+   * @template TExtension The extension resource model.
+   * @template TResource The resource model.
+   */
   @autoRoute
   @doc("Deletes an existing instance of the extension resource.")
   @deletesResource(TExtension)
-  Delete(
+  delete(
     ...ResourceParameters<TResource>,
     ...ResourceParameters<TExtension>
   ): ResourceDeletedResponse | TError;
@@ -377,10 +446,15 @@ interface ExtensionResourceDelete<TExtension extends object, TResource extends o
  * @template TError The error response.
  */
 interface ExtensionResourceList<TExtension extends object, TResource extends object, TError> {
+  /**
+   * Lists all instances of the extension resource.
+   * @template TExtension The extension resource model.
+   * @template TResource The resource model.
+   */
   @autoRoute
   @doc("Lists all instances of the extension resource.")
   @listsResource(TExtension)
-  List(
+  list(
     ...ResourceParameters<TResource>,
     ...ResourceCollectionParameters<TExtension>
   ): CollectionWithNextLink<TExtension> | TError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/rest",
-  "version": "0.44.0-dev.6",
+  "version": "0.44.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec REST protocol binding",
   "homepage": "https://microsoft.github.io/typespec",
@@ -42,16 +42,16 @@
     "!dist/test/**"
   ],
   "peerDependencies": {
-    "@typespec/compiler": ">=0.43.0"
+    "@typespec/compiler": "~0.44.0"
   },
   "devDependencies": {
     "@types/mocha": "~10.0.0",
     "@types/node": "~18.11.9",
-    "@typespec/compiler": ">=0.43.0",
-    "@typespec/http": ">=0.43.1",
-    "@typespec/eslint-config-typespec": ">=0.6.0",
-    "@typespec/library-linter": ">=0.43.0",
-    "@typespec/eslint-plugin": ">=0.43.0",
+    "@typespec/compiler": "~0.44.0",
+    "@typespec/http": "~0.44.0",
+    "@typespec/eslint-config-typespec": "~0.7.0",
+    "@typespec/library-linter": "~0.44.0",
+    "@typespec/eslint-plugin": "~0.44.0",
     "eslint": "^8.36.0",
     "mocha": "~10.2.0",
     "mocha-junit-reporter": "~2.2.0",
@@ -60,7 +60,6 @@
     "rimraf": "~5.0.0",
     "typescript": "~5.0.2"
   },
-  "dependencies": {},
   "scripts": {
     "clean": "rimraf ./dist ./temp",
     "build": "tsc -p . && npm run lint-typespec-library",