@typespec/http-specs 0.38.0-dev.3 → 0.38.0-dev.5

package/specs/type/property/nullable/main.tsp

@@ -1,8 +1,8 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
-using Azure.ClientGenerator.Core;
+using Http;
+using SpecLib;
 
 @doc("Illustrates models with nullable properties.")
 @scenarioService("/type/property/nullable")
@@ -18,54 +18,43 @@ model ModelTemplate<TProperty> {
 }
 
 @doc("Operations associated with getting and putting models with nullable properties.")
-interface OperationsTemplate<TModel, TDoc extends string, TDefaultDoc extends string = "null"> {
+interface OperationsTemplate<
+  TModel,
+  TDoc extends valueof string,
+  TDefaultDoc extends valueof string = "null"
+> {
   @doc("Get models that will return all properties in the model")
   @scenario
-  @scenarioDoc(
-    """
-      Expected response body:
-      ```json
-      { "requiredProperty": "foo", "nullableProperty": {allDoc}}
-      ```
-      """,
-    {
-      allDoc: TDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected response body:
+    ```json
+    { "requiredProperty": "foo", "nullableProperty": ${TDoc}}
+    ```
+    """)
   @route("/non-null")
   @get
   getNonNull(): TModel;
 
   @doc("Get models that will return the default object")
   @scenario
-  @scenarioDoc(
-    """
-      Expected response body:
-      ```json
-      { "requiredProperty": "foo", "nullableProperty": {defaultDoc}}
-      ```
-      """,
-    {
-      defaultDoc: TDefaultDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected response body:
+    ```json
+    { "requiredProperty": "foo", "nullableProperty": ${TDefaultDoc}}
+    ```
+    """)
   @route("/null")
   @get
   getNull(): TModel;
 
   @doc("Put a body with all properties present.")
   @scenario
-  @scenarioDoc(
-    """
-      Expected request body:
-      ```json
-      { "requiredProperty": "foo", "nullableProperty": {allDoc}}
-      ```
-      """,
-    {
-      allDoc: TDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected request body:
+    ```json
+    { "requiredProperty": "foo", "nullableProperty": ${TDoc}}
+    ```
+    """)
   @route("/non-null")
   @patch
   patchNonNull(
@@ -78,17 +67,12 @@ interface OperationsTemplate<TModel, TDoc extends string, TDefaultDoc extends st
 
   @doc("Put a body with default properties.")
   @scenario
-  @scenarioDoc(
-    """
-      Expected request body:
-      ```json
-      { "requiredProperty": "foo", "nullableProperty": {defaultDoc}}
-      ```
-      """,
-    {
-      defaultDoc: TDefaultDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected request body:
+    ```json
+    { "requiredProperty": "foo", "nullableProperty": ${TDefaultDoc}}
+    ```
+    """)
   @route("/null")
   @patch
   patchNull(
@@ -103,34 +87,29 @@ interface OperationsTemplate<TModel, TDoc extends string, TDefaultDoc extends st
 // Model with nullable string property
 model StringProperty is ModelTemplate<string>;
 @route("/string")
-@operationGroup
 interface String extends OperationsTemplate<StringProperty, "hello"> {}
 
 // Model with nullable bytes property
 model BytesProperty is ModelTemplate<bytes>;
 @route("/bytes")
-@operationGroup
 interface Bytes extends OperationsTemplate<BytesProperty, "aGVsbG8sIHdvcmxkIQ=="> {}
 
 // Model with nullable datetime property
 @doc("Model with a datetime property")
 model DatetimeProperty is ModelTemplate<utcDateTime>;
 @route("/datetime")
-@operationGroup
 interface Datetime extends OperationsTemplate<DatetimeProperty, "2022-08-26T18:38:00Z"> {}
 
 // Model with nullable duration property
 @doc("Model with a duration property")
 model DurationProperty is ModelTemplate<duration>;
 @route("/duration")
-@operationGroup
 interface Duration extends OperationsTemplate<DurationProperty, "P123DT22H14M12.011S"> {}
 
 // Model with nullable collection bytes property
 @doc("Model with collection bytes properties")
 model CollectionsByteProperty is ModelTemplate<bytes[]>;
 @route("/collections/bytes")
-@operationGroup
 interface CollectionsByte
   extends OperationsTemplate<
       CollectionsByteProperty,
@@ -146,7 +125,6 @@ model InnerModel {
 @doc("Model with collection models properties")
 model CollectionsModelProperty is ModelTemplate<InnerModel[]>;
 @route("/collections/model")
-@operationGroup
 interface CollectionsModel
   extends OperationsTemplate<
       CollectionsModelProperty,
@@ -157,6 +135,5 @@ interface CollectionsModel
 @doc("Model with collection string properties")
 model CollectionsStringProperty is ModelTemplate<string[]>;
 @route("/collections/string")
-@operationGroup
 interface CollectionsString
   extends OperationsTemplate<CollectionsStringProperty, "['hello', 'world']"> {}

package/specs/type/property/optionality/main.tsp

@@ -1,8 +1,8 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
-using Azure.ClientGenerator.Core;
+using Http;
+using SpecLib;
 
 @doc("Illustrates models with optional properties.")
 @scenarioService("/type/property/optional")
@@ -15,71 +15,55 @@ model ModelTemplate<TProperty> {
 }
 
 @doc("Operations associated with getting and putting models with optional properties.")
-interface OperationsTemplate<TModel, TDoc extends string, TDefaultDoc extends string = "{}"> {
+interface OperationsTemplate<
+  TModel,
+  TDoc extends valueof string,
+  TDefaultDoc extends valueof string = "{}"
+> {
   @doc("Get models that will return all properties in the model")
   @scenario
-  @scenarioDoc(
-    """
-      Expected response body:
-      ```json
-      {"property": {allDoc}}
-      ```
-      """,
-    {
-      allDoc: TDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected response body:
+    ```json
+    {"property": ${TDoc}}
+    ```
+    """)
   @route("/all")
   @get
   getAll(): TModel;
 
   @doc("Get models that will return the default object")
   @scenario
-  @scenarioDoc(
-    """
-      Expected response body:
-      ```json
-      {defaultDoc}
-      ```
-      """,
-    {
-      defaultDoc: TDefaultDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected response body:
+    ```json
+    ${TDefaultDoc}
+    ```
+    """)
   @route("/default")
   @get
   getDefault(): TModel;
 
   @doc("Put a body with all properties present.")
   @scenario
-  @scenarioDoc(
-    """
-      Expected request body:
-      ```json
-      {"property": {allDoc}}
-      ```
-      """,
-    {
-      allDoc: TDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected request body:
+    ```json
+    {"property": ${TDoc}}
+    ```
+    """)
   @route("/all")
   @put
   putAll(@body body: TModel): void;
 
   @doc("Put a body with default properties.")
   @scenario
-  @scenarioDoc(
-    """
-      Expected request body:
-      ```json
-      {defaultDoc}
-      ```
-      """,
-    {
-      defaultDoc: TDefaultDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected request body:
+    ```json
+    ${TDefaultDoc}
+    ```
+    """)
   @route("/default")
   @put
   putDefault(@body body: TModel): void;
@@ -88,48 +72,41 @@ interface OperationsTemplate<TModel, TDoc extends string, TDefaultDoc extends st
 // Model with optional string property
 model StringProperty is ModelTemplate<string>;
 @route("/string")
-@operationGroup
 interface String extends OperationsTemplate<StringProperty, "\"hello\""> {}
 
 // Model with optional bytes property
 model BytesProperty is ModelTemplate<bytes>;
 @route("/bytes")
-@operationGroup
 interface Bytes extends OperationsTemplate<BytesProperty, "\"aGVsbG8sIHdvcmxkIQ==\""> {}
 
 // Model with optional datetime property
 @doc("Model with a datetime property")
 model DatetimeProperty is ModelTemplate<utcDateTime>;
 @route("/datetime")
-@operationGroup
 interface Datetime extends OperationsTemplate<DatetimeProperty, "\"2022-08-26T18:38:00Z\""> {}
 
 // Model with optional duration property
 @doc("Model with a duration property")
 model DurationProperty is ModelTemplate<duration>;
 @route("/duration")
-@operationGroup
 interface Duration extends OperationsTemplate<DurationProperty, "\"P123DT22H14M12.011S\""> {}
 
 // Model with optional plainDate property
 @doc("Model with a plainDate property")
 model PlainDateProperty is ModelTemplate<plainDate>;
 @route("/plainDate")
-@operationGroup
 interface PlainDate extends OperationsTemplate<PlainDateProperty, "\"2022-12-12\""> {}
 
 // Model with optional  property
 @doc("Model with a plainTime property")
 model PlainTimeProperty is ModelTemplate<plainTime>;
 @route("/plainTime")
-@operationGroup
 interface PlainTime extends OperationsTemplate<PlainTimeProperty, "\"13:06:12\""> {}
 
 // Model with optional collection bytes property
 @doc("Model with collection bytes properties")
 model CollectionsByteProperty is ModelTemplate<bytes[]>;
 @route("/collections/bytes")
-@operationGroup
 interface CollectionsByte
   extends OperationsTemplate<
       CollectionsByteProperty,
@@ -140,7 +117,6 @@ interface CollectionsByte
 @doc("Model with collection models properties")
 model CollectionsModelProperty is ModelTemplate<StringProperty[]>;
 @route("/collections/model")
-@operationGroup
 interface CollectionsModel
   extends OperationsTemplate<
       CollectionsModelProperty,
@@ -151,49 +127,42 @@ interface CollectionsModel
 @doc("Model with string literal property")
 model StringLiteralProperty is ModelTemplate<"hello">;
 @route("/string/literal")
-@operationGroup
 interface StringLiteral extends OperationsTemplate<StringLiteralProperty, "\"hello\""> {}
 
 // Model with optional int literal property
 @doc("Model with int literal property")
 model IntLiteralProperty is ModelTemplate<1>;
 @route("/int/literal")
-@operationGroup
 interface IntLiteral extends OperationsTemplate<IntLiteralProperty, "1"> {}
 
 // Model with optional float literal property
 @doc("Model with float literal property")
 model FloatLiteralProperty is ModelTemplate<1.25>;
 @route("/float/literal")
-@operationGroup
 interface FloatLiteral extends OperationsTemplate<FloatLiteralProperty, "1.25"> {}
 
 // Model with optional boolean literal property
 @doc("Model with boolean literal property")
 model BooleanLiteralProperty is ModelTemplate<true>;
 @route("/boolean/literal")
-@operationGroup
 interface BooleanLiteral extends OperationsTemplate<BooleanLiteralProperty, "true"> {}
 
 // Model with union of string literal property
 @doc("Model with union of string literal property")
 model UnionStringLiteralProperty is ModelTemplate<"hello" | "world">;
 @route("/union/string/literal")
-@operationGroup
 interface UnionStringLiteral extends OperationsTemplate<UnionStringLiteralProperty, "\"world\""> {}
 
 // Model with union of int literal property
 @doc("Model with union of int literal property")
 model UnionIntLiteralProperty is ModelTemplate<1 | 2>;
 @route("/union/int/literal")
-@operationGroup
 interface UnionIntLiteral extends OperationsTemplate<UnionIntLiteralProperty, "2"> {}
 
 // Model with union of float literal property
 @doc("Model with union of float literal property")
 model UnionFloatLiteralProperty is ModelTemplate<1.25 | 2.375>;
 @route("/union/float/literal")
-@operationGroup
 interface UnionFloatLiteral extends OperationsTemplate<UnionFloatLiteralProperty, "2.375"> {}
 
 @doc("Model with required and optional properties")
@@ -206,7 +175,6 @@ model RequiredAndOptionalProperty {
 }
 @doc("Test optional and required properties")
 @route("/requiredAndOptional")
-@operationGroup
 interface RequiredAndOptional {
   @doc("Get models that will return all properties in the model")
   @scenario

package/specs/type/property/value-types/main.tsp

@@ -1,8 +1,8 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
-using Azure.ClientGenerator.Core;
+using Http;
+using SpecLib;
 
 @doc("Illustrates various property types for models")
 @scenarioService("/type/property/value-types")
@@ -16,37 +16,27 @@ model ModelTemplate<TProperty> {
 }
 
 @doc("Template to have models operations")
-interface ModelOperations<TModel, TDoc extends string> {
+interface ModelOperations<TModel, TDoc extends valueof string> {
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing"
   @scenario
-  @scenarioDoc(
-    """
-      Expected response body:
-      ```json
-      {"property": {doc}}
-      ```
-      """,
-    {
-      doc: TDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected response body:
+    ```json
+    {"property": ${TDoc}}
+    ```
+    """)
   @get
   @doc("Get call")
   get(): TModel;
 
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing"
   @scenario
-  @scenarioDoc(
-    """
-      Expected input body:
-      ```json
-      {"property": {doc}}
-      ```
-      """,
-    {
-      doc: TDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected input body:
+    ```json
+    {"property": ${TDoc}}
+    ```
+    """)
   @put
   @doc("Put operation")
   put(@body @doc("body") body: TModel): void;
@@ -56,63 +46,54 @@ interface ModelOperations<TModel, TDoc extends string> {
 @doc("Model with a boolean property")
 model BooleanProperty is ModelTemplate<boolean>;
 @route("/boolean")
-@operationGroup
 interface Boolean extends ModelOperations<BooleanProperty, "true"> {}
 
 // Test a model with a string property
 @doc("Model with a string property")
 model StringProperty is ModelTemplate<string>;
 @route("/string")
-@operationGroup
 interface String extends ModelOperations<StringProperty, "\"hello\""> {}
 
 // Test a model with a bytes property
 @doc("Model with a bytes property")
 model BytesProperty is ModelTemplate<bytes>;
 @route("/bytes")
-@operationGroup
 interface Bytes extends ModelOperations<BytesProperty, "aGVsbG8sIHdvcmxkIQ=="> {}
 
 // Test a model with an int property
 @doc("Model with a int property")
 model IntProperty is ModelTemplate<int32>;
 @route("/int")
-@operationGroup
 interface Int extends ModelOperations<IntProperty, "42"> {}
 
 // Test a model with a float property
 @doc("Model with a float property")
 model FloatProperty is ModelTemplate<float32>;
 @route("/float")
-@operationGroup
 interface Float extends ModelOperations<FloatProperty, "43.125"> {}
 
 // Test a model with a decimal property
 @doc("Model with a decimal property")
 model DecimalProperty is ModelTemplate<decimal>;
 @route("/decimal")
-@operationGroup
 interface Decimal extends ModelOperations<DecimalProperty, "0.33333"> {}
 
 // Test a model with a decimal128 property
 @doc("Model with a decimal128 property")
 model Decimal128Property is ModelTemplate<decimal128>;
 @route("/decimal128")
-@operationGroup
 interface Decimal128 extends ModelOperations<Decimal128Property, "0.33333"> {}
 
 // Test a model with a datetime property
 @doc("Model with a datetime property")
 model DatetimeProperty is ModelTemplate<utcDateTime>;
 @route("/datetime")
-@operationGroup
 interface Datetime extends ModelOperations<DatetimeProperty, "2022-08-26T18:38:00Z"> {}
 
 // Test a model with a duration property
 @doc("Model with a duration property")
 model DurationProperty is ModelTemplate<duration>;
 @route("/duration")
-@operationGroup
 interface Duration extends ModelOperations<DurationProperty, "P123DT22H14M12.011S"> {}
 
 // Test a model with an enum property
@@ -127,9 +108,7 @@ union InnerEnum {
   ValueTwo: "ValueTwo",
 }
 
-#suppress "@azure-tools/typespec-azure-core/use-extensible-enum" "For testing"
 @doc("Enum that will be used as a property for model EnumProperty. Non-extensible.")
-@Azure.Core.fixed
 enum FixedInnerEnum {
   @doc("First value.")
   ValueOne,
@@ -141,13 +120,11 @@ enum FixedInnerEnum {
 @doc("Model with enum properties")
 model EnumProperty is ModelTemplate<FixedInnerEnum>;
 @route("/enum")
-@operationGroup
 interface Enum extends ModelOperations<EnumProperty, "\"ValueOne\""> {}
 
 @doc("Model with extensible enum properties")
 model ExtensibleEnumProperty is ModelTemplate<InnerEnum>;
 @route("/extensible-enum")
-@operationGroup
 interface ExtensibleEnum extends ModelOperations<ExtensibleEnumProperty, "\"UnknownValue\""> {}
 
 // Test a model with a model property
@@ -159,14 +136,12 @@ model InnerModel {
 @doc("Model with model properties")
 model ModelProperty is ModelTemplate<InnerModel>;
 @route("/model")
-@operationGroup
 interface Model extends ModelOperations<ModelProperty, "{'property': 'hello'}"> {}
 
 // Test a model with a string collection property
 @doc("Model with collection string properties")
 model CollectionsStringProperty is ModelTemplate<string[]>;
 @route("/collections/string")
-@operationGroup
 interface CollectionsString
   extends ModelOperations<CollectionsStringProperty, "['hello', 'world']"> {}
 
@@ -174,14 +149,12 @@ interface CollectionsString
 @doc("Model with collection int properties")
 model CollectionsIntProperty is ModelTemplate<int32[]>;
 @route("/collections/int")
-@operationGroup
 interface CollectionsInt extends ModelOperations<CollectionsIntProperty, "[1, 2]"> {}
 
 // Test a model with a model collection property
 @doc("Model with collection model properties")
 model CollectionsModelProperty is ModelTemplate<InnerModel[]>;
 @route("/collections/model")
-@operationGroup
 interface CollectionsModel
   extends ModelOperations<
       CollectionsModelProperty,
@@ -192,7 +165,6 @@ interface CollectionsModel
 @doc("Model with dictionary string properties")
 model DictionaryStringProperty is ModelTemplate<Record<string>>;
 @route("/dictionary/string")
-@operationGroup
 interface DictionaryString
   extends ModelOperations<DictionaryStringProperty, "{'k1': 'hello', 'k2': 'world'}"> {}
 
@@ -200,77 +172,65 @@ interface DictionaryString
 @doc("Model with a property never. (This property should not be included).")
 model NeverProperty is ModelTemplate<never>;
 @route("/never")
-@operationGroup
 interface Never extends ModelOperations<NeverProperty, "<don't include this property>"> {}
 
 // Test a model with unknown and string
 @doc("Model with a property unknown, and the data is a string.")
 model UnknownStringProperty is ModelTemplate<unknown>;
 @route("/unknown/string")
-@operationGroup
 interface UnknownString extends ModelOperations<UnknownStringProperty, "\"hello\""> {}
 
 // Test a model with unknown and int
 @doc("Model with a property unknown, and the data is a int32.")
 model UnknownIntProperty is ModelTemplate<unknown>;
 @route("/unknown/int")
-@operationGroup
 interface UnknownInt extends ModelOperations<UnknownIntProperty, "42"> {}
 
 // Test a model with unknown and a dictionnary
 @doc("Model with a property unknown, and the data is a dictionnary.")
 model UnknownDictProperty is ModelTemplate<unknown>;
 @route("/unknown/dict")
-@operationGroup
 interface UnknownDict extends ModelOperations<UnknownDictProperty, "{'k1': 'hello', 'k2': 42}"> {}
 
 // Test a model with unknown and an array
 @doc("Model with a property unknown, and the data is an array.")
 model UnknownArrayProperty is ModelTemplate<unknown>;
 @route("/unknown/array")
-@operationGroup
 interface UnknownArray extends ModelOperations<UnknownArrayProperty, "['hello', 'world']"> {}
 
 @doc("Model with a string literal property.")
 model StringLiteralProperty is ModelTemplate<"hello">;
 @route("/string/literal")
-@operationGroup
 interface StringLiteral extends ModelOperations<StringLiteralProperty, "\"hello\""> {}
 
 @doc("Model with a int literal property.")
 model IntLiteralProperty is ModelTemplate<42>;
 @route("/int/literal")
-@operationGroup
 interface IntLiteral extends ModelOperations<IntLiteralProperty, "42"> {}
 
 @doc("Model with a float literal property.")
 model FloatLiteralProperty is ModelTemplate<43.125>;
 @route("/float/literal")
-@operationGroup
 interface FloatLiteral extends ModelOperations<FloatLiteralProperty, "43.125"> {}
 
 @doc("Model with a boolean literal property.")
 model BooleanLiteralProperty is ModelTemplate<true>;
 @route("/boolean/literal")
-@operationGroup
 interface BooleanLiteral extends ModelOperations<BooleanLiteralProperty, "true"> {}
 
 @doc("Model with a union of string literal as property.")
 model UnionStringLiteralProperty is ModelTemplate<"hello" | "world">;
 @route("/union/string/literal")
-@operationGroup
 interface UnionStringLiteral extends ModelOperations<UnionStringLiteralProperty, "\"world\""> {}
 
 @doc("Model with a union of int literal as property.")
 model UnionIntLiteralProperty is ModelTemplate<42 | 43>;
 @route("/union/int/literal")
-@operationGroup
 interface UnionIntLiteral extends ModelOperations<UnionIntLiteralProperty, "42"> {}
 
 @doc("Model with a union of float literal as property.")
 model UnionFloatLiteralProperty is ModelTemplate<43.125 | 46.875>;
 @route("/union/float/literal")
-@operationGroup
 interface UnionFloatLiteral extends ModelOperations<UnionFloatLiteralProperty, "46.875"> {}
 
 union ExtendedEnum {
@@ -281,5 +241,4 @@ union ExtendedEnum {
 model UnionEnumValueProperty is ModelTemplate<ExtendedEnum.EnumValue2>;
 
 @route("/union-enum-value")
-@operationGroup
 interface UnionEnumValue extends ModelOperations<UnionEnumValueProperty, "\"value2\""> {}