Azure / Azure/bicep-types-az

Incorporate `x-ms-identifiers` swagger annotation into generated types

Open
#2,123 1 comment 0 reactions 0 assignees View on GitHub
enhancement Needs: Triage :mag:
Dominant language
TypeScript
Stars
108
Forks
44
Avg merge
18h 53m
Merged PRs (30d)
29

Description

**x-ms-identifiers**
Indicates the identifying property for objects in arrays
* Options
- Can provide multiple identifiers in the array to form composite identifier
- Can use JSON pointer to point to identifier that is inner property, e.g., /properties/subnet/id
* Example

```json
"myArrayProperty": {
"type":"array",
"items": {
"$ref":"#/definitions/Example"
},
"x-ms-identifiers": ["itemName"]
}
```

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no files, tests, or generator entry point. Start by locating the swagger-to-generated-types pipeline and its handling of array annotations, then use the supplied x-ms-identifiers example, including composite identifiers and JSON Pointer identifiers, to define verification.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.