From 6ced80b6855043ae95d5d06aed9e969557fea91f Mon Sep 17 00:00:00 2001 From: thegeeklab-bot Date: Wed, 3 Jan 2024 21:54:02 +0000 Subject: [PATCH] [skip ci] auto-update documentation --- data/data.yaml | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/data/data.yaml b/data/data.yaml index dbce9ec..ba8798f 100644 --- a/data/data.yaml +++ b/data/data.yaml @@ -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