schemas.schema-form.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-fetcher-bitbucket Show documentation
The newest version!
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Bitbucket",
    "properties": {
        "bitbucketUrl": {
            "title": "Bitbucket api url",
            "description": "Bitbucket API url (e.g. https://api.bitbucket.org/2.0)",
            "type": "string",
            "default": "https://api.bitbucket.org/2.0"
        },
        "useSystemProxy": {
            "title": "Use system proxy",
            "description": "Use the system proxy configured by your administrator",
            "type": "boolean"
        },
        "username": {
            "title": "Username",
            "description": "Username or organization",
            "type": "string"
        },
        "repository": {
            "title": "Repository",
            "description": "Repository name",
            "type": "string"
        },
        "branchOrTag": {
            "title": "Ref",
            "description": "Branch name or tag (e.g. master). Default to master.",
            "type": "string",
            "default": "master"
        },
        "filepath": {
            "title": "Filepath",
            "description": "The path to the file to fetch (e.g. /docs/main/README.md)",
            "type": "string"
        },
        "login": {
            "title": "Login",
            "description": "The user login used in basic authentication. See https://developer.atlassian.com/bitbucket/api/2/reference/meta/authentication#basic-auth for details.",
            "type": "string"
        },
        "password": {
            "title": "Password",
            "description": "Use an application password. See https://developer.atlassian.com/bitbucket/api/2/reference/meta/authentication#app-pw for details.",
            "type": "string",
            "x-schema-form": {
                "type": "password"
            }
        },
        "autoFetch": {
            "title": "Enable Auto Fetch",
            "description": "Enable a periodic update of this documentation page",
            "type": "boolean",
            "default": false
        },
        "fetchCron": {
            "title": "Update frequency",
            "description": "Define update frequency using Crontab pattern. Leaving it empty will not trigger any update. Note: Platform administrator may have configured a max frequency that you cannot exceed.",
            "type": "string",
            "format": "gio-cron",
            "gioConfig": {
                "displayIf": {
                    "$eq": {
                        "value.autoFetch": true
                    }
                }
            }
        }
    },
    "required": ["bitbucketUrl", "username", "repository", "branchOrTag", "filepath", "login", "password"]
}