REST docu content modifications, operations index page xrefs added

Evolveum · Feb 21, 2024 · 1fe4374 · 1fe4374
1 parent ffd038d
commit 1fe4374
Showing 1 changed file with 24 additions and 24 deletions.
diff --git a/docs/interfaces/rest/operations/index.adoc b/docs/interfaces/rest/operations/index.adoc
@@ -25,7 +25,7 @@ To specify option, use query parameters, e.g. http://localhots:8080/midpoint/api
 |===
 | Operation name | Operation type | Path | Supported options | Data | Response
 
-| Create new object
+| xref:/midpoint/reference/interfaces/rest/operations/create-op-rest.adoc[Create new object]
 | POST
 | /\{type}
 | link:https://evolveum.com/downloads/midpoint/latest/midpoint-latest-schemadoc/http---midpoint-evolveum-com-xml-ns-public-common-common-3/type/ModelExecuteOptionsType.html[ModelExecuteOptionsType]
@@ -35,7 +35,7 @@ a| * 201 Created, Location set to point to the newly created object
 * 250 Partial error, xref:/midpoint/architecture/concepts/operation-result/[OperationResult] is returned in the body
 
 
-| Create or update object
+| xref:/midpoint/reference/interfaces/rest/operations/create-op-rest.adoc[Create or update object]
 | PUT
 | /\{type}/\{oid}
 | link:https://evolveum.com/downloads/midpoint/latest/midpoint-latest-schemadoc/http---midpoint-evolveum-com-xml-ns-public-common-common-3/type/ModelExecuteOptionsType.html[ModelExecuteOptionsType]
@@ -45,15 +45,15 @@ a| * 201 Created, Location set to point to the newly created object
 * 250 Partial error, xref:/midpoint/architecture/concepts/operation-result/[OperationResult] is returned in the body
 
 
-| Get object
+| xref:/midpoint/reference/interfaces/rest/operations/get-op-rest.adoc[Get object]
 | GET
 | /\{type}/\{oid}
 | link:https://github.com/Evolveum/midpoint/blob/731e408905650d81ecab410f1f1c4f07a0d8795c/infra/schema/src/main/java/com/evolveum/midpoint/schema/GetOperationOptions.java[GetOperationOptionsType]
 | -
 a| * 200 OK, current object in the response body
 
 
-| Modify object
+| xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest.adoc[Modify object]
 | PATCH, POST
 | /\{type}/\{oid}
 | link:https://evolveum.com/downloads/midpoint/latest/midpoint-latest-schemadoc/http---midpoint-evolveum-com-xml-ns-public-common-common-3/type/ModelExecuteOptionsType.html[ModelExecuteOptionsType]
@@ -63,7 +63,7 @@ a| * 204 No Content
 * 250 Partial error, xref:/midpoint/architecture/concepts/operation-result/[OperationResult] is returned in the body
 
 
-| Delete object
+| xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest.adoc[Delete object]
 | DELETE
 | /\{type}/\{oid}
 | link:https://evolveum.com/downloads/midpoint/latest/midpoint-latest-schemadoc/http---midpoint-evolveum-com-xml-ns-public-common-common-3/type/ModelExecuteOptionsType.html[ModelExecuteOptionsType]
@@ -73,70 +73,70 @@ a| * 204 No Content
 * 250 Partial error, xref:/midpoint/architecture/concepts/operation-result/[OperationResult] is returned in the body
 
 
-| Test (configured) Resource
+| xref:/midpoint/reference/interfaces/rest/operations/resource-op-rest.adoc[Test (configured) Resource]
 | POST
 | /resources/\{oid}/test
 | No
 | -
 a| * 200 OK, result of the test operation in the body
 
 
-| Import from Resource
+| xref:/midpoint/reference/interfaces/rest/operations/resource-op-rest.adoc[Import from Resource]
 | POST
 | /resources/\{oid}/import/\{objectClass}
 | No
 | -
 a| * 303 See Other, Location set to point to the concrete "import" task
 
 
-| Find owner of shadow
+| xref:/midpoint/reference/interfaces/rest/operations/shadow-op-rest.adoc[Find owner of shadow]
 | GET
 | /shadows/\{oid}/owner
 | No
 | -
 a| * 200 OK, owner of the shadow returned in the response body
 
 
-| Import shadow
+| xref:/midpoint/reference/interfaces/rest/operations/shadow-op-rest.adoc[Import shadow]
 | POST
 | /shadows/\{oid}/import
 | No
 | -
 a| * 200 OK, result of the import operation in the body
 
 
-| Search
+| xref:/midpoint/reference/interfaces/rest/operations/shadow-op-rest.adoc[Search]
 | POST
 | /\{type}/search
 | link:https://github.com/Evolveum/midpoint/blob/731e408905650d81ecab410f1f1c4f07a0d8795c/infra/schema/src/main/java/com/evolveum/midpoint/schema/GetOperationOptions.java[GetOperationOptionsType]
 | xref:/midpoint/reference/concepts/query/[Query] in XML format
 a| * 200 OK, list of found objects in the body
 
 
-| Suspend tasks
+| xref:/midpoint/reference/interfaces/rest/operations/task-specific-op-rest.adoc[Suspend tasks]
 | POST
 | /tasks/\{oid}/suspend
 | No
 | -
 a| * 204 No Content
 
 
-| Resume tasks
+| xref:/midpoint/reference/interfaces/rest/operations/task-specific-op-rest.adoc[Resume tasks]
 | POST
 | /tasks/\{oid}/resume
 | No
 | -
 a| * 202 Accepted
 
 
-| Schedule task now
+| xref:/midpoint/reference/interfaces/rest/operations/task-specific-op-rest.adoc[Schedule task now]
 | POST
 | /tasks/\{oid}/run
 | No
 | -
 a| * 202 Accepted
 
-
+//TODO
 | Notify change
 | POST
 | /notifyChange
@@ -145,7 +145,7 @@ a| * 202 Accepted
 a| * 200 OK
 
 
-| Generate value for concrete object
+| xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest.adoc[Generate value for concrete object]
 | POST
 | /\{type}/\{oid}/generate
 | No
@@ -155,7 +155,7 @@ a| * 200 OK
 * 250 Partial error, xref:/midpoint/architecture/concepts/operation-result/[OperationResult] is returned in the body
 
 
-| Generate value
+| xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-op-rest.adoc[Generate value]
 | POST
 | /rpc/generate
 | No
@@ -165,7 +165,7 @@ a| * 200 OK
 * 250 Partial error, xref:/midpoint/architecture/concepts/operation-result/[OperationResult] is returned in the body
 
 
-| Validate value for concrete object
+| xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest.adoc[Validate value for concrete object]
 | POST
 | /\{type}/\{oid}/validate
 | No
@@ -175,7 +175,7 @@ a| * 200 OK
 * 250 Partial error, xref:/midpoint/architecture/concepts/operation-result/[OperationResult] is returned in the body
 
 
-| Validate value
+| xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-op-rest.adoc[Validate value]
 | POST
 | /rpc/validate
 | No
@@ -185,31 +185,31 @@ a| * 200 OK
 * 250 Partial error, xref:/midpoint/architecture/concepts/operation-result/[OperationResult] is returned in the body
 
 
-| Get user's value policy
+| xref:/midpoint/reference/interfaces/rest/operations/user-specific-op-rest.adoc[Get user's value policy]
 | GET
 | /users/\{oid}/policy
 | No
 |
 a| * 200 OK, value policy for user in the response body
 
 
-| Get 'self'
+| xref:/midpoint/reference/interfaces/rest/operations/get-op-rest.adoc[Get 'self']
 | GET
 | /self
 | No
 |
 a| * 200 OK, current object in the response body
 
-
-| Search objects by type
+//TODO
+| xref:/midpoint/reference/interfaces/rest/operations/search-op-rest.adoc[Search objects by type]
 | GET
 | /\{type}
 | link:https://github.com/Evolveum/midpoint/blob/731e408905650d81ecab410f1f1c4f07a0d8795c/infra/schema/src/main/java/com/evolveum/midpoint/schema/GetOperationOptions.java[GetOperationOptionsType]
 |
 a| * 200 OK, list of object of specified type in the response body
 
 
-| Reset credentials
+| xref:/midpoint/reference/interfaces/rest/operations/user-specific-op-rest.adoc[Reset credentials]
 | POST
 | /users/\{oid}/credential
 | No
@@ -218,7 +218,7 @@ a| * 200 OK, ExecuteCredentialResetResponseType returned in the body.
 
 
 
-| Execute script
+| xref:/midpoint/reference/interfaces/rest/operations/script-execute-op-rest.adoc[Execute script]
 | POST
 | /rpc/executeScript
 | No