0
0
mirror of https://github.com/thegeeklab/wp-github-comment.git synced 2024-11-25 09:20:40 +00:00
wp-github-comment/_docs/data/data.yaml

35 lines
929 B
YAML
Raw Normal View History

2022-05-29 20:06:59 +00:00
---
properties:
- name: api_key
2022-05-29 20:06:59 +00:00
description: Personal Access token to access the GitHub API.
type: string
required: true
2022-05-29 20:06:59 +00:00
- name: base_url
2022-05-29 20:06:59 +00:00
description: API URL. Only need to be changed for GitHub enterprise in most cases
defaultValue: https://api.github.com
type: string
required: false
- name: key
2022-05-29 20:06:59 +00:00
description: Unique identifier to assign to a comment. The identifier is used to update an existing comment.
type: string
required: false
- name: message
description: Path to file or string that contains the comment text.
2022-05-29 20:06:59 +00:00
type: string
required: true
2022-05-29 20:06:59 +00:00
- name: update
2022-05-29 20:06:59 +00:00
description: Enables update of an existing comment that matches the key.
defaultValue: false
type: bool
required: false
- name: skip_missing
2022-05-29 20:06:59 +00:00
description: Skips comment creation if the given message file does not exist
defaultValue: false
type: bool
required: false