Skip to content

Commit

Permalink
Merge branch 'docs/cleanup-4.8'
Browse files Browse the repository at this point in the history
  • Loading branch information
matusmacik committed Mar 14, 2024
2 parents e43e6f3 + 1087310 commit 764a15b
Show file tree
Hide file tree
Showing 141 changed files with 189 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/interfaces/rest/concepts/authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
:page-wiki-metadata-modify-date: 2020-06-02T10:29:25.618+02:00
:page-toc: top
:page-keywords: [ 'rest', 'authentication' ]
:page-upkeep-status: yellow

[TIP]
====
Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/concepts/index.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
= API Concepts
:page-nav-title: API Concepts
:page-display-order: 100
:page-upkeep-status: green

== Description

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/rest/concepts/media-types-rest.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Supported Media Types
:page-nav-title: Supported Media Types
:page-display-order: 300

:page-upkeep-status: green

== Supported media types

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Usage of HTTP Methods
:page-nav-title: Usage of HTTP Methods
:page-display-order: 400

:page-upkeep-status: green

== Use of HTTP Verbs

Expand Down
3 changes: 3 additions & 0 deletions docs/interfaces/rest/concepts/raw/outcome.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:page-upkeep-status: green


=== Response

[%autowidth]
Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/concepts/using-rest-examples.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 500
:page-keywords: [ 'rest', 'examples', 'samples' ]
:page-toc: top
:page-upkeep-status: green

== Introduction

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 900
:page-toc: top
:page-keywords: [ 'rest', 'certification', 'campaign' ,'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 1000
:page-toc: top
:page-keywords: [ 'rest', 'certification', 'definition' ,'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/archetypes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 1200
:page-toc: top
:page-keywords: [ 'rest', 'archetype' ,'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/cases.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 1300
:page-toc: top
:page-keywords: [ 'rest', 'case' ,'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/connector-hosts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 1400
:page-toc: top
:page-keywords: [ 'rest', 'connector', 'host', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/connectors.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 1500
:page-toc: top
:page-keywords: [ 'rest', 'connector' ,'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/dashboards.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 1600
:page-toc: top
:page-keywords: [ 'rest', 'dashboard' ,'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/forms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 1700
:page-toc: top
:page-keywords: [ 'rest', 'form' ,'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 1800
:page-toc: top
:page-keywords: [ 'rest', 'function', 'library','endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/generic-objects.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 1900
:page-toc: top
:page-keywords: [ 'rest', 'generic' ,'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
:page-nav-title: REST Endpoints
:page-display-order: 100
:page-toc: top
:page-upkeep-status: green

== Overview
The REST api provides you with access to a long list of web resources. The web
Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/lookup-tables.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 2100
:page-toc: top
:page-keywords: [ 'rest', 'lookup', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/nodes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 2300
:page-toc: top
:page-keywords: [ 'rest', 'node', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/object-collections.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 2400
:page-toc: top
:page-keywords: [ 'rest', 'object', 'collection', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/object-templates.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 2500
:page-toc: top
:page-keywords: [ 'rest', 'template', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/organizational-units.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 400
:page-toc: top
:page-keywords: [ 'rest', 'organizational', 'unit' , 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/report-data.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 2500
:page-toc: top
:page-keywords: [ 'rest', 'report', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/reports.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 2600
:page-toc: top
:page-keywords: [ 'rest', 'report', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 700
:page-toc: top
:page-keywords: [ 'rest', 'resource', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/roles.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 300
:page-toc: top
:page-keywords: [ 'rest', 'role', 'endpoint' ]
:page-upkeep-status: green

== Role Type REST Endpoint

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/rpc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 2800
:page-toc: top
:page-keywords: [ 'rest', 'rpc', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/security-policies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 2900
:page-toc: top
:page-keywords: [ 'rest', 'security', 'policy', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/sequences.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 3000
:page-toc: top
:page-keywords: [ 'rest', 'sequnce', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 500
:page-toc: top
:page-keywords: [ 'rest', 'service', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/shadows.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 800
:page-toc: top
:page-keywords: [ 'rest', 'shadow', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/system-configurations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 3100
:page-toc: top
:page-keywords: [ 'rest', 'system', 'configuration', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/tasks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 600
:page-toc: top
:page-keywords: [ 'rest', 'task', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/users.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 200
:page-toc: top
:page-keywords: [ 'rest', 'user', 'endpoint' ]
:page-upkeep-status: green

== User Type REST Endpoint

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/endpoints/value-policies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 3200
:page-toc: top
:page-keywords: [ 'rest', 'value', 'password', 'policy', 'endpoint' ]
:page-upkeep-status: green

== Description

Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/operations/create-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 300
:page-toc: top
:page-keywords: [ 'rest', 'create', 'operation' ]
:page-upkeep-status: green

== Create With Rest
Request to create a midPoint object based on data provided in the body of the request.
Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/operations/delete-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:page-display-order: 400
:page-toc: top
:page-keywords: [ 'rest', 'delete', 'opeation' ]
:page-upkeep-status: green

== Delete With Rest
Request to delete a midPoint object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
:page-nav-title: Access Request Approval
:page-display-order: 800
:page-toc: top
:page-upkeep-status: green

== Description

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
:page-nav-title: Access Request
:page-display-order: 700
:page-toc: top
:page-upkeep-status: green

== Description
The example represents a use-case, where an authorized user requests for membership to a specific role from the role catalogue.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
:page-nav-title: Create Object
:page-display-order: 400
:page-toc: top
:page-upkeep-status: green

== Description
Example of creating an midPoint object either representing some identity data in the
Expand Down
1 change: 1 addition & 0 deletions docs/interfaces/rest/operations/examples/create-user.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
:page-nav-title: Create User
:page-display-order: 500
:page-toc: top
:page-upkeep-status: green

== Description
Example of creating an midPoint object representing some identity data in the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
:page-nav-title: Get User Self
:page-display-order: 800
:page-toc: top
:page-upkeep-status: green

== Description
Example of retrieving identity data from a web resource object representing a user. In this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
:page-nav-title: Get user based on his unique identificator
:page-display-order: 200
:page-toc: top
:page-upkeep-status: green

== Description
Example of retrieving identity data from a web resource object representing a user.
Expand Down
6 changes: 6 additions & 0 deletions docs/interfaces/rest/operations/examples/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ Additionally, each REST endpoint (REST object type) has some basic examples pres
For the list of endpoints please consult the xref:/midpoint/reference/interfaces/rest/endpoints/[following] page.


=== User Story Examples

++++
{% children %}
++++

== See Also

- xref:/midpoint/reference/interfaces/rest/concepts/media-types-rest/[Supported Media Types]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
:page-visibility: hidden
:page-upkeep-status: green

.*Create Access Certification Campaign*
[source,bash]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
:page-visibility: hidden
:page-upkeep-status: green

.*Create a new Organizational Unit object in MidPoint with file data source*
[source,bash]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
:page-visibility: hidden
:page-upkeep-status: green

.*Create a new Report regarding Error audit records in 24h*
[source,bash]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
:page-visibility: hidden
:page-upkeep-status: green

.*Create a new Resource object in MidPoint with file data source*
[source,bash]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
:page-visibility: hidden
:page-upkeep-status: green

.*Create a new Role object in MidPoint with file data source*
[source,bash]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
:page-visibility: hidden
:page-upkeep-status: green

.*Create a new Task for Report Execution*
[source,bash]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
:page-visibility: hidden
:page-upkeep-status: green

.*Create a new Task object in MidPoint with file data source*
[source,bash]
Expand Down

0 comments on commit 764a15b

Please sign in to comment.