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:
|
properties:
|
||||||
- name: api_key
|
- name: api_key
|
||||||
description: Personal Access token to access the GitHub API.
|
description: |
|
||||||
|
Personal access token to access the GitHub API.
|
||||||
type: string
|
type: string
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- name: base_url
|
- name: base_url
|
||||||
description: API URL. Only need to be changed for GitHub enterprise in most cases
|
description: |
|
||||||
defaultValue: https://api.github.com
|
Api url.
|
||||||
|
|
||||||
|
Only need to be changed for GitHub enterprise in most cases.
|
||||||
type: string
|
type: string
|
||||||
|
defaultvalue: "https://api.github.com/"
|
||||||
required: false
|
required: false
|
||||||
|
|
||||||
- name: key
|
- 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
|
type: string
|
||||||
required: false
|
required: false
|
||||||
|
|
||||||
- name: message
|
- 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
|
type: string
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- name: update
|
- name: skip_missing
|
||||||
description: Enables update of an existing comment that matches the key.
|
description: |
|
||||||
defaultValue: false
|
Skip comment creation if the given message file does not exist.
|
||||||
type: bool
|
type: bool
|
||||||
|
defaultvalue: false
|
||||||
required: false
|
required: false
|
||||||
|
|
||||||
- name: skip_missing
|
- name: update
|
||||||
description: Skips comment creation if the given message file does not exist
|
description: |
|
||||||
|
Enable update of an existing comment that matches the key.
|
||||||
defaultValue: false
|
defaultValue: false
|
||||||
type: bool
|
type: bool
|
||||||
|
defaultvalue: false
|
||||||
required: false
|
required: false
|
||||||
|
Loading…
Reference in New Issue
Block a user