Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Google Analytics 360 is a web service for hosting IT projects and their joint development. Web service based on Git version control system. Google Analytics 360 (GA 360) source plugin would allow users to get data from GitHub API. The plugin would deliver GitHub data in batch mode and would allow users to pick from a variety of data ? available under GitHub API.
User Expectations
- User would like to enable GitHub API to start retieving GitHub data
- User would like to have full flexibility in picking data for GitHub dataset
Plugin Type
- Batch Source
- Batch Sink
- Real-time Source
- Real-time Sink
- Action
- Post-Run Action
- Aggregate
- Join
- Spark Model
- Spark Compute
User Configurations
| Option Level | User Configuration Label | Label Description | Variable | User Widget | Notes |
|---|---|---|---|---|---|
| General | Authorization token | Authorization token to access GitHub API | authorizationToken | Text Box | https://developer.github.com/v3/#authentication |
| Data retrieval options | ? | ? | ? | ? |
Design / Implementation Tips
Plugin will be implemented using third-part The GitHub Java API library, It is part of the GitHub Mylyn Connector and aims to support the entire GitHub v3 API. Authentication will be performed using access token. Output schema must be automatically generated from selected data.
Output schema completely based on Data items. All fields are nullable strings.
References
- GitHub API v3 documentation: https://developer.github.com/v3/
- GitHub API v4 (GraphQL) documentation: https://developer.github.com/v4/
- GitHub API v3 third-part libraries: https://developer.github.com/v3/libraries/
Table of Contents
Checklist
- User stories documented
- User stories reviewed
- Design documented
- Design reviewed
- Feature merged
- Examples and guides
- Integration tests
- Documentation for feature
- Short video demonstrating the feature