Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
7 changes: 7 additions & 0 deletions .chronus/changes/spector-new-case-2025-10-18-7-0-48.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
changeKind: feature
packages:
- "@typespec/http-specs"
---

Add test case for special words about model property name
23 changes: 23 additions & 0 deletions packages/http-specs/spec-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -3392,6 +3392,29 @@ Expected header parameters:

Check we recognize Repeatability-Request-ID and Repeatability-First-Sent.

### SpecialWords_ModelProperties_dictMethods

- Endpoint: `get /special-words/model-properties/dict-methods`

Verify that model properties can use names that are Python dict methods. These names (keys, items, values, etc.) may conflict with Python's dict class methods.

Send

```json
{
"keys": "ok",
"items": "ok",
"values": "ok",
"popitem": "ok",
"clear": "ok",
"update": "ok",
"setdefault": "ok",
"pop": "ok",
"get": "ok",
"copy": "ok"
}
```

### SpecialWords_ModelProperties_sameAsModel

- Endpoint: `get /special-words/model-properties/same-as-model`
Expand Down
38 changes: 38 additions & 0 deletions packages/http-specs/specs/special-words/main.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -231,4 +231,42 @@ namespace ModelProperties {
""")
@route("same-as-model")
op sameAsModel(@body body: SameAsModel): void;

// Python dict method names that could conflict
model DictMethods {
keys: string;
items: string;
values: string;
popitem: string;
clear: string;
update: string;
setdefault: string;
pop: string;
get: string;
copy: string;
}

@scenario
@scenarioDoc("""
Verify that model properties can use names that are Python dict methods. These names (keys, items, values, etc.) may conflict with Python's dict class methods.
Send
```json
{
"keys": "ok",
"items": "ok",
"values": "ok",
"popitem": "ok",
"clear": "ok",
"update": "ok",
"setdefault": "ok",
"pop": "ok",
"get": "ok",
"copy": "ok"
}
```
""")
@route("dict-methods")
op dictMethods(@body body: DictMethods): void;
}
23 changes: 23 additions & 0 deletions packages/http-specs/specs/special-words/mockapi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,29 @@ Scenarios.SpecialWords_ModelProperties_sameAsModel = passOnSuccess({
kind: "MockApiDefinition",
});

Scenarios.SpecialWords_ModelProperties_dictMethods = passOnSuccess({
uri: "/special-words/model-properties/dict-methods",
method: "post",
request: {
body: json({
keys: "ok",
items: "ok",
values: "ok",
popitem: "ok",
clear: "ok",
update: "ok",
setdefault: "ok",
pop: "ok",
get: "ok",
copy: "ok",
}),
},
response: {
status: 204,
},
kind: "MockApiDefinition",
});

function createModelsTests(uri: string) {
return passOnSuccess({
uri,
Expand Down
Loading