0
0
mirror of https://github.com/thegeeklab/wp-github-comment.git synced 2024-11-10 03:50:39 +00:00
wp-github-comment/docs/data/data.yaml

46 lines
1018 B
YAML
Raw Normal View History

2022-05-29 20:06:59 +00:00
---
properties:
- name: api_key
2024-01-03 21:49:33 +00:00
description: |
Personal access token to access the GitHub API.
2022-05-29 20:06:59 +00:00
type: string
required: true
2022-05-29 20:06:59 +00:00
- name: base_url
2024-01-03 21:49:33 +00:00
description: |
Api url.
Only need to be changed for GitHub enterprise in most cases.
2022-05-29 20:06:59 +00:00
type: string
2024-01-03 21:49:33 +00:00
defaultvalue: "https://api.github.com/"
2022-05-29 20:06:59 +00:00
required: false
- name: key
2024-01-03 21:49:33 +00:00
description: |
Unique identifier to assign to a comment.
The identifier is used to update an existing comment.
2022-05-29 20:06:59 +00:00
type: string
required: false
- name: message
2024-01-03 21:49:33 +00:00
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
2024-01-03 21:49:33 +00:00
- name: skip_missing
description: |
Skip comment creation if the given message file does not exist.
2022-05-29 20:06:59 +00:00
type: bool
2024-01-03 21:49:33 +00:00
defaultvalue: false
2022-05-29 20:06:59 +00:00
required: false
2024-01-03 21:49:33 +00:00
- name: update
description: |
Enable update of an existing comment that matches the key.
2022-05-29 20:06:59 +00:00
defaultValue: false
type: bool
2024-01-03 21:49:33 +00:00
defaultvalue: false
2022-05-29 20:06:59 +00:00
required: false