Skip to content

Commit

Permalink
Merge branch 'main' into json-converter
Browse files Browse the repository at this point in the history
  • Loading branch information
live1206 authored Jul 30, 2024
2 parents 8f35f17 + 4434dc2 commit 79effb3
Show file tree
Hide file tree
Showing 88 changed files with 4,203 additions and 1,449 deletions.
6 changes: 6 additions & 0 deletions .chronus/changes/improve-armid-doc-2024-6-26-10-21-28.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
changeKind: internal
packages:
- "@azure-tools/typespec-azure-core"
---

This file was deleted.

2 changes: 1 addition & 1 deletion core
Submodule core updated 163 files
9 changes: 5 additions & 4 deletions cspell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ enableFiletypes:
- typespec
words:
- allof
- mobo
- apim
- apos
- armId
- azsdk
- Bazs
- byos
- clsx
- contosowidgetmanager
- DMSS
- Donezo
- dynatrace
Expand All @@ -49,12 +49,14 @@ words:
- LINUXNEXTVMIMAGE
- LINUXOS
- LINUXVMIMAGE
- locationyaml
- logz
- LRO
- lropaging
- Lucene
- MACVMIMAGE
- mgmt
- mobo
- msazure
- msdata
- mylocation
Expand All @@ -64,8 +66,8 @@ words:
- oncophenotype
- PAYG
- prismjs
- pytest
- psscriptanalyzer
- pytest
- qnas
- regionality
- Reranker
Expand All @@ -74,6 +76,5 @@ words:
- SERVICERP
- tcgc
- userrp
- vnet
- WINDOWSVMIMAGE
- contosowidgetmanager
- locationyaml
37 changes: 22 additions & 15 deletions docs/howtos/DataPlane Generation - DPG/07tcgcTypes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1219,7 +1219,9 @@ interface SdkTypeBase {
// created by tcgc. Those won't have an original type
__raw?: Type;
kind: string;
deprecations?: string;
deprecation?: string;
description?: string;
details?: string;
}
```

Expand All @@ -1236,16 +1238,22 @@ There is a one-to-one mapping between the TypeSpec scalar kinds and the `SdkBuil
export interface SdkBuiltInType extends SdkTypeBase {
kind: SdkBuiltInKinds;
encode: string;
name: string;
baseType?: SdkBuiltInType;
crossLanguageDefinitionId: string;
}
```

### SdkDateTimeType

```ts
interface SdkDatetimeTypeBase extends SdkTypeBase {
name: string;
baseType?: SdkDateTimeType;
encode: DateTimeKnownEncoding;
// what we send over the wire. Often it's string
wireType: SdkBuiltInType;
crossLanguageDefinitionId: string;
}

interface SdkUtcDatetimeType extends SdkDatetimeTypeBase {
Expand All @@ -1262,9 +1270,12 @@ interface SdkOffsetDatetimeType extends SdkDatetimeTypeBase {
```ts
interface SdkDurationType extends SdkTypeBase {
kind: "duration";
name: string;
baseType?: SdkDurationType;
encode: DurationKnownEncoding;
// What we send over the wire. It's usually either a string or a float
wireType: SdkBuiltInType;
crossLanguageDefinitionId: string;
}
```

Expand All @@ -1273,8 +1284,9 @@ interface SdkDurationType extends SdkTypeBase {
```ts
interface SdkArrayType extends SdkTypeBase {
kind: "array";
name: string;
valueType: SdkType;
nullableValues: boolean;
crossLanguageDefinitionId: string;
}
```

Expand All @@ -1285,7 +1297,6 @@ interface SdkDictionaryType extends SdkTypeBase {
kind: "dict";
keyType: SdkType; // currently can only be string
valueType: SdkType;
nullableValues: boolean;
}
```

Expand All @@ -1296,17 +1307,16 @@ export interface SdkEnumType extends SdkTypeBase {
kind: "enum";
name: string;
// Determines whether the name was generated or not
generatedName: boolean;
isGeneratedName: boolean;
valueType: SdkBuiltInType;
values: SdkEnumValueType[];
isFixed: boolean;
description?: string;
details?: string;
isFlags: boolean;
usage: UsageFlags;
access: AccessFlags;
crossLanguageDefinitionId: string;
apiVersions: string[];
isUnionAsEnum: boolean;
}
```

Expand All @@ -1318,9 +1328,7 @@ export interface SdkEnumValueType extends SdkTypeBase {
name: string;
value: string | number;
enumType: SdkEnumType;
valueType: SdkType;
description?: string;
details?: string;
valueType: SdkBuiltInType;
}
```

Expand All @@ -1331,6 +1339,8 @@ export interface SdkConstantType extends SdkTypeBase {
kind: "constant";
value: string | number | boolean | null;
valueType: SdkBuiltInType;
name: string;
isGeneratedName: boolean;
}
```

Expand All @@ -1340,9 +1350,10 @@ export interface SdkConstantType extends SdkTypeBase {
export interface SdkUnionType extends SdkTypeBase {
name: string;
// determines if the union name was generated or not
generatedName: boolean;
isGeneratedName: boolean;
kind: "union";
values: SdkType[];
crossLanguageDefinitionId: string;
}
```

Expand All @@ -1353,13 +1364,9 @@ export interface SdkModelType extends SdkTypeBase {
kind: "model";
// purposely can also be header / query params for fidelity with TypeSpec
properties: SdkModelPropertyType[];
isFormDataType: boolean;
isError: boolean;
// we will always have a name. generatedName determines if it's generated or not.
name: string;
generatedName: string;
description?: string;
details?: string;
isGeneratedName: boolean;
access: AccessFlags;
usage: UsageFlags;
additionalProperties?: SdkType;
Expand Down
Loading

0 comments on commit 79effb3

Please sign in to comment.