File: SIP_ROUTING_SWAGGER.md

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (73 lines) | stat: -rw-r--r-- 1,687 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# Azure Communication Configuration for Python

> see https://aka.ms/autorest

### Setup
```ps
npm install -g autorest
```

### Generation
```ps
cd <swagger-folder>
autorest SWAGGER.md
```

### Settings
``` yaml
require: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/communication/data-plane/SipRouting/readme.md
tag: package-2023-03
output-folder: ../azure/communication/phonenumbers/siprouting/_generated
namespace: azure.communication.phonenumbers.siprouting
no-namespace-folders: true
license-header: MICROSOFT_MIT_NO_VERSION
clear-output-folder: true
python: true
v3: true
title: SIP Routing Service
model-namespace: false
models-mode: msrest
```

### Remove the -Update types and use simple types instead, to simplify user interface
``` yaml
directive:
  from: swagger-document
  where: $.paths.*[?(@.operationId == "SipRouting_Update")].parameters..[?(@.description == "Sip configuration update object.")]
  transform: >
    $.schema = {"$ref": "#/definitions/SipConfiguration"}
```

``` yaml
directive:
  from: swagger-document
  where: $.definitions
  transform: >
    delete $.TrunkUpdate
```

``` yaml
directive:
  from: swagger-document
  where: $.definitions
  transform: >
    delete $.SipConfigurationUpdate
```

### Directive renaming "Trunk" model to "SipTrunkInternal"
``` yaml
directive:
  from: swagger-document
  where: "$.definitions.Trunk"
  transform: >
    $["x-ms-client-name"] = "SipTrunkInternal";
```

### Directive renaming "TrunkRoute" model to "SipTrunkRouteInternal"
``` yaml
directive:
  from: swagger-document
  where: "$.definitions.TrunkRoute"
  transform: >
    $["x-ms-client-name"] = "SipTrunkRouteInternal";
```