WIP: Add developer documentation

doc/developer/apis/administrative.md

@@ -0,0 +1,15 @@
+# Administrative REST API
+
+This section provides information of the administrative end-points including examples of requests and responses.
+
+TBD
+
+## Domains endpoint
+
+This endpoint is used to manage integration domains.
+
+### POST/ Add Domain
+### GET/ Get Domain by ID
+### DELETE/ Delete Domain by ID
+### GET/ Get Domains
+### PUT/ Update Domain

doc/developer/apis/creds.md

@@ -0,0 +1,4 @@
+# Credentials Validation
+
+TBD
+

doc/developer/apis/rest-apis.md

@@ -0,0 +1,9 @@
+# Available ipa-tuura REST APIs
+
+This section describes the ipa-tuura APIs relevant for developers.
+
+## Authentication and Authorization
+
+How requests to REST APIs are authenticated and authorized in ipa-tuura.
+
+TBD

doc/developer/apis/scimv2.md

@@ -0,0 +1,38 @@
+# SCIMv2.0 REST API
+
+The ipa-tuura SCIMv2.0 REST API implements the SCIM 2.0 Protocol according to the [SCIM 2.0 specification.](https://tools.ietf.org/html/rfc7644).
+
+## Users endpoint
+
+This endpoint is used to create and manage users.
+
+### POST/ Create User
+### GET/ Get User by ID
+### DELETE/ Delete User by ID
+### GET/ Get Users
+### POST/ Search Users
+### PATCH/ Update User
+### PUT/ Update User
+
+## Groups endpoint
+
+This endpoint is used to create and manage groups and group members.
+
+### POST/ Create Group
+### GET/ Group by ID
+### DELETE/ Delete Group By ID
+### GET/ Filter Groups
+### POST/ Search Groups
+### PATCH/ Update Group
+### PATCH/ Remove Group Member
+### PUT/ Update Group
+
+## Bulk Endpoint
+
+TBD
+
+## ResourceType Endpoint
+
+TBD
+
+## ServiceProviderConfig Endpoint

doc/developer/index.rst

@@ -0,0 +1,11 @@
+ipa-tuura developer documentation
+=================================
+
+.. toctree::
+   :maxdepth: 1
+
+   introduction.md
+   apis/rest-apis.md
+   apis/administrative.md
+   apis/scimv2.md
+   apis/creds.md

doc/developer/introduction.md

@@ -0,0 +1,18 @@
+# Developer Guide
+
+This section provides information regarding the administration and user features
+available in ipa-tuura.
+
+# Source Code
+
+The ipa-tuura source code is maintained in a GitHub repository. If you are a developer
+you can easily clone the source code of ipa-tuura, do modifications and build a customized
+version on your own.
+
+- ipa-tuura GitHub URL: https://github.com/freeipa/ipa-tuura
+
+- Project Documentation: https://ipa-tuura.readthedocs.io/en/latest/
+
+- How to contribute to the code base: TBD
+
+

doc/index.rst

@@ -15,5 +15,6 @@ Welcome to ipa-tuura's documentation!
    :caption: Contents:
 
    ../README.md
+   developer/index.rst