Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .chronus/changes/safe-int-openapi3-2024-1-17-0-53-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
changeKind: breaking
packages:
- "@typespec/openapi3"
---

`safeint` scalar now map to `type: integer, format: double-int`. To revert to the previous output of `type: integer, format: int64`. You can either:

1. Use the `safeint-as-int64` option:
```yaml
# tspconfig.yaml
options:
"@typespec/openapi3":
safeint-as-int64: true
```
2. Apply `@encode("int64", int64)` on every usage of safeint(or create a new scalar)
```tsp
@encode("int64", int64)
scalar int64Safeint extends safeint;
```
2 changes: 1 addition & 1 deletion packages/openapi3/src/schema-emitter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -699,7 +699,7 @@ export class OpenAPI3SchemaEmitter extends TypeEmitter<
case "int64":
return { type: "integer", format: "int64" };
case "safeint":
return { type: "integer", format: "int64" };
return { type: "integer", format: "double-int" };
case "uint8":
return { type: "integer", format: "uint8" };
case "uint16":
Expand Down
2 changes: 1 addition & 1 deletion packages/openapi3/test/primitive-types.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ describe("openapi3: primitives", () => {
["int16", { type: "integer", format: "int16" }],
["int32", { type: "integer", format: "int32" }],
["int64", { type: "integer", format: "int64" }],
["safeint", { type: "integer", format: "int64" }],
["safeint", { type: "integer", format: "double-int" }],
["uint8", { type: "integer", format: "uint8" }],
["uint16", { type: "integer", format: "uint16" }],
["uint32", { type: "integer", format: "uint32" }],
Expand Down