REST docu change, addition of Example HOW TO ref to operation pages

Evolveum · Mar 6, 2024 · cf13d17 · cf13d17
1 parent 5ce96ec
commit cf13d17
Show file tree

Hide file tree

Showing 13 changed files with 55 additions and 0 deletions.
diff --git a/docs/interfaces/rest/operations/create-op-rest.adoc b/docs/interfaces/rest/operations/create-op-rest.adoc
@@ -84,6 +84,11 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
+
 include::../operations/examples/raw/create-user-jack.adoc[]
 
 == See Also

diff --git a/docs/interfaces/rest/operations/delete-op-rest.adoc b/docs/interfaces/rest/operations/delete-op-rest.adoc
@@ -48,6 +48,11 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
+
 include::../../rest/operations/examples/raw/delete-user.adoc[]
 
 include::../../rest/operations/examples/raw/delete-role.adoc[]

diff --git a/docs/interfaces/rest/operations/generate-and-validate-concrete-op-rest.adoc b/docs/interfaces/rest/operations/generate-and-validate-concrete-op-rest.adoc
@@ -80,6 +80,11 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
+
 include::../../rest/operations/examples/raw/role-id-generate.adoc[]
 
 include::../../rest/operations/examples/raw/modify-id-generate.adoc[]

diff --git a/docs/interfaces/rest/operations/generate-and-validate-op-rest.adoc b/docs/interfaces/rest/operations/generate-and-validate-op-rest.adoc
@@ -75,6 +75,10 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
 include::../../rest/operations/examples/raw/validate-value-rpc.adoc[]
 
 == See Also

diff --git a/docs/interfaces/rest/operations/get-op-rest.adoc b/docs/interfaces/rest/operations/get-op-rest.adoc
@@ -175,6 +175,10 @@ had some technical information and metadata related to the environment removed b
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
 include::../operations/examples/raw/get-user-administrator.adoc[]
 
 .Additional examples

diff --git a/docs/interfaces/rest/operations/modify-op-rest.adoc b/docs/interfaces/rest/operations/modify-op-rest.adoc
@@ -81,6 +81,10 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
 include::../../rest/operations/examples/raw/modify-attr-user.adoc[]
 include::../../rest/operations/examples/raw/modify-attr.adoc[]
 

diff --git a/docs/interfaces/rest/operations/notify-op-rest.adoc b/docs/interfaces/rest/operations/notify-op-rest.adoc
@@ -73,6 +73,10 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
 include::../../rest/operations/examples/raw/notify-change-password.adoc[]
 
 == See Also

diff --git a/docs/interfaces/rest/operations/resource-op-rest.adoc b/docs/interfaces/rest/operations/resource-op-rest.adoc
@@ -73,6 +73,10 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
 include::../../rest/operations/examples/raw/test-resource.adoc[]
 include::../../rest/operations/examples/raw/import-from-resource.adoc[]
 

diff --git a/docs/interfaces/rest/operations/script-execute-op-rest.adoc b/docs/interfaces/rest/operations/script-execute-op-rest.adoc
@@ -77,6 +77,10 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
 include::../../rest/operations/examples/raw/execute-script-rpc.adoc[]
 
 == See Also

diff --git a/docs/interfaces/rest/operations/search-op-rest.adoc b/docs/interfaces/rest/operations/search-op-rest.adoc
@@ -77,6 +77,10 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
 include::../../rest/operations/examples/raw/search-all-users.adoc[]
 include::../../rest/operations/examples/raw/search-all.adoc[]
 

diff --git a/docs/interfaces/rest/operations/shadow-op-rest.adoc b/docs/interfaces/rest/operations/shadow-op-rest.adoc
@@ -74,6 +74,10 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
 include::../../rest/operations/examples/raw/get-shadow-owner.adoc[]
 
 include::../../rest/operations/examples/raw/import-shadow.adoc[]

diff --git a/docs/interfaces/rest/operations/task-specific-op-rest.adoc b/docs/interfaces/rest/operations/task-specific-op-rest.adoc
@@ -82,6 +82,10 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
 include::../../rest/operations/examples/raw/task-op-suspend.adoc[]
 
 include::../../rest/operations/examples/raw/task-op-resume.adoc[]

diff --git a/docs/interfaces/rest/operations/user-specific-op-rest.adoc b/docs/interfaces/rest/operations/user-specific-op-rest.adoc
@@ -80,6 +80,10 @@ include::../../rest/concepts/raw/outcome.adoc[]
 
 include::../raw/curl-env-note.adoc[]
 
+For some help regarding the REST examples please see this link:
+
+xref:/midpoint/reference/interfaces/rest/concepts/using-rest-examples.adoc[How to use MidPoint REST examples]
+
 include::../../rest/operations/examples/raw/user-get-value-policy.adoc[]
 
 include::../../rest/operations/examples/raw/user-pwd-reset.adoc[]