From 0128d6d2135e880300ae5450ad202029c6056cd9 Mon Sep 17 00:00:00 2001 From: Renata Date: Wed, 29 Sep 2021 19:16:48 +0200 Subject: [PATCH] Remove generated schema docs File names are too long and are causing issues --- docs/updater/schemas/descriptions.md | 11 - docs/updater/schemas/docs/README.md | 177 ---------- ...st-update-properties-configuration-data.md | 15 - ...-properties-state-properties-persistent.md | 15 - ...e-properties-state-properties-transient.md | 15 - .../docs/host-update-properties-state.md | 58 ---- ...-repositories-repository-handlers-input.md | 240 ------------- ...-properties-authentication-repositories.md | 15 - ...update-data-properties-change-indicator.md | 15 - ...roperties-update-data-properties-custom.md | 15 - ...es-update-data-properties-error-message.md | 15 - ...-properties-update-data-properties-name.md | 15 - ...ies-update-data-properties-update-event.md | 15 - .../host-update-properties-update-data.md | 134 -------- docs/updater/schemas/docs/host-update.md | 77 ----- ...nd-custom-information-properties-commit.md | 15 - ...nd-custom-information-properties-custom.md | 15 - ...tions-commit-sha-and-custom-information.md | 58 ---- ...itions-git-repository-properties-custom.md | 15 - ...it-repository-properties-default-branch.md | 15 - ...tory-properties-librarys-root-directory.md | 15 - ...initions-git-repository-properties-name.md | 15 - ...ns-git-repository-properties-urls-items.md | 15 - ...initions-git-repository-properties-urls.md | 21 -- .../repo-update-definitions-git-repository.md | 121 ------- .../schemas/docs/repo-update-definitions.md | 15 - ...po-update-properties-configuration-data.md | 15 - ...-properties-state-properties-persistent.md | 15 - ...e-properties-state-properties-transient.md | 15 - .../docs/repo-update-properties-state.md | 58 ---- ...nfiguration-directorys-parent-directory.md | 15 - ...-properties-auth-repo-properties-custom.md | 15 - ...ies-auth-repo-properties-default-branch.md | 15 - ...name-with-custom-info-properties-custom.md | 15 - ...rnproperties-host-name-with-custom-info.md | 39 --- ...repo-properties-hosts-patternproperties.md | 15 - ...s-properties-auth-repo-properties-hosts.md | 39 --- ...repo-properties-librarys-root-directory.md | 15 - ...ls-properties-auth-repo-properties-name.md | 15 - ...o-properties-out-of-band-authentication.md | 15 - ...ls-properties-auth-repo-properties-urls.md | 15 - ...ith-update-details-properties-auth-repo.md | 176 ---------- ...operties-commits-properties-before_pull.md | 15 - ...es-commits-properties-commit-after-pull.md | 15 - ...commits-properties-pulled-commits-items.md | 15 - ...rties-commits-properties-pulled-commits.md | 19 -- ...-with-update-details-properties-commits.md | 81 ----- ...roperties-auth-repo-with-update-details.md | 62 ---- ...update-data-properties-change-indicator.md | 15 - ...roperties-update-data-properties-custom.md | 15 - ...es-update-data-properties-error-message.md | 15 - ...-properties-update-data-properties-name.md | 15 - ...operties-branchs-commits-properties-new.md | 15 - ...ommits-properties-unauthenticated-items.md | 15 - ...nchs-commits-properties-unauthenticated.md | 19 -- ...nches-patternproperties-branchs-commits.md | 100 ------ ...s-commits-by-branches-patternproperties.md | 15 - ...-commits-properties-commits-by-branches.md | 39 --- ...epos-patternproperties-repo-and-commits.md | 58 ---- ...operties-target-repos-patternproperties.md | 15 - ...ies-update-data-properties-target-repos.md | 39 --- ...ies-update-data-properties-update-event.md | 15 - .../repo-update-properties-update-data.md | 153 --------- docs/updater/schemas/docs/repo-update.md | 240 ------------- docs/updater/schemas/host-update.schema.json | 81 ----- docs/updater/schemas/repo-update.schema.json | 314 ------------------ 66 files changed, 3029 deletions(-) delete mode 100644 docs/updater/schemas/descriptions.md delete mode 100644 docs/updater/schemas/docs/README.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-configuration-data.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-state-properties-persistent.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-state-properties-transient.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-state.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-update-data-properties-authentication-repositories-repository-handlers-input.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-update-data-properties-authentication-repositories.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-update-data-properties-change-indicator.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-update-data-properties-custom.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-update-data-properties-error-message.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-update-data-properties-name.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-update-data-properties-update-event.md delete mode 100644 docs/updater/schemas/docs/host-update-properties-update-data.md delete mode 100644 docs/updater/schemas/docs/host-update.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information-properties-commit.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information-properties-custom.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-custom.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-default-branch.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-librarys-root-directory.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-name.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-urls-items.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-urls.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions-git-repository.md delete mode 100644 docs/updater/schemas/docs/repo-update-definitions.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-configuration-data.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-state-properties-persistent.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-state-properties-transient.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-state.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-configuration-directorys-parent-directory.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-custom.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-default-branch.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-librarys-root-directory.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-name.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-out-of-band-authentication.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-urls.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-before_pull.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-commit-after-pull.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits-items.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-change-indicator.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-custom.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-error-message.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-name.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-new.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated-items.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data-properties-update-event.md delete mode 100644 docs/updater/schemas/docs/repo-update-properties-update-data.md delete mode 100644 docs/updater/schemas/docs/repo-update.md delete mode 100644 docs/updater/schemas/host-update.schema.json delete mode 100644 docs/updater/schemas/repo-update.schema.json diff --git a/docs/updater/schemas/descriptions.md b/docs/updater/schemas/descriptions.md deleted file mode 100644 index 170a940e..00000000 --- a/docs/updater/schemas/descriptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# Schemas - -## Repository handler schema - -- [Full schema](./repo-update.schema.json) -- [Schema documentation](./docs/repo-update.md) - -## Host handler schema - -- [Full schema](./host-update.schema.json) -- [Schema documentation](./docs/host-update.md) diff --git a/docs/updater/schemas/docs/README.md b/docs/updater/schemas/docs/README.md deleted file mode 100644 index a412e842..00000000 --- a/docs/updater/schemas/docs/README.md +++ /dev/null @@ -1,177 +0,0 @@ -# README - -## Top-level Schemas - -* [Host Handlers Input](./host-update.md) – `host_update.schema.json` - -* [Repository Handlers Input](./repo-update.md) – `repo_update.schema.json` - -## Other Schemas - -### Objects - -* [Auth Repo](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md "All properties of the authentication repository") – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/data` - -* [Auth Repo](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md "All properties of the authentication repository") – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/data` - -* [Auth Repo with Update Details](./repo-update-properties-update-data-properties-auth-repo-with-update-details.md "All information about an authentication repository coupled with update details") – `repo_update.schema.json#/properties/update/properties/auth_repo` - -* [Auth Repo with Update Details](./repo-update-properties-update-data-properties-auth-repo-with-update-details.md "All information about an authentication repository coupled with update details") – `repo_update.schema.json#/properties/update/properties/auth_repo` - -* [Branch's Commits](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md "Commit before pull, after pull and lists of new and unauthenticated commits belonging to the given branch") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$` - -* [Branch's Commits](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md "Commit before pull, after pull and lists of new and unauthenticated commits belonging to the given branch") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$` - -* [Commit SHA and Custom Information](./repo-update-definitions-commit-sha-and-custom-information.md) – `repo_update.schema.json#/definitions/commit_with_custom` - -* [Commit SHA and Custom Information](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-commit-sha-and-custom-information.md "Repository's top commit before pull") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/before_pull` - -* [Commit SHA and Custom Information](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-commit-sha-and-custom-information-1.md "Repository's top commit after pull") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/after_pull` - -* [Commit SHA and Custom Information](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-new-commit-sha-and-custom-information.md) – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/new/items` - -* [Commit SHA and Custom Information](./repo-update-definitions-commit-sha-and-custom-information.md) – `repo_update.schema.json#/definitions/commit_with_custom` - -* [Commit SHA and Custom Information](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-commit-sha-and-custom-information.md "Repository's top commit before pull") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/before_pull` - -* [Commit SHA and Custom Information](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-commit-sha-and-custom-information-1.md "Repository's top commit after pull") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/after_pull` - -* [Commit SHA and Custom Information](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-new-commit-sha-and-custom-information.md) – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/new/items` - -* [Commits](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md "Information about commits - top commit before pull, pulled commits and top commit after pull") – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits` - -* [Commits](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md "Information about commits - top commit before pull, pulled commits and top commit after pull") – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits` - -* [Commits by Branches](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md) – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits` - -* [Commits by Branches](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md) – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits` - -* [Configuration Data](./repo-update-properties-configuration-data.md "Additional configuration, loaded from config") – `repo_update.schema.json#/properties/config` - -* [Configuration Data](./repo-update-properties-configuration-data.md "Additional configuration, loaded from config") – `repo_update.schema.json#/properties/config` - -* [Configuration data](./host-update-properties-configuration-data.md "Additional configuration, loaded from config") – `host_update.schema.json#/properties/config` - -* [Custom](./repo-update-definitions-git-repository-properties-custom.md "Any additional information about the repository") – `repo_update.schema.json#/definitions/repo_data/properties/custom` - -* [Custom](./repo-update-definitions-commit-sha-and-custom-information-properties-custom.md) – `repo_update.schema.json#/definitions/commit_with_custom/properties/custom` - -* [Custom](./repo-update-definitions-git-repository-properties-custom.md "Any additional information about the repository") – `repo_update.schema.json#/definitions/repo_data/properties/custom` - -* [Custom](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md) – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties/^.*$/properties/custom` - -* [Custom](./repo-update-definitions-git-repository-properties-custom.md "Any additional information about the repository") – `repo_update.schema.json#/definitions/repo_data/properties/custom` - -* [Custom](./repo-update-definitions-commit-sha-and-custom-information-properties-custom.md) – `repo_update.schema.json#/definitions/commit_with_custom/properties/custom` - -* [Custom](./repo-update-definitions-commit-sha-and-custom-information-properties-custom.md) – `repo_update.schema.json#/definitions/commit_with_custom/properties/custom` - -* [Custom](./repo-update-definitions-commit-sha-and-custom-information-properties-custom.md) – `repo_update.schema.json#/definitions/commit_with_custom/properties/custom` - -* [Custom](./repo-update-properties-update-data-properties-custom.md "Additional custom data") – `repo_update.schema.json#/properties/update/properties/custom` - -* [Custom](./host-update-properties-update-data-properties-custom.md "Additional host data") – `host_update.schema.json#/properties/update/properties/custom` - -* [Custom](./repo-update-definitions-git-repository-properties-custom.md "Any additional information about the repository") – `repo_update.schema.json#/definitions/repo_data/properties/custom` - -* [Custom](./repo-update-definitions-commit-sha-and-custom-information-properties-custom.md) – `repo_update.schema.json#/definitions/commit_with_custom/properties/custom` - -* [Custom](./repo-update-definitions-git-repository-properties-custom.md "Any additional information about the repository") – `repo_update.schema.json#/definitions/repo_data/properties/custom` - -* [Custom](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md) – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties/^.*$/properties/custom` - -* [Custom](./repo-update-definitions-git-repository-properties-custom.md "Any additional information about the repository") – `repo_update.schema.json#/definitions/repo_data/properties/custom` - -* [Custom](./repo-update-definitions-commit-sha-and-custom-information-properties-custom.md) – `repo_update.schema.json#/definitions/commit_with_custom/properties/custom` - -* [Custom](./repo-update-definitions-commit-sha-and-custom-information-properties-custom.md) – `repo_update.schema.json#/definitions/commit_with_custom/properties/custom` - -* [Custom](./repo-update-definitions-commit-sha-and-custom-information-properties-custom.md) – `repo_update.schema.json#/definitions/commit_with_custom/properties/custom` - -* [Custom](./repo-update-properties-update-data-properties-custom.md "Additional custom data") – `repo_update.schema.json#/properties/update/properties/custom` - -* [Git Repository](./repo-update-definitions-git-repository.md "All information about a git repository instance") – `repo_update.schema.json#/definitions/repo_data` - -* [Git Repository](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-allof-git-repository.md "All information about a git repository instance") – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/allOf/0` - -* [Git Repository](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-git-repository.md "All information about a git repository instance") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/repo_data` - -* [Git Repository](./repo-update-definitions-git-repository.md "All information about a git repository instance") – `repo_update.schema.json#/definitions/repo_data` - -* [Git Repository](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-allof-git-repository.md "All information about a git repository instance") – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/allOf/0` - -* [Git Repository](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-git-repository.md "All information about a git repository instance") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/repo_data` - -* [Host Name with Custom Info](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md) – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties/^.*$` - -* [Host Name with Custom Info](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md) – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties/^.*$` - -* [Hosts](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md "A dictionary mapping host names to additional information about them") – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts` - -* [Hosts](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md "A dictionary mapping host names to additional information about them") – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts` - -* [Persistent](./repo-update-properties-state-properties-persistent.md "Persistent data is arbitrary date passed from one script execution the next one and stored to disk (to a file called persistent") – `repo_update.schema.json#/properties/state/properties/persistent` - -* [Persistent](./host-update-properties-state-properties-persistent.md "Persistent data is arbitrary date passed from one script execution the next one and stored to disk (to a file called persistent") – `host_update.schema.json#/properties/state/properties/persistent` - -* [Persistent](./repo-update-properties-state-properties-persistent.md "Persistent data is arbitrary date passed from one script execution the next one and stored to disk (to a file called persistent") – `repo_update.schema.json#/properties/state/properties/persistent` - -* [Repo and Commits](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md) – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$` - -* [Repo and Commits](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md) – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$` - -* [Repository Handlers Input](./host-update-properties-update-data-properties-authentication-repositories-repository-handlers-input.md) – `repo_update.schema.json#/properties/update/properties/auth_repos/items` - -* [State](./repo-update-properties-state.md "Persistent and transient states") – `repo_update.schema.json#/properties/state` - -* [State](./host-update-properties-state.md "Persistent and transient states") – `host_update.schema.json#/properties/state` - -* [State](./repo-update-properties-state.md "Persistent and transient states") – `repo_update.schema.json#/properties/state` - -* [Target Repos](./repo-update-properties-update-data-properties-target-repos.md "Information about the authentication repository's target repositories, including the update details") – `repo_update.schema.json#/properties/update/properties/target_repos` - -* [Target Repos](./repo-update-properties-update-data-properties-target-repos.md "Information about the authentication repository's target repositories, including the update details") – `repo_update.schema.json#/properties/update/properties/target_repos` - -* [Transient](./repo-update-properties-state-properties-transient.md "Transient data is arbitrary data passed from one script execution to the next one") – `repo_update.schema.json#/properties/state/properties/transient` - -* [Transient](./host-update-properties-state-properties-transient.md "Transient data is arbitrary data passed from one script execution to the next one") – `host_update.schema.json#/properties/state/properties/transient` - -* [Transient](./repo-update-properties-state-properties-transient.md "Transient data is arbitrary data passed from one script execution to the next one") – `repo_update.schema.json#/properties/state/properties/transient` - -* [Update Data](./repo-update-properties-update-data.md "All information related to the update process of an authentication repository - updated repository and pulled commits") – `repo_update.schema.json#/properties/update` - -* [Update Data](./repo-update-properties-update-data.md "All information related to the update process of an authentication repository - updated repository and pulled commits") – `repo_update.schema.json#/properties/update` - -* [Update data](./host-update-properties-update-data.md "All information related to the update process of a host (containing all authentication repositories linked to that host)") – `host_update.schema.json#/properties/update` - -### Arrays - -* [Authentication Repositories](./host-update-properties-update-data-properties-authentication-repositories.md) – `host_update.schema.json#/properties/update/properties/auth_repos` - -* [Pulled Commits](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits.md "A list of pulled (new) commits") – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/new` - -* [Pulled Commits](./repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits.md "A list of pulled (new) commits") – `repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/new` - -* [URLs](./repo-update-definitions-git-repository-properties-urls.md "A list of repository's urls") – `repo_update.schema.json#/definitions/repo_data/properties/urls` - -* [URLs](./repo-update-definitions-git-repository-properties-urls.md "A list of repository's urls") – `repo_update.schema.json#/definitions/repo_data/properties/urls` - -* [URLs](./repo-update-definitions-git-repository-properties-urls.md "A list of repository's urls") – `repo_update.schema.json#/definitions/repo_data/properties/urls` - -* [URLs](./repo-update-definitions-git-repository-properties-urls.md "A list of repository's urls") – `repo_update.schema.json#/definitions/repo_data/properties/urls` - -* [URLs](./repo-update-definitions-git-repository-properties-urls.md "A list of repository's urls") – `repo_update.schema.json#/definitions/repo_data/properties/urls` - -* [URLs](./repo-update-definitions-git-repository-properties-urls.md "A list of repository's urls") – `repo_update.schema.json#/definitions/repo_data/properties/urls` - -* [Untitled array in Repository Handlers Input](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-new.md "A list of new authenticated commits (specified in target files of the authentication repository)") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/new` - -* [Untitled array in Repository Handlers Input](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated.md "New unauthenticated commits - additional commits newer than the last authenticated commit in case of repositories where unauthenticated commits are allowed") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/unauthenticated` - -* [Untitled array in Repository Handlers Input](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-new.md "A list of new authenticated commits (specified in target files of the authentication repository)") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/new` - -* [Untitled array in Repository Handlers Input](./repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated.md "New unauthenticated commits - additional commits newer than the last authenticated commit in case of repositories where unauthenticated commits are allowed") – `repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/unauthenticated` - -## Version Note - -The schemas linked above follow the JSON Schema Spec version: `http://json-schema.org/draft-07/schema#` diff --git a/docs/updater/schemas/docs/host-update-properties-configuration-data.md b/docs/updater/schemas/docs/host-update-properties-configuration-data.md deleted file mode 100644 index 5df9adf4..00000000 --- a/docs/updater/schemas/docs/host-update-properties-configuration-data.md +++ /dev/null @@ -1,15 +0,0 @@ -# Configuration data Schema - -```txt -host_update.schema.json#/properties/config -``` - -Additional configuration, loaded from config.json located inside the library root - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## config Type - -`object` ([Configuration data](host-update-properties-configuration-data.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-state-properties-persistent.md b/docs/updater/schemas/docs/host-update-properties-state-properties-persistent.md deleted file mode 100644 index aee3596d..00000000 --- a/docs/updater/schemas/docs/host-update-properties-state-properties-persistent.md +++ /dev/null @@ -1,15 +0,0 @@ -# Persistent Schema - -```txt -host_update.schema.json#/properties/state/properties/persistent -``` - -Persistent data is arbitrary date passed from one script execution the next one and stored to disk (to a file called persistent.json directly inside the library root) - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## persistent Type - -`object` ([Persistent](host-update-properties-state-properties-persistent.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-state-properties-transient.md b/docs/updater/schemas/docs/host-update-properties-state-properties-transient.md deleted file mode 100644 index 22ee427d..00000000 --- a/docs/updater/schemas/docs/host-update-properties-state-properties-transient.md +++ /dev/null @@ -1,15 +0,0 @@ -# Transient Schema - -```txt -host_update.schema.json#/properties/state/properties/transient -``` - -Transient data is arbitrary data passed from one script execution to the next one. It is discarded at the end of the process - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## transient Type - -`object` ([Transient](host-update-properties-state-properties-transient.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-state.md b/docs/updater/schemas/docs/host-update-properties-state.md deleted file mode 100644 index 100ec1cd..00000000 --- a/docs/updater/schemas/docs/host-update-properties-state.md +++ /dev/null @@ -1,58 +0,0 @@ -# State Schema - -```txt -host_update.schema.json#/properties/state -``` - -Persistent and transient states - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## state Type - -`object` ([State](host-update-properties-state.md)) - -# state Properties - -| Property | Type | Required | Nullable | Defined by | -| :------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- | -| [transient](#transient) | `object` | Optional | cannot be null | [Host Handlers Input](host-update-properties-state-properties-transient.md "host_update.schema.json#/properties/state/properties/transient") | -| [persistent](#persistent) | `object` | Optional | cannot be null | [Host Handlers Input](host-update-properties-state-properties-persistent.md "host_update.schema.json#/properties/state/properties/persistent") | - -## transient - -Transient data is arbitrary data passed from one script execution to the next one. It is discarded at the end of the process - -`transient` - -* is optional - -* Type: `object` ([Transient](host-update-properties-state-properties-transient.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-state-properties-transient.md "host_update.schema.json#/properties/state/properties/transient") - -### transient Type - -`object` ([Transient](host-update-properties-state-properties-transient.md)) - -## persistent - -Persistent data is arbitrary date passed from one script execution the next one and stored to disk (to a file called persistent.json directly inside the library root) - -`persistent` - -* is optional - -* Type: `object` ([Persistent](host-update-properties-state-properties-persistent.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-state-properties-persistent.md "host_update.schema.json#/properties/state/properties/persistent") - -### persistent Type - -`object` ([Persistent](host-update-properties-state-properties-persistent.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-update-data-properties-authentication-repositories-repository-handlers-input.md b/docs/updater/schemas/docs/host-update-properties-update-data-properties-authentication-repositories-repository-handlers-input.md deleted file mode 100644 index 1049adf7..00000000 --- a/docs/updater/schemas/docs/host-update-properties-update-data-properties-authentication-repositories-repository-handlers-input.md +++ /dev/null @@ -1,240 +0,0 @@ -# Repository Handlers Input Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repos/items -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | Yes | Unknown status | No | Forbidden | Forbidden | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## items Type - -`object` ([Repository Handlers Input](host-update-properties-update-data-properties-authentication-repositories-repository-handlers-input.md)) - -# items Properties - -| Property | Type | Required | Nullable | Defined by | -| :---------------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------- | -| [update](#update) | `object` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data.md "repo_update.schema.json#/properties/update") | -| [state](#state) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-state.md "repo_update.schema.json#/properties/state") | -| [config](#config) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-configuration-data.md "repo_update.schema.json#/properties/config") | - -## update - -All information related to the update process of an authentication repository - updated repository and pulled commits - -`update` - -* is required - -* Type: `object` ([Update Data](repo-update-properties-update-data.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data.md "repo_update.schema.json#/properties/update") - -### update Type - -`object` ([Update Data](repo-update-properties-update-data.md)) - -## state - -Persistent and transient states - -`state` - -* is optional - -* Type: `object` ([State](repo-update-properties-state.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-state.md "repo_update.schema.json#/properties/state") - -### state Type - -`object` ([State](repo-update-properties-state.md)) - -## config - -Additional configuration, loaded from config.json located inside the library root - -`config` - -* is optional - -* Type: `object` ([Configuration Data](repo-update-properties-configuration-data.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-configuration-data.md "repo_update.schema.json#/properties/config") - -### config Type - -`object` ([Configuration Data](repo-update-properties-configuration-data.md)) - -# Repository Handlers Input Definitions - -## Definitions group repo_data - -Reference this group by using - -```json -{"$ref":"repo_update.schema.json#/definitions/repo_data"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :-------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [library_dir](#library_dir) | `string` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-librarys-root-directory.md "repo_update.schema.json#/definitions/repo_data/properties/library_dir") | -| [name](#name) | `string` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-name.md "repo_update.schema.json#/definitions/repo_data/properties/name") | -| [urls](#urls) | `array` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-urls.md "repo_update.schema.json#/definitions/repo_data/properties/urls") | -| [custom](#custom) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-custom.md "repo_update.schema.json#/definitions/repo_data/properties/custom") | -| [default_branch](#default_branch) | `string` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-default-branch.md "repo_update.schema.json#/definitions/repo_data/properties/default_branch") | - -### library_dir - - - -`library_dir` - -* is required - -* Type: `string` ([Library's Root Directory](repo-update-definitions-git-repository-properties-librarys-root-directory.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-librarys-root-directory.md "repo_update.schema.json#/definitions/repo_data/properties/library_dir") - -#### library_dir Type - -`string` ([Library's Root Directory](repo-update-definitions-git-repository-properties-librarys-root-directory.md)) - -### name - -Repository's name, in namespace/repo_name format - -`name` - -* is required - -* Type: `string` ([Name](repo-update-definitions-git-repository-properties-name.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-name.md "repo_update.schema.json#/definitions/repo_data/properties/name") - -#### name Type - -`string` ([Name](repo-update-definitions-git-repository-properties-name.md)) - -### urls - -A list of repository's urls - -`urls` - -* is required - -* Type: `string[]` - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-urls.md "repo_update.schema.json#/definitions/repo_data/properties/urls") - -#### urls Type - -`string[]` - -#### urls Constraints - -**minimum number of items**: the minimum number of items for this array is: `1` - -**unique items**: all items in this array must be unique. Duplicates are not allowed. - -### custom - -Any additional information about the repository. Not used by the framework. - -`custom` - -* is optional - -* Type: `object` ([Custom](repo-update-definitions-git-repository-properties-custom.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-custom.md "repo_update.schema.json#/definitions/repo_data/properties/custom") - -#### custom Type - -`object` ([Custom](repo-update-definitions-git-repository-properties-custom.md)) - -### default_branch - -Name of the default branch, e.g. master or main - -`default_branch` - -* is optional - -* Type: `string` ([Default Branch](repo-update-definitions-git-repository-properties-default-branch.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-default-branch.md "repo_update.schema.json#/definitions/repo_data/properties/default_branch") - -#### default_branch Type - -`string` ([Default Branch](repo-update-definitions-git-repository-properties-default-branch.md)) - -## Definitions group commit_with_custom - -Reference this group by using - -```json -{"$ref":"repo_update.schema.json#/definitions/commit_with_custom"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :------------------ | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [commit](#commit) | `string` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-commit.md "repo_update.schema.json#/definitions/commit_with_custom/properties/commit") | -| [custom](#custom-1) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md "repo_update.schema.json#/definitions/commit_with_custom/properties/custom") | - -### commit - -Commit SHA - -`commit` - -* is optional - -* Type: `string` - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-commit.md "repo_update.schema.json#/definitions/commit_with_custom/properties/commit") - -#### commit Type - -`string` - -### custom - - - -`custom` - -* is optional - -* Type: `object` ([Custom](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md "repo_update.schema.json#/definitions/commit_with_custom/properties/custom") - -#### custom Type - -`object` ([Custom](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-update-data-properties-authentication-repositories.md b/docs/updater/schemas/docs/host-update-properties-update-data-properties-authentication-repositories.md deleted file mode 100644 index 298559b4..00000000 --- a/docs/updater/schemas/docs/host-update-properties-update-data-properties-authentication-repositories.md +++ /dev/null @@ -1,15 +0,0 @@ -# Authentication Repositories Schema - -```txt -host_update.schema.json#/properties/update/properties/auth_repos -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## auth_repos Type - -`object[]` ([Repository Handlers Input](host-update-properties-update-data-properties-authentication-repositories-repository-handlers-input.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-update-data-properties-change-indicator.md b/docs/updater/schemas/docs/host-update-properties-update-data-properties-change-indicator.md deleted file mode 100644 index 79ebb2b7..00000000 --- a/docs/updater/schemas/docs/host-update-properties-update-data-properties-change-indicator.md +++ /dev/null @@ -1,15 +0,0 @@ -# Change Indicator Schema - -```txt -host_update.schema.json#/properties/update/properties/changed -``` - -Indicates if at least one of the host's repositories was updated (will be false if pull was successful, but there were no new commits) - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## changed Type - -`boolean` ([Change Indicator](host-update-properties-update-data-properties-change-indicator.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-update-data-properties-custom.md b/docs/updater/schemas/docs/host-update-properties-update-data-properties-custom.md deleted file mode 100644 index 1f8ca882..00000000 --- a/docs/updater/schemas/docs/host-update-properties-update-data-properties-custom.md +++ /dev/null @@ -1,15 +0,0 @@ -# Custom Schema - -```txt -host_update.schema.json#/properties/update/properties/custom -``` - -Additional host data. Not used by the framework - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## custom Type - -`object` ([Custom](host-update-properties-update-data-properties-custom.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-update-data-properties-error-message.md b/docs/updater/schemas/docs/host-update-properties-update-data-properties-error-message.md deleted file mode 100644 index c850cd94..00000000 --- a/docs/updater/schemas/docs/host-update-properties-update-data-properties-error-message.md +++ /dev/null @@ -1,15 +0,0 @@ -# Error message Schema - -```txt -host_update.schema.json#/properties/update/properties/error_msg -``` - -Error message that was raised while updating the host's repositories - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## error_msg Type - -`string` ([Error message](host-update-properties-update-data-properties-error-message.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-update-data-properties-name.md b/docs/updater/schemas/docs/host-update-properties-update-data-properties-name.md deleted file mode 100644 index 07a6afb9..00000000 --- a/docs/updater/schemas/docs/host-update-properties-update-data-properties-name.md +++ /dev/null @@ -1,15 +0,0 @@ -# Name Schema - -```txt -host_update.schema.json#/properties/update/properties/host_name -``` - -Name of the host whose update was attempted - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## host_name Type - -`string` ([Name](host-update-properties-update-data-properties-name.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-update-data-properties-update-event.md b/docs/updater/schemas/docs/host-update-properties-update-data-properties-update-event.md deleted file mode 100644 index cb1726cc..00000000 --- a/docs/updater/schemas/docs/host-update-properties-update-data-properties-update-event.md +++ /dev/null @@ -1,15 +0,0 @@ -# Update Event Schema - -```txt -host_update.schema.json#/properties/update/properties/event -``` - -Event type - succeeded, changed, unchanged, failed, completed - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## event Type - -`string` ([Update Event](host-update-properties-update-data-properties-update-event.md)) diff --git a/docs/updater/schemas/docs/host-update-properties-update-data.md b/docs/updater/schemas/docs/host-update-properties-update-data.md deleted file mode 100644 index 92e224e4..00000000 --- a/docs/updater/schemas/docs/host-update-properties-update-data.md +++ /dev/null @@ -1,134 +0,0 @@ -# Update data Schema - -```txt -host_update.schema.json#/properties/update -``` - -All information related to the update process of a host (containing all authentication repositories linked to that host) - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [host-update.schema.json*](docs/host-update.schema.json "open original schema") | - -## update Type - -`object` ([Update data](host-update-properties-update-data.md)) - -# update Properties - -| Property | Type | Required | Nullable | Defined by | -| :------------------------ | :-------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [changed](#changed) | `boolean` | Required | cannot be null | [Host Handlers Input](host-update-properties-update-data-properties-change-indicator.md "host_update.schema.json#/properties/update/properties/changed") | -| [event](#event) | `string` | Required | cannot be null | [Host Handlers Input](host-update-properties-update-data-properties-update-event.md "host_update.schema.json#/properties/update/properties/event") | -| [host_name](#host_name) | `string` | Required | cannot be null | [Host Handlers Input](host-update-properties-update-data-properties-name.md "host_update.schema.json#/properties/update/properties/host_name") | -| [error_msg](#error_msg) | `string` | Required | cannot be null | [Host Handlers Input](host-update-properties-update-data-properties-error-message.md "host_update.schema.json#/properties/update/properties/error_msg") | -| [auth_repos](#auth_repos) | `array` | Required | cannot be null | [Host Handlers Input](host-update-properties-update-data-properties-authentication-repositories.md "host_update.schema.json#/properties/update/properties/auth_repos") | -| [custom](#custom) | `object` | Optional | cannot be null | [Host Handlers Input](host-update-properties-update-data-properties-custom.md "host_update.schema.json#/properties/update/properties/custom") | - -## changed - -Indicates if at least one of the host's repositories was updated (will be false if pull was successful, but there were no new commits) - -`changed` - -* is required - -* Type: `boolean` ([Change Indicator](host-update-properties-update-data-properties-change-indicator.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-update-data-properties-change-indicator.md "host_update.schema.json#/properties/update/properties/changed") - -### changed Type - -`boolean` ([Change Indicator](host-update-properties-update-data-properties-change-indicator.md)) - -## event - -Event type - succeeded, changed, unchanged, failed, completed - -`event` - -* is required - -* Type: `string` ([Update Event](host-update-properties-update-data-properties-update-event.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-update-data-properties-update-event.md "host_update.schema.json#/properties/update/properties/event") - -### event Type - -`string` ([Update Event](host-update-properties-update-data-properties-update-event.md)) - -## host_name - -Name of the host whose update was attempted - -`host_name` - -* is required - -* Type: `string` ([Name](host-update-properties-update-data-properties-name.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-update-data-properties-name.md "host_update.schema.json#/properties/update/properties/host_name") - -### host_name Type - -`string` ([Name](host-update-properties-update-data-properties-name.md)) - -## error_msg - -Error message that was raised while updating the host's repositories - -`error_msg` - -* is required - -* Type: `string` ([Error message](host-update-properties-update-data-properties-error-message.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-update-data-properties-error-message.md "host_update.schema.json#/properties/update/properties/error_msg") - -### error_msg Type - -`string` ([Error message](host-update-properties-update-data-properties-error-message.md)) - -## auth_repos - - - -`auth_repos` - -* is required - -* Type: `object[]` ([Repository Handlers Input](host-update-properties-update-data-properties-authentication-repositories-repository-handlers-input.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-update-data-properties-authentication-repositories.md "host_update.schema.json#/properties/update/properties/auth_repos") - -### auth_repos Type - -`object[]` ([Repository Handlers Input](host-update-properties-update-data-properties-authentication-repositories-repository-handlers-input.md)) - -## custom - -Additional host data. Not used by the framework - -`custom` - -* is optional - -* Type: `object` ([Custom](host-update-properties-update-data-properties-custom.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-update-data-properties-custom.md "host_update.schema.json#/properties/update/properties/custom") - -### custom Type - -`object` ([Custom](host-update-properties-update-data-properties-custom.md)) diff --git a/docs/updater/schemas/docs/host-update.md b/docs/updater/schemas/docs/host-update.md deleted file mode 100644 index ce98d02e..00000000 --- a/docs/updater/schemas/docs/host-update.md +++ /dev/null @@ -1,77 +0,0 @@ -# Host Handlers Input Schema - -```txt -host_update.schema.json -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [host-update.schema.json](docs/host-update.schema.json "open original schema") | - -## Host Handlers Input Type - -`object` ([Host Handlers Input](host-update.md)) - -# Host Handlers Input Properties - -| Property | Type | Required | Nullable | Defined by | -| :---------------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------- | -| [update](#update) | `object` | Required | cannot be null | [Host Handlers Input](host-update-properties-update-data.md "host_update.schema.json#/properties/update") | -| [state](#state) | `object` | Optional | cannot be null | [Host Handlers Input](host-update-properties-state.md "host_update.schema.json#/properties/state") | -| [config](#config) | `object` | Optional | cannot be null | [Host Handlers Input](host-update-properties-configuration-data.md "host_update.schema.json#/properties/config") | - -## update - -All information related to the update process of a host (containing all authentication repositories linked to that host) - -`update` - -* is required - -* Type: `object` ([Update data](host-update-properties-update-data.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-update-data.md "host_update.schema.json#/properties/update") - -### update Type - -`object` ([Update data](host-update-properties-update-data.md)) - -## state - -Persistent and transient states - -`state` - -* is optional - -* Type: `object` ([State](host-update-properties-state.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-state.md "host_update.schema.json#/properties/state") - -### state Type - -`object` ([State](host-update-properties-state.md)) - -## config - -Additional configuration, loaded from config.json located inside the library root - -`config` - -* is optional - -* Type: `object` ([Configuration data](host-update-properties-configuration-data.md)) - -* cannot be null - -* defined in: [Host Handlers Input](host-update-properties-configuration-data.md "host_update.schema.json#/properties/config") - -### config Type - -`object` ([Configuration data](host-update-properties-configuration-data.md)) diff --git a/docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information-properties-commit.md b/docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information-properties-commit.md deleted file mode 100644 index ef05bc50..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information-properties-commit.md +++ /dev/null @@ -1,15 +0,0 @@ -# Untitled string in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/definitions/commit_with_custom/properties/commit -``` - -Commit SHA - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## commit Type - -`string` diff --git a/docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information-properties-custom.md b/docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information-properties-custom.md deleted file mode 100644 index a169034a..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information-properties-custom.md +++ /dev/null @@ -1,15 +0,0 @@ -# Custom Schema - -```txt -repo_update.schema.json#/definitions/commit_with_custom/properties/custom -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## custom Type - -`object` ([Custom](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md)) diff --git a/docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information.md b/docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information.md deleted file mode 100644 index ff84657e..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions-commit-sha-and-custom-information.md +++ /dev/null @@ -1,58 +0,0 @@ -# Commit SHA and Custom Information Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/new/items -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## items Type - -`object` ([Commit SHA and Custom Information](repo-update-definitions-commit-sha-and-custom-information.md)) - -# items Properties - -| Property | Type | Required | Nullable | Defined by | -| :---------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [commit](#commit) | `string` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-commit.md "repo_update.schema.json#/definitions/commit_with_custom/properties/commit") | -| [custom](#custom) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md "repo_update.schema.json#/definitions/commit_with_custom/properties/custom") | - -## commit - -Commit SHA - -`commit` - -* is optional - -* Type: `string` - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-commit.md "repo_update.schema.json#/definitions/commit_with_custom/properties/commit") - -### commit Type - -`string` - -## custom - - - -`custom` - -* is optional - -* Type: `object` ([Custom](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md "repo_update.schema.json#/definitions/commit_with_custom/properties/custom") - -### custom Type - -`object` ([Custom](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md)) diff --git a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-custom.md b/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-custom.md deleted file mode 100644 index 4a25242a..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-custom.md +++ /dev/null @@ -1,15 +0,0 @@ -# Custom Schema - -```txt -repo_update.schema.json#/definitions/repo_data/properties/custom -``` - -Any additional information about the repository. Not used by the framework. - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## custom Type - -`object` ([Custom](repo-update-definitions-git-repository-properties-custom.md)) diff --git a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-default-branch.md b/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-default-branch.md deleted file mode 100644 index 80b809fe..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-default-branch.md +++ /dev/null @@ -1,15 +0,0 @@ -# Default Branch Schema - -```txt -repo_update.schema.json#/definitions/repo_data/properties/default_branch -``` - -Name of the default branch, e.g. master or main - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## default_branch Type - -`string` ([Default Branch](repo-update-definitions-git-repository-properties-default-branch.md)) diff --git a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-librarys-root-directory.md b/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-librarys-root-directory.md deleted file mode 100644 index 159af212..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-librarys-root-directory.md +++ /dev/null @@ -1,15 +0,0 @@ -# Library's Root Directory Schema - -```txt -repo_update.schema.json#/definitions/repo_data/properties/library_dir -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## library_dir Type - -`string` ([Library's Root Directory](repo-update-definitions-git-repository-properties-librarys-root-directory.md)) diff --git a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-name.md b/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-name.md deleted file mode 100644 index 9fbfdfca..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-name.md +++ /dev/null @@ -1,15 +0,0 @@ -# Name Schema - -```txt -repo_update.schema.json#/definitions/repo_data/properties/name -``` - -Repository's name, in namespace/repo_name format - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## name Type - -`string` ([Name](repo-update-definitions-git-repository-properties-name.md)) diff --git a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-urls-items.md b/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-urls-items.md deleted file mode 100644 index 8acc16e5..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-urls-items.md +++ /dev/null @@ -1,15 +0,0 @@ -# Untitled string in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/definitions/repo_data/properties/urls/items -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## items Type - -`string` diff --git a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-urls.md b/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-urls.md deleted file mode 100644 index a16c4396..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions-git-repository-properties-urls.md +++ /dev/null @@ -1,21 +0,0 @@ -# URLs Schema - -```txt -repo_update.schema.json#/definitions/repo_data/properties/urls -``` - -A list of repository's urls - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## urls Type - -`string[]` - -## urls Constraints - -**minimum number of items**: the minimum number of items for this array is: `1` - -**unique items**: all items in this array must be unique. Duplicates are not allowed. diff --git a/docs/updater/schemas/docs/repo-update-definitions-git-repository.md b/docs/updater/schemas/docs/repo-update-definitions-git-repository.md deleted file mode 100644 index cc4ead1b..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions-git-repository.md +++ /dev/null @@ -1,121 +0,0 @@ -# Git Repository Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/repo_data -``` - -All information about a git repository instance. Can be used to create a new object. - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## repo_data Type - -`object` ([Git Repository](repo-update-definitions-git-repository.md)) - -# repo_data Properties - -| Property | Type | Required | Nullable | Defined by | -| :-------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [library_dir](#library_dir) | `string` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-librarys-root-directory.md "repo_update.schema.json#/definitions/repo_data/properties/library_dir") | -| [name](#name) | `string` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-name.md "repo_update.schema.json#/definitions/repo_data/properties/name") | -| [urls](#urls) | `array` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-urls.md "repo_update.schema.json#/definitions/repo_data/properties/urls") | -| [custom](#custom) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-custom.md "repo_update.schema.json#/definitions/repo_data/properties/custom") | -| [default_branch](#default_branch) | `string` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-default-branch.md "repo_update.schema.json#/definitions/repo_data/properties/default_branch") | - -## library_dir - - - -`library_dir` - -* is required - -* Type: `string` ([Library's Root Directory](repo-update-definitions-git-repository-properties-librarys-root-directory.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-librarys-root-directory.md "repo_update.schema.json#/definitions/repo_data/properties/library_dir") - -### library_dir Type - -`string` ([Library's Root Directory](repo-update-definitions-git-repository-properties-librarys-root-directory.md)) - -## name - -Repository's name, in namespace/repo_name format - -`name` - -* is required - -* Type: `string` ([Name](repo-update-definitions-git-repository-properties-name.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-name.md "repo_update.schema.json#/definitions/repo_data/properties/name") - -### name Type - -`string` ([Name](repo-update-definitions-git-repository-properties-name.md)) - -## urls - -A list of repository's urls - -`urls` - -* is required - -* Type: `string[]` - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-urls.md "repo_update.schema.json#/definitions/repo_data/properties/urls") - -### urls Type - -`string[]` - -### urls Constraints - -**minimum number of items**: the minimum number of items for this array is: `1` - -**unique items**: all items in this array must be unique. Duplicates are not allowed. - -## custom - -Any additional information about the repository. Not used by the framework. - -`custom` - -* is optional - -* Type: `object` ([Custom](repo-update-definitions-git-repository-properties-custom.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-custom.md "repo_update.schema.json#/definitions/repo_data/properties/custom") - -### custom Type - -`object` ([Custom](repo-update-definitions-git-repository-properties-custom.md)) - -## default_branch - -Name of the default branch, e.g. master or main - -`default_branch` - -* is optional - -* Type: `string` ([Default Branch](repo-update-definitions-git-repository-properties-default-branch.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-default-branch.md "repo_update.schema.json#/definitions/repo_data/properties/default_branch") - -### default_branch Type - -`string` ([Default Branch](repo-update-definitions-git-repository-properties-default-branch.md)) diff --git a/docs/updater/schemas/docs/repo-update-definitions.md b/docs/updater/schemas/docs/repo-update-definitions.md deleted file mode 100644 index 92585012..00000000 --- a/docs/updater/schemas/docs/repo-update-definitions.md +++ /dev/null @@ -1,15 +0,0 @@ -# Untitled undefined type in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/definitions -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## definitions Type - -unknown diff --git a/docs/updater/schemas/docs/repo-update-properties-configuration-data.md b/docs/updater/schemas/docs/repo-update-properties-configuration-data.md deleted file mode 100644 index 634efba1..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-configuration-data.md +++ /dev/null @@ -1,15 +0,0 @@ -# Configuration Data Schema - -```txt -repo_update.schema.json#/properties/config -``` - -Additional configuration, loaded from config.json located inside the library root - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## config Type - -`object` ([Configuration Data](repo-update-properties-configuration-data.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-state-properties-persistent.md b/docs/updater/schemas/docs/repo-update-properties-state-properties-persistent.md deleted file mode 100644 index 2c1020bb..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-state-properties-persistent.md +++ /dev/null @@ -1,15 +0,0 @@ -# Persistent Schema - -```txt -repo_update.schema.json#/properties/state/properties/persistent -``` - -Persistent data is arbitrary date passed from one script execution the next one and stored to disk (to a file called persistent.json directly inside the library root) - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## persistent Type - -`object` ([Persistent](repo-update-properties-state-properties-persistent.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-state-properties-transient.md b/docs/updater/schemas/docs/repo-update-properties-state-properties-transient.md deleted file mode 100644 index 3a8e20dd..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-state-properties-transient.md +++ /dev/null @@ -1,15 +0,0 @@ -# Transient Schema - -```txt -repo_update.schema.json#/properties/state/properties/transient -``` - -Transient data is arbitrary data passed from one script execution to the next one. It is discarded at the end of the process - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## transient Type - -`object` ([Transient](repo-update-properties-state-properties-transient.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-state.md b/docs/updater/schemas/docs/repo-update-properties-state.md deleted file mode 100644 index ca8b88cc..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-state.md +++ /dev/null @@ -1,58 +0,0 @@ -# State Schema - -```txt -repo_update.schema.json#/properties/state -``` - -Persistent and transient states - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## state Type - -`object` ([State](repo-update-properties-state.md)) - -# state Properties - -| Property | Type | Required | Nullable | Defined by | -| :------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- | -| [transient](#transient) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-state-properties-transient.md "repo_update.schema.json#/properties/state/properties/transient") | -| [persistent](#persistent) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-state-properties-persistent.md "repo_update.schema.json#/properties/state/properties/persistent") | - -## transient - -Transient data is arbitrary data passed from one script execution to the next one. It is discarded at the end of the process - -`transient` - -* is optional - -* Type: `object` ([Transient](repo-update-properties-state-properties-transient.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-state-properties-transient.md "repo_update.schema.json#/properties/state/properties/transient") - -### transient Type - -`object` ([Transient](repo-update-properties-state-properties-transient.md)) - -## persistent - -Persistent data is arbitrary date passed from one script execution the next one and stored to disk (to a file called persistent.json directly inside the library root) - -`persistent` - -* is optional - -* Type: `object` ([Persistent](repo-update-properties-state-properties-persistent.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-state-properties-persistent.md "repo_update.schema.json#/properties/state/properties/persistent") - -### persistent Type - -`object` ([Persistent](repo-update-properties-state-properties-persistent.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-configuration-directorys-parent-directory.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-configuration-directorys-parent-directory.md deleted file mode 100644 index 4d379f0a..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-configuration-directorys-parent-directory.md +++ /dev/null @@ -1,15 +0,0 @@ -# Configuration Directory's Parent Directory Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/conf_directory_root -``` - -Path to the direcotry containing the configuration directory. The configuration direcotry contain last_validated_commit file and its name is equal to \_repo_name - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## conf_directory_root Type - -`string` ([Configuration Directory's Parent Directory](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-configuration-directorys-parent-directory.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-custom.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-custom.md deleted file mode 100644 index beeb60b1..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-custom.md +++ /dev/null @@ -1,15 +0,0 @@ -# Custom Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/custom -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## custom Type - -unknown ([Custom](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-custom.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-default-branch.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-default-branch.md deleted file mode 100644 index 0ba9e19b..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-default-branch.md +++ /dev/null @@ -1,15 +0,0 @@ -# Default Branch Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/default_branch -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## default_branch Type - -unknown ([Default Branch](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-default-branch.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md deleted file mode 100644 index 43962c66..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md +++ /dev/null @@ -1,15 +0,0 @@ -# Custom Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties/^.*$/properties/custom -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## custom Type - -`object` ([Custom](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md deleted file mode 100644 index 4c2482b0..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md +++ /dev/null @@ -1,39 +0,0 @@ -# Host Name with Custom Info Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties/^.*$ -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## ^.\*$ Type - -`object` ([Host Name with Custom Info](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md)) - -# ^.\*$ Properties - -| Property | Type | Required | Nullable | Defined by | -| :---------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [custom](#custom) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties/^.*$/properties/custom") | - -## custom - - - -`custom` - -* is optional - -* Type: `object` ([Custom](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties/^.\*$/properties/custom") - -### custom Type - -`object` ([Custom](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info-properties-custom.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties.md deleted file mode 100644 index 53902fa0..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties.md +++ /dev/null @@ -1,15 +0,0 @@ -# Untitled undefined type in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## patternProperties Type - -unknown diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md deleted file mode 100644 index 54b14084..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md +++ /dev/null @@ -1,39 +0,0 @@ -# Hosts Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts -``` - -A dictionary mapping host names to additional information about them. - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## hosts Type - -`object` ([Hosts](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md)) - -# hosts Properties - -| Property | Type | Required | Nullable | Defined by | -| :------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `^.*$` | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties/^.*$") | - -## Pattern: `^.*$` - - - -`^.*$` - -* is optional - -* Type: `object` ([Host Name with Custom Info](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts/patternProperties/^.\*$") - -### ^.\*$ Type - -`object` ([Host Name with Custom Info](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts-patternproperties-host-name-with-custom-info.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-librarys-root-directory.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-librarys-root-directory.md deleted file mode 100644 index ef4a4b1a..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-librarys-root-directory.md +++ /dev/null @@ -1,15 +0,0 @@ -# Library's Root Directory Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/library_dir -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## library_dir Type - -unknown ([Library's Root Directory](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-librarys-root-directory.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-name.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-name.md deleted file mode 100644 index 96b33e54..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-name.md +++ /dev/null @@ -1,15 +0,0 @@ -# Name Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/name -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## name Type - -unknown ([Name](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-name.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-out-of-band-authentication.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-out-of-band-authentication.md deleted file mode 100644 index 2ecab819..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-out-of-band-authentication.md +++ /dev/null @@ -1,15 +0,0 @@ -# Out of Band Authentication Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/out_of_band_authentication -``` - -Commit used to check the authentication repository's validity. Supposed to be uqual to the first commit - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## out_of_band_authentication Type - -`string` ([Out of Band Authentication](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-out-of-band-authentication.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-urls.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-urls.md deleted file mode 100644 index e73995dd..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-urls.md +++ /dev/null @@ -1,15 +0,0 @@ -# URLs Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/urls -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## urls Type - -unknown ([URLs](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-urls.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md deleted file mode 100644 index e04b23f0..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md +++ /dev/null @@ -1,176 +0,0 @@ -# Auth Repo Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/data -``` - -All properties of the authentication repository. Can be used to instantiate the AuthenticationRepository - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## data Type - -`object` ([Auth Repo](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md)) - -all of - -* [Git Repository](repo-update-definitions-git-repository.md "check type definition") - -# data Properties - -| Property | Type | Required | Nullable | Defined by | -| :-------------------------------------------------------- | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [library_dir](#library_dir) | Not specified | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-librarys-root-directory.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/library_dir") | -| [name](#name) | Not specified | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-name.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/name") | -| [urls](#urls) | Not specified | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-urls.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/urls") | -| [default_branch](#default_branch) | Not specified | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-default-branch.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/default_branch") | -| [custom](#custom) | Not specified | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-custom.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/custom") | -| [conf_directory_root](#conf_directory_root) | `string` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-configuration-directorys-parent-directory.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/conf_directory_root") | -| [out_of_band_authentication](#out_of_band_authentication) | `string` | Optional | can be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-out-of-band-authentication.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/out_of_band_authentication") | -| [hosts](#hosts) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts") | - -## library_dir - - - -`library_dir` - -* is required - -* Type: unknown ([Library's Root Directory](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-librarys-root-directory.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-librarys-root-directory.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/library_dir") - -### library_dir Type - -unknown ([Library's Root Directory](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-librarys-root-directory.md)) - -## name - - - -`name` - -* is required - -* Type: unknown ([Name](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-name.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-name.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/name") - -### name Type - -unknown ([Name](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-name.md)) - -## urls - - - -`urls` - -* is required - -* Type: unknown ([URLs](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-urls.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-urls.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/urls") - -### urls Type - -unknown ([URLs](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-urls.md)) - -## default_branch - - - -`default_branch` - -* is optional - -* Type: unknown ([Default Branch](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-default-branch.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-default-branch.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/default_branch") - -### default_branch Type - -unknown ([Default Branch](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-default-branch.md)) - -## custom - - - -`custom` - -* is optional - -* Type: unknown ([Custom](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-custom.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-custom.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/custom") - -### custom Type - -unknown ([Custom](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-custom.md)) - -## conf_directory_root - -Path to the direcotry containing the configuration directory. The configuration direcotry contain last_validated_commit file and its name is equal to \_repo_name - -`conf_directory_root` - -* is optional - -* Type: `string` ([Configuration Directory's Parent Directory](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-configuration-directorys-parent-directory.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-configuration-directorys-parent-directory.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/conf_directory_root") - -### conf_directory_root Type - -`string` ([Configuration Directory's Parent Directory](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-configuration-directorys-parent-directory.md)) - -## out_of_band_authentication - -Commit used to check the authentication repository's validity. Supposed to be uqual to the first commit - -`out_of_band_authentication` - -* is optional - -* Type: `string` ([Out of Band Authentication](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-out-of-band-authentication.md)) - -* can be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-out-of-band-authentication.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/out_of_band_authentication") - -### out_of_band_authentication Type - -`string` ([Out of Band Authentication](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-out-of-band-authentication.md)) - -## hosts - -A dictionary mapping host names to additional information about them. - -`hosts` - -* is optional - -* Type: `object` ([Hosts](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data/properties/hosts") - -### hosts Type - -`object` ([Hosts](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo-properties-hosts.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-before_pull.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-before_pull.md deleted file mode 100644 index e8dddbdb..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-before_pull.md +++ /dev/null @@ -1,15 +0,0 @@ -# Untitled undefined type in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/before_pull -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## before_pull Type - -`string` diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-commit-after-pull.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-commit-after-pull.md deleted file mode 100644 index a53091fc..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-commit-after-pull.md +++ /dev/null @@ -1,15 +0,0 @@ -# Commit After Pull Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/after_pull -``` - -Repository's top commit before pull - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## after_pull Type - -`string` ([Commit After Pull](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-commit-after-pull.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits-items.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits-items.md deleted file mode 100644 index 1476a9f0..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits-items.md +++ /dev/null @@ -1,15 +0,0 @@ -# Untitled string in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/new/items -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## items Type - -`string` diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits.md deleted file mode 100644 index bd1773b7..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits.md +++ /dev/null @@ -1,19 +0,0 @@ -# Pulled Commits Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/new -``` - -A list of pulled (new) commits - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## new Type - -`string[]` - -## new Constraints - -**unique items**: all items in this array must be unique. Duplicates are not allowed. diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md deleted file mode 100644 index d99cf16a..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md +++ /dev/null @@ -1,81 +0,0 @@ -# Commits Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits -``` - -Information about commits - top commit before pull, pulled commits and top commit after pull - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## commits Type - -`object` ([Commits](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md)) - -# commits Properties - -| Property | Type | Required | Nullable | Defined by | -| :-------------------------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [before_pull](#before_pull) | `string` | Required | can be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-before_pull.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/before_pull") | -| [new](#new) | `array` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/new") | -| [after_pull](#after_pull) | `string` | Required | can be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-commit-after-pull.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/after_pull") | - -## before_pull - - - -`before_pull` - -* is required - -* Type: `string` - -* can be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-before_pull.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/before_pull") - -### before_pull Type - -`string` - -## new - -A list of pulled (new) commits - -`new` - -* is required - -* Type: `string[]` - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-pulled-commits.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/new") - -### new Type - -`string[]` - -### new Constraints - -**unique items**: all items in this array must be unique. Duplicates are not allowed. - -## after_pull - -Repository's top commit before pull - -`after_pull` - -* is required - -* Type: `string` ([Commit After Pull](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-commit-after-pull.md)) - -* can be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-commit-after-pull.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits/properties/after_pull") - -### after_pull Type - -`string` ([Commit After Pull](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits-properties-commit-after-pull.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details.md deleted file mode 100644 index 4e27c67f..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-auth-repo-with-update-details.md +++ /dev/null @@ -1,62 +0,0 @@ -# Auth Repo with Update Details Schema - -```txt -repo_update.schema.json#/properties/update/properties/auth_repo -``` - -All information about an authentication repository coupled with update details - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## auth_repo Type - -`object` ([Auth Repo with Update Details](repo-update-properties-update-data-properties-auth-repo-with-update-details.md)) - -# auth_repo Properties - -| Property | Type | Required | Nullable | Defined by | -| :------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [data](#data) | Merged | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data") | -| [commits](#commits) | `object` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits") | - -## data - -All properties of the authentication repository. Can be used to instantiate the AuthenticationRepository - -`data` - -* is required - -* Type: `object` ([Auth Repo](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/data") - -### data Type - -`object` ([Auth Repo](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-auth-repo.md)) - -all of - -* [Git Repository](repo-update-definitions-git-repository.md "check type definition") - -## commits - -Information about commits - top commit before pull, pulled commits and top commit after pull - -`commits` - -* is required - -* Type: `object` ([Commits](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md "repo_update.schema.json#/properties/update/properties/auth_repo/properties/commits") - -### commits Type - -`object` ([Commits](repo-update-properties-update-data-properties-auth-repo-with-update-details-properties-commits.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-change-indicator.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-change-indicator.md deleted file mode 100644 index 1c4d407f..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-change-indicator.md +++ /dev/null @@ -1,15 +0,0 @@ -# Change Indicator Schema - -```txt -repo_update.schema.json#/properties/update/properties/changed -``` - -Indicates if the repository was updated or not (will be false if pull was successful, but there were no new commits) - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## changed Type - -`boolean` ([Change Indicator](repo-update-properties-update-data-properties-change-indicator.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-custom.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-custom.md deleted file mode 100644 index c03baf69..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-custom.md +++ /dev/null @@ -1,15 +0,0 @@ -# Custom Schema - -```txt -repo_update.schema.json#/properties/update/properties/custom -``` - -Additional custom data. Not used by the framework. - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## custom Type - -`object` ([Custom](repo-update-properties-update-data-properties-custom.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-error-message.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-error-message.md deleted file mode 100644 index c3d7b829..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-error-message.md +++ /dev/null @@ -1,15 +0,0 @@ -# Error message Schema - -```txt -repo_update.schema.json#/properties/update/properties/error_msg -``` - -Error message that was raised while updating the repository - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## error_msg Type - -`string` ([Error message](repo-update-properties-update-data-properties-error-message.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-name.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-name.md deleted file mode 100644 index 8317318e..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-name.md +++ /dev/null @@ -1,15 +0,0 @@ -# Name Schema - -```txt -repo_update.schema.json#/properties/update/properties/repo_name -``` - -Name of the repository whose update was attempted - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## repo_name Type - -`string` ([Name](repo-update-properties-update-data-properties-name.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-new.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-new.md deleted file mode 100644 index 49c354dd..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-new.md +++ /dev/null @@ -1,15 +0,0 @@ -# Untitled array in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/new -``` - -A list of new authenticated commits (specified in target files of the authentication repository) - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## new Type - -`object[]` ([Commit SHA and Custom Information](repo-update-definitions-commit-sha-and-custom-information.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated-items.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated-items.md deleted file mode 100644 index 3f2fcfcd..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated-items.md +++ /dev/null @@ -1,15 +0,0 @@ -# Untitled string in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/unauthenticated/items -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## items Type - -`string` diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated.md deleted file mode 100644 index f7b4105b..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated.md +++ /dev/null @@ -1,19 +0,0 @@ -# Untitled array in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/unauthenticated -``` - -New unauthenticated commits - additional commits newer than the last authenticated commit in case of repositories where unauthenticated commits are allowed - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## unauthenticated Type - -`string[]` - -## unauthenticated Constraints - -**unique items**: all items in this array must be unique. Duplicates are not allowed. diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md deleted file mode 100644 index f7b8ab4f..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md +++ /dev/null @@ -1,100 +0,0 @@ -# Branch's Commits Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$ -``` - -Commit before pull, after pull and lists of new and unauthenticated commits belonging to the given branch - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## ^.\*$ Type - -`object` ([Branch's Commits](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md)) - -# ^.\*$ Properties - -| Property | Type | Required | Nullable | Defined by | -| :---------------------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [before_pull](#before_pull) | `object` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/before_pull") | -| [after_pull](#after_pull) | `object` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/after_pull") | -| [new](#new) | `array` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-new.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/new") | -| [unauthenticated](#unauthenticated) | `array` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$/properties/unauthenticated") | - -## before_pull - -Repository's top commit before pull - -`before_pull` - -* is required - -* Type: `object` ([Commit SHA and Custom Information](repo-update-definitions-commit-sha-and-custom-information.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.\*$/properties/commits/patternProperties/^.\*$/properties/before_pull") - -### before_pull Type - -`object` ([Commit SHA and Custom Information](repo-update-definitions-commit-sha-and-custom-information.md)) - -## after_pull - -Repository's top commit after pull - -`after_pull` - -* is required - -* Type: `object` ([Commit SHA and Custom Information](repo-update-definitions-commit-sha-and-custom-information.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.\*$/properties/commits/patternProperties/^.\*$/properties/after_pull") - -### after_pull Type - -`object` ([Commit SHA and Custom Information](repo-update-definitions-commit-sha-and-custom-information.md)) - -## new - -A list of new authenticated commits (specified in target files of the authentication repository) - -`new` - -* is required - -* Type: `object[]` ([Commit SHA and Custom Information](repo-update-definitions-commit-sha-and-custom-information.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-new.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.\*$/properties/commits/patternProperties/^.\*$/properties/new") - -### new Type - -`object[]` ([Commit SHA and Custom Information](repo-update-definitions-commit-sha-and-custom-information.md)) - -## unauthenticated - -New unauthenticated commits - additional commits newer than the last authenticated commit in case of repositories where unauthenticated commits are allowed - -`unauthenticated` - -* is required - -* Type: `string[]` - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits-properties-unauthenticated.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.\*$/properties/commits/patternProperties/^.\*$/properties/unauthenticated") - -### unauthenticated Type - -`string[]` - -### unauthenticated Constraints - -**unique items**: all items in this array must be unique. Duplicates are not allowed. diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties.md deleted file mode 100644 index 6eed6116..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties.md +++ /dev/null @@ -1,15 +0,0 @@ -# Untitled undefined type in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## patternProperties Type - -unknown diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md deleted file mode 100644 index 6fe59730..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md +++ /dev/null @@ -1,39 +0,0 @@ -# Commits by Branches Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Forbidden | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## commits Type - -`object` ([Commits by Branches](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md)) - -# commits Properties - -| Property | Type | Required | Nullable | Defined by | -| :------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `^.*$` | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits/patternProperties/^.*$") | - -## Pattern: `^.*$` - -Commit before pull, after pull and lists of new and unauthenticated commits belonging to the given branch - -`^.*$` - -* is optional - -* Type: `object` ([Branch's Commits](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.\*$/properties/commits/patternProperties/^.\*$") - -### ^.\*$ Type - -`object` ([Branch's Commits](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches-patternproperties-branchs-commits.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md deleted file mode 100644 index a75826ab..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md +++ /dev/null @@ -1,58 +0,0 @@ -# Repo and Commits Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$ -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## ^.\*$ Type - -`object` ([Repo and Commits](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md)) - -# ^.\*$ Properties - -| Property | Type | Required | Nullable | Defined by | -| :---------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [repo_data](#repo_data) | `object` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/repo_data") | -| [commits](#commits) | `object` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$/properties/commits") | - -## repo_data - -All information about a git repository instance. Can be used to create a new object. - -`repo_data` - -* is required - -* Type: `object` ([Git Repository](repo-update-definitions-git-repository.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.\*$/properties/repo_data") - -### repo_data Type - -`object` ([Git Repository](repo-update-definitions-git-repository.md)) - -## commits - - - -`commits` - -* is required - -* Type: `object` ([Commits by Branches](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.\*$/properties/commits") - -### commits Type - -`object` ([Commits by Branches](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits-properties-commits-by-branches.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties.md deleted file mode 100644 index 579dd800..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos-patternproperties.md +++ /dev/null @@ -1,15 +0,0 @@ -# Untitled undefined type in Repository Handlers Input Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos/patternProperties -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## patternProperties Type - -unknown diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos.md deleted file mode 100644 index 865140c2..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-target-repos.md +++ /dev/null @@ -1,39 +0,0 @@ -# Target Repos Schema - -```txt -repo_update.schema.json#/properties/update/properties/target_repos -``` - -Information about the authentication repository's target repositories, including the update details - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Forbidden | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## target_repos Type - -`object` ([Target Repos](repo-update-properties-update-data-properties-target-repos.md)) - -# target_repos Properties - -| Property | Type | Required | Nullable | Defined by | -| :------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `^.*$` | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.*$") | - -## Pattern: `^.*$` - - - -`^.*$` - -* is optional - -* Type: `object` ([Repo and Commits](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md "repo_update.schema.json#/properties/update/properties/target_repos/patternProperties/^.\*$") - -### ^.\*$ Type - -`object` ([Repo and Commits](repo-update-properties-update-data-properties-target-repos-patternproperties-repo-and-commits.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-update-event.md b/docs/updater/schemas/docs/repo-update-properties-update-data-properties-update-event.md deleted file mode 100644 index 5d5719d6..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data-properties-update-event.md +++ /dev/null @@ -1,15 +0,0 @@ -# Update Event Schema - -```txt -repo_update.schema.json#/properties/update/properties/event -``` - -Update event type - succeeded, changed, unchanged, failed, completed - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## event Type - -`string` ([Update Event](repo-update-properties-update-data-properties-update-event.md)) diff --git a/docs/updater/schemas/docs/repo-update-properties-update-data.md b/docs/updater/schemas/docs/repo-update-properties-update-data.md deleted file mode 100644 index 6bb8aa75..00000000 --- a/docs/updater/schemas/docs/repo-update-properties-update-data.md +++ /dev/null @@ -1,153 +0,0 @@ -# Update Data Schema - -```txt -repo_update.schema.json#/properties/update -``` - -All information related to the update process of an authentication repository - updated repository and pulled commits - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [repo-update.schema.json*](docs/repo-update.schema.json "open original schema") | - -## update Type - -`object` ([Update Data](repo-update-properties-update-data.md)) - -# update Properties - -| Property | Type | Required | Nullable | Defined by | -| :---------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [changed](#changed) | `boolean` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-change-indicator.md "repo_update.schema.json#/properties/update/properties/changed") | -| [event](#event) | `string` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-update-event.md "repo_update.schema.json#/properties/update/properties/event") | -| [repo_name](#repo_name) | `string` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-name.md "repo_update.schema.json#/properties/update/properties/repo_name") | -| [error_msg](#error_msg) | `string` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-error-message.md "repo_update.schema.json#/properties/update/properties/error_msg") | -| [auth_repo](#auth_repo) | `object` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details.md "repo_update.schema.json#/properties/update/properties/auth_repo") | -| [target_repos](#target_repos) | `object` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos.md "repo_update.schema.json#/properties/update/properties/target_repos") | -| [custom](#custom) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-update-data-properties-custom.md "repo_update.schema.json#/properties/update/properties/custom") | - -## changed - -Indicates if the repository was updated or not (will be false if pull was successful, but there were no new commits) - -`changed` - -* is required - -* Type: `boolean` ([Change Indicator](repo-update-properties-update-data-properties-change-indicator.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-change-indicator.md "repo_update.schema.json#/properties/update/properties/changed") - -### changed Type - -`boolean` ([Change Indicator](repo-update-properties-update-data-properties-change-indicator.md)) - -## event - -Update event type - succeeded, changed, unchanged, failed, completed - -`event` - -* is required - -* Type: `string` ([Update Event](repo-update-properties-update-data-properties-update-event.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-update-event.md "repo_update.schema.json#/properties/update/properties/event") - -### event Type - -`string` ([Update Event](repo-update-properties-update-data-properties-update-event.md)) - -## repo_name - -Name of the repository whose update was attempted - -`repo_name` - -* is required - -* Type: `string` ([Name](repo-update-properties-update-data-properties-name.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-name.md "repo_update.schema.json#/properties/update/properties/repo_name") - -### repo_name Type - -`string` ([Name](repo-update-properties-update-data-properties-name.md)) - -## error_msg - -Error message that was raised while updating the repository - -`error_msg` - -* is required - -* Type: `string` ([Error message](repo-update-properties-update-data-properties-error-message.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-error-message.md "repo_update.schema.json#/properties/update/properties/error_msg") - -### error_msg Type - -`string` ([Error message](repo-update-properties-update-data-properties-error-message.md)) - -## auth_repo - -All information about an authentication repository coupled with update details - -`auth_repo` - -* is required - -* Type: `object` ([Auth Repo with Update Details](repo-update-properties-update-data-properties-auth-repo-with-update-details.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-auth-repo-with-update-details.md "repo_update.schema.json#/properties/update/properties/auth_repo") - -### auth_repo Type - -`object` ([Auth Repo with Update Details](repo-update-properties-update-data-properties-auth-repo-with-update-details.md)) - -## target_repos - -Information about the authentication repository's target repositories, including the update details - -`target_repos` - -* is required - -* Type: `object` ([Target Repos](repo-update-properties-update-data-properties-target-repos.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-target-repos.md "repo_update.schema.json#/properties/update/properties/target_repos") - -### target_repos Type - -`object` ([Target Repos](repo-update-properties-update-data-properties-target-repos.md)) - -## custom - -Additional custom data. Not used by the framework. - -`custom` - -* is optional - -* Type: `object` ([Custom](repo-update-properties-update-data-properties-custom.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data-properties-custom.md "repo_update.schema.json#/properties/update/properties/custom") - -### custom Type - -`object` ([Custom](repo-update-properties-update-data-properties-custom.md)) diff --git a/docs/updater/schemas/docs/repo-update.md b/docs/updater/schemas/docs/repo-update.md deleted file mode 100644 index 7826d21a..00000000 --- a/docs/updater/schemas/docs/repo-update.md +++ /dev/null @@ -1,240 +0,0 @@ -# Repository Handlers Input Schema - -```txt -repo_update.schema.json -``` - - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | -| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------- | -| Can be instantiated | Yes | Unknown status | No | Forbidden | Forbidden | none | [repo-update.schema.json](docs/repo-update.schema.json "open original schema") | - -## Repository Handlers Input Type - -`object` ([Repository Handlers Input](repo-update.md)) - -# Repository Handlers Input Properties - -| Property | Type | Required | Nullable | Defined by | -| :---------------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------- | -| [update](#update) | `object` | Required | cannot be null | [Repository Handlers Input](repo-update-properties-update-data.md "repo_update.schema.json#/properties/update") | -| [state](#state) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-state.md "repo_update.schema.json#/properties/state") | -| [config](#config) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-properties-configuration-data.md "repo_update.schema.json#/properties/config") | - -## update - -All information related to the update process of an authentication repository - updated repository and pulled commits - -`update` - -* is required - -* Type: `object` ([Update Data](repo-update-properties-update-data.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-update-data.md "repo_update.schema.json#/properties/update") - -### update Type - -`object` ([Update Data](repo-update-properties-update-data.md)) - -## state - -Persistent and transient states - -`state` - -* is optional - -* Type: `object` ([State](repo-update-properties-state.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-state.md "repo_update.schema.json#/properties/state") - -### state Type - -`object` ([State](repo-update-properties-state.md)) - -## config - -Additional configuration, loaded from config.json located inside the library root - -`config` - -* is optional - -* Type: `object` ([Configuration Data](repo-update-properties-configuration-data.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-properties-configuration-data.md "repo_update.schema.json#/properties/config") - -### config Type - -`object` ([Configuration Data](repo-update-properties-configuration-data.md)) - -# Repository Handlers Input Definitions - -## Definitions group repo_data - -Reference this group by using - -```json -{"$ref":"repo_update.schema.json#/definitions/repo_data"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :-------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [library_dir](#library_dir) | `string` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-librarys-root-directory.md "repo_update.schema.json#/definitions/repo_data/properties/library_dir") | -| [name](#name) | `string` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-name.md "repo_update.schema.json#/definitions/repo_data/properties/name") | -| [urls](#urls) | `array` | Required | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-urls.md "repo_update.schema.json#/definitions/repo_data/properties/urls") | -| [custom](#custom) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-custom.md "repo_update.schema.json#/definitions/repo_data/properties/custom") | -| [default_branch](#default_branch) | `string` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-git-repository-properties-default-branch.md "repo_update.schema.json#/definitions/repo_data/properties/default_branch") | - -### library_dir - - - -`library_dir` - -* is required - -* Type: `string` ([Library's Root Directory](repo-update-definitions-git-repository-properties-librarys-root-directory.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-librarys-root-directory.md "repo_update.schema.json#/definitions/repo_data/properties/library_dir") - -#### library_dir Type - -`string` ([Library's Root Directory](repo-update-definitions-git-repository-properties-librarys-root-directory.md)) - -### name - -Repository's name, in namespace/repo_name format - -`name` - -* is required - -* Type: `string` ([Name](repo-update-definitions-git-repository-properties-name.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-name.md "repo_update.schema.json#/definitions/repo_data/properties/name") - -#### name Type - -`string` ([Name](repo-update-definitions-git-repository-properties-name.md)) - -### urls - -A list of repository's urls - -`urls` - -* is required - -* Type: `string[]` - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-urls.md "repo_update.schema.json#/definitions/repo_data/properties/urls") - -#### urls Type - -`string[]` - -#### urls Constraints - -**minimum number of items**: the minimum number of items for this array is: `1` - -**unique items**: all items in this array must be unique. Duplicates are not allowed. - -### custom - -Any additional information about the repository. Not used by the framework. - -`custom` - -* is optional - -* Type: `object` ([Custom](repo-update-definitions-git-repository-properties-custom.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-custom.md "repo_update.schema.json#/definitions/repo_data/properties/custom") - -#### custom Type - -`object` ([Custom](repo-update-definitions-git-repository-properties-custom.md)) - -### default_branch - -Name of the default branch, e.g. master or main - -`default_branch` - -* is optional - -* Type: `string` ([Default Branch](repo-update-definitions-git-repository-properties-default-branch.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-git-repository-properties-default-branch.md "repo_update.schema.json#/definitions/repo_data/properties/default_branch") - -#### default_branch Type - -`string` ([Default Branch](repo-update-definitions-git-repository-properties-default-branch.md)) - -## Definitions group commit_with_custom - -Reference this group by using - -```json -{"$ref":"repo_update.schema.json#/definitions/commit_with_custom"} -``` - -| Property | Type | Required | Nullable | Defined by | -| :------------------ | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [commit](#commit) | `string` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-commit.md "repo_update.schema.json#/definitions/commit_with_custom/properties/commit") | -| [custom](#custom-1) | `object` | Optional | cannot be null | [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md "repo_update.schema.json#/definitions/commit_with_custom/properties/custom") | - -### commit - -Commit SHA - -`commit` - -* is optional - -* Type: `string` - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-commit.md "repo_update.schema.json#/definitions/commit_with_custom/properties/commit") - -#### commit Type - -`string` - -### custom - - - -`custom` - -* is optional - -* Type: `object` ([Custom](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md)) - -* cannot be null - -* defined in: [Repository Handlers Input](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md "repo_update.schema.json#/definitions/commit_with_custom/properties/custom") - -#### custom Type - -`object` ([Custom](repo-update-definitions-commit-sha-and-custom-information-properties-custom.md)) diff --git a/docs/updater/schemas/host-update.schema.json b/docs/updater/schemas/host-update.schema.json deleted file mode 100644 index 2d74befd..00000000 --- a/docs/updater/schemas/host-update.schema.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "type": "object", - "$id": "host_update.schema.json", - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Host Handlers Input", - "properties": { - "update": { - "description": "All information related to the update process of a host (containing all authentication repositories linked to that host)", - "type": "object", - "title": "Update data", - "properties": { - "changed": { - "title": "Change Indicator", - "description": "Indicates if at least one of the host's repositories was updated (will be false if pull was successful, but there were no new commits)", - "type": "boolean" - }, - "event": { - "title": "Update Event", - "description": "Event type - succeeded, changed, unchanged, failed, completed", - "type": "string" - }, - "host_name": { - "title": "Name", - "description": "Name of the host whose update was attempted", - "type": "string" - }, - "error_msg": { - "title": "Error message", - "description": "Error message that was raised while updating the host's repositories", - "type": "string" - }, - "auth_repos": { - "title": "Authentication Repositories", - "type": "array", - "items": { - "$ref": "repo_update.schema.json#" - } - }, - "custom": { - "title": "Custom", - "description": "Additional host data. Not used by the framework", - "type": "object" - } - }, - "required": [ - "changed", - "event", - "host_name", - "error_msg", - "auth_repos" - ], - "additionalProperties": false - }, - "state": { - "title": "State", - "description": "Persistent and transient states", - "type": "object", - "properties": { - "transient": { - "title": "Transient", - "type": "object", - "description": "Transient data is arbitrary data passed from one script execution to the next one. It is discarded at the end of the process" - }, - "persistent": { - "title": "Persistent", - "type": "object", - "description": "Persistent data is arbitrary date passed from one script execution the next one and stored to disk (to a file called persistent.json directly inside the library root)" - } - } - }, - "config": { - "title": "Configuration data", - "description": "Additional configuration, loaded from config.json located inside the library root", - "type": "object" - } - }, - "required": [ - "update" - ], - "additionalProperties": false -} \ No newline at end of file diff --git a/docs/updater/schemas/repo-update.schema.json b/docs/updater/schemas/repo-update.schema.json deleted file mode 100644 index 1a36c246..00000000 --- a/docs/updater/schemas/repo-update.schema.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "definitions": { - "repo_data": { - "description": "All information about a git repository instance. Can be used to create a new object.", - "type": "object", - "title": "Git Repository", - "properties": { - "library_dir": { - "title": "Library's Root Directory", - "descirption": "Library's root directory. Repository's name is appended to it to form the full path", - "type": "string" - }, - "name": { - "title": "Name", - "description": "Repository's name, in namespace/repo_name format", - "type": "string" - }, - "urls": { - "title": "URLs", - "description": "A list of repository's urls", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1, - "uniqueItems": true - }, - "custom": { - "title": "Custom", - "description": "Any additional information about the repository. Not used by the framework.", - "type": "object" - }, - "default_branch": { - "title": "Default Branch", - "description": "Name of the default branch, e.g. master or main", - "type": "string" - } - }, - "required": [ - "library_dir", - "name", - "urls" - ] - }, - "commit_with_custom": { - "type": "object", - "title": "Commit SHA and Custom Information", - "properties": { - "commit": { - "description": "Commit SHA", - "type": "string" - }, - "custom": { - "title": "Custom", - "decription": "Additional custom information - can be anything that is useful for further processing. Not used by the framework.", - "type": "object" - } - } - } - }, - "type": "object", - "$id": "repo_update.schema.json", - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Repository Handlers Input", - "properties": { - "update": { - "description": "All information related to the update process of an authentication repository - updated repository and pulled commits", - "type": "object", - "title": "Update Data", - "properties": { - "changed": { - "title": "Change Indicator", - "description": "Indicates if the repository was updated or not (will be false if pull was successful, but there were no new commits)", - "type": "boolean" - }, - "event": { - "title": "Update Event", - "description": "Update event type - succeeded, changed, unchanged, failed, completed", - "type": "string" - }, - "repo_name": { - "title": "Name", - "description": "Name of the repository whose update was attempted", - "type": "string" - }, - "error_msg": { - "title": "Error message", - "description": "Error message that was raised while updating the repository", - "type": "string" - }, - "auth_repo": { - "description": "All information about an authentication repository coupled with update details", - "type": "object", - "title": "Auth Repo with Update Details", - "properties": { - "data": { - "description": "All properties of the authentication repository. Can be used to instantiate the AuthenticationRepository", - "title": "Auth Repo", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/repo_data" - } - ], - "properties": { - "library_dir": { - "title": "Library's Root Directory" - }, - "name": { - "title": "Name" - }, - "urls": { - "title": "URLs" - }, - "default_branch": { - "title": "Default Branch" - }, - "custom": { - "title": "Custom" - }, - "conf_directory_root": { - "title": "Configuration Directory's Parent Directory", - "description": "Path to the direcotry containing the configuration directory. The configuration direcotry contain last_validated_commit file and its name is equal to _repo_name", - "type": "string" - }, - "out_of_band_authentication": { - "title": "Out of Band Authentication", - "description": "Commit used to check the authentication repository's validity. Supposed to be uqual to the first commit", - "type": [ - "string", - "null" - ] - }, - "hosts": { - "description": "A dictionary mapping host names to additional information about them.", - "title": "Hosts", - "type": "object", - "patternProperties": { - "^.*$": { - "title": "Host Name with Custom Info", - "type": "object", - "properties": { - "custom": { - "title": "Custom", - "descirption": "Any information required for futher processing. Not used by the framework", - "type": "object" - } - }, - "additionalProperties": false - } - } - } - }, - "required": [ - "library_dir", - "name", - "urls" - ], - "additionalProperties": false - }, - "commits": { - "description": "Information about commits - top commit before pull, pulled commits and top commit after pull", - "type": "object", - "title": "Commits", - "properties": { - "before_pull": { - "titledescription": "Repository's top commit before pull", - "type": [ - "string", - "null" - ] - }, - "new": { - "title": "Pulled Commits", - "type": "array", - "description": "A list of pulled (new) commits", - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "after_pull": { - "title": "Commit After Pull", - "description": "Repository's top commit before pull", - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "before_pull", - "new", - "after_pull" - ], - "additionalProperties": false - } - }, - "additionalProperties": false, - "required": [ - "data", - "commits" - ] - }, - "target_repos": { - "description": "Information about the authentication repository's target repositories, including the update details", - "type": "object", - "title": "Target Repos", - "patternProperties": { - "^.*$": { - "title": "Repo and Commits", - "type": "object", - "properties": { - "repo_data": { - "$ref": "#/definitions/repo_data" - }, - "commits": { - "title": "Commits by Branches", - "type": "object", - "patternProperties": { - "^.*$": { - "description": "Commit before pull, after pull and lists of new and unauthenticated commits belonging to the given branch", - "type": "object", - "title": "Branch's Commits", - "properties": { - "before_pull": { - "description": "Repository's top commit before pull", - "$ref": "#/definitions/commit_with_custom" - }, - "after_pull": { - "description": "Repository's top commit after pull", - "$ref": "#/definitions/commit_with_custom" - }, - "new": { - "description": "A list of new authenticated commits (specified in target files of the authentication repository)", - "type": "array", - "items": { - "$ref": "#/definitions/commit_with_custom" - } - }, - "unauthenticated": { - "description": "New unauthenticated commits - additional commits newer than the last authenticated commit in case of repositories where unauthenticated commits are allowed", - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true - } - }, - "additionalProperties": false, - "required": [ - "before_pull", - "after_pull", - "new", - "unauthenticated" - ] - } - }, - "additionalProperties": false - } - }, - "required": [ - "repo_data", - "commits" - ], - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "custom": { - "title": "Custom", - "description": "Additional custom data. Not used by the framework.", - "type": "object" - } - }, - "required": [ - "changed", - "event", - "repo_name", - "error_msg", - "auth_repo", - "target_repos" - ], - "additionalProperties": false - }, - "state": { - "title": "State", - "description": "Persistent and transient states", - "type": "object", - "properties": { - "transient": { - "title": "Transient", - "type": "object", - "description": "Transient data is arbitrary data passed from one script execution to the next one. It is discarded at the end of the process" - }, - "persistent": { - "title": "Persistent", - "type": "object", - "description": "Persistent data is arbitrary date passed from one script execution the next one and stored to disk (to a file called persistent.json directly inside the library root)" - } - } - }, - "config": { - "description": "Additional configuration, loaded from config.json located inside the library root", - "title": "Configuration Data", - "type": "object" - } - }, - "required": [ - "update" - ], - "additionalProperties": false -} \ No newline at end of file