[User] Provide a JSON object that satisfies the schema "MergifyConfigModel". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.

Actions

AndCondition

A string template using the Jinja2 syntax.

Template

Users

Template

Add Users

Template

Remove Users

AssignActionModel

Template

Mergify can impersonate a GitHub user to copy a pull request. If no `bot_account` is set, Mergify copies the pull request itself.

Bot Account

The list of branches the pull request should be copied to.

Branches

The list of regexes to find branches the pull request should be copied to.

Regexes

Whether to create the pull requests even if there are conflicts when cherry-picking the commits.

Ignore Conflicts

Users to assign the newly created pull request to. As the type is a data type template, you could use, e.g., `{{author}}` to assign the pull request to its original author.

Template

Assignees

The list of labels to add to the created pull requests.

Labels

The label to add to the created pull request if it has conflicts and `ignore_conflicts` is set to `true`.

Label Conflicts

The pull request's title.

Template

{{ body }}<hr>This is an automatic backport of pull request #{{number}} done by [Mergify](https://mergify.com).

The pull request's body.

Template

Reporting modes for the action's result. Check will create a check on the pull request, and comment will post a comment on the pull request.

Report Mode

Style used by git when displaying merge conflicts

Merge Conflict Style

BackportActionModel

A Git branch name.

Branch Name

This pull request has been automatically closed by Mergify.

Template

CloseActionModel

List of conditions

Command Restrictions

sender-permission >= write
sender = {{author}}

CommandsRestrictionsRulesModel

Template

The message to write as a comment.

Message

Template

Mergify can impersonate a GitHub user to comment a pull request. If no `bot_account` is set, Mergify will comment the pull request itself.

Bot Account

CommentActionModel

Sha

Parents

Commit Message

Indicates if the commit has been marked as verified by GitHub

Commit Verification Verified

Name of the author

Author

Name of the committer

Committer

Date Author

Date Committer

Email Author

Email Committer

GitHub login of the author

Gh Author Login

Commit

Name of the author

Name

Email address of the author

Email

CommitAuthor

Template

Bot Account

Branches

Regexes

Ignore Conflicts

Template

Assignees

Labels

Label Conflicts

The pull request's title.

Template

{{ body }}<hr>This is an automatic copy of pull request #{{number}} done by [Mergify](https://mergify.com).

The pull request's body.

Template

Report Mode

Merge Conflict Style

CopyActionModel

DefaultsRulesModel

If set to `true`, the branch will be deleted even if another pull request depends on the head branch. GitHub will therefore close the dependent pull requests.

Force

DeleteHeadBranchActionModel

Reason

DisabledDict

If set to `true`, all the approving reviews will be removed when the pull request is updated. If set to `false`, nothing will be done. If set to a list, each item should be the GitHub login of a user whose review will be removed. If set to `from_requested_reviewers`, the list of requested reviewers will be used to get whose review will be removed.

Approved

If set to `true`, all the reviews requesting changes will be removed when the pull request is updated. If set to false, nothing will be done. If set to a list, each item should be the GitHub login of a user whose review will be removed. If set to `from_requested_reviewers`, the list of requested reviewers will be used to get whose review will be removed.

Changes Requested

Template

Message to use when dismissing reviews.

Message

If set to `synchronize`, the action will run only if the pull request commits changed. Otherwise, it will run each time the rule matches.

When

DismissReviewsActionModel

Template

Bot Account

If the pull request should be a draft (true) or the other way around (false).

Draft

EditActionModel

GhaActionModel

GitHub Actions workflow dispatch

The name of the .yaml GitHub Workflow file with its extension.

Workflow

The reference to use when triggering the job. If none is passed, the default repository branch is used.

Ref

A string template using the Jinja2 syntax.

Template

The inputs passed to your workflow execution if any. Values can be either a template, a number or a Boolean.

Inputs

Workflow Action Dispatch

GitHub Actions workflow action

The list of workflows to dispatch via the action.

Dispatch

Workflow Action

GitHubRepositoryPermission

Add or remove labels on a pull request.

The list of labels to add.

Template

Add

The list of labels to remove.

Template

Remove

Remove all labels from the pull request.

Remove All

Toggle labels in the list based on the conditions. If all the conditions are a success, all the labels in the list will be added, otherwise, they will all be removed.

Template

Toggle

LabelActionModel

List of conditions

Method

Template

Mergify can impersonate a GitHub user to merge pull requests. If no `merge_bot_account` is set, Mergify merges the pull request itself. The user account **must** have already been logged in Mergify dashboard once and have **write** or **maintain** permission.

Merge Bot Account

Template

Template to use as the commit message when using the merge or squash merge method.

Commit Message Template

MergeActionModel

List of conditions

The name of the rule

Name

The conditions to check before applying the rule

The conditions to check to validate the rule

A description of the rule

Description

MergeProtectionRuleModel

MergeProtectionRulesModel

The merge protection reporting method

Reporting Method

MergeProtectionsModel

The maximum number of speculative checks allowed to run at the same time.

Max Parallel Checks

Defines the behavior of the merge queue when something is merged outside of the queue.
"always": The queue is reset when an external merge is detected. All queued pull requests are re-evaluated to ensure correctness based on the new base branch state.
"never": The queue remains unchanged. It does not reset or re-evaluate based on the external merge.

Reset On External Merge

MergeQueueModel

Not

NegationCondition

OrCondition

List of conditions

Name of the partition

Name

List of conditions to determine the partition(s) in which the pull request will be queued. If a pull request matches no partition, it is added to the fallback partition if defined. Otherwise it is added to every partition.

Allow the partition to work as the fallback partition. There can be only one fallback partition.

Fallback Partition

PartitionRuleModel

PartitionRulesModel

'{{ check_rule_name }}'{% if check_status == 'success' %} succeeded{% elif check_status == 'failure' %} failed{% endif %}

The title of the check.

Template

The summary of the check.

Template

List of conditions to match to mark the pull request check as succeeded, otherwise, it will be marked as failing. If unset, the conditions from the rule that triggers this action are used.

List of conditions to match to mark the pull request check as neutral, otherwise, it will be marked as failing.

PostCheckActionModel

List of conditions

Name of the rule.

Name

The list of conditions that needs to match to assign priority to the pull request.

The priority of the pull request.

Priority

Allow interrupting the ongoing checks when the pull request entering the queue has a higher priority than the queued one(s). If set to false, a pull request with higher priority will be inserted just after the pull requests that have checks running.

Allow Checks Interruption

PriorityRuleModel

PriorityRulesModel

Whether the pull request is in draft state.

Draft

Whether the pull request is merged.

Merged

Whether the pull request contains changes in the configuration file.

Mergify configuration changed

Whether the pull request is closed.

Closed

Whether the pull request is locked.

Locked

Whether the pull request commits history is linear (no merge commit).

Linear history

Whether the pull request is conflicting with its base branch.

Conflict

The review decision. This indicates if `CODEOWNERS` have reviewed the pull request when the `Require Review from Code Owners` branch protection rule is enabled.

Branch protection review decision

The pull request number.

Number

The position of the pull request in its queue if queued. The first pull request in the queue has position 0. The value is set to -1 if the pull request is not queued. If you are using partitions, this returns the maximum position of the pull request from all the partitions it is queued in.

Queue position

The GitHub user or team login of the author of the pull request.

Author

The GitHub user that merged the pull request.

Merged by

The merge commit SHA of the pull request returned by GitHub.

Merge commit sha

The milestone title associated to the pull request.

Milestone

The name of the branch the pull request should be pulled into.

Base

The name of the branch where the pull request changes are implemented.

Head

The head branch repository full name (complete version with the organization name).

Head repo full name

The title of the pull request.

Title

The content of the pull request description without Markdown/HTML comments.

Body

The content of the pull request description.

Body raw

The current repository name (short version without the organization name).

Repository name

The current repository full name (complete version with the organization name).

Repository full name

A dequeue code for when a pull request has been disembarked from the merge queue.

Queue dequeue reason

The name of the queue containing the pull request.

Queue name

The name of the partitions the pull request is queued in.

Queue partition name

The list of GitHub user or team login that are assigned to the pull request. Team logins are prefixed with the `@` character and must belong to the repository organization.

Assignee

The list of labels of the pull request.

Label

The list of GitHub user or team login that were requested to review the pull request. Team logins are prefixed with the @ character. This only matches reviewers with `admin`, `write` or `maintain` permission on the repository.

Review requested

The list of GitHub user or team login that approved the pull request. Team logins are prefixed with the `@` character and must belong to the repository organization. This only matches reviewers with `admin`, `write` or `maintain` permission on the repository.

Approved reviews by

The list of GitHub user login that have their review dismissed in the pull request.

Dismissed reviews by

The list of GitHub user or team login that have requested changes in a review for the pull request.

Changes requested reviews by

The list of GitHub user that have commented in a review for the pull request. This only matches reviewers with `admin`, `write` or `maintain` permission on the repository.

Commented reviews by

The list of checks that successfully passed for the pull request.

Check success

The list of checks that failed for the pull request. Checks that report being cancelled, timed out, and action required are also considered as failures.

Check failure

The list of checks that are neutral for the pull request.

Check neutral

The list of checks that timed out for the pull request.

Check timed out

The list of checks that was skipped for the pull request.

Check skipped

The list of checks that are pending for the pull request.

Check pending

The list of checks for that pull request.

Check

The list of checks that are stale for the pull request.

Check stale

The list of commit messages that are marked as unverified by GitHub.

Commits unverified

The list of deployments that successfully passed for the pull request.

Deployment success

The list of deployments that failed for the pull request.

Deployment failure

The list of bodies associated to review threads that are marked as resolved by GitHub.

Review threads resolved

The list of bodies associated to review threads that are NOT marked as resolved by GitHub.

Review threads unresolved

The files that are modified, deleted or added by the pull request.

Files

The files that are added by the pull request.

Added files

The files that are modified by the pull request.

Modified files

The files that are removed by the pull request.

Removed files

The lines that are added by the pull request. Only usable as `#added-lines` for the number of added lines.

Added lines

The lines that are modified by the pull request. Only usable as `#modified-lines` for the number of modified lines.

Modified lines

The lines that are deleted by the pull request. Only usable as `#deleted-lines` for the number of deleted lines.

Deleted lines

The list of co-authors on the pull request (excluding merge commits and bots).

Co authors

The list of commits between the head of the base branch and the base of the pull request. This can only be used with the length operator as `#commits-behind`.

Commits behind

The list of dependencies to other pull request in the format `owner/repo#prnumber`.

Depends on

The dependency-name value included in the Dependabot commit message.

Dependabot dependency name

The dependency-type value included in the Dependabot commit message.

Dependabot dependency type

The update-type value included in the Dependabot commit message.

Dependabot update type

The list of commits of the pull request. The index 0 is the first commit, while -1 is the last commit.

Commits

The current date and time.

Current datetime

The time the pull request was updated at.

Updated at

The time the pull request was created at.

Created at

The time the pull request was closed at.

Closed at

The time the pull request was merged at.

Merged at

The time the pull request was queued at for merge.

Queued at

The time the pull request mergeability checks have started at. This attribute does not work yet when using partition rules.

Queue merge started at

The current time will be compared against this schedule to validate this attribute.

Schedule

The permission of the command author.

Sender permission

The GitHub login of the command author.

Sender

The list of updates done on an opened pull request.

Updates

draft merged mergify-configuration-changed closed locked linear-history conflict branch-protection-review-decision number queue-position author merged-by merge-commit-sha milestone base head head-repo-full-name title body body-raw repository-name repository-full-name queue-dequeue-reason queue-name queue-partition-name assignee label review-requested approved-reviews-by dismissed-reviews-by changes-requested-reviews-by commented-reviews-by check-success check-failure check-neutral check-timed-out check-skipped check-pending check check-stale commits-unverified deployment-success deployment-failure review-threads-resolved review-threads-unresolved files added-files modified-files removed-files added-lines modified-lines deleted-lines co-authors commits-behind depends-on dependabot-dependency-name dependabot-dependency-type dependabot-update-type commits current-datetime updated-at created-at closed-at merged-at queued-at queue-merge-started-at schedule sender-permission sender updates

PullRequestAttributes

Head sha

Timestamp

PullRequestHeadShaHistoryDict

List of conditions

The name of the rule. This is used when reporting information about a rule. It's not possible to have two rules with the same name.

Name

A description of the rule.

Description

If the rule is disabled, the reason why it's disabled.

The conditions that must be met for the rule to be evaluated.

The actions to perform when the rule matches.

Pull Request Rule

PullRequestRulesModel

The name of the queue where the pull request should be added. If no name is set, queue_conditions will be applied instead.

Name

QueueActionModel

List of conditions

The list of conditions that needs to match to queue the pull request.

The list of conditions to match to get the queued pull request merged. This automatically includes the `queue_conditions`. In case of speculative merge pull request, the merge conditions starting by check- are evaluated against the temporary pull request instead of the original one.

Branch protections conditions injection mode to use.

- `queue` will inject branch protections conditions as required conditions for queuing and merging pull requests.
- `merge` will inject branch protections conditions as required conditions only for merging pull requests.
- `none` will disable branch protections. This mode is supported only on queues using a `merge_bot_account` with admin rights.

Branch Protection Injection Mode

:bangbang: **Action Required** :bangbang:
> **The configuration uses the deprecated `speculative_checks` attribute in the `queue_rules` section. It has been replaced in favor of `max_parallel_checks` in the `merge_queue` section of the configuration.
> For more information: https://docs.mergify.com/merge-queue/speculative-checks/

The maximum number of checks to run in parallel in the queue. Must be between 1 and 128.

Speculative Checks

The maximum number of pull requests per speculative check in the queue. Must be between 1 and 128.

Batch Size

The maximum amount of time to wait before creating a batch when the batch is not full.

Batch Max Wait Time

Allow to update or rebase the original pull request to check its mergeability when first in the queue and not part of a batch or speculative check.

Allow Inplace Checks

The amount of time the merge queue waits for pending checks to return before dequeueing pull requests. This cannot be less than 60 seconds.

Checks Timeout

Mergify can impersonate a GitHub user to create its draft pull requests. If no `draft_bot_account` is set, Mergify creates the draft pull request itself. The user account must have already been logged in Mergify dashboard once and have admin, write or maintain permission.

Draft Bot Account

If set to `fast-forward`, Mergify will merge the draft pull request instead of merging the original pull request that has been checked. This only works when `merge_method` is set to `merge`.

Queue Branch Merge Method

Prefix for the merge queue branch name

Template

When creating a branch for a queue, if the commits of this branch are edited by an entity external to Mergify, Mergify dequeues all pull requests embarked in the branch and report the issue as a failure. If set to `true`, Mergify will allow such modifications and trust the content of the branch. Make sure only Mergify and your external application are allowed to edit these branches.

Allow Queue Branch Edit

The number of attempts to resolve a batch failure before dequeueing pull requests. By default, Mergify will attempt to resolve a batch failure by splitting the batch multiple times until it finds the root cause of the failure. You can stop this process earlier by limiting the number of resolution attempts. Setting this to 0 will dequeue all the pull requests from a batch when a batch fails.

Batch Max Failure Resolution Attempts

Merge method to use. If no value is set, Mergify uses the first authorized method available in the repository configuration. `fast-forward` is not supported on queues with `max_parallel_checks > 1`, `batch_size > 1`, or with `allow_inplace_checks` set to `false`.

Merge Method

This option is relevant only if you do in place checks and if you use the `rebase` option of the update_method. It will automatically squash your commits beginning by `squash!`, `fixup!` or `amend!`, just like the option with the same name when doing a `git rebase`.

Autosquash

Method to use to update the pull request with its base branch when the check is done in place.
Possible values:

- `merge` to merge the base branch into the pull request.
- `rebase` to rebase the pull request against its base branch.

This option overrides the value defined in the queue rules section of the configuration.
The default is rebase when the `merge_method` is `fast-forward`.

Update Method

A string template using the Jinja2 syntax.

Template

Template to use as the commit message when using the merge or squash merge method.

Commit Message Template

Template

Merge Bot Account

Template

For certain actions, such as rebasing branches, Mergify has to impersonate a GitHub user. You can specify the account to use with this option. If no `update_bot_account` is set, Mergify picks randomly one of the organization users instead. The user account **must** have already been logged in Mergify dashboard once. This option overrides the value defined in the queue rules section of the configuration.

Update Bot Account

Name

QueueRuleModel

The list of conditions that needs to match to queue the pull request.

Branch Protection Injection Mode

The maximum number of checks to run in parallel in the queue. Must be between 1 and 128.

Speculative Checks

The maximum number of pull requests per speculative check in the queue. Must be between 1 and 128.

Batch Size

The maximum amount of time to wait before creating a batch when the batch is not full.

Batch Max Wait Time

Allow Inplace Checks

Checks Timeout

Draft Bot Account

Queue Branch Merge Method

Prefix for the merge queue branch name

Template

Allow Queue Branch Edit

Batch Max Failure Resolution Attempts

Merge Method

Autosquash

Update Method

A string template using the Jinja2 syntax.

Template

Template to use as the commit message when using the merge or squash merge method.

Commit Message Template

Template

Merge Bot Account

Template

Update Bot Account

QueueRuleModelForDefaults

QueueRulesModel

Template

To rebase, Mergify needs to impersonate a GitHub user. You can specify the account to use with this option. If no `bot_account` is set, Mergify picks the pull request author. The user account must have already been logged in Mergify dashboard once.

Bot Account

When set to `true`, commits starting with `fixup!`, `squash!` and `amend!` are squashed during the rebase.

Autosquash

RebaseActionModel

Template

Mergify can impersonate a GitHub user to request a review on a pull request. If no `bot_account` is set, Mergify will request the review itself.

Bot Account

Pick random users and teams from the provided lists. When `random_count` is specified, `users` and `teams` can be a dictionary where the key is the login and the value is the weight to use. Weight must be between 1 and 15 included.

Random Count

The usernames to request reviews from.

Users

The team names to request reviews from.

Teams

The team names to get the list of users to request reviews from.

Users From Teams

RequestReviewsActionModel

The type of review to post

Type

Template

The message to post in the review

Message

Template

Mergify can impersonate a GitHub user to review a pull request. If no `bot_account` is set, Mergify will review the pull request itself.

Bot Account

ReviewActionModel

Model defining a single rule condition 'leaf of a condition tree'

RuleConditionModel

Template

Mergify can impersonate a GitHub user to squash a pull request. If no `bot_account` is set, Mergify will squash the pull request itself

Bot Account

Defines what commit message to use for the squashed commit if no commit message is defined in the pull request body.
Possible values are:

- `all-commits` to use the same format as GitHub squashed merge commit.
- `first-commit` to use the message of the first commit of the pull request.
- `title+body` means to use the title and body from the pull request itself as the commit message. The pull request number will be added to end of the title.

Commit Message

SquashActionModel

Template

Mergify can impersonate a GitHub user to update a pull request. If no `bot_account` is set, Mergify will update the pull request itself.

Bot Account

UpdateActionModel

MergifyConfigModel

Shared

Extends

Provide a JSON object that satisfies the schema "MergifyConfigModel". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$defs":{"ActionGroup":{"items":{"oneOf":[{"type":"string"},{"$ref":"#/$defs/Metadata"}]},"type":"array"},"Metadata":{"properties":{"metadata":{"properties":{"extend_group":{"items":{"type":"string"},"type":"array"}},"type":"object"}},"type":"object"},"Redirect":{"properties":{"redirect":{"type":"string"}},"type":"object"}},"$id":"https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/meta-runtime.json","$schema":"http://json-schema.org/draft-07/schema","additionalProperties":false,"description":"See https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_structure.html#meta-directory","examples":["**/meta/runtime.yml"],"properties":{"action_groups":{"additionalProperties":{"$ref":"#/$defs/ActionGroup"},"description":"A mapping of groups and the list of action plugin and module names they contain. They may also have a special \u2018metadata\u2019 dictionary in the list, which can be used to include actions from other groups.","title":"Action Groups","type":"object"},"import_redirection":{"additionalProperties":{"$ref":"#/$defs/Redirect"},"description":"A mapping of names for Python import statements and their redirected locations.","title":"Import Redirection","type":"object"},"plugin_routing":{"markdownDescription":"Content in a collection that Ansible needs to load from another location or that has been deprecated/removed. The top level keys of plugin_routing are types of plugins, with individual plugin names as subkeys. To define a new location for a plugin, set the redirect field to another name. To deprecate a plugin, use the deprecation field to provide a custom warning message and the removal version or date. If the plugin has been renamed or moved to a new location, the redirect field should also be provided. If a plugin is being removed entirely, tombstone can be used for the fatal error message and removal version or date.","properties":{"inventory":{},"module_utils":{},"modules":{}},"title":"Plugin Routing","type":"object"},"requires_ansible":{"examples":[">=2.10,<2.11"],"pattern":"^[^\\s]*$","title":"The version of Ansible Core (ansible-core) required to use the collection. Multiple versions can be separated with a comma.","type":"string"}},"title":"Ansible Meta Runtime Schema","type":"object"}
</schema>

[User] Provide a JSON object that satisfies the schema "Ansible Meta Runtime Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.

See https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_structure.html#meta-directory

A mapping of groups and the list of action plugin and module names they contain. They may also have a special ‘metadata’ dictionary in the list, which can be used to include actions from other groups.

Action Groups

A mapping of names for Python import statements and their redirected locations.

Import Redirection

Content in a collection that Ansible needs to load from another location or that has been deprecated/removed. The top level keys of plugin_routing are types of plugins, with individual plugin names as subkeys. To define a new location for a plugin, set the redirect field to another name. To deprecate a plugin, use the deprecation field to provide a custom warning message and the removal version or date. If the plugin has been renamed or moved to a new location, the redirect field should also be provided. If a plugin is being removed entirely, tombstone can be used for the fatal error message and removal version or date.

Plugin Routing

The version of Ansible Core (ansible-core) required to use the collection. Multiple versions can be separated with a comma.

Ansible Meta Runtime Schema

Provide a JSON object that satisfies the schema "Ansible Meta Runtime Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://dwp.gov.uk/exchange/publishing-tools/apigw/meta-schema.json","title":"Meta","type":"object","properties":{"workspace":{"$id":"#root/workspace","title":"Workspace","type":"string","minLength":2,"maxLength":60,"examples":["integration"],"pattern":"^(?!-)[a-zA-Z0-9./_-]*$"},"product_name":{"$id":"#root/product_name","title":"Product name","type":"string","minLength":2,"maxLength":60,"examples":["NHS Charge Exemption"],"pattern":"^(?!-\\s)[a-zA-Z0-9\\s._-]+$"},"product_id":{"$id":"#root/product_id","title":"Product ID","type":"string","format":"uuid"},"authentication_proxy":{"$id":"#root/authentication_proxy","title":"Authentication proxy","type":"boolean","examples":["true"]},"workspace_gitlab_groups":{"$id":"#root/workspace_gitlab_groups","title":"GitLab groups for workspace","description":"This field is deprecated and will be removed in a future version","x-deprecated":true,"type":"array","items":{"type":"string","pattern":"^@dwp/(?:\\w+|-\\w+|/\\w+)+$","examples":["@dwp/team-name"]}},"product_gitlab_groups":{"$id":"#root/product_gitlab_groups","title":"GitLab groups for product name","type":"array","pattern":"^@dwp/(?:\\w+|-\\w+|/\\w+)+$","items":{"type":"string","examples":["@dwp/team-name"]}},"onboarding":{"$id":"#root/onboarding","title":"Additional information required for onboarding","type":"object","properties":{"ifdp":{"type":"string","pattern":"^IFDP-\\d+$","examples":["IFDP-1234"]},"hcs":{"type":"boolean"},"hosts":{"type":"object","properties":{"non-prod":{"type":"array","items":{"type":"string","pattern":"^(?:(\\*\\.)?[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)*)?$","examples":["api.example.dwp.gov.uk"]}},"prod":{"type":"array","items":{"type":"string","pattern":"^(?:(\\*\\.)?[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)*)?$","examples":["api.example.dwp.gov.uk"]}}}},"ip_ranges":{"type":"object","properties":{"non-prod":{"type":"array","items":{"type":"string","pattern":"^\\d+(?:\\.\\d+)+/\\d+$","examples":["10.82.108.0/22"]}},"prod":{"type":"array","items":{"type":"string","pattern":"^\\d+(?:\\.\\d+)+/\\d+$","examples":["10.82.108.0/22"]}}}}},"additionalProperties":false}},"additionalProperties":false,"required":["workspace"],"anyOf":[{"required":["product_name"]},{"required":["workspace_gitlab_groups"]}],"dependencies":{"product_gitlab_groups":["product_name"],"product_name":["product_id"]}}
</schema>

[User] Provide a JSON object that satisfies the schema "Meta". Here are the required top‑level fields: workspace. Return only the valid JSON object.

Meta

Workspace

Product name

Product ID

Authentication proxy

GitLab groups for workspace

This field is deprecated and will be removed in a future version

GitLab groups for product name

Additional information required for onboarding

Provide a JSON object that satisfies the schema "Meta". Here are the required top‑level fields: workspace. Return only the valid JSON object.


[User] Provide a JSON object that satisfies the schema "Ansible Meta Schema v1/v2". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.

Name

AIXPlatformModel

Name

AlpinePlatformModel

Name

Amazon Linux 2PlatformModel

Name

AmazonPlatformModel

Name

ArchLinuxPlatformModel

Name

AstraLinuxPlatformModel

Name

ClearLinuxPlatformModel

Name

CumulusPlatformModel

Name

bookworm bullseye buster etch jessie lenny sid squeeze stretch trixie wheezy all

DebianPlatformModel

Name

DellOSPlatformModel

See https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_reuse_roles.html#role-dependencies and https://github.com/ansible/ansible/blob/devel/lib/ansible/playbook/role/metadata.py#L79

Other keys are treated as role [parameters](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#passing-different-parameters).

Become

Name

Role

Scm

Src

Tags

Vars

Version

When

Dependency entry

Name

ascii beowulf chimaera daedalus jessie all

DevuanPlatformModel

Name

DragonFlyBSDPlatformModel

Name

ELPlatformModel

Name

FedoraPlatformModel

Name

FreeBSDPlatformModel

Standalone role, so we require several fields.

author description license min_ansible_version

Collection roles do not use most galaxy fields.

If standalone is false, then we have a collection role and only description is required

Author

Company

Description

Galaxy Tags

Optionally specify the branch Galaxy will use when accessing the GitHub repo for this role

GitHub Branch

Issue Tracker Url

License

Min Ansible Container Version

Min Ansible Version

Used by molecule and ansible-lint to compute FQRN for roles outside collections

Namespace Name

Role Name

Set to true for old standalone roles, or false for new collection roles.

Standalone

GalaxyInfoModel

Name

GenericBSDPlatformModel

Name

GenericLinuxPlatformModel

Name

GenericUNIXPlatformModel

Name

GentooPlatformModel

Name

HardenedBSDPlatformModel

Name

IOSPlatformModel

Name

JunosPlatformModel

Name

KaliPlatformModel

Name

MacOSXPlatformModel

Name

MageiaPlatformModel

Name

NXOSPlatformModel

Name

NetBSDPlatformModel

Name

OpenBSDPlatformModel

Name

OpenWrtPlatformModel

Name

OracleLinuxPlatformModel

Name

PAN-OSPlatformModel

Name

RockyLinuxPlatformModel

Name

SLESPlatformModel

Name

SmartOSPlatformModel

Name

SolarisPlatformModel

Name

SynologyPlatformModel

Name

TMOSPlatformModel

Name

artful bionic cosmic disco eoan focal groovy hirsute impish jammy kinetic lucid lunar mantic noble maverick natty oneiric oracular plucky precise quantal raring saucy trusty utopic vivid wily xenial yakkety zesty all

UbuntuPlatformModel

Name

Void LinuxPlatformModel

Name

WindowsPlatformModel

Name

aosPlatformModel

See [Using collections in roles](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#using-collections-in-roles) and [collection naming conventions](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_in_groups.html#naming-conventions)

Collections

Name

eosPlatformModel

Name

Big-Sur Catalina High-Sierra Mojave Monterey Sierra Sonoma Ventura all

macOSPlatformModel

Name

opensusePlatformModel

Name

os10PlatformModel

Platforms

Name

vCenterPlatformModel

Name

vSpherePlatformModel

Allow Duplicates

Dependencies

Ansible Meta Schema v1/v2

Provide a JSON object that satisfies the schema "Ansible Meta Schema v1/v2". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.