ya-corapi

Table of Contents

• Description
• What is a ya-corapi?
• Usage
  • Switch to production
• Roadmap
  • r0.1 (first release)
  • r0.2
  • r0.3
  • r0.4
  • Near or Far Future
• Additional Information
• Notice
• Reference

Description

Managing the maintenance of a Confluence instance by REST API

What is a ya-corapi?

Y - et
a - nother
-
co - nfluence
r - est
api

Usage

The functions are separated in subfolders uner example

• Restapi → Base folder for all REST-API examples

• Projectdoc → Examples using the Projectdoc Toolbox

Starting a function is easy from the shell (commandline)

php -f ./example/<subfolder>/<function>.php

E.g.

php -f ./example/search/searchpage.php

The results are printed to the console or into a file in the target folder

./target/<subfolder>/<yyyymmdd-hhnnss>/<function>.<extension>

The output can be

• Text

• CSV

• JSON

Switch to production

By default the requests are sent to the URL of #confluence-url_for_testing#

• Edit the file:

  • Unix / Linux: ${HOME}/.ya-corapi/myauth.php

  • Windows: %USERPROFILE%\.ya-corapi\myauth.php

• Set CONST USE_PROD = false to CONST USE_PROD = true

Roadmap

r0.1 (first release)

• Move code from PoC to OO

• Create simple write actions

• Create examples and describe their purpose

• Describe the installation and usage of this library

r0.2

• Decouple IConnectionProvider to support different provider

• Externalize functions for the Projectdoc Toolbox into its own library

r0.3

• Decouple the REST-API definitions to support different Confluence versions (e.g. Cloud) or Atlassian tools (e.g. Jira)

• Create write actions by batch

r0.4

• Code cleanup release

• Code coverage release

• Setup github actions

Near or Far Future

• Create an alternative provider

• Implement a Cloud fortifed REST-API definition

Additional Information

• Configuration - How to configure

• Composer Commands - New commands for composer

• Analysis - Project Status

Notice

• Examples are working with privat access token (PAT) only!

• Tested & Working with the Confluence Data Center Edition (DCE)

Reference

• Composer

(c) 2024 by Oliver Glowa