Skip to content

Commit 4a15d89

Browse files
ryansbensonRyan Benson
andauthored
Microsoft.PortalServices CompileFile (#22297)
* portalservices compilefile * compilefile custom word * prettier fix * api version fix * fix tag --------- Co-authored-by: Ryan Benson <[email protected]>
1 parent 30b2a73 commit 4a15d89

File tree

4 files changed

+184
-0
lines changed

4 files changed

+184
-0
lines changed

custom-words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,7 @@ commandshistory
414414
commitmentplans
415415
Compat
416416
compilationjobs
417+
compilefile
417418
compositeentities
418419
computervision
419420
CONCURRENTAPPEND
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-01-01-preview",
4+
"portalTenantCompileFile": {
5+
"contents": {
6+
"$schema": "../../Definitions/dx.schema.json#",
7+
"stringSource": "Resources/MyStrings.resjson",
8+
"view": {
9+
"kind": "Markdown",
10+
"export": true,
11+
"properties": {
12+
"content": {
13+
"property": "markdownContent"
14+
}
15+
}
16+
}
17+
},
18+
"stringSource": {
19+
"markdownContent": "# This is an example of a markdown view!"
20+
}
21+
}
22+
},
23+
"responses": {
24+
"200": {
25+
"headers": {
26+
"Azure-AsyncOperation": "http://azure.async.operation/status"
27+
},
28+
"body": {}
29+
}
30+
}
31+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "2023-01-01-preview",
5+
"title": "portal",
6+
"description": "Allows creation and deletion of Azure portal extensions."
7+
},
8+
"host": "management.azure.com",
9+
"schemes": [
10+
"https"
11+
],
12+
"consumes": [
13+
"application/json"
14+
],
15+
"produces": [
16+
"application/json"
17+
],
18+
"security": [
19+
{
20+
"azure_auth": [
21+
"user_impersonation"
22+
]
23+
}
24+
],
25+
"securityDefinitions": {
26+
"azure_auth": {
27+
"type": "oauth2",
28+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
29+
"flow": "implicit",
30+
"description": "Azure Active Directory OAuth2 Flow",
31+
"scopes": {
32+
"user_impersonation": "impersonate your user account"
33+
}
34+
}
35+
},
36+
"paths": {
37+
"/providers/Microsoft.PortalServices/compilefile": {
38+
"post": {
39+
"tags": [
40+
"PortalTenant"
41+
],
42+
"operationId": "PortalTenant_CompileFile",
43+
"x-ms-examples": {
44+
"Compile single file using inline content": {
45+
"$ref": "examples/portalTenantCompileFile.json"
46+
}
47+
},
48+
"description": "compiles a file using inline content.",
49+
"parameters": [
50+
{
51+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
52+
},
53+
{
54+
"name": "portalTenantCompileFile",
55+
"in": "body",
56+
"required": true,
57+
"schema": {
58+
"$ref": "#/definitions/PortalTenantCompileFile"
59+
},
60+
"description": "The parameters required to compile a file."
61+
}
62+
],
63+
"responses": {
64+
"200": {
65+
"description": "OK - Returns the runtime configuration of the file.",
66+
"schema": {
67+
"$ref": "#/definitions/PortalTenantCompileFileResult"
68+
}
69+
},
70+
"default": {
71+
"description": "Error response describing why the operation failed.",
72+
"schema": {
73+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
74+
}
75+
}
76+
},
77+
"produces": [
78+
"application/json"
79+
],
80+
"consumes": [
81+
"application/json"
82+
]
83+
}
84+
}
85+
},
86+
"definitions": {
87+
"PortalTenantCompileFileResult": {
88+
"type": "object",
89+
"description": "The runtime result of source compilation",
90+
"additionalProperties": true
91+
},
92+
"PortalTenantCompileFile": {
93+
"type": "object",
94+
"description": "The contents of the file to compile.",
95+
"properties": {
96+
"contents": {
97+
"type": "object",
98+
"description": "The contents of the file."
99+
},
100+
"stringSource": {
101+
"type": "object",
102+
"description": "The contents of the string source."
103+
}
104+
}
105+
}
106+
},
107+
"parameters": {}
108+
}
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# portal
2+
3+
> see https://aka.ms/autorest
4+
5+
This is the AutoRest configuration file for portal.
6+
7+
## Getting Started
8+
9+
To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run:
10+
11+
> `autorest readme.md`
12+
13+
To see additional help and options, run:
14+
15+
> `autorest --help`
16+
17+
For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page.
18+
19+
---
20+
21+
## Configuration
22+
23+
### Basic Information
24+
25+
These are the global settings for the portal.
26+
27+
```yaml
28+
openapi-type: arm
29+
openapi-subtype: rpaas
30+
tag: package-2023-01-01-preview
31+
```
32+
33+
### Tag: package-2023-01-01-preview
34+
35+
These settings apply only when `--tag=package-2023-01-01-preview` is specified on the command line.
36+
37+
```yaml $(tag) == 'package-2023-01-01-preview'
38+
input-file:
39+
- Microsoft.PortalServices/preview/2023-01-01-preview/extensions.json
40+
```
41+
42+
---
43+
44+
# Code Generation

0 commit comments

Comments
 (0)