Skip to content

Adding swagger spec for MachineLearning/webservices RP #279

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

Closed
tudordid wants to merge 21 commits into from
Closed

Adding swagger spec for MachineLearning/webservices RP #279

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
48046f2
Porting Klein's initial changes to new fork
tudordid Mar 23, 2016
dfe1b3e
Adapt swagger spec to latest RP wire contracts
tudordid Mar 23, 2016
f4d49e3
Merge pull request #1 from tudordid/dev
tudordid Mar 24, 2016
114b445
Updated spec to refelct current state of RP / RRS wire contracts
tudordid Mar 28, 2016
e33471a
More updates to the swagger schema
tudordid Mar 30, 2016
18744fd
Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs
tudordid Mar 30, 2016
51bb867
Fetched latest changes from origin
tudordid Mar 30, 2016
541ff45
Made PUT/PATCH/DELETE web services long running to account for async …
tudordid Mar 31, 2016
6bffce3
- Fix DeleteWebService reesponse definition
tudordid Apr 4, 2016
74ee5fb
Fix PaginatedWebServicesList to have "value" property instead of "val…
tudordid Apr 5, 2016
52ab7c8
Added missing values to ProvisioningState enum
tudordid Apr 5, 2016
389cd88
- added type property to GraphParameter of enum type ParameterType
tudordid Apr 11, 2016
03a7d33
Refactored global parameters definition to allow generation of some …
tudordid Apr 13, 2016
067680e
Add potential 204 response code on delete when resource does not exist
tudordid Apr 15, 2016
4564cd4
Changes to swagger spec to reflect sevice changes:
tudordid Apr 15, 2016
9d8a79d
added metadata and parameters properties to the asset contract to sup…
tudordid Apr 20, 2016
d160c9e
porting changes to schema to the 2016-05-01 version also
tudordid Apr 21, 2016
3d49dfe
Renamed asset location property to 'locationInfo'
tudordid Apr 21, 2016
b968aa3
remove obsolete now spec
tudordid Apr 26, 2016
2924baa
added missing documentation for module asset parameters
tudordid Apr 27, 2016
6af9b08
Synced fork with origin
tudordid Apr 29, 2016
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
Prev Previous commit
Next Next commit
More updates to the swagger schema
  • Loading branch information
@tudordid
tudordid committed Mar 30, 2016
commit e33471abb8047176890ce80165aec0901b9e1a23
168 changes: 53 additions & 115 deletions arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,32 +383,40 @@
"type": "boolean",
"description": "True, if the Web Service should be read-only; False, otherwise"
},
"swaggerUri": {
"swaggerLocation": {
"type": "string",
"description": "The uri for the swagger spec associated with this web service"
},
"realtimeConfiguration": {
"description": "[TODO] Realtime configuration",
"$ref": "#/definitions/RealtimeConfiguration"
},
"diagnostics": {
"description": "[TODO] Diagnostics settings",
"$ref": "#/definitions/DiagnosticsConfiguration"
},
"storageAccount": {
"description": "[TODO] BYOS description",
"$ref": "#/definitions/StorageAccount"
},
"machineLearningWorkspace": {
"description": "[TODO] Service workspace data",
"$ref": "#/definitions/MachineLearningWorkspace"
},
"commitmentPlan": {
"description": "[TODO] Service commitment plan data",
"$ref": "#/definitions/CommitmentPlan"
},
"input": {
"$ref": "#/definitions/ModuleInterfaceSchema"
"description": "[TODO] Service input definition",
"$ref": "#/definitions/ServiceInputOutputSpecification"
},
"output": {
"$ref": "#/definitions/ModuleInterfaceSchema"
"description": "[TODO] Service output definition",
"$ref": "#/definitions/ServiceInputOutputSpecification"
},
"assets": {
"description": "[TODO] Service assets",
"$ref": "#/definitions/AssetProperties"
},
"parameters": {
Expand All @@ -424,7 +432,11 @@
"enum": [
"Code",
"Graph"
]
],
"x-ms-enum": {
"name": "PackageType",
"modelAsString": false
}
}
}
},
Expand All @@ -442,10 +454,10 @@
"description": "[TODO] Graph Package",
"properties": {
"nodes": {
"type": "array",
"type": "object",
"description": "[TODO] Graph nodes collection",
"items": {
"$ref": "#/definitions/GraphNodeKeyPair"
"additionalProperties": {
"$ref": "#/definitions/GraphNode"
}
},
"edges": {
Expand All @@ -456,10 +468,10 @@
}
},
"graphParameters": {
"type": "array",
"type": "object",
"description": "[TODO] Graph parameter collection",
"items": {
"$ref": "#/definitions/GraphParameterKeyPair"
"additionalProperties": {
"$ref": "#/definitions/GraphParameter"
}
}
}
Expand Down Expand Up @@ -594,22 +606,23 @@
"None",
"Error",
"All"
]
],
"x-ms-enum": {
"name": "DiagnosticsLevel",
"modelAsString": false
}
},
"expiry": {
"type": "string",
"description": "[TODO] Expiry"
"description": "[TODO] Expiry date",
"format": "date-time"
}
}
},
"StorageAccount": {
"type": "object",
"description": "[TODO] The Storage Account used in GraphSharp",
"properties": {
"id": {
"type": "string",
"description": "[TODO] The storage account's Id"
},
"name": {
"type": "string",
"description": "[TODO] The storage account's name"
Expand Down Expand Up @@ -644,7 +657,7 @@
}
}
},
"ModuleInterfaceSchema": {
"ServiceInputOutputSpecification": {
"type": "object",
"description": "[TODO] The swagger schema describing the service's input.",
"properties": {
Expand All @@ -656,25 +669,21 @@
"type": "string",
"description": "[TODO] Description of the interface"
},
"format": {
"type": "string",
"description": "[TODO] Format of the interface"
},
"type": {
"type": "string",
"description": "[TODO] Interface properties' type. Always use 'object' here.",
"default": "object"
},
"properties": {
"type": "array",
"description": "[TODO]",
"items": {
"$ref": "#/definitions/DataTableKeyValuePair"
"type": "object",
"description": "[TODO]",
"additionalProperties": {
"$ref": "#/definitions/TableSpecification"
}
}
}
},
"DataTableSchema": {
"TableSpecification": {
"type": "object",
"description": "[TODO] schema for a data table",
"properties": {
Expand All @@ -691,31 +700,16 @@
"description": "[TODO] Table properties' type. Always use 'object' here.",
"default": "object"
},
"format": {
"type": "string",
"description": "[TODO] Table format"
},
"properties": {
"type": "array",
"type": "object",
"description": "The set of columns within the data table",
"items": {
"$ref": "#/definitions/DataTableColumnKeyPair"
"additionalProperties": {
"$ref": "#/definitions/ColumnSpecification"
}
}
}
},
"DataTableKeyValuePair": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"$ref": "#/definitions/DataTableSchema"
}
}
},
"DataTableColumnSchema": {
"ColumnSpecification": {
"type": "object",
"description": "[TODO] input column.",
"properties": {
Expand Down Expand Up @@ -744,17 +738,6 @@
}
}
},
"DataTableColumnKeyPair": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"$ref": "#/definitions/DataTableColumnSchema"
}
}
},
"AssetProperties": {
"type": "object",
"additionalProperties": {
Expand All @@ -780,20 +763,14 @@
"inputPorts": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AssetPort"
"$ref": "#/definitions/InputPort"
}
},
"outputPorts": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AssetPort"
"$ref": "#/definitions/OutputPort"
}
},
"parameters": {
"$ref": "#/definitions/AssetParameters"
},
"metadata": {
"$ref": "#/definitions/AssetMetadata"
}
}
},
Expand All @@ -812,30 +789,24 @@
}
}
},
"AssetPort": {
"InputPort": {
"type": "object",
"description": "[TODO] Asset Port",
"description": "[TODO] Asset input port",
"properties": {
"type": {
"type": "string",
"description": "[TODO] dataset or zip"
}
}
},
"AssetParameters": {
"OutputPort": {
"type": "object",
"description": "[TODO] Asset parameters",
"additionalProperties": {
"type": "string",
"description": "[TODO] Parameter value"
}
},
"AssetMetadata": {
"type": "object",
"description": "[TODO] Asset metadata",
"additionalProperties": {
"type": "string",
"description": "[TODO] Metadata value"
"description": "[TODO] Asset output port",
"properties": {
"type": {
"type": "string",
"description": "[TODO] dataset or zip"
}
}
},
"GraphNode": {
Expand Down Expand Up @@ -863,17 +834,6 @@
}
}
},
"GraphNodeKeyPair": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"$ref": "#/definitions/GraphNode"
}
}
},
"GraphEdge": {
"type": "object",
"description": "[TODO] Graph edge",
Expand All @@ -882,15 +842,15 @@
"type": "string",
"description": "[TODO] Edge source"
},
"sourceOutputPortId": {
"sourcePortId": {
"type": "string",
"description": "[TODO] Source node output port id"
},
"targetNodeId": {
"type": "string",
"description": "[TODO] Edge target"
},
"targetInputPortId": {
"targetPortId": {
"type": "string",
"description": "[TODO] Target node input port id"
}
Expand All @@ -910,13 +870,6 @@
"items": {
"$ref": "#/definitions/GraphParameterLink"
}
},
"parameterRules": {
"type": "array",
"description": "[TODO] Rules for this parameter",
"items": {
"$ref": "#/definitions/GraphParameterRule"
}
}
}
},
Expand All @@ -933,22 +886,7 @@
"description": "[TODO] The parameter key"
}
}
},
"GraphParameterRule": {
"type": "object",
"description": "[TODO] A rule for a graph parameter"
},
"GraphParameterKeyPair": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"$ref": "#/definitions/GraphParameter"
}
}
},
},
"Resource": {
"required": [
"location"
Expand Down