Skip to content

Commit

Permalink
Fixed some comments in gen-ed files
Browse files Browse the repository at this point in the history
  • Loading branch information
rossgrambo-zz committed Apr 17, 2020
1 parent 9098eb4 commit 4d76560
Show file tree
Hide file tree
Showing 26 changed files with 141 additions and 143 deletions.
2 changes: 1 addition & 1 deletion src/main/java/com/asana/Client.java
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ public Client(Dispatcher dispatcher, Map<String, Object> options, Map<String, St
/**
* @param request Asana client request object
* @return Raw HttpResponse object
* @throws IOException
* @throws IOException if the request fails
*/
public HttpResponse request(Request request) throws IOException {
GenericUrl url = new GenericUrl(request.options.get("base_url") + request.path);
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/asana/resources/gen/AttachmentsBase.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public class AttachmentsBase extends Resource {
* @param attachmentGid Globally unique identifier for the attachment. (required)
* @param optFields Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. (optional)
* @param optPretty Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. (optional)
* @return ItemRequest<JsonElement>
* @return ItemRequest(JsonElement)
* @throws IOException If we fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ItemRequest<JsonElement> deleteAttachment(String attachmentGid, List<String> optFields, Boolean optPretty) throws IOException {
Expand All @@ -47,7 +47,7 @@ public ItemRequest<JsonElement> deleteAttachment(String attachmentGid) throws IO
* @param attachmentGid Globally unique identifier for the attachment. (required)
* @param optFields Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. (optional)
* @param optPretty Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. (optional)
* @return ItemRequest<Attachment>
* @return ItemRequest(Attachment)
* @throws IOException If we fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ItemRequest<Attachment> getAttachment(String attachmentGid, List<String> optFields, Boolean optPretty) throws IOException {
Expand All @@ -71,7 +71,7 @@ public ItemRequest<Attachment> getAttachment(String attachmentGid) throws IOExce
* @param limit Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional)
* @param optFields Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. (optional)
* @param optPretty Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. (optional)
* @return CollectionRequest<Attachment>
* @return CollectionRequest(Attachment)
* @throws IOException If we fail to call the API, e.g. server error or cannot deserialize the response body
*/
public CollectionRequest<Attachment> getAttachmentsForTask(String taskGid, String offset, Integer limit, List<String> optFields, Boolean optPretty) throws IOException {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/asana/resources/gen/BatchApiBase.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public class BatchApiBase extends Resource {
* Make multiple requests in parallel to Asana&#x27;s API.
* @param optFields Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. (optional)
* @param optPretty Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. (optional)
* @return CollectionRequest<JsonElement>
* @return CollectionRequest(JsonElement)
* @throws IOException If we fail to call the API, e.g. server error or cannot deserialize the response body
*/
public CollectionRequest<JsonElement> createBatchRequest(List<String> optFields, Boolean optPretty) throws IOException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public class CustomFieldSettingsBase extends Resource {
* @param limit Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional)
* @param optFields Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. (optional)
* @param optPretty Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. (optional)
* @return CollectionRequest<CustomFieldSetting>
* @return CollectionRequest(CustomFieldSetting)
* @throws IOException If we fail to call the API, e.g. server error or cannot deserialize the response body
*/
public CollectionRequest<CustomFieldSetting> getCustomFieldSettingsForPortfolio(String portfolioGid, String offset, Integer limit, List<String> optFields, Boolean optPretty) throws IOException {
Expand All @@ -52,7 +52,7 @@ public CollectionRequest<CustomFieldSetting> getCustomFieldSettingsForPortfolio(
* @param limit Results per page. The number of objects to return per page. The value must be between 1 and 100. (optional)
* @param optFields Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. (optional)
* @param optPretty Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. (optional)
* @return CollectionRequest<CustomFieldSetting>
* @return CollectionRequest(CustomFieldSetting)
* @throws IOException If we fail to call the API, e.g. server error or cannot deserialize the response body
*/
public CollectionRequest<CustomFieldSetting> getCustomFieldSettingsForProject(String projectGid, String offset, Integer limit, List<String> optFields, Boolean optPretty) throws IOException {
Expand Down
Loading

0 comments on commit 4d76560

Please sign in to comment.