Repository Handlers Input Schema
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 |
Repository Handlers Input Type
object
(Repository Handlers Input)
Repository Handlers Input Properties
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
update | object |
Required | cannot be null | Repository Handlers Input |
state | object |
Optional | cannot be null | Repository Handlers Input |
config | object |
Optional | cannot be null | Repository Handlers Input |
update
All information related to the update process of an authentication repository - updated repository and pulled commits
update
-
is required
-
Type:
object
(Update Data) -
cannot be null
-
defined in: Repository Handlers Input
update Type
object
(Update Data)
state
Persistent and transient states
state
-
is optional
-
Type:
object
(State) -
cannot be null
-
defined in: Repository Handlers Input
state Type
object
(State)
config
Additional configuration, loaded from config.json located inside the library root
config
-
is optional
-
Type:
object
(Configuration Data) -
cannot be null
-
defined in: Repository Handlers Input
config Type
object
(Configuration Data)
Repository Handlers Input Definitions
Definitions group repo_data
Reference this group by using
{"$ref":"repo_update.schema.json#/definitions/repo_data"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
library_dir | string |
Required | cannot be null | Repository Handlers Input |
name | string |
Required | cannot be null | Repository Handlers Input |
urls | array |
Required | cannot be null | Repository Handlers Input |
custom | object |
Optional | cannot be null | Repository Handlers Input |
default_branch | string |
Optional | cannot be null | Repository Handlers Input |
library_dir
library_dir
-
is required
-
Type:
string
(Library's Root Directory) -
cannot be null
-
defined in: Repository Handlers Input
library_dir Type
string
(Library's Root Directory)
name
Repository's name, in namespace/repo_name format
name
-
is required
-
Type:
string
(Name) -
cannot be null
-
defined in: Repository Handlers Input
name Type
string
(Name)
urls
A list of repository's urls
urls
-
is required
-
Type:
string[]
-
cannot be null
-
defined in: Repository Handlers Input
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) -
cannot be null
-
defined in: Repository Handlers Input
custom Type
object
(Custom)
default_branch
Name of the default branch, e.g. master or main
default_branch
-
is optional
-
Type:
string
(Default Branch) -
cannot be null
-
defined in: Repository Handlers Input
default_branch Type
string
(Default Branch)
Definitions group commit_with_custom
Reference this group by using
{"$ref":"repo_update.schema.json#/definitions/commit_with_custom"}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
commit | string |
Optional | cannot be null | Repository Handlers Input |
custom | object |
Optional | cannot be null | Repository Handlers Input |
commit
Commit SHA
commit
-
is optional
-
Type:
string
-
cannot be null
-
defined in: Repository Handlers Input
commit Type
string
custom
custom
-
is optional
-
Type:
object
(Custom) -
cannot be null
-
defined in: Repository Handlers Input
custom Type
object
(Custom)