REST doc updates, Resource types header changes and some modes before…

… 'dirty' launch

docs/interfaces/rest/resource-types/access-certification-campaign-type.adoc

@@ -1,8 +1,8 @@
 = Access Certification Campaign Type Web Resource
 :page-nav-title: REST API Access Certification Campaign Resource
-:page-display-order: 100
-// :page-since: "4.4"
-// :page-since-improved: [ "4.5", "4.6", "4.7", "4.8" ]
+:page-display-order: 900
+:page-toc: top
+
 
 == Description
 
@@ -21,12 +21,14 @@ accessCertificationCampaigns/
 The Access Certification Campaign web resource is a part of the Create-Read-Update-Delete (CRUD) web resources
 present in midPoint. This is apparent in the operations which are available for this type of object.
 
-- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
+
+-- TODO
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
 
 
 == JSON Example

docs/interfaces/rest/resource-types/access-certification-definition-type.adoc

@@ -1,8 +1,8 @@
 = Access Certification Definition Type Web Resource
 :page-nav-title: REST API Access Certification Definition Resource
-:page-display-order: 100
-// :page-since: "4.4"
-// :page-since-improved: [ "4.5", "4.6", "4.7", "4.8" ]
+:page-display-order: 1000
+:page-toc: top
+
 
 == Description
 
@@ -19,12 +19,15 @@ accessCertificationDefinitions/
 The Access Certification Definition web resource is a part of the Create-Read-Update-Delete (CRUD) web resources
 present in midPoint. This is apparent in the operations which are available for this type of object.
 
-- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest.adoc/[Generate and Validate Operations]
+-- TODO
+
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest.adoc/[Generate and
+// Validate Operations]
 
 == JSON Example
 

docs/interfaces/rest/resource-types/archetypes.adoc

@@ -1,8 +1,7 @@
 = Archetype Type Web Resource
 :page-nav-title: REST API Archetype Resource
-:page-display-order: 100
-// :page-since: "4.4"
-// :page-since-improved: [ "4.5", "4.6", "4.7", "4.8" ]
+:page-display-order: 1200
+:page-toc: top
 
 == Description
 
@@ -20,12 +19,14 @@ archetypes/
 The Archetype web resource is a part of the Create-Read-Update-Delete (CRUD) web resources
 present in midPoint. This is apparent in the operations which are available for this type of object.
 
-- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
+-- TODO
+
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
 
 == JSON Example
 

docs/interfaces/rest/resource-types/cases.adoc

@@ -1,8 +1,7 @@
 = Case Type Web Resource
 :page-nav-title: REST API Case Resource
-:page-display-order: 100
-// :page-since: "4.4"
-// :page-since-improved: [ "4.5", "4.6", "4.7", "4.8" ]
+:page-display-order: 1300
+:page-toc: top
 
 == Description
 
@@ -20,12 +19,14 @@ cases/
 The Case web resource is a part of the Create-Read-Update-Delete (CRUD) web resources
 present in midPoint. This is apparent in the operations which are available for this type of object.
 
-- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
+-- TODO
+
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
 
 
 == JSON Example

docs/interfaces/rest/resource-types/connector-hosts.adoc

@@ -1,8 +1,7 @@
 = Connector Host Type Web Resource
 :page-nav-title: REST API Connector Host Resource
-:page-display-order: 100
-// :page-since: "4.4"
-// :page-since-improved: [ "4.5", "4.6", "4.7", "4.8" ]
+:page-display-order: 1400
+:page-toc: top
 
 == Description
 
@@ -20,12 +19,14 @@ connectorHosts/
 The Connector Host web resource is a part of the Create-Read-Update-Delete (CRUD) web resources
 present in midPoint. This is apparent in the operations which are available for this type of object.
 
-- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
+-- TODO
+
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
 
 == JSON Example
 

docs/interfaces/rest/resource-types/connectors.adoc

@@ -1,8 +1,7 @@
 = Connector Type Web Resource
 :page-nav-title: REST API Connector Resource
-:page-display-order: 100
-// :page-since: "4.4"
-// :page-since-improved: [ "4.5", "4.6", "4.7", "4.8" ]
+:page-display-order: 1500
+:page-toc: top
 
 == Description
 
@@ -20,12 +19,15 @@ connectors/
 The Connector web resource is a part of the Create-Read-Update-Delete (CRUD) web resources
 present in midPoint. This is apparent in the operations which are available for this type of object.
 
-- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest.adoc/[Generate and Validate Operations]
+
+-- TODO
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest.adoc/[Generate and
+//Validate Operations]
 
 
 == JSON Example

docs/interfaces/rest/resource-types/dashboards.adoc

@@ -1,8 +1,7 @@
 = Dashboard type Web Resource
 :page-nav-title: REST API Dashboard Resource
-:page-display-order: 100
-// :page-since: "4.4"
-// :page-since-improved: [ "4.5", "4.6", "4.7", "4.8" ]
+:page-display-order: 1600
+:page-toc: top
 
 == Description
 
@@ -20,12 +19,14 @@ dashboards/
 The Dashboard web resource is a part of the Create-Read-Update-Delete (CRUD) web resources
 present in midPoint. This is apparent in the operations which are available for this type of object.
 
-- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
+-- TODO
+
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
 
 == JSON Example
 

docs/interfaces/rest/resource-types/forms.adoc

@@ -1,8 +1,7 @@
 = Form Type Web Resource
 :page-nav-title: REST API Form Resource
-:page-display-order: 100
-// :page-since: "4.4"
-// :page-since-improved: [ "4.5", "4.6", "4.7", "4.8" ]
+:page-display-order: 1700
+:page-toc: top
 
 == Description
 
@@ -20,12 +19,14 @@ forms/
 The Form web resource is a part of the Create-Read-Update-Delete (CRUD) web resources
 present in midPoint. This is apparent in the operations which are available for this type of object.
 
-- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
+-- TODO
+
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
 
 
 == JSON Example

docs/interfaces/rest/resource-types/functions.adoc

@@ -1,8 +1,7 @@
 = Function Library Type Web Resource
 :page-nav-title: REST API Function Resource
-:page-display-order: 100
-// :page-since: "4.4"
-// :page-since-improved: [ "4.5", "4.6", "4.7", "4.8" ]
+:page-display-order: 1800
+:page-toc: top
 
 == Description
 
@@ -20,12 +19,14 @@ functionLibraries/
 The Function Library web resource is a part of the Create-Read-Update-Delete (CRUD) web resources
 present in midPoint. This is apparent in the operations which are available for this type of object.
 
-- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
+-- TODO
+
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
 
 
 == JSON Example

docs/interfaces/rest/resource-types/generic-objects.adoc

@@ -1,8 +1,7 @@
 = Generic Object Type Web Resource
 :page-nav-title: REST API Generic Object Resource
-:page-display-order: 100
-// :page-since: "4.4"
-// :page-since-improved: [ "4.5", "4.6", "4.7", "4.8" ]
+:page-display-order: 1900
+:page-toc: top
 
 == Description
 
@@ -20,12 +19,14 @@ genericObjects/
 The Generic Objet type web resource is a part of the Create-Read-Update-Delete (CRUD) web resources
 present in midPoint. This is apparent in the operations which are available for this type of object.
 
-- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
-- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
+-- TODO
+
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
 
 
 == JSON Example

docs/interfaces/rest/resource-types/index.adoc

@@ -1,7 +1,7 @@
 = Web Resource Types
 :page-nav-title: Web Resource Types
 :page-display-order: 100
-
+:page-toc: top
 
 == Overview
 The REST api provides you with access to a long list of web resources. The web
@@ -132,11 +132,9 @@ the complete *list of supported operations*.
 
 === General Classification of Web Resource Types
 
---TODO simplify
-
 MidPoint REST API is not entirely RESTful.
 There are operations that would be very difficult and very inefficient if modeled as pure RESTful web resource - just because the very nature of those operations is to invoke an operation.
-Therefore the API web resources are divided into two broad categories:
+Therefore, the API web resources are divided into two broad categories:
 
 * *Create-Read-Update-Delete (CRUD) web resources*: Those resources try to adhere to the RESTful approach as close as possible (a.k.a. "almost real REST web resources"). Those resources support the full range of HTTP verbs and they almost behave in a way that can be expected from a RESTful API.
 Those resources can be subdivided into two groups: +
@@ -152,7 +150,7 @@ Typical example is a web resource that represents all users (e.g. URI `.../ws/re
 
 * *Remote Procedure Call (RPC) web resources*: Those are simply endpoints for RPC-like operations.
 They typically support only POST operation.
-There are also two sub-groups:
+There are also two subgroups:
 
 ** *Object-related RPC operations*: Operations that deal with a specific midPoint object.
 They are hierarchically located in the namespace of that object.
@@ -161,7 +159,9 @@ Speaking strict REST those operations might in fact be modeled as state changes
 But we have decided to model those operations as RPC-like for several reasons.
 Those are non-trivial operations that may have complex consequences, the operations may fail in a non-trivial way, we may need to execute them in an asynchronous mode in the future and so on.
 Modeling those as state changes would pollute both the server and the client code with a lot of special-case-handling code and it would make everything more complex and fragile.
-Therefore we have decided not to follow strict REST guidelines here and to model those operations as RPC.
+Therefore, we have decided not to follow strict REST guidelines here and to model those operations as RPC.
 
 ** *Global RPC operations:* Operations that do not deal with any specific object, operations that deal with broad selection of objects or simply operations that cannot be classified to any of the above categories.
 Typical example is an execution of a xref:/midpoint/reference/misc/bulk/[bulk action].
+
+== See Also