mirror of
https://github.com/thegeeklab/wp-github-comment.git
synced 2024-11-22 20:20:40 +00:00
[skip ci] auto-update documentation
This commit is contained in:
parent
b73410d476
commit
6ced80b685
@ -1,34 +1,45 @@
|
||||
---
|
||||
properties:
|
||||
- name: api_key
|
||||
description: Personal Access token to access the GitHub API.
|
||||
description: |
|
||||
Personal access token to access the GitHub API.
|
||||
type: string
|
||||
required: true
|
||||
|
||||
- name: base_url
|
||||
description: API URL. Only need to be changed for GitHub enterprise in most cases
|
||||
defaultValue: https://api.github.com
|
||||
description: |
|
||||
Api url.
|
||||
|
||||
Only need to be changed for GitHub enterprise in most cases.
|
||||
type: string
|
||||
defaultvalue: "https://api.github.com/"
|
||||
required: false
|
||||
|
||||
- name: key
|
||||
description: Unique identifier to assign to a comment. The identifier is used to update an existing comment.
|
||||
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.
|
||||
description: |
|
||||
Path to file or string that contains the comment text.
|
||||
type: string
|
||||
required: true
|
||||
|
||||
- name: update
|
||||
description: Enables update of an existing comment that matches the key.
|
||||
defaultValue: false
|
||||
- name: skip_missing
|
||||
description: |
|
||||
Skip comment creation if the given message file does not exist.
|
||||
type: bool
|
||||
defaultvalue: false
|
||||
required: false
|
||||
|
||||
- name: skip_missing
|
||||
description: Skips comment creation if the given message file does not exist
|
||||
- name: update
|
||||
description: |
|
||||
Enable update of an existing comment that matches the key.
|
||||
defaultValue: false
|
||||
type: bool
|
||||
defaultvalue: false
|
||||
required: false
|
||||
|
Loading…
Reference in New Issue
Block a user