Skip to content

Commit

Permalink
Merge pull request #22 from shrutimantri/correct-name
Browse files Browse the repository at this point in the history 
fix(docs): correct the name of the attributes
  • Loading branch information
@wrussell1999
wrussell1999 authored Aug 22, 2024
2 parents 50fa656 + 7e1f12b commit 66ab236
Show file tree
Hide file tree
Showing 10 changed files with 158 additions and 158 deletions.
34 changes: 18 additions & 16 deletions src/main/java/io/kestra/plugin/github/code/Search.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
@Getter
@NoArgsConstructor
@Schema(
title = "Search for GitHub code",
description = "Requires authentication"
title = "Search for GitHub code.",
description = "Requires authentication."
)
@Plugin(
examples = {
Expand Down Expand Up @@ -84,20 +84,20 @@ public enum Fork {
}

@Schema(
title = "The query contains one or more search keywords and qualifiers",
description = "Allow you to limit your search to specific areas of GitHub"
title = "The query contains one or more search keywords and qualifiers.",
description = "Allow you to limit your search to specific areas of GitHub."
)
@PluginProperty(dynamic = true)
private String query;

@Schema(
title = "The GitHub repository"
title = "The GitHub repository."
)
@PluginProperty(dynamic = true)
private String repository;

@Schema(
title = "Search commits in all repositories owned by a certain user"
title = "Search commits in all repositories owned by a certain user."
)
@PluginProperty(dynamic = true)
private String user;
Expand All @@ -109,45 +109,46 @@ public enum Fork {
private String in;

@Schema(
title = "The language"
title = "The language."
)
@PluginProperty(dynamic = true)
private String language;

@Schema(
title = "The file extension"
title = "The file extension."
)
@PluginProperty(dynamic = true)
private String extension;

@Schema(
name = "Whether to include forks"
description = "Whether to include forks."
)
@PluginProperty
private Fork fork;

@Schema(
title = "The file name"
title = "The file name."
)
@PluginProperty(dynamic = true)
private String filename;

@Schema(
title = "The file path"
title = "The file path."
)
@PluginProperty(dynamic = true)
private String path;

@Schema(
title = "The file path"
title = "The file size."
)
@PluginProperty(dynamic = true)
private String size;

@Schema(
name = "Order output",
name = "order",
title = "Order of the output.",
description = """
ASC - the results will be in ascending order
ASC - the results will be in ascending order\n
DESC - the results will be in descending order
"""
)
Expand All @@ -156,9 +157,10 @@ public enum Fork {
private Order order = Order.ASC;

@Schema(
name = "Sort output",
name = "sort",
title = "Sort condition for the output.",
description = """
BEST_MATCH - the results will be sorted by best match results
BEST_MATCH - the results will be sorted by best match results\n
INDEXED - the results will be sorted by the index
"""
)
Expand Down
47 changes: 23 additions & 24 deletions src/main/java/io/kestra/plugin/github/commits/Search.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,114 +75,113 @@ public enum Sort {
}

@Schema(
name = "The query contains one or more search keywords and qualifiers",
description = "Allow you to limit your search to specific areas of GitHub"
title = "The query contains one or more search keywords and qualifiers.",
description = "Allows you to limit your search to specific areas of GitHub."
)
@PluginProperty(dynamic = true)
private String query;

@Schema(
name = "Search in specified repository"
title = "Search in specified repository."
)
@PluginProperty(dynamic = true)
private String repository;

@Schema(
name = "Matches commits from repositories with the specified visibility"
title = "Matches commits from repositories with the specified visibility."
)
@PluginProperty(dynamic = true)
private String is;

@Schema(
name = "Matches commits with the specified SHA-1 hash"
title = "Matches commits with the specified SHA-1 hash."
)
@PluginProperty(dynamic = true)
private String hash;

@Schema(
name = "matches commits whose parent has the specified SHA-1 hash"
title = "Matches commits whose parent has the specified SHA-1 hash."
)
@PluginProperty(dynamic = true)
private String parent;

@Schema(
name = "Matches commits with the specified SHA-1 git tree hash"
title = "Matches commits with the specified SHA-1 git tree hash."
)
@PluginProperty(dynamic = true)
private String tree;

@Schema(
name = "Search commits in all repositories owned by a certain user"
title = "Search commits in all repositories owned by a certain user"
)
@PluginProperty(dynamic = true)
private String user;

@Schema(
name = "Search commits in all repositories owned by a certain organization"
title = "Search commits in all repositories owned by a certain organization."
)
@PluginProperty(dynamic = true)
private String org;

@Schema(
name = "Find commits by a particular user"
title = "Find commits by a particular user."
)
@PluginProperty(dynamic = true)
private String author;

@Schema(
name = "Match commits authored within the specified date range",
description = "When you search for a date, you can use greater than, less than, and range qualifiers to further filter results"
title = "Match commits authored within the specified date range. When you search for a date, you can use greater than, less than, and range qualifiers to further filter results."
)
@PluginProperty(dynamic = true)
private String authorDate;

@Schema(
name = "Match commits by the author's full email address"
title = "Match commits by the author's full email address."
)
@PluginProperty(dynamic = true)
private String authorEmail;

@Schema(
name = "Match commits by the name of the author"
title = "Match commits by the name of the author"
)
@PluginProperty(dynamic = true)
private String authorName;

@Schema(
name = "Find commits by a particular user"
title = "Find commits by a particular user"
)
@PluginProperty(dynamic = true)
private String committer;

@Schema(
name = "Match commits committed within the specified date range",
description = "When you search for a date, you can use greater than, less than, and range qualifiers to further filter results"
title = "Match commits committed within the specified date range.",
description = "When you search for a date, you can use greater than, less than, and range qualifiers to further filter results."
)
@PluginProperty(dynamic = true)
private String committerDate;

@Schema(
name = "Match commits by the committer's full email address"
title = "Match commits by the committer's full email address."
)
@PluginProperty(dynamic = true)
private String committerEmail;

@Schema(
name = "Match commits by the name of the committer"
title = "Match commits by the name of the committer"
)
@PluginProperty(dynamic = true)
private String committerName;

@Schema(
name = "Filters merge commits"
title = "Whether to filter merge commits."
)
@PluginProperty
private Boolean merge;

@Schema(
name = "Order output",
title = "Order of the output.",
description = """
ASC - the results will be in ascending order
ASC - the results will be in ascending order\n
DESC - the results will be in descending order
"""
)
Expand All @@ -191,9 +190,9 @@ public enum Sort {
private Order order = Order.ASC;

@Schema(
name = "Sort output",
title = "Sort condition for the output.",
description = """
COMMITTER_DATE - the results will be sorted by when user joined to Github
COMMITTER_DATE - the results will be sorted by when user joined to Github\n
AUTHOR_DATE - the results will be sorted by the number of repositories owned by user
"""
)
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/io/kestra/plugin/github/issues/Comment.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
@Getter
@NoArgsConstructor
@Schema(
title = "Create GitHub issue comment",
description = "If no authentication is provided, anonymous authentication will be used"
title = "Create GitHub issue comment.",
description = "If no authentication is provided, anonymous authentication will be used."
)
@Plugin(
examples = {
Expand All @@ -43,13 +43,13 @@ public class Comment extends GithubConnector implements RunnableTask<Comment.Out
private String repository;

@Schema(
title = "Ticket number"
title = "Ticket number."
)
@PluginProperty
private Integer issueNumber;

@Schema(
title = "Ticket body"
title = "Ticket body."
)
@PluginProperty(dynamic = true)
private String body;
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/io/kestra/plugin/github/issues/Create.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
@Getter
@NoArgsConstructor
@Schema(
title = "Create a GitHub issue",
description = "If no authentication is provided, anonymous authentication will be used"
title = "Create a GitHub issue.",
description = "If no authentication is provided, anonymous authentication will be used."
)
@Plugin(
examples = {
Expand Down Expand Up @@ -80,27 +80,27 @@ public class Create extends GithubConnector implements RunnableTask<Create.Outpu
private String repository;

@Schema(
title = "Ticket title"
title = "Ticket title."
)
@PluginProperty(dynamic = true)
private String title;

@Schema(
title = "Ticket body"
title = "Ticket body."
)
@PluginProperty(dynamic = true)
private String body;

@Schema(
title = "Ticket label",
description = "List of labels for ticket"
title = "Ticket label.",
description = "List of labels for ticket."
)
@PluginProperty(dynamic = true)
private List<String> labels;

@Schema(
title = "Ticket assignee",
description = "List of unique names of assignees"
title = "Ticket assignee.",
description = "List of unique names of assignees."
)
@PluginProperty(dynamic = true)
private List<String> assignees;
Expand Down
21 changes: 10 additions & 11 deletions src/main/java/io/kestra/plugin/github/issues/Search.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,40 +61,39 @@ public enum Sort {
}

@Schema(
name = "The query contains one or more search keywords and qualifiers",
description = "Allow you to limit your search to specific areas of GitHub"
title = "The query contains one or more search keywords and qualifiers. Allows you to limit your search to specific areas of GitHub."
)
@PluginProperty(dynamic = true)
private String query;

@Schema(
name = "Searched issues mentions by specified user"
title = "Searched issues mentions by specified user."
)
@PluginProperty(dynamic = true)
private String mentions;

@Schema(
name = "Specifies whether issue is open"
title = "Whether the issue is open."
)
@PluginProperty
private Boolean open;

@Schema(
name = "Specifies whether issue is closed"
title = "Whether issue is closed."
)
@PluginProperty
private Boolean closed;

@Schema(
name = "Specifies whether issue is merged"
title = "Whether issue is merged."
)
@PluginProperty
private Boolean merged;

@Schema(
name = "Order output",
title = "Order of the output.",
description = """
ASC - the results will be in ascending order
ASC - the results will be in ascending order\n
DESC - the results will be in descending order
"""
)
Expand All @@ -103,10 +102,10 @@ public enum Sort {
private Order order = Order.ASC;

@Schema(
name = "Sort output",
title = "Sort condition for the output.",
description = """
CREATED - Sorts the results of query by the time issue was created (DEFAULT)
UPDATED - Sorts the results of query by the tome issue was last time updated
CREATED - Sorts the results of query by the time issue was created (DEFAULT)\n
UPDATED - Sorts the results of query by the tome issue was last time updated\n
COMMENTS - Sorts the results of query by the number of comments
"""
)
Expand Down
Loading

0 comments on commit 66ab236

Please sign in to comment.