Skip to content
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.

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

Microsoft.Relay API version 2021-11-01 #17480

Merged
Merged
Show file tree
Hide file tree
Changes from 14 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
3 changes: 3 additions & 0 deletions custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2531,6 +2531,9 @@ businessmetadata
Qualys
operatorconnect
servermetrics
Autorization

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Authorization?

Please fix this in your swagger and examples.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

usermetadata
Relaytype
Deboards
Deregisters
Dataworld
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,59 @@
"type": "string"
}
}
},
"SystemData": {
weidongxu-microsoft marked this conversation as resolved.
Show resolved Hide resolved
"description": "Metadata pertaining to creation and last modification of the resource.",
"type": "object",
"readOnly": true,
"properties": {
"createdBy": {
"type": "string",
"description": "The identity that created the resource."
},
"createdByType": {
"type": "string",
"description": "The type of identity that created the resource.",
"enum": [
"User",
"Application",
"ManagedIdentity",
"Key"
],
"x-ms-enum": {
"name": "createdByType",
"modelAsString": true
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp of resource creation (UTC)."
},
"lastModifiedBy": {
"type": "string",
"description": "The identity that last modified the resource."
},
"lastModifiedByType": {
"type": "string",
"description": "The type of identity that last modified the resource.",
"enum": [
"User",
"Application",
"ManagedIdentity",
"Key"
],
"x-ms-enum": {
"name": "createdByType",
"modelAsString": true
}
},
"lastModifiedAt": {
"type": "string",
"format": "date-time",
"description": "The type of identity that last modified the resource."
}
}
}
},
"parameters": {
Expand Down Expand Up @@ -122,6 +175,49 @@
"maxLength": 50,
"x-ms-parameter-location": "method",
"description": "The namespace name"
},
"PrivateEndpointConnectionNameParameter": {
"name": "privateEndpointConnectionName",
"in": "path",
"required": true,
"type": "string",
"x-ms-parameter-location": "method",
"description": "The PrivateEndpointConnection name"
},
"PrivateLinkResourceNameParameter": {
"name": "privateLinkResourceName",
"in": "path",
"required": true,
"type": "string",
"x-ms-parameter-location": "method",
"description": "The PrivateLinkResource name"
},
"HybridConnectionNameParameter": {
"name": "hybridConnectionName",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"x-ms-parameter-location": "method",
"description": "The hybrid connection name."
},
"AuthorizationRuleNameParameter": {
"name": "authorizationRuleName",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"x-ms-parameter-location": "method",
"description": "The authorization rule name."
},
"RelayNameParameter": {
"name": "relayName",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"x-ms-parameter-location": "method",
"description": "The relay name."
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
{
"swagger": "2.0",
"info": {
"version": "2.0",
"title": "Common types"
},
"paths": {},
"definitions": {
"ProxyResource": {
"title": "Resource",
"description": "Common fields that are returned in the response for all Azure Resource Manager resources",
"type": "object",
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
},
"name": {
"readOnly": true,
"type": "string",
"description": "The name of the resource"
},
"type": {
"readOnly": true,
"type": "string",
"description": "The type of the resource. E.g. \"Microsoft.EventHub/Namespaces\" or \"Microsoft.EventHub/Namespaces/EventHubs\""
},
"location": {
"type": "string",
"readOnly": true,
"description": "The geo-location where the resource lives"
}
},
"x-ms-azure-resource": true
},
"ErrorDetail": {
"description": "The error detail.",
"type": "object",
"properties": {
"code": {
"readOnly": true,
"type": "string",
"description": "The error code."
},
"message": {
"readOnly": true,
"type": "string",
"description": "The error message."
},

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code and message should be "required" (this had to be enforced by service as well)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now using Error Response from common type.

Copy link
Member

@weidongxu-microsoft weidongxu-microsoft Apr 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If no other JSON uses it, can it be removed? Same for SystemData.

If there is other swagger JSON that uses it and they are not by this PR, you can leave it here.

"target": {
"readOnly": true,
"type": "string",
"description": "The error target."
},
"details": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/definitions/ErrorDetail"
},
"x-ms-identifiers": [],
"description": "The error details."
},
"additionalInfo": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/definitions/ErrorAdditionalInfo"
},
"x-ms-identifiers": [],
"description": "The error additional info."
}
}
},
"ErrorResponse": {
"description": "Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.",
"type": "object",
"properties": {
"error": {
"description": "The error object.",
"$ref": "#/definitions/ErrorDetail"
}
}
},
"ErrorAdditionalInfo": {
"type": "object",
"properties": {
"type": {
"readOnly": true,
"type": "string",
"description": "The additional info type."
},
"info": {
"readOnly": true,
"type": "object",
"description": "The additional info."
}
},
"description": "The resource management error additional info."
}
},
"parameters": {}
}
Loading