CHANGELOG.json

{
  "name": "@cadl-lang/rest",
  "entries": [
    {
      "version": "0.18.0",
      "tag": "@cadl-lang/rest_v0.18.0",
      "date": "Wed, 12 Oct 2022 21:12:35 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Empty object as a response will not produce a 204 response anymore"
          },
          {
            "comment": "Feature: Add `isContentTypeHeader` helper."
          },
          {
            "comment": "Implement automatic visibility transformations"
          },
          {
            "comment": "**BREAKING** Remove `@discriminator` decorator. (Moved to @cadl-lang/compiler)"
          },
          {
            "comment": "Disallow optional path params even if they have a default value"
          },
          {
            "comment": "Add support for overloads(Using `@overload` decorator)"
          },
          {
            "comment": "Reorganization of http data accessor. `getAllRoutes` is now deprecated and replaced with `getAllHttpServices`"
          },
          {
            "comment": "`ResourceLocation<T>` is `uri`"
          }
        ],
        "patch": [
          {
            "comment": "Remove workaround for issue https://github.com/microsoft/cadl/issues/1069"
          },
          {
            "comment": "Detect unannotated path parameters that are specified in route path"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.35.0` to `~0.36.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/library-linter\" from `~0.2.0` to `~0.2.1`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.35.0` to `~0.36.0`"
          }
        ]
      }
    },
    {
      "version": "0.17.0",
      "tag": "@cadl-lang/rest_v0.17.0",
      "date": "Thu, 08 Sep 2022 01:04:53 GMT",
      "comments": {
        "patch": [
          {
            "comment": "Api: Route resolution take projection into account"
          },
          {
            "comment": "Guard against uninitialized parent type in `parentResource` decorator"
          },
          {
            "comment": "Support more kinds of unions, fix various union bugs, and add support for @discriminator on unions"
          }
        ],
        "minor": [
          {
            "comment": "**Deprecation**: Mark `@produces` and `@consumes` as deprecated"
          },
          {
            "comment": "Uptake changes to compiler with current projection"
          },
          {
            "comment": "Update decororator state key to allow multiple instance of library to work together."
          },
          {
            "comment": "React to Type suffix removal"
          },
          {
            "comment": "**BREAKING CHANGE** Rename `Page` to `CollectionWithNextLink`"
          },
          {
            "comment": "Fix doc for route and move autoRoute to rest library"
          },
          {
            "comment": "Api: Service Authentication oauth2 flow scopes is now an object with value and description"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.34.0` to `~0.35.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/eslint-config-cadl\" from `~0.4.0` to `~0.4.1`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/library-linter\" from `~0.1.3` to `~0.2.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.34.0` to `~0.35.0`"
          }
        ]
      }
    },
    {
      "version": "0.16.0",
      "tag": "@cadl-lang/rest_v0.16.0",
      "date": "Thu, 11 Aug 2022 19:05:23 GMT",
      "comments": {
        "patch": [
          {
            "comment": "Add a @resource decorator to simplify how one defines resource types and specifies the collection (segment) name"
          },
          {
            "comment": "Add `ResourceCreateOrReplace` type and `createsOrReplaces` decorator to model an \"upsert\" operation"
          },
          {
            "comment": "Improve `cloneKeyProperties` implementation so that original model type is not affected"
          },
          {
            "comment": "Ensure that all @key properties turned into @path parameters by KeysOf<T> are required even if the original is optional"
          },
          {
            "comment": "Operations with a body and no verb will default route to POST"
          },
          {
            "comment": "Add `ResourceLocation<T>` to mark a property as containing a link to a specific resource type"
          },
          {
            "comment": "Make response descriptions more consistent"
          }
        ],
        "none": [
          {
            "comment": "readme.md documentation change"
          }
        ],
        "minor": [
          {
            "comment": "Add new `@useAuth` decorator providing support to define service authentication"
          },
          {
            "comment": "Uptake changes to type relations"
          },
          {
            "comment": "Update resource operation interfaces to configure Create and Update model properties correctly"
          },
          {
            "comment": "Support set of unannotated parameters as request body"
          },
          {
            "comment": "Add friendly name for Page<T> as TPage"
          },
          {
            "comment": "Make OkResponse non-generic"
          },
          {
            "comment": "Remove `groupName` from `OperationDetails`"
          },
          {
            "comment": "Emit diagnostic when defining @path property that is optional without a default value"
          },
          {
            "comment": "Update route resolution logic to be more consistent. If service namespace is provided use routes under otherwise use routes directly at the global namespace level(do not go into the nested namespaces)"
          },
          {
            "comment": "Internal: Uptake new compiler helpers to work with template types"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.33.0` to `~0.34.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/eslint-config-cadl\" from `~0.3.0` to `~0.4.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/library-linter\" from `~0.1.2` to `~0.1.3`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/eslint-plugin\" from `~0.1.0` to `~0.1.1`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.33.0` to `~0.34.0`"
          }
        ]
      }
    },
    {
      "version": "0.15.1",
      "tag": "@cadl-lang/rest_v0.15.1",
      "date": "Fri, 08 Jul 2022 23:22:57 GMT",
      "comments": {
        "patch": [
          {
            "comment": "$consumes decorator better validation"
          },
          {
            "comment": "Add `@collectionAction` decorator for defining collection-level resource actions"
          },
          {
            "comment": "Make string literal \"Content-Type\" header check case-insensitive"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.32.0` to `~0.33.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/library-linter\" from `~0.1.1` to `~0.1.2`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.32.0` to `~0.33.0`"
          }
        ]
      }
    },
    {
      "version": "0.15.0",
      "tag": "@cadl-lang/rest_v0.15.0",
      "date": "Mon, 13 Jun 2022 23:42:28 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Uptake changes to compiler with decorator validator helpers"
          },
          {
            "comment": "Update accessor functions `getAllRoutes`, `getContentTypes`, etc. to follow the new Accessor pattern which return any encountered diagnostics along with the expected value"
          },
          {
            "comment": "Uptake changes to decorator context"
          },
          {
            "comment": " Added `@server` decorator to specify namespace endpoints"
          },
          {
            "comment": "Fix decorator and functions not belonging to a namespace"
          }
        ],
        "patch": [
          {
            "comment": "Properly exclude operation templates when scanning for routes"
          },
          {
            "comment": "Skip templated operations when scanning for operation routes"
          },
          {
            "comment": "Enable customization of route segment separators in autoRoutes"
          }
        ],
        "none": [
          {
            "comment": "Upgrade to TS4.7"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.31.0` to `~0.32.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/library-linter\" from `~0.1.0` to `~0.1.1`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.31.0` to `~0.32.0`"
          }
        ]
      }
    },
    {
      "version": "0.14.0",
      "tag": "@cadl-lang/rest_v0.14.0",
      "date": "Fri, 06 May 2022 17:19:57 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Add RouteOptions and AutoRouteOptions types to enable customization of automatic route generation when calling getAllRoutes"
          },
          {
            "comment": "Uptake `mixes` -> `extends` rename"
          },
          {
            "comment": "Remove node 14 support"
          }
        ],
        "patch": [
          {
            "comment": "Fix issue where empty response model with children would result in 204\""
          },
          {
            "comment": "Add validation to `Resource` interface to ensure `TError` is an error type"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.30.0` to `~0.31.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.30.0` to `~0.31.0`"
          }
        ]
      }
    },
    {
      "version": "0.13.0",
      "tag": "@cadl-lang/rest_v0.13.0",
      "date": "Thu, 31 Mar 2022 17:10:49 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Handle error type being passed to `KeyOf` model"
          },
          {
            "comment": "Add validation when using Resource interfaces when missing @key on resource"
          },
          {
            "comment": "Add logic to interpret the http responses."
          }
        ],
        "patch": [
          {
            "comment": "Fix issue with empty routes in namespace/interface and operation causing path with '//'"
          },
          {
            "comment": "Support browser builds"
          },
          {
            "comment": "Raise a diagnostic when a resource type specifies a parent type which holds the same key name."
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.29.0` to `~0.30.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/eslint-config-cadl\" from `~0.2.0` to `~0.3.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.29.0` to `~0.30.0`"
          }
        ]
      }
    },
    {
      "version": "0.12.0",
      "tag": "@cadl-lang/rest_v0.12.0",
      "date": "Wed, 09 Mar 2022 17:42:09 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Move @key decorator to core"
          }
        ],
        "patch": [
          {
            "comment": "Filter out string literal typed path parameters when generating routes automatically"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.28.0` to `~0.29.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/eslint-config-cadl\" from `~0.1.0` to `~0.2.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.28.0` to `~0.29.0`"
          }
        ]
      }
    },
    {
      "version": "0.11.0",
      "tag": "@cadl-lang/rest_v0.11.0",
      "date": "Tue, 15 Feb 2022 22:35:02 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Add validation to decorators"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.27.0` to `~0.28.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.27.0` to `~0.28.0`"
          }
        ]
      }
    },
    {
      "version": "0.10.0",
      "tag": "@cadl-lang/rest_v0.10.0",
      "date": "Mon, 14 Feb 2022 03:01:07 GMT",
      "comments": {
        "minor": [
          {
            "comment": "refactor status code handling to http library"
          },
          {
            "comment": "Update decorators to take in api change"
          }
        ],
        "patch": [
          {
            "comment": "Bump dependency versions"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.26.0` to `~0.27.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.26.0` to `~0.27.0`"
          }
        ]
      }
    },
    {
      "version": "0.9.0",
      "tag": "@cadl-lang/rest_v0.9.0",
      "date": "Fri, 04 Feb 2022 18:00:18 GMT",
      "comments": {
        "patch": [
          {
            "comment": "Move `@key`, `@parentResource`, and `@copyResourceKeyParameters` decorators into `Cadl.Rest`"
          },
          {
            "comment": "Operations marked with `@action` will now default to `POST` verb unless another verb has been explicitly specified"
          },
          {
            "comment": "Add interfaces for modelling extension and singleton resources"
          },
          {
            "comment": "**Fix** Duplicate @key on model properties will produce diagnostic instead of exception"
          }
        ],
        "minor": [
          {
            "comment": "Add support for discriminator decorator"
          },
          {
            "comment": "Internals: switch to internal path manipulation"
          },
          {
            "comment": "Added shared logic to resolve http operation parameters and validate compatibility(duplicate bodies)"
          },
          {
            "comment": "**Added** Validation for uniqueness of operation by verb and path"
          },
          {
            "comment": "**Added** `@head` decorator to describe `head` http verb operation"
          },
          {
            "comment": "Validate http verb decorators(`@get`, `@post`, etc.) do not receive any argument"
          },
          {
            "comment": "Expose response template in Http library and refactor"
          },
          {
            "comment": "Add statusCode decorator for http status code"
          },
          {
            "comment": "**Validate `@route` decorator is used only once"
          },
          {
            "comment": "Update cadl dependencies to peerDependencies"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.25.0` to `~0.26.0`"
          },
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `~0.25.0` to `~0.26.0`"
          }
        ]
      }
    },
    {
      "version": "0.8.0",
      "tag": "@cadl-lang/rest_v0.8.0",
      "date": "Thu, 16 Dec 2021 08:02:20 GMT",
      "comments": {
        "patch": [
          {
            "comment": "Adding @CreateOrUpdate (PUT) and standard operation in REST."
          },
          {
            "comment": "camelCase operations"
          },
          {
            "comment": "Add new route scanning functionality which provides the same capabilities (both explicit and autogenerated routes) to normal operations and those defined inside of interfaces"
          }
        ],
        "none": [
          {
            "comment": "Formatting changes"
          }
        ],
        "minor": [
          {
            "comment": "Add Cadl.Http.PlainData<T>"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `0.24.1` to `0.25.0`"
          }
        ]
      }
    },
    {
      "version": "0.7.1",
      "tag": "@cadl-lang/rest_v0.7.1",
      "date": "Wed, 01 Dec 2021 22:56:11 GMT",
      "comments": {
        "patch": [
          {
            "comment": "Add README"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `0.24.0` to `0.24.1`"
          }
        ]
      }
    },
    {
      "version": "0.7.0",
      "tag": "@cadl-lang/rest_v0.7.0",
      "date": "Thu, 18 Nov 2021 13:58:15 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Refactor REST and HTTP decorators and split them into Cadl.Rest and Cadl.Http, respectively"
          }
        ],
        "patch": [
          {
            "comment": "Add new Cadl.Rest.Resource namespace for new resource modelling pattern"
          },
          {
            "comment": "Add documentation strings to models and operations"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `0.23.0` to `0.24.0`"
          }
        ]
      }
    },
    {
      "version": "0.6.4",
      "tag": "@cadl-lang/rest_v0.6.4",
      "date": "Thu, 11 Nov 2021 21:46:21 GMT",
      "comments": {
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `0.22.0` to `0.23.0`"
          }
        ]
      }
    },
    {
      "version": "0.6.3",
      "tag": "@cadl-lang/rest_v0.6.3",
      "date": "Thu, 28 Oct 2021 21:17:50 GMT",
      "comments": {
        "patch": [
          {
            "comment": "Remove management.azure.com service host default"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `0.21.0` to `0.22.0`"
          }
        ]
      }
    },
    {
      "version": "0.6.2",
      "tag": "@cadl-lang/rest_v0.6.2",
      "date": "Fri, 15 Oct 2021 21:33:37 GMT",
      "comments": {
        "patch": [
          {
            "comment": "Strongly defined diagnostics"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `0.20.0` to `0.21.0`"
          }
        ]
      }
    },
    {
      "version": "0.6.1",
      "tag": "@cadl-lang/rest_v0.6.1",
      "date": "Fri, 17 Sep 2021 00:49:37 GMT",
      "comments": {
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `0.19.0` to `0.20.0`"
          }
        ]
      }
    },
    {
      "version": "0.6.0",
      "tag": "@cadl-lang/rest_v0.6.0",
      "date": "Sat, 21 Aug 2021 00:04:02 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Introduce naming convention `$name` for JavaScript-defined Cadl functions and decorators"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `0.18.0` to `0.19.0`"
          }
        ]
      }
    },
    {
      "version": "0.5.1",
      "tag": "@cadl-lang/rest_v0.5.1",
      "date": "Fri, 13 Aug 2021 19:10:21 GMT",
      "comments": {
        "patch": [
          {
            "comment": "Add isHeader functionality to discover if a property is a header property"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `0.17.0` to `0.18.0`"
          }
        ]
      }
    },
    {
      "version": "0.5.0",
      "tag": "@cadl-lang/rest_v0.5.0",
      "date": "Tue, 10 Aug 2021 20:23:04 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Rename package to @cadl-lang/rest"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@cadl-lang/compiler\" from `0.16.0` to `0.17.0`"
          }
        ]
      }
    },
    {
      "version": "0.4.1",
      "tag": "@azure-tools/cadl-rest_v0.4.1",
      "date": "Mon, 09 Aug 2021 21:14:12 GMT",
      "comments": {
        "dependency": [
          {
            "comment": "Updating dependency \"@azure-tools/cadl\" from `0.15.0` to `0.16.0`"
          }
        ]
      }
    },
    {
      "version": "0.4.0",
      "tag": "@azure-tools/cadl-rest_v0.4.0",
      "date": "Mon, 02 Aug 2021 18:17:00 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Rename ADL to Cadl"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@azure-tools/cadl\" from `0.14.0` to `0.15.0`"
          }
        ]
      }
    },
    {
      "version": "0.3.2",
      "tag": "@azure-tools/adl-rest_v0.3.2",
      "date": "Wed, 28 Jul 2021 19:40:06 GMT",
      "comments": {
        "patch": [
          {
            "comment": "Add additional api to support code generation and host property"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@azure-tools/adl\" from `0.13.0` to `0.14.0`"
          }
        ]
      }
    },
    {
      "version": "0.3.1",
      "tag": "@azure-tools/adl-rest_v0.3.1",
      "date": "Fri, 09 Jul 2021 20:21:06 GMT",
      "comments": {
        "dependency": [
          {
            "comment": "Updating dependency \"@azure-tools/adl\" from `0.12.0` to `0.13.0`"
          }
        ]
      }
    },
    {
      "version": "0.3.0",
      "tag": "@azure-tools/adl-rest_v0.3.0",
      "date": "Thu, 24 Jun 2021 03:57:43 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Add semantic error recovery"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@azure-tools/adl\" from `0.11.0` to `0.12.0`"
          }
        ]
      }
    },
    {
      "version": "0.2.1",
      "tag": "@azure-tools/adl-rest_v0.2.1",
      "date": "Tue, 18 May 2021 23:43:31 GMT",
      "comments": {
        "dependency": [
          {
            "comment": "Updating dependency \"@azure-tools/adl\" from `0.10.0` to `0.11.0`"
          }
        ]
      }
    },
    {
      "version": "0.2.0",
      "tag": "@azure-tools/adl-rest_v0.2.0",
      "date": "Thu, 06 May 2021 14:56:01 GMT",
      "comments": {
        "minor": [
          {
            "comment": "Implement alias and enum, remove model ="
          }
        ],
        "patch": [
          {
            "comment": "**Added** New type NoContentResponse"
          },
          {
            "comment": "Replace several internal compiler errors with diagnostics"
          }
        ],
        "dependency": [
          {
            "comment": "Updating dependency \"@azure-tools/adl\" from `0.9.0` to `0.10.0`"
          }
        ]
      }
    },
    {
      "version": "0.1.2",
      "tag": "@azure-tools/adl-rest_v0.1.2",
      "date": "Tue, 20 Apr 2021 15:23:29 GMT",
      "comments": {
        "dependency": [
          {
            "comment": "Updating dependency \"@azure-tools/adl\" from `0.8.0` to `0.9.0`"
          }
        ]
      }
    }
  ]
}