Skip to content

Commit

Permalink
adding documentation to getScheduledJobs and logging
Browse files Browse the repository at this point in the history
  • Loading branch information
pitchmuc committed Jul 8, 2021
1 parent 1d9b2c1 commit baaa7b1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
14 changes: 14 additions & 0 deletions docs/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ mycompany1 = loggin.createAnalyticsConnection('comp1')

We will see later that you can also directly use the `Analytics` class.

**Note**: you can enable logging capability for the class by passing an object in the `loggingObject` parameter. More information [here](./logging.md)

### Retry Parameter

The latest version of the aanalytics2 module also provides a **retry** parameter.\
Expand Down Expand Up @@ -196,6 +198,8 @@ mycompany.refreshToken(token)
With all of my API wrappers, I ususall separate the methody by the GET (fetching information), the CREATE methods (posting information), the DELETE methods, the UPDATE mehthods.
This API is no exception.

**Note**: you can enable logging capability for the class by passing an object in the `loggingObject` parameter. More information [here](./logging.md)

## The Project class

There is a way to retrieve projects and especially project definition.\
Expand Down Expand Up @@ -349,6 +353,16 @@ Possible kwargs:
Arguments:
* limit : OPTIONAL : Amount of tag to be returned by request. Default 100

* getScheduledJobs: Retrieve the list of scheduled Jobs for your login company.
Arguments:
* includeType : OPTIONAL : By default gets all non-expired or deleted projects. (default "all")
You can specify e.g. "all,shared,expired,deleted" to get more.
Active schedules always get exported,so you need to use the `rsLocalExpirationTime` parameter in the `schedule` column to e.g. see which schedules are expired
* full : OPTIONAL : By default True. It returns the following additional information "ownerFullName,groups,tags,sharesFullName,modified,favorite,approved,scheduledItemName,scheduledUsersFullNames,deletedReason"
* limit : OPTIONAL : Number of element retrieved by request (default max 1000)
* format : OPTIONAL : Define the format you want to output the result. Default "df" for dataframe, other option "raw"
* verbose: OPTIONAL : set to True for debug output

* getComponentTagName : Given a comma separated list of tag names, return component ids associated with them
Arguments:
* tagNames : REQUIRED : Comma separated list of tag names.
Expand Down
5 changes: 3 additions & 2 deletions docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ The changes have been tracked starting version 0.1.0

## version 0.2.9

* Adding logging capability
* Adding the `getScheduledJobs` endpoint
* Adding logging capability ([documentation](./logging.md))
* Fixing some typo on regex used for `findComponentUsage`
* Adding better docstring
* Adding better docstring for some methods.

## version 0.2.8

Expand Down

0 comments on commit baaa7b1

Please sign in to comment.