diff --git a/src/murano-manual/src/docbkx/content/specification.xml b/src/murano-manual/src/docbkx/content/specification.xml index ca5cd4f..5c08280 100644 --- a/src/murano-manual/src/docbkx/content/specification.xml +++ b/src/murano-manual/src/docbkx/content/specification.xml @@ -1094,13 +1094,521 @@
- Active Directory API - This section describes API calls for Active Directory - service management. + Services API + This section describes API calls for managing all types of services. +
+ Calls and Endpoints +
+ GET + Using GET calls to services endpoint user works with list containing all services for + specified environment. User can request whole list, specific service, or specific attribute of + specific service using tree traversing. + + To request specific service user should add to endpoint part with service id, e.g.: + /environments/<id>/services/<service_id>. For selection of + specific attribute on service, simply appending part with attribute name will work. For example + to request service name, user should use next endpoint: + /environments/<id>/services/<service_id>/name + +
+ Call + + GET /environments/<id>/services + Call + + + + + + + Method + URI + + + + + GET + /environments/<id>/services + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + no + ID of valid configuration session + + + +
+
+
+ Payload + None +
+
+ Returns + Json Object +
+
+
+ PUT + Using PUT calls user can update or add any attribute on any service. +
+ Call + + PUT /environments/<id>/services + Call + + + + + + + Method + URI + + + + + PUT + /environments/<id>/services + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + yes + ID of valid configuration session + + + +
+
+
+ Payload + Json Object +
+
+ Returns + Json Object +
+
+
+ POST + POST calls used for adding new elements to lists with objectes. +
+ Call + + POST /environments/<id>/services + Call + + + + + + + Method + URI + + + + + POST + /environments/<id>/services + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + yes + ID of valid configuration session + + + +
+
+
+ Payload + Json Object +
+
+ Returns + Json Object +
+
+
+ DELETE + User can remove any attribute or list item using DELETE calls. +
+ Call + + DELETE /environments/<id>/services + Call + + + + + + + Method + URI + + + + + DELETE + /environments/<id>/services + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + yes + ID of valid configuration session + + + +
+
+
+ Payload + None +
+
+ Returns + None +
+
+
+
+
+ Example Calls using Web Server as example + Please use this example for constructing general CRUD calls to services. +
+ Get a List of existing services +
+ Call + + GET /environments/<id>/services + Call + + + + + + + + Method + URI + Description + + + + + GET + /environments/<id>/services + Get a list of existing WebServers + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + no + ID of valid configuration session + + + +
+
+
+ Payload + None +
+
+ Returns + This call returns list of services: + + + + +
+
+
+ Create Web Server instance +
+ Call + + POST /environments/<id>/services + Call + + + + + + + + Method + URI + Description + + + + + POST + /environments/<id>/services + Create new Web Server + + + +
+ + Headers + + + + + + + + Name + Type + Required + Description + + + + + X-Configuration-Session + string + yes + ID of valid configuration session + + + +
+
+
+ Payload + + + +
+
+ Returns + This call returns created web server: + + + + +
+
+
+
+ Remove Web Server +
+ Call + + DELETE /environments/<id>/services/<service_id> Call + + + + + + + Method + URI + Description + + + + + DELETE + /environments/<id>/services/<service_id> + Remove specified service. + + + + +
+
+
+ Payload + None +
+
+ Returns + None +
+
+
+ Active Directory Specs + This section describes objects specs for Active Directory service.
- Get a List of existing Active Directory instances - + Request Object Specs Active Directory Object @@ -1125,6 +1633,11 @@ string Domain name + + type + string + Service Type + created datetime @@ -1198,102 +1711,9 @@
-
- Call - - GET /environments/<id>/activeDirectories - Call - - - - - - - - Method - URI - Description - - - - - GET - /environments/<id>/activeDirectories - Get a list of Active Directory - instances - - - - -
- - Headers - - - - - - - - Name - Type - Required - Description - - - - - X-Configuration-Session - string - no - ID of valid configuration session - - - -
-
-
- Payload - None -
-
- Returns - This call returns list of Active Directory - instances: - - - - -
- Create Active Directory instance + Create Object Specs Active Directory Object @@ -1316,6 +1736,11 @@ yes Domain name + + type + string + Service Type + adminPassword string @@ -1378,120 +1803,13 @@
-
- Call - - POST /environments/<id>/activeDirectories - Call - - - - - - - - Method - URI - Description - - - - - POST - /environments/<id>/activeDirectories - Create new Active Directory - - - - -
- - Headers - - - - - - - - Name - Type - Required - Description - - - - - X-Configuration-Session - string - yes - ID of valid configuration session - - - -
-
-
- Payload - - - -
-
- Returns - This call returns created active directory - domain: - - - - -
- Web Server API + Web Server Specs This section describes API calls for managing Windows web-server software – IIS.
- Get a List of existing Web Servers + Request Object Specs Web Server Object @@ -1511,6 +1829,11 @@ string Unique ID + + type + string + Service Type + name string @@ -1583,110 +1906,9 @@
-
- Call - - GET /environments/<id>/webServers - Call - - - - - - - - Method - URI - Description - - - - - GET - /environments/<id>/webServers - Get a list of existing Web - Servers - - - - -
- - Headers - - - - - - - - Name - Type - Required - Description - - - - - X-Configuration-Session - string - no - ID of valid configuration session - - - -
-
-
- Payload - None -
-
- Returns - This call returns list of web servers: - - - - -
- Create Web Server instance + Create Object Specs Web Server Object @@ -1709,6 +1931,11 @@ yes User-friendly name + + type + string + Service Type + domain string @@ -1750,102 +1977,15 @@
-
- Call - - POST /environments/<id>/webServers - Call - - - - - - - - Method - URI - Description - - - - - POST - /environments/<id>/webServers - Create new Web Server - - - -
- - Headers - - - - - - - - Name - Type - Required - Description - - - - - X-Configuration-Session - string - yes - ID of valid configuration session - - - -
-
-
- Payload - - - -
-
- Returns - This call returns created web server: - - - - -
- ASP.NET Application API + ASP.NET Application Specs This section describes API calls for managing ASP.NET Applications
- Get a List of existing ASP.NET Applications + Request Object Specs ASP.NET Application Object @@ -1865,6 +2005,11 @@ string Unique ID + + type + string + Service Type + name string @@ -1947,112 +2092,9 @@
-
- Call - - GET /environments/<id>/aspNetApps - Call - - - - - - - - Method - URI - Description - - - - - GET - /environments/<id>/aspNetApps - Get a list of existing ASP.NET - Applications - - - - -
- - Headers - - - - - - - - Name - Type - Required - Description - - - - - X-Configuration-Session - string - no - ID of valid configuration session - - - -
-
-
- Payload - None -
-
- Returns - This call returns list of ASP.NET Applications: - - - - -
- Create ASP.NET Application instance + Create Object Specs ASP.NET Application Object @@ -2075,6 +2117,11 @@ yes User-friendly name + + type + string + Service Type + repository string @@ -2124,95 +2171,6 @@
-
- Call - - POST /environments/<id>/aspNetApps - Call - - - - - - - - Method - URI - Description - - - - - POST - /environments/<id>/aspNetApps - Create new ASP.NET Application - - - -
- - Headers - - - - - - - - Name - Type - Required - Description - - - - - X-Configuration-Session - string - yes - ID of valid configuration session - - - -
-
-
- Payload - - - -
-
- Returns - This call returns created ASP.NET Application: - - - - -
@@ -2221,7 +2179,7 @@ (IIS) Web Farm services
- Get a List of existing Web Server Farms + Request Object Specs Web Server Farm Object @@ -2241,6 +2199,11 @@ string Unique ID + + type + string + Service Type + name string @@ -2316,105 +2279,9 @@
-
- Call - - GET /environments/<id>/webServerFarms - Call - - - - - - - - Method - URI - Description - - - - - GET - /environments/<id>/webServerFarms - Get a list of existing - Web Server Farms - - - - -
- - Headers - - - - - - - - Name - Type - Required - Description - - - - - X-Configuration-Session - string - no - ID of valid configuration session - - - -
-
-
- Payload - None -
-
- Returns - This call returns list of Web Server Farms: - - - - -
- Create Web Server Farm instance + Create Object Specs Web Server Farm Object @@ -2437,6 +2304,11 @@ yes User-friendly name + + type + string + Service Type + loadBalancerPort integer @@ -2484,105 +2356,15 @@
-
- Call - - POST /environments/<id>/webServerFarms - Call - - - - - - - - Method - URI - Description - - - - - POST - /environments/<id>/webServerFarms - Create new Web Server Farm - - - -
- - Headers - - - - - - - - Name - Type - Required - Description - - - - - X-Configuration-Session - string - yes - ID of valid configuration session - - - -
-
-
- Payload - - - -
-
- Returns - This call returns created Web Server Farm: - - - - -
-
ASP.NET Application Farm API This section describes API calls for managing ASP.NET Web Farm Application Services
- Get a List of existing ASP.NET Application Farms + Request Object Specs ASP.NET Application Farm Object @@ -2602,6 +2384,11 @@ string Unique ID + + type + string + Service Type + name string @@ -2689,105 +2476,9 @@
-
- Call - - GET /environments/<id>/aspNetAppFarms - Call - - - - - - - - Method - URI - Description - - - - - GET - /environments/<id>/aspNetAppFarms - Get a list of existing - ASP.NET Application Farms - - - - -
- - Headers - - - - - - - - Name - Type - Required - Description - - - - - X-Configuration-Session - string - no - ID of valid configuration session - - - -
-
-
- Payload - None -
-
- Returns - This call returns list of ASP.NET Application Farms: - - - - -
- Create ASP.NET Application Farm instance + Create Object Specs ASP.NET Application Farm Object @@ -2810,6 +2501,11 @@ yes User-friendly name + + type + string + Service Type + repository string @@ -2865,97 +2561,6 @@
-
- Call - - POST /environments/<id>/aspNetAppFarms - Call - - - - - - - - Method - URI - Description - - - - - POST - /environments/<id>/aspNetAppFarms - Create new ASP.NET Application Farm - - - -
- - Headers - - - - - - - - Name - Type - Required - Description - - - - - X-Configuration-Session - string - yes - ID of valid configuration session - - - -
-
-
- Payload - - - -
-
- Returns - This call returns created ASP.NET Application Farm: - - - - -