{"id":30791887,"url":"https://github.com/the-oglow/ya-corapi","last_synced_at":"2025-09-05T15:08:10.813Z","repository":{"id":299690595,"uuid":"1003428443","full_name":"The-oGlow/ya-corapi","owner":"The-oGlow","description":"Yet Another Confluence Rest API","archived":false,"fork":false,"pushed_at":"2025-09-04T12:39:53.000Z","size":349,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-04T14:38:07.520Z","etag":null,"topics":["confluence","confluence-data-center","data-center","datacenter","rest-api","restapi"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/The-oGlow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-17T06:18:50.000Z","updated_at":"2025-06-17T10:47:22.000Z","dependencies_parsed_at":"2025-06-17T20:40:45.856Z","dependency_job_id":null,"html_url":"https://github.com/The-oGlow/ya-corapi","commit_stats":null,"previous_names":["the-oglow/ya-corapi"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/The-oGlow/ya-corapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-oGlow%2Fya-corapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-oGlow%2Fya-corapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-oGlow%2Fya-corapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-oGlow%2Fya-corapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/The-oGlow","download_url":"https://codeload.github.com/The-oGlow/ya-corapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-oGlow%2Fya-corapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273774979,"owners_count":25165741,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["confluence","confluence-data-center","data-center","datacenter","rest-api","restapi"],"created_at":"2025-09-05T15:08:04.823Z","updated_at":"2025-09-05T15:08:10.800Z","avatar_url":"https://github.com/The-oGlow.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yet Another Confluence REST API\n\n![Latest Version](https://img.shields.io/badge/release-latest-blue?logo=github\u0026style=plastic \"Latest Version\")\n![Software License](https://img.shields.io/github/license/The-oGlow/ya-corapi?logo=github\u0026style=plastic \"Software License\")\n![GitHub Release](https://img.shields.io/github/v/release/The-oGlow/ya-corapi?logo=github\u0026style=plastic \"GitHub Release\")\n\n![Language Count](https://img.shields.io/github/languages/count/The-oGlow/ya-corapi?logo=github\u0026style=plastic \"Language Count\")\n![Language Top](https://img.shields.io/github/languages/top/The-oGlow/ya-corapi?logo=github\u0026style=plastic \"Language Top\")\n![Commit Status Master](https://img.shields.io/github/checks-status/The-oGlow/ya-corapi/master?logo=github\u0026label=checks%20master\u0026style=plastic \"Commit Status Master\")\n![Commit Status Develop](https://img.shields.io/github/checks-status/The-oGlow/ya-corapi/develop?logo=github\u0026label=checks%20develop\u0026style=plastic \"Commit Status Develop\")\n\n\n(c) 2024 Oliver Glowa\n\n# Description\n\nManaging the maintenance of a confluence instance via REST API.\n\n# Requirements\n\n- Commandline\n  - Linux / Unix Shell or\n  - Windows Shell\n- [PHP](https://www.php.net)\n- [Composer](https://getcomposer.org/) (optional)\n\n# Configuration\n\n## Unix / Linux\n\n- Clone this repository to your local drive\n- Create the folder \n  - `mkdir ${HOME}/.ya-corapi`\n- Copy the file to the created folder  \n  - `cp ./cfg/myauth.php.dist ${HOME}/.ya-corapi/myauth.php`\n- Edit the file `${HOME}/.ya-corapi/myauth.php`\n  - Replace `#confluence-url_for_production#` with your Confluence URL for the production environment\n  - Replace `#confluence-url_for_testing#` with your Confluence URL for the testing environment\n\n## Windows\n\n- Clone this repository to your local drive\n- Create the folder \n  - `mkdir %USERPROFILE%\\.ya-corapi`\n- Copy the file to the created folder\n  - `copy .\\cfg\\myauth.php.dist %USERPROFILE%\\.ya-corapi\\myauth.php` \n- Edit the file `%USERPROFILE%\\.ya-corapi\\myauth.php`\n  - Replace `#confluence-url_for_production#` with your Confluence URL for the production environment\n  - Replace `#confluence-url_for_testing#` with your Confluence URL for the testing environment\n\n# How to use it\n\nThe functions are separated in subfolders\n- count  -\u003e Count specific pages / elements \n- search -\u003e Search for specific pages / elements\n\n\nStarting a function is easy from the shell (commandline)\n\n    php -f ./\u003csubfolder\u003e/\u003cfunction\u003e.php\n\nE.g.\n\n    php -f ./search/searchpage.php   \n\nThe results are printed to the console or into a file in the target folder\n\n    ./target/\u003csubfolder\u003e/\u003cyyyymmdd-hhnnss\u003e/\u003cfunction\u003e.\u003cextension\u003e\n    \nThe output can be\n- Text\n- CSV\n- JSON\n\n# Roadmap\n\n## r0.1 (first release)\n- Move code from PoC to OO\n- Create simple write actions\n- Create examples and describe their purpose\n- Describe the installation and usage of this library\n\n## r0.2\n- Decouple [`IConnectionProvider`](src/yacorapi/IConnectionProvider.php)  to support different provider\n- Externalize functions for the [Projectdoc Toolbox](https://www.smartics.eu/spaces/PDAC1/projectdoc-Toolbox_3671724.html) into its own library\n\n## r0.3\n- Decouple the REST-API definitions to support different confluence versions (e.g. Cloud) or atlassian tools (e.g. Jira)\n- Create write actions by batch\n\n## r0.4\n- Code cleanup release\n- Code coverage release\n- Setup github actions\n\n## Near or Far Future\n- Create an alternative provider\n- Implement a Cloud fortifed REST-API definition\n\n# Development\n\nSome infos, in case you want to fork and extend this library,\n\n## Structure\n\nRelevant files and folders\n\n    \u003cproject-root\u003e\n    |--cfg\n    |  |-mayauth.php.dist\n    |  |-myspaces.php.dist\n    |\n    |--example\n    |  |-*\n    \n    |--src\n    |  |-- Monolog\n    |  |-- PHPUnit\n    |  |-- yacorapi\n    |  \n    |--target\n    |  |- *\n    |\n    |--tests\n    |  |--yacorapi\n    |\n    |--vendor\n    |  |- *\n    |\n    |-composer.json\n    |-composer.lock\n    |-php-cs-fixer.php.dist\n    |-phpstan.neon.dist\n    |-phpunit.xml.dist\n    |-README.md\n    \n      \n\n## UNIT Tests\n\nStarting the unit tests (PHP Unit)\n\n    ./vendor/bin/phpunit\n    \n    \n## Quality Analysis\n\n| | Branch 'master' | Branch 'develop' \n| :--- | :---: | :---: \n|  **Build** \n| Github.com | - | - \n| **Quality Information** \n| Sonarcloud.io | - | [![Sonarcloud](https://sonarcloud.io/api/project_badges/quality_gate?project=The-oGlow_ya-corapi)](https://sonarcloud.io/dashboard?id=The-oGlow_ya-corapi)  \n| **Test Information**\n| Sonarcloud.io | [![Sonarcloud](https://img.shields.io/sonar/tests/The-oGlow_ya-corapi/master?server=https%3A%2F%2Fsonarcloud.io\u0026compact_message\u0026style=plastic\u0026logo=sonar)](https://sonarcloud.io/dashboard?id=The-oGlow_ya-corapi)\u003cbr/\u003e[![Sonarcloud](https://img.shields.io/sonar/test_success_density/The-oGlow_ya-corapi/master?server=https%3A%2F%2Fsonarcloud.io\u0026compact_message\u0026style=plastic\u0026logo=sonar)](https://sonarcloud.io/dashboard?id=The-oGlow_ya-corapi)\u003cbr/\u003e[![Sonarcloud](https://img.shields.io/sonar/coverage/The-oGlow_ya-corapi/master?server=https%3A%2F%2Fsonarcloud.io\u0026compact_message\u0026style=plastic\u0026logo=sonar)](https://sonarcloud.io/dashboard?id=The-oGlow_ya-corapi)\u003cbr/\u003e[![Sonarcloud](https://img.shields.io/sonar/violations/The-oGlow_ya-corapi/master?server=https%3A%2F%2Fsonarcloud.io\u0026compact_message\u0026style=plastic\u0026logo=sonar)](https://sonarcloud.io/dashboard?id=The-oGlow_ya-corapi)\u003cbr/\u003e | [![Sonarcloud](https://img.shields.io/sonar/tests/The-oGlow_ya-corapi/develop?server=https%3A%2F%2Fsonarcloud.io\u0026compact_message\u0026style=plastic\u0026logo=sonar)](https://sonarcloud.io/dashboard?id=The-oGlow_ya-corapi)\u003cbr/\u003e[![Sonarcloud](https://img.shields.io/sonar/test_success_density/The-oGlow_ya-corapi/develop?server=https%3A%2F%2Fsonarcloud.io\u0026compact_message\u0026style=plastic\u0026logo=sonar)](https://sonarcloud.io/dashboard?id=The-oGlow_ya-corapi)\u003cbr/\u003e[![Sonarcloud](https://img.shields.io/sonar/coverage/The-oGlow_ya-corapi/develop?server=https%3A%2F%2Fsonarcloud.io\u0026compact_message\u0026style=plastic\u0026logo=sonar)](https://sonarcloud.io/dashboard?id=The-oGlow_ya-corapi)\u003cbr/\u003e[![Sonarcloud](https://img.shields.io/sonar/violations/The-oGlow_ya-corapi/develop?server=https%3A%2F%2Fsonarcloud.io\u0026compact_message\u0026style=plastic\u0026logo=sonar)](https://sonarcloud.io/dashboard?id=The-oGlow_ya-corapi)\u003cbr/\u003e\n\n[![SonarQube Cloud](https://sonarcloud.io/images/project_badges/sonarcloud-light.svg)](https://sonarcloud.io/summary/new_code?id=The-oGlow_ya-corapi)\n\n# Notice\n\n- Examples are working with privat access token (PAT) only!\n- Tested \u0026 Working with the Confluence Data Center Edition (DCE)\n- By default the requests are sent to the URL of `#confluence-url_for_testing#`\n  - Edit the file `${HOME}/.ya-corapi/myauth.php` (Windows: `%USERPROFILE%\\.ya-corapi\\myauth.php`)\n    - Set `CONST USE_PROD = false` to `CONST USE_PROD = true` \n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-oglow%2Fya-corapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe-oglow%2Fya-corapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-oglow%2Fya-corapi/lists"}