Skip to content

Fix generation of ARM markdown help files. #1765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fearthecowboy merged 1 commit into from
Feb 2, 2017
Merged

Fix generation of ARM markdown help files. #1765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
304 changes: 255 additions & 49 deletions ...piManagement/Microsoft.ApiManagement.json → ...t/2016-07-07/Microsoft.ApiManagement.json
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 16 additions & 4 deletions ...-07-07/Microsoft.ApiManagement/service.md → ...ected/ApiManagement/2016-07-07/service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a Microsoft.ApiManagement/service resource, add the following JSON to

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service",
"apiVersion": "2016-07-07",
"location": "string",
Expand Down Expand Up @@ -73,6 +74,7 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | The name of the Api Management service. |
| type | enum | Yes | Microsoft.ApiManagement/service |
| apiVersion | enum | Yes | 2016-07-07 |
| location | string | Yes | Api Management service data center location. |
Expand Down Expand Up @@ -117,9 +119,9 @@ The following tables describe the values you need to set in the schema.
### service_openidConnectProviders_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | openidConnectProviders |
| apiVersion | enum | Yes | 2016-07-07 |
| name | string | Yes | User-friendly OpenID Connect Provider name. |
| description | string | No | User-friendly description of OpenID Connect Provider. |
| metadataEndpoint | string | Yes | Metadata endpoint URI. |
| clientId | string | Yes | Client ID of developer console which is the client application. |
Expand All @@ -130,9 +132,9 @@ The following tables describe the values you need to set in the schema.
### service_properties_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | properties |
| apiVersion | enum | Yes | 2016-07-07 |
| name | string | Yes | Unique name of Property. |
| value | string | Yes | The Value of the Property. |
| tags | array | No | Collection of tags associated with a property. - string |
| secret | boolean | No | The value which determines the value should be encrypted or not. Default value is false. |
Expand All @@ -142,6 +144,7 @@ The following tables describe the values you need to set in the schema.
### service_loggers_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | loggers |
| apiVersion | enum | Yes | 2016-07-07 |
| description | string | No | Logger description. |
Expand All @@ -153,6 +156,7 @@ The following tables describe the values you need to set in the schema.
### service_authorizationServers_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | authorizationServers |
| apiVersion | enum | Yes | 2016-07-07 |
| OAuth2AuthorizationServerContract | object | Yes | OAuth2 Authorization Server details. - [OAuth2AuthorizationServerContract object](#OAuth2AuthorizationServerContract) |
Expand All @@ -162,6 +166,7 @@ The following tables describe the values you need to set in the schema.
### service_users_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | User identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | users |
| apiVersion | enum | Yes | 2016-07-07 |
| email | string | Yes | Email address. |
Expand All @@ -176,6 +181,7 @@ The following tables describe the values you need to set in the schema.
### service_certificates_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | certificates |
| apiVersion | enum | Yes | 2016-07-07 |
| data | string | No | Base 64 encoded Certificate |
Expand All @@ -186,9 +192,9 @@ The following tables describe the values you need to set in the schema.
### service_groups_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | groups |
| apiVersion | enum | Yes | 2016-07-07 |
| name | string | Yes | Group name. |
| description | string | No | Group description. |
| externalId | string | No | Identifier for an external group. |
| resources | array | No | [service_groups_users_childResource object](#service_groups_users_childResource) |
Expand All @@ -198,6 +204,7 @@ The following tables describe the values you need to set in the schema.
### service_products_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | Product identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | products |
| apiVersion | enum | Yes | 2016-07-07 |
| ProductContract | object | Yes | [ProductContract object](#ProductContract) |
Expand All @@ -208,11 +215,11 @@ The following tables describe the values you need to set in the schema.
### service_subscriptions_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | subscriptions |
| apiVersion | enum | Yes | 2016-07-07 |
| userId | string | Yes | User (user id path) for whom subscription is being created in form /users/{uid} |
| productId | string | Yes | Product (product id path) for which subscription is being created in form /products/{productid} |
| name | string | Yes | Subscription name. |
| primaryKey | string | No | Primary subscription key. If not specified during request key will be generated automatically. |
| secondaryKey | string | No | Secondary subscription key. If not specified during request key will be generated automatically. |
| state | enum | No | Initial subscription state. - Suspended, Active, Expired, Submitted, Rejected, Cancelled |
Expand All @@ -222,6 +229,7 @@ The following tables describe the values you need to set in the schema.
### service_apis_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | API identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | apis |
| apiVersion | enum | Yes | 2016-07-07 |
| ApiContract | object | Yes | ApiContract. - [ApiContract object](#ApiContract) |
Expand Down Expand Up @@ -282,6 +290,7 @@ The following tables describe the values you need to set in the schema.
### service_groups_users_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | User identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | users |
| apiVersion | enum | Yes | 2016-07-07 |

Expand All @@ -304,6 +313,7 @@ The following tables describe the values you need to set in the schema.
### service_products_groups_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | groups |
| apiVersion | enum | Yes | 2016-07-07 |

Expand All @@ -312,6 +322,7 @@ The following tables describe the values you need to set in the schema.
### service_products_apis_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | API identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | apis |
| apiVersion | enum | Yes | 2016-07-07 |

Expand All @@ -334,6 +345,7 @@ The following tables describe the values you need to set in the schema.
### service_apis_operations_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | operations |
| apiVersion | enum | Yes | 2016-07-07 |
| OperationContract | object | Yes | operation details. - [OperationContract object](#OperationContract) |
Expand Down
3 changes: 3 additions & 0 deletions ...7/Microsoft.ApiManagement/service_apis.md → .../ApiManagement/2016-07-07/service_apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a Microsoft.ApiManagement/service/apis resource, add the following JSO

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2016-07-07",
"ApiContract": {
Expand Down Expand Up @@ -41,6 +42,7 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/apis object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | API identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | Microsoft.ApiManagement/service/apis |
| apiVersion | enum | Yes | 2016-07-07 |
| ApiContract | object | Yes | ApiContract. - [ApiContract object](#ApiContract) |
Expand All @@ -65,6 +67,7 @@ The following tables describe the values you need to set in the schema.
### service_apis_operations_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | operations |
| apiVersion | enum | Yes | 2016-07-07 |
| OperationContract | object | Yes | operation details. - [OperationContract object](#OperationContract) |
Expand Down
2 changes: 2 additions & 0 deletions ....ApiManagement/service_apis_operations.md → ...ent/2016-07-07/service_apis_operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a Microsoft.ApiManagement/service/apis/operations resource, add the fo

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2016-07-07",
"OperationContract": {
Expand Down Expand Up @@ -82,6 +83,7 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/apis/operations object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | Microsoft.ApiManagement/service/apis/operations |
| apiVersion | enum | Yes | 2016-07-07 |
| OperationContract | object | Yes | operation details. - [OperationContract object](#OperationContract) |
Expand Down
2 changes: 2 additions & 0 deletions ...anagement/service_authorizationServers.md → ...016-07-07/service_authorizationServers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a Microsoft.ApiManagement/service/authorizationServers resource, add t

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/authorizationServers",
"apiVersion": "2016-07-07",
"OAuth2AuthorizationServerContract": {
Expand Down Expand Up @@ -49,6 +50,7 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/authorizationServers object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | Microsoft.ApiManagement/service/authorizationServers |
| apiVersion | enum | Yes | 2016-07-07 |
| OAuth2AuthorizationServerContract | object | Yes | OAuth2 Authorization Server details. - [OAuth2AuthorizationServerContract object](#OAuth2AuthorizationServerContract) |
Expand Down
2 changes: 2 additions & 0 deletions ...oft.ApiManagement/service_certificates.md → ...gement/2016-07-07/service_certificates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a Microsoft.ApiManagement/service/certificates resource, add the follo

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/certificates",
"apiVersion": "2016-07-07",
"data": "string",
Expand All @@ -20,6 +21,7 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/certificates object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | Microsoft.ApiManagement/service/certificates |
| apiVersion | enum | Yes | 2016-07-07 |
| data | string | No | Base 64 encoded Certificate |
Expand Down
5 changes: 3 additions & 2 deletions ...Microsoft.ApiManagement/service_groups.md → ...piManagement/2016-07-07/service_groups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ To create a Microsoft.ApiManagement/service/groups resource, add the following J

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/groups",
"apiVersion": "2016-07-07",
"name": "string",
"description": "string",
"externalId": "string",
"resources": [
Expand All @@ -24,9 +24,9 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/groups object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | Microsoft.ApiManagement/service/groups |
| apiVersion | enum | Yes | 2016-07-07 |
| name | string | Yes | Group name. |
| description | string | No | Group description. |
| externalId | string | No | Identifier for an external group. |
| resources | array | No | [service_groups_users_childResource object](#service_groups_users_childResource) |
Expand All @@ -36,6 +36,7 @@ The following tables describe the values you need to set in the schema.
### service_groups_users_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | User identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | users |
| apiVersion | enum | Yes | 2016-07-07 |

2 changes: 2 additions & 0 deletions ...oft.ApiManagement/service_groups_users.md → ...gement/2016-07-07/service_groups_users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a Microsoft.ApiManagement/service/groups/users resource, add the follo

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/groups/users",
"apiVersion": "2016-07-07"
}
Expand All @@ -18,6 +19,7 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/groups/users object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | User identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | Microsoft.ApiManagement/service/groups/users |
| apiVersion | enum | Yes | 2016-07-07 |

2 changes: 2 additions & 0 deletions ...icrosoft.ApiManagement/service_loggers.md → ...iManagement/2016-07-07/service_loggers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a Microsoft.ApiManagement/service/loggers resource, add the following

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/loggers",
"apiVersion": "2016-07-07",
"description": "string",
Expand All @@ -21,6 +22,7 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/loggers object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | Microsoft.ApiManagement/service/loggers |
| apiVersion | enum | Yes | 2016-07-07 |
| description | string | No | Logger description. |
Expand Down
4 changes: 2 additions & 2 deletions ...agement/service_openidConnectProviders.md → ...6-07-07/service_openidConnectProviders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ To create a Microsoft.ApiManagement/service/openidConnectProviders resource, add

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
"apiVersion": "2016-07-07",
"name": "string",
"description": "string",
"metadataEndpoint": "string",
"clientId": "string",
Expand All @@ -23,9 +23,9 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/openidConnectProviders object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | Microsoft.ApiManagement/service/openidConnectProviders |
| apiVersion | enum | Yes | 2016-07-07 |
| name | string | Yes | User-friendly OpenID Connect Provider name. |
| description | string | No | User-friendly description of OpenID Connect Provider. |
| metadataEndpoint | string | Yes | Metadata endpoint URI. |
| clientId | string | Yes | Client ID of developer console which is the client application. |
Expand Down
4 changes: 4 additions & 0 deletions ...crosoft.ApiManagement/service_products.md → ...Management/2016-07-07/service_products.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a Microsoft.ApiManagement/service/products resource, add the following

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/products",
"apiVersion": "2016-07-07",
"ProductContract": {
Expand All @@ -31,6 +32,7 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/products object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | Product identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | Microsoft.ApiManagement/service/products |
| apiVersion | enum | Yes | 2016-07-07 |
| ProductContract | object | Yes | [ProductContract object](#ProductContract) |
Expand All @@ -55,6 +57,7 @@ The following tables describe the values you need to set in the schema.
### service_products_groups_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | groups |
| apiVersion | enum | Yes | 2016-07-07 |

Expand All @@ -63,6 +66,7 @@ The following tables describe the values you need to set in the schema.
### service_products_apis_childResource object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | API identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | apis |
| apiVersion | enum | Yes | 2016-07-07 |

2 changes: 2 additions & 0 deletions ...ft.ApiManagement/service_products_apis.md → ...ement/2016-07-07/service_products_apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a Microsoft.ApiManagement/service/products/apis resource, add the foll

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/products/apis",
"apiVersion": "2016-07-07"
}
Expand All @@ -18,6 +19,7 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/products/apis object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | API identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | Microsoft.ApiManagement/service/products/apis |
| apiVersion | enum | Yes | 2016-07-07 |

2 changes: 2 additions & 0 deletions ....ApiManagement/service_products_groups.md → ...ent/2016-07-07/service_products_groups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a Microsoft.ApiManagement/service/products/groups resource, add the fo

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/products/groups",
"apiVersion": "2016-07-07"
}
Expand All @@ -18,6 +19,7 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/products/groups object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. |
| type | enum | Yes | Microsoft.ApiManagement/service/products/groups |
| apiVersion | enum | Yes | 2016-07-07 |

4 changes: 2 additions & 2 deletions ...osoft.ApiManagement/service_properties.md → ...nagement/2016-07-07/service_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ To create a Microsoft.ApiManagement/service/properties resource, add the followi

```json
{
"name": "string",
"type": "Microsoft.ApiManagement/service/properties",
"apiVersion": "2016-07-07",
"name": "string",
"value": "string",
"tags": [
"string"
Expand All @@ -24,9 +24,9 @@ The following tables describe the values you need to set in the schema.
### Microsoft.ApiManagement/service/properties object
| Name | Type | Required | Value |
| ---- | ---- | ---- | ---- |
| name | string | Yes | |
| type | enum | Yes | Microsoft.ApiManagement/service/properties |
| apiVersion | enum | Yes | 2016-07-07 |
| name | string | Yes | Unique name of Property. |
| value | string | Yes | The Value of the Property. |
| tags | array | No | Collection of tags associated with a property. - string |
| secret | boolean | No | The value which determines the value should be encrypted or not. Default value is false. |
Expand Down
Loading