athenian 2.1.81
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CODE_OF_CONDUCT.md +84 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +60 -0
- data/LICENSE.txt +21 -0
- data/README.md +76 -0
- data/Rakefile +10 -0
- data/athenian.gemspec +35 -0
- data/bin/console +15 -0
- data/bin/setup +8 -0
- data/docs/AcceptedInvitation.md +22 -0
- data/docs/Account.md +26 -0
- data/docs/AccountStatus.md +26 -0
- data/docs/AccountUserChangeRequest.md +22 -0
- data/docs/AlignApi.md +367 -0
- data/docs/CalculatedCodeCheckHistogram.md +28 -0
- data/docs/CalculatedCodeCheckMetrics.md +32 -0
- data/docs/CalculatedCodeCheckMetricsItem.md +26 -0
- data/docs/CalculatedDeploymentMetric.md +24 -0
- data/docs/CalculatedDeveloperMetrics.md +28 -0
- data/docs/CalculatedDeveloperMetricsItem.md +22 -0
- data/docs/CalculatedJIRAHistogram.md +28 -0
- data/docs/CalculatedJIRAMetricValues.md +26 -0
- data/docs/CalculatedLinearMetricValues.md +26 -0
- data/docs/CalculatedLinearMetricValuesConfidenceMinsInner.md +49 -0
- data/docs/CalculatedLinearMetricValuesValuesInner.md +51 -0
- data/docs/CalculatedPullRequestHistogram.md +28 -0
- data/docs/CalculatedPullRequestHistogramFrequenciesInner.md +49 -0
- data/docs/CalculatedPullRequestMetrics.md +32 -0
- data/docs/CalculatedPullRequestMetricsItem.md +22 -0
- data/docs/CalculatedReleaseMetric.md +30 -0
- data/docs/CodeBypassingPRsMeasurement.md +26 -0
- data/docs/CodeCheckHistogramDefinition.md +24 -0
- data/docs/CodeCheckHistogramsRequest.md +32 -0
- data/docs/CodeCheckMetricID.md +15 -0
- data/docs/CodeCheckMetricsRequest.md +34 -0
- data/docs/CodeCheckRunStatistics.md +40 -0
- data/docs/CodeCheckRunStatisticsMeanExecutionTime.md +15 -0
- data/docs/CodeCheckRunStatisticsMedianExecutionTime.md +15 -0
- data/docs/CodeCheckRunStatisticsStddevExecutionTime.md +15 -0
- data/docs/CodeFilter.md +34 -0
- data/docs/Commit.md +36 -0
- data/docs/CommitSignature.md +26 -0
- data/docs/CommitsList.md +20 -0
- data/docs/CommitsListInclude.md +20 -0
- data/docs/Contributor.md +26 -0
- data/docs/ContributorIdentity.md +20 -0
- data/docs/CreateTokenRequest.md +20 -0
- data/docs/CreatedIdentifier.md +18 -0
- data/docs/CreatedToken.md +20 -0
- data/docs/Datasource.md +15 -0
- data/docs/DeleteEventsCacheRequest.md +22 -0
- data/docs/DeployedComponent.md +20 -0
- data/docs/DeployedPullRequest.md +32 -0
- data/docs/DeployedPullRequestAllOf.md +18 -0
- data/docs/DeployedRelease.md +40 -0
- data/docs/DeploymentAnalysis.md +22 -0
- data/docs/DeploymentAnalysisCode.md +28 -0
- data/docs/DeploymentConclusion.md +15 -0
- data/docs/DeploymentMetricID.md +15 -0
- data/docs/DeploymentMetricsRequest.md +32 -0
- data/docs/DeploymentModifyLabelsRequest.md +20 -0
- data/docs/DeploymentNotification.md +32 -0
- data/docs/DeploymentWith.md +22 -0
- data/docs/DeveloperMetricID.md +15 -0
- data/docs/DeveloperMetricsRequest.md +30 -0
- data/docs/DeveloperSummary.md +26 -0
- data/docs/DeveloperUpdates.md +28 -0
- data/docs/DiffReleasesRequest.md +20 -0
- data/docs/DiffedReleases.md +20 -0
- data/docs/DiffedReleasesInclude.md +20 -0
- data/docs/EventsApi.md +370 -0
- data/docs/FilterApi.md +832 -0
- data/docs/FilterCodeChecksRequest.md +36 -0
- data/docs/FilterCommitsRequest.md +34 -0
- data/docs/FilterContributorsRequest.md +28 -0
- data/docs/FilterDeploymentsRequest.md +42 -0
- data/docs/FilterEnvironmentsRequest.md +26 -0
- data/docs/FilterJIRACommon.md +30 -0
- data/docs/FilterJIRAStuff.md +40 -0
- data/docs/FilterJIRAStuffWith.md +22 -0
- data/docs/FilterLabelsRequest.md +20 -0
- data/docs/FilterPullRequestsRequest.md +48 -0
- data/docs/FilterReleasesRequest.md +34 -0
- data/docs/FilterRepositoriesRequest.md +28 -0
- data/docs/FilteredCodeCheckRun.md +30 -0
- data/docs/FilteredCodeCheckRunPrsStats.md +40 -0
- data/docs/FilteredCodeCheckRunTotalStats.md +40 -0
- data/docs/FilteredCodeCheckRuns.md +20 -0
- data/docs/FilteredDeployment.md +38 -0
- data/docs/FilteredDeployments.md +20 -0
- data/docs/FilteredDeploymentsInclude.md +20 -0
- data/docs/FilteredEnvironment.md +24 -0
- data/docs/FilteredJIRAStuff.md +32 -0
- data/docs/FilteredLabel.md +24 -0
- data/docs/FilteredRelease.md +42 -0
- data/docs/ForSetCodeChecks.md +32 -0
- data/docs/ForSetCodeChecksJira.md +32 -0
- data/docs/ForSetDeployments.md +38 -0
- data/docs/ForSetDevelopers.md +30 -0
- data/docs/ForSetPullRequests.md +36 -0
- data/docs/GenericError.md +26 -0
- data/docs/GetApi.md +305 -0
- data/docs/GetDeploymentLabels200Response.md +18 -0
- data/docs/GetJIRAIssuesInclude.md +15 -0
- data/docs/GetJIRAIssuesRequest.md +22 -0
- data/docs/GetJIRAIssuesResponse.md +20 -0
- data/docs/GetJIRAIssuesResponseInclude.md +20 -0
- data/docs/GetPullRequestsRequest.md +22 -0
- data/docs/GetReleasesRequest.md +20 -0
- data/docs/GoalMetricParams.md +18 -0
- data/docs/GoalMetricParamsThreshold.md +49 -0
- data/docs/GoalTemplate.md +28 -0
- data/docs/GoalTemplateCreateRequest.md +26 -0
- data/docs/GoalTemplateMetric.md +51 -0
- data/docs/GoalTemplateUpdateRequest.md +24 -0
- data/docs/HistogramScale.md +15 -0
- data/docs/HistogramsApi.md +226 -0
- data/docs/IncludedDeployments.md +18 -0
- data/docs/IncludedJIRAIssues.md +18 -0
- data/docs/IncludedNativeUser.md +18 -0
- data/docs/IncludedNativeUsers.md +18 -0
- data/docs/InstallationProgress.md +26 -0
- data/docs/IntegrationsApi.md +157 -0
- data/docs/Interquartile.md +20 -0
- data/docs/InvalidRequestError.md +28 -0
- data/docs/InvalidRequestErrorAllOf.md +18 -0
- data/docs/InvitationCheckResult.md +22 -0
- data/docs/InvitationLink.md +18 -0
- data/docs/InvitedUser.md +20 -0
- data/docs/JIRAComment.md +22 -0
- data/docs/JIRAEpic.md +58 -0
- data/docs/JIRAEpicAllOf.md +22 -0
- data/docs/JIRAEpicChild.md +56 -0
- data/docs/JIRAEpicChildAllOf.md +20 -0
- data/docs/JIRAEpicIssueCommon.md +52 -0
- data/docs/JIRAFilter.md +32 -0
- data/docs/JIRAFilterReturn.md +15 -0
- data/docs/JIRAFilterWith.md +22 -0
- data/docs/JIRAHistogramDefinition.md +24 -0
- data/docs/JIRAHistogramsRequest.md +44 -0
- data/docs/JIRAInstallation.md +20 -0
- data/docs/JIRAIssue.md +56 -0
- data/docs/JIRAIssueAllOf.md +20 -0
- data/docs/JIRAIssueType.md +30 -0
- data/docs/JIRALabel.md +24 -0
- data/docs/JIRAMetricID.md +15 -0
- data/docs/JIRAMetricsRequest.md +50 -0
- data/docs/JIRAPriority.md +24 -0
- data/docs/JIRAProject.md +30 -0
- data/docs/JIRAProjectsRequest.md +20 -0
- data/docs/JIRAStatus.md +22 -0
- data/docs/JIRAStatusCategory.md +15 -0
- data/docs/JIRAUser.md +24 -0
- data/docs/LinkedJIRAIssue.md +26 -0
- data/docs/ListedToken.md +22 -0
- data/docs/LogicalDeploymentRules.md +20 -0
- data/docs/LogicalPRRules.md +20 -0
- data/docs/LogicalRepository.md +26 -0
- data/docs/LogicalRepositoryGetRequest.md +20 -0
- data/docs/LogicalRepositoryRequest.md +28 -0
- data/docs/MappedJIRAIdentity.md +24 -0
- data/docs/MappedJIRAIdentityChange.md +20 -0
- data/docs/MatchIdentitiesRequest.md +20 -0
- data/docs/MatchedIdentity.md +22 -0
- data/docs/MatchedIdentityTo.md +15 -0
- data/docs/MetricsApi.md +518 -0
- data/docs/NotifiedDeploymentsInner.md +20 -0
- data/docs/NotifyDeployments200Response.md +18 -0
- data/docs/Organization.md +22 -0
- data/docs/PaginatePullRequestsRequest.md +20 -0
- data/docs/PaginationApi.md +82 -0
- data/docs/PatchTokenRequest.md +18 -0
- data/docs/ProductFeature.md +20 -0
- data/docs/ProductFeatureParameters.md +51 -0
- data/docs/PullRequest.md +74 -0
- data/docs/PullRequestEvent.md +15 -0
- data/docs/PullRequestHistogramDefinition.md +24 -0
- data/docs/PullRequestHistogramsRequest.md +34 -0
- data/docs/PullRequestLabel.md +22 -0
- data/docs/PullRequestMetricID.md +15 -0
- data/docs/PullRequestMetricsRequest.md +36 -0
- data/docs/PullRequestNumbers.md +20 -0
- data/docs/PullRequestPaginationPlan.md +18 -0
- data/docs/PullRequestParticipant.md +20 -0
- data/docs/PullRequestSet.md +20 -0
- data/docs/PullRequestSetInclude.md +20 -0
- data/docs/PullRequestStage.md +15 -0
- data/docs/PullRequestWith.md +30 -0
- data/docs/RegistrationApi.md +420 -0
- data/docs/ReleaseDiff.md +22 -0
- data/docs/ReleaseMatchRequest.md +28 -0
- data/docs/ReleaseMatchSetting.md +26 -0
- data/docs/ReleaseMatchStrategy.md +15 -0
- data/docs/ReleaseMetricID.md +15 -0
- data/docs/ReleaseMetricsRequest.md +42 -0
- data/docs/ReleaseMetricsRequestForInner.md +49 -0
- data/docs/ReleaseNames.md +20 -0
- data/docs/ReleaseNotification.md +28 -0
- data/docs/ReleaseNotificationStatus.md +15 -0
- data/docs/ReleasePair.md +20 -0
- data/docs/ReleaseSet.md +20 -0
- data/docs/ReleaseSetInclude.md +22 -0
- data/docs/ReleaseWith.md +22 -0
- data/docs/ReleasedPullRequest.md +30 -0
- data/docs/ReleasedPullRequestAuthor.md +15 -0
- data/docs/ReposetApi.md +363 -0
- data/docs/RepositorySetCreateRequest.md +22 -0
- data/docs/RepositorySetListItem.md +26 -0
- data/docs/RepositorySetWithName.md +22 -0
- data/docs/SecurityApi.md +290 -0
- data/docs/SetMappedJIRAIdentitiesRequest.md +20 -0
- data/docs/SettingsApi.md +942 -0
- data/docs/Share.md +22 -0
- data/docs/StageTimings.md +26 -0
- data/docs/TableFetchingProgress.md +22 -0
- data/docs/Team.md +24 -0
- data/docs/TeamApi.md +440 -0
- data/docs/TeamCreateRequest.md +24 -0
- data/docs/TeamUpdateRequest.md +22 -0
- data/docs/User.md +34 -0
- data/docs/UserApi.md +431 -0
- data/docs/VersionApi.md +67 -0
- data/docs/Versions.md +20 -0
- data/docs/WithBothJiraAndJiragroups.md +20 -0
- data/docs/WorkType.md +22 -0
- data/docs/WorkTypeGetRequest.md +20 -0
- data/docs/WorkTypePutRequest.md +20 -0
- data/docs/WorkTypeRule.md +20 -0
- data/generator/generate_api.sh +37 -0
- data/generator/generator_config.yml +10 -0
- data/generator/openapi.yaml +11297 -0
- data/generator/openapi_generated.yaml +11139 -0
- data/generator/template/api_info.mustache +6 -0
- data/generator/template_data.json +3 -0
- data/lib/athenian/api/align_api.rb +335 -0
- data/lib/athenian/api/events_api.rb +334 -0
- data/lib/athenian/api/filter_api.rb +701 -0
- data/lib/athenian/api/get_api.rb +266 -0
- data/lib/athenian/api/histograms_api.rb +217 -0
- data/lib/athenian/api/integrations_api.rb +150 -0
- data/lib/athenian/api/metrics_api.rb +481 -0
- data/lib/athenian/api/pagination_api.rb +81 -0
- data/lib/athenian/api/registration_api.rb +395 -0
- data/lib/athenian/api/reposet_api.rb +332 -0
- data/lib/athenian/api/security_api.rb +271 -0
- data/lib/athenian/api/settings_api.rb +820 -0
- data/lib/athenian/api/team_api.rb +396 -0
- data/lib/athenian/api/user_api.rb +381 -0
- data/lib/athenian/api/version_api.rb +74 -0
- data/lib/athenian/api_client.rb +389 -0
- data/lib/athenian/api_error.rb +55 -0
- data/lib/athenian/configuration.rb +294 -0
- data/lib/athenian/models/accepted_invitation.rb +241 -0
- data/lib/athenian/models/account.rb +283 -0
- data/lib/athenian/models/account_status.rb +281 -0
- data/lib/athenian/models/account_user_change_request.rb +285 -0
- data/lib/athenian/models/calculated_code_check_histogram.rb +318 -0
- data/lib/athenian/models/calculated_code_check_metrics.rb +386 -0
- data/lib/athenian/models/calculated_code_check_metrics_item.rb +291 -0
- data/lib/athenian/models/calculated_deployment_metric.rb +268 -0
- data/lib/athenian/models/calculated_developer_metrics.rb +340 -0
- data/lib/athenian/models/calculated_developer_metrics_item.rb +252 -0
- data/lib/athenian/models/calculated_jira_histogram.rb +313 -0
- data/lib/athenian/models/calculated_jira_metric_values.rb +266 -0
- data/lib/athenian/models/calculated_linear_metric_values.rb +273 -0
- data/lib/athenian/models/calculated_linear_metric_values_confidence_mins_inner.rb +101 -0
- data/lib/athenian/models/calculated_linear_metric_values_values_inner.rb +102 -0
- data/lib/athenian/models/calculated_pull_request_histogram.rb +318 -0
- data/lib/athenian/models/calculated_pull_request_histogram_frequencies_inner.rb +101 -0
- data/lib/athenian/models/calculated_pull_request_metrics.rb +391 -0
- data/lib/athenian/models/calculated_pull_request_metrics_item.rb +247 -0
- data/lib/athenian/models/calculated_release_metric.rb +301 -0
- data/lib/athenian/models/code_bypassing_prs_measurement.rb +357 -0
- data/lib/athenian/models/code_check_histogram_definition.rb +303 -0
- data/lib/athenian/models/code_check_histograms_request.rb +365 -0
- data/lib/athenian/models/code_check_metric_id.rb +55 -0
- data/lib/athenian/models/code_check_metrics_request.rb +401 -0
- data/lib/athenian/models/code_check_run_statistics.rb +448 -0
- data/lib/athenian/models/code_check_run_statistics_mean_execution_time.rb +224 -0
- data/lib/athenian/models/code_check_run_statistics_median_execution_time.rb +224 -0
- data/lib/athenian/models/code_check_run_statistics_stddev_execution_time.rb +224 -0
- data/lib/athenian/models/code_filter.rb +351 -0
- data/lib/athenian/models/commit.rb +405 -0
- data/lib/athenian/models/commit_signature.rb +266 -0
- data/lib/athenian/models/commits_list.rb +236 -0
- data/lib/athenian/models/commits_list_include.rb +242 -0
- data/lib/athenian/models/contributor.rb +261 -0
- data/lib/athenian/models/contributor_identity.rb +230 -0
- data/lib/athenian/models/create_token_request.rb +235 -0
- data/lib/athenian/models/created_identifier.rb +220 -0
- data/lib/athenian/models/created_token.rb +236 -0
- data/lib/athenian/models/datasource.rb +37 -0
- data/lib/athenian/models/delete_events_cache_request.rb +277 -0
- data/lib/athenian/models/deployed_component.rb +255 -0
- data/lib/athenian/models/deployed_pull_request.rb +326 -0
- data/lib/athenian/models/deployed_pull_request_all_of.rb +220 -0
- data/lib/athenian/models/deployed_release.rb +488 -0
- data/lib/athenian/models/deployment_analysis.rb +244 -0
- data/lib/athenian/models/deployment_analysis_code.rb +303 -0
- data/lib/athenian/models/deployment_conclusion.rb +38 -0
- data/lib/athenian/models/deployment_metric_id.rb +52 -0
- data/lib/athenian/models/deployment_metrics_request.rb +391 -0
- data/lib/athenian/models/deployment_modify_labels_request.rb +227 -0
- data/lib/athenian/models/deployment_notification.rb +390 -0
- data/lib/athenian/models/deployment_with.rb +233 -0
- data/lib/athenian/models/developer_metric_id.rb +51 -0
- data/lib/athenian/models/developer_metrics_request.rb +355 -0
- data/lib/athenian/models/developer_summary.rb +271 -0
- data/lib/athenian/models/developer_updates.rb +356 -0
- data/lib/athenian/models/diff_releases_request.rb +237 -0
- data/lib/athenian/models/diffed_releases.rb +237 -0
- data/lib/athenian/models/diffed_releases_include.rb +242 -0
- data/lib/athenian/models/filter_code_checks_request.rb +356 -0
- data/lib/athenian/models/filter_commits_request.rb +385 -0
- data/lib/athenian/models/filter_contributors_request.rb +331 -0
- data/lib/athenian/models/filter_deployments_request.rb +383 -0
- data/lib/athenian/models/filter_environments_request.rb +294 -0
- data/lib/athenian/models/filter_jira_common.rb +318 -0
- data/lib/athenian/models/filter_jira_stuff.rb +373 -0
- data/lib/athenian/models/filter_jira_stuff_with.rb +248 -0
- data/lib/athenian/models/filter_labels_request.rb +233 -0
- data/lib/athenian/models/filter_pull_requests_request.rb +456 -0
- data/lib/athenian/models/filter_releases_request.rb +339 -0
- data/lib/athenian/models/filter_repositories_request.rb +307 -0
- data/lib/athenian/models/filtered_code_check_run.rb +306 -0
- data/lib/athenian/models/filtered_code_check_run_prs_stats.rb +454 -0
- data/lib/athenian/models/filtered_code_check_run_total_stats.rb +454 -0
- data/lib/athenian/models/filtered_code_check_runs.rb +240 -0
- data/lib/athenian/models/filtered_deployment.rb +436 -0
- data/lib/athenian/models/filtered_deployments.rb +237 -0
- data/lib/athenian/models/filtered_deployments_include.rb +243 -0
- data/lib/athenian/models/filtered_environment.rb +283 -0
- data/lib/athenian/models/filtered_jira_stuff.rb +334 -0
- data/lib/athenian/models/filtered_label.rb +298 -0
- data/lib/athenian/models/filtered_release.rb +483 -0
- data/lib/athenian/models/for_set_code_checks.rb +334 -0
- data/lib/athenian/models/for_set_code_checks_jira.rb +306 -0
- data/lib/athenian/models/for_set_deployments.rb +343 -0
- data/lib/athenian/models/for_set_developers.rb +288 -0
- data/lib/athenian/models/for_set_pull_requests.rb +371 -0
- data/lib/athenian/models/generic_error.rb +270 -0
- data/lib/athenian/models/get_deployment_labels200_response.rb +220 -0
- data/lib/athenian/models/get_jira_issues_include.rb +39 -0
- data/lib/athenian/models/get_jira_issues_request.rb +269 -0
- data/lib/athenian/models/get_jira_issues_response.rb +231 -0
- data/lib/athenian/models/get_jira_issues_response_include.rb +229 -0
- data/lib/athenian/models/get_pull_requests_request.rb +284 -0
- data/lib/athenian/models/get_releases_request.rb +238 -0
- data/lib/athenian/models/goal_metric_params.rb +215 -0
- data/lib/athenian/models/goal_metric_params_threshold.rb +101 -0
- data/lib/athenian/models/goal_template.rb +305 -0
- data/lib/athenian/models/goal_template_create_request.rb +290 -0
- data/lib/athenian/models/goal_template_metric.rb +102 -0
- data/lib/athenian/models/goal_template_update_request.rb +275 -0
- data/lib/athenian/models/histogram_scale.rb +37 -0
- data/lib/athenian/models/included_deployments.rb +218 -0
- data/lib/athenian/models/included_jira_issues.rb +218 -0
- data/lib/athenian/models/included_native_user.rb +220 -0
- data/lib/athenian/models/included_native_users.rb +223 -0
- data/lib/athenian/models/installation_progress.rb +283 -0
- data/lib/athenian/models/interquartile.rb +234 -0
- data/lib/athenian/models/invalid_request_error.rb +288 -0
- data/lib/athenian/models/invalid_request_error_all_of.rb +215 -0
- data/lib/athenian/models/invitation_check_result.rb +274 -0
- data/lib/athenian/models/invitation_link.rb +221 -0
- data/lib/athenian/models/invited_user.rb +235 -0
- data/lib/athenian/models/jira_comment.rb +250 -0
- data/lib/athenian/models/jira_epic.rb +487 -0
- data/lib/athenian/models/jira_epic_all_of.rb +247 -0
- data/lib/athenian/models/jira_epic_child.rb +475 -0
- data/lib/athenian/models/jira_epic_child_all_of.rb +235 -0
- data/lib/athenian/models/jira_epic_issue_common.rb +437 -0
- data/lib/athenian/models/jira_filter.rb +300 -0
- data/lib/athenian/models/jira_filter_return.rb +44 -0
- data/lib/athenian/models/jira_filter_with.rb +242 -0
- data/lib/athenian/models/jira_histogram_definition.rb +303 -0
- data/lib/athenian/models/jira_histograms_request.rb +436 -0
- data/lib/athenian/models/jira_installation.rb +238 -0
- data/lib/athenian/models/jira_issue.rb +471 -0
- data/lib/athenian/models/jira_issue_all_of.rb +232 -0
- data/lib/athenian/models/jira_issue_type.rb +330 -0
- data/lib/athenian/models/jira_label.rb +260 -0
- data/lib/athenian/models/jira_metric_id.rb +48 -0
- data/lib/athenian/models/jira_metrics_request.rb +495 -0
- data/lib/athenian/models/jira_priority.rb +306 -0
- data/lib/athenian/models/jira_project.rb +307 -0
- data/lib/athenian/models/jira_projects_request.rb +238 -0
- data/lib/athenian/models/jira_status.rb +272 -0
- data/lib/athenian/models/jira_status_category.rb +39 -0
- data/lib/athenian/models/jira_user.rb +294 -0
- data/lib/athenian/models/linked_jira_issue.rb +273 -0
- data/lib/athenian/models/listed_token.rb +251 -0
- data/lib/athenian/models/logical_deployment_rules.rb +228 -0
- data/lib/athenian/models/logical_pr_rules.rb +228 -0
- data/lib/athenian/models/logical_repository.rb +303 -0
- data/lib/athenian/models/logical_repository_get_request.rb +236 -0
- data/lib/athenian/models/logical_repository_request.rb +318 -0
- data/lib/athenian/models/mapped_jira_identity.rb +289 -0
- data/lib/athenian/models/mapped_jira_identity_change.rb +232 -0
- data/lib/athenian/models/match_identities_request.rb +237 -0
- data/lib/athenian/models/matched_identity.rb +277 -0
- data/lib/athenian/models/matched_identity_to.rb +224 -0
- data/lib/athenian/models/notified_deployments_inner.rb +235 -0
- data/lib/athenian/models/notify_deployments200_response.rb +222 -0
- data/lib/athenian/models/organization.rb +248 -0
- data/lib/athenian/models/paginate_pull_requests_request.rb +254 -0
- data/lib/athenian/models/patch_token_request.rb +216 -0
- data/lib/athenian/models/product_feature.rb +234 -0
- data/lib/athenian/models/product_feature_parameters.rb +102 -0
- data/lib/athenian/models/pull_request.rb +727 -0
- data/lib/athenian/models/pull_request_event.rb +45 -0
- data/lib/athenian/models/pull_request_histogram_definition.rb +303 -0
- data/lib/athenian/models/pull_request_histograms_request.rb +380 -0
- data/lib/athenian/models/pull_request_label.rb +265 -0
- data/lib/athenian/models/pull_request_metric_id.rb +105 -0
- data/lib/athenian/models/pull_request_metrics_request.rb +416 -0
- data/lib/athenian/models/pull_request_numbers.rb +237 -0
- data/lib/athenian/models/pull_request_pagination_plan.rb +218 -0
- data/lib/athenian/models/pull_request_participant.rb +259 -0
- data/lib/athenian/models/pull_request_set.rb +237 -0
- data/lib/athenian/models/pull_request_set_include.rb +242 -0
- data/lib/athenian/models/pull_request_stage.rb +43 -0
- data/lib/athenian/models/pull_request_with.rb +290 -0
- data/lib/athenian/models/release_diff.rb +251 -0
- data/lib/athenian/models/release_match_request.rb +304 -0
- data/lib/athenian/models/release_match_setting.rb +292 -0
- data/lib/athenian/models/release_match_strategy.rb +39 -0
- data/lib/athenian/models/release_metric_id.rb +60 -0
- data/lib/athenian/models/release_metrics_request.rb +448 -0
- data/lib/athenian/models/release_metrics_request_for_inner.rb +101 -0
- data/lib/athenian/models/release_names.rb +238 -0
- data/lib/athenian/models/release_notification.rb +322 -0
- data/lib/athenian/models/release_notification_status.rb +38 -0
- data/lib/athenian/models/release_pair.rb +236 -0
- data/lib/athenian/models/release_set.rb +227 -0
- data/lib/athenian/models/release_set_include.rb +255 -0
- data/lib/athenian/models/release_with.rb +233 -0
- data/lib/athenian/models/released_pull_request.rb +303 -0
- data/lib/athenian/models/released_pull_request_author.rb +224 -0
- data/lib/athenian/models/repository_set_create_request.rb +252 -0
- data/lib/athenian/models/repository_set_list_item.rb +271 -0
- data/lib/athenian/models/repository_set_with_name.rb +235 -0
- data/lib/athenian/models/set_mapped_jira_identities_request.rb +238 -0
- data/lib/athenian/models/share.rb +251 -0
- data/lib/athenian/models/stage_timings.rb +335 -0
- data/lib/athenian/models/table_fetching_progress.rb +289 -0
- data/lib/athenian/models/team.rb +264 -0
- data/lib/athenian/models/team_create_request.rb +264 -0
- data/lib/athenian/models/team_update_request.rb +249 -0
- data/lib/athenian/models/user.rb +313 -0
- data/lib/athenian/models/versions.rb +233 -0
- data/lib/athenian/models/with_both_jira_and_jiragroups.rb +226 -0
- data/lib/athenian/models/work_type.rb +292 -0
- data/lib/athenian/models/work_type_get_request.rb +255 -0
- data/lib/athenian/models/work_type_put_request.rb +235 -0
- data/lib/athenian/models/work_type_rule.rb +255 -0
- data/lib/athenian/version.rb +12 -0
- data/lib/athenian.rb +255 -0
- data/spec/api/align_api_spec.rb +89 -0
- data/spec/api/events_api_spec.rb +88 -0
- data/spec/api/filter_api_spec.rb +153 -0
- data/spec/api/get_api_spec.rb +76 -0
- data/spec/api/histograms_api_spec.rb +65 -0
- data/spec/api/integrations_api_spec.rb +55 -0
- data/spec/api/metrics_api_spec.rb +109 -0
- data/spec/api/pagination_api_spec.rb +43 -0
- data/spec/api/registration_api_spec.rb +98 -0
- data/spec/api/reposet_api_spec.rb +88 -0
- data/spec/api/security_api_spec.rb +77 -0
- data/spec/api/settings_api_spec.rb +175 -0
- data/spec/api/team_api_spec.rb +100 -0
- data/spec/api/user_api_spec.rb +97 -0
- data/spec/api/version_api_spec.rb +42 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/configuration_spec.rb +39 -0
- data/spec/models/accepted_invitation_spec.rb +43 -0
- data/spec/models/account_spec.rb +55 -0
- data/spec/models/account_status_spec.rb +55 -0
- data/spec/models/account_user_change_request_spec.rb +47 -0
- data/spec/models/calculated_code_check_histogram_spec.rb +61 -0
- data/spec/models/calculated_code_check_metrics_item_spec.rb +55 -0
- data/spec/models/calculated_code_check_metrics_spec.rb +73 -0
- data/spec/models/calculated_deployment_metric_spec.rb +49 -0
- data/spec/models/calculated_developer_metrics_item_spec.rb +43 -0
- data/spec/models/calculated_developer_metrics_spec.rb +61 -0
- data/spec/models/calculated_jira_histogram_spec.rb +61 -0
- data/spec/models/calculated_jira_metric_values_spec.rb +55 -0
- data/spec/models/calculated_linear_metric_values_confidence_mins_inner_spec.rb +28 -0
- data/spec/models/calculated_linear_metric_values_spec.rb +55 -0
- data/spec/models/calculated_linear_metric_values_values_inner_spec.rb +28 -0
- data/spec/models/calculated_pull_request_histogram_frequencies_inner_spec.rb +28 -0
- data/spec/models/calculated_pull_request_histogram_spec.rb +61 -0
- data/spec/models/calculated_pull_request_metrics_item_spec.rb +43 -0
- data/spec/models/calculated_pull_request_metrics_spec.rb +73 -0
- data/spec/models/calculated_release_metric_spec.rb +67 -0
- data/spec/models/code_bypassing_prs_measurement_spec.rb +55 -0
- data/spec/models/code_check_histogram_definition_spec.rb +49 -0
- data/spec/models/code_check_histograms_request_spec.rb +73 -0
- data/spec/models/code_check_metric_id_spec.rb +25 -0
- data/spec/models/code_check_metrics_request_spec.rb +79 -0
- data/spec/models/code_check_run_statistics_mean_execution_time_spec.rb +25 -0
- data/spec/models/code_check_run_statistics_median_execution_time_spec.rb +25 -0
- data/spec/models/code_check_run_statistics_spec.rb +97 -0
- data/spec/models/code_check_run_statistics_stddev_execution_time_spec.rb +25 -0
- data/spec/models/code_filter_spec.rb +79 -0
- data/spec/models/commit_signature_spec.rb +55 -0
- data/spec/models/commit_spec.rb +85 -0
- data/spec/models/commits_list_include_spec.rb +37 -0
- data/spec/models/commits_list_spec.rb +37 -0
- data/spec/models/contributor_identity_spec.rb +37 -0
- data/spec/models/contributor_spec.rb +55 -0
- data/spec/models/create_token_request_spec.rb +37 -0
- data/spec/models/created_identifier_spec.rb +31 -0
- data/spec/models/created_token_spec.rb +37 -0
- data/spec/models/datasource_spec.rb +25 -0
- data/spec/models/delete_events_cache_request_spec.rb +47 -0
- data/spec/models/deployed_component_spec.rb +37 -0
- data/spec/models/deployed_pull_request_all_of_spec.rb +31 -0
- data/spec/models/deployed_pull_request_spec.rb +73 -0
- data/spec/models/deployed_release_spec.rb +97 -0
- data/spec/models/deployment_analysis_code_spec.rb +61 -0
- data/spec/models/deployment_analysis_spec.rb +43 -0
- data/spec/models/deployment_conclusion_spec.rb +25 -0
- data/spec/models/deployment_metric_id_spec.rb +25 -0
- data/spec/models/deployment_metrics_request_spec.rb +73 -0
- data/spec/models/deployment_modify_labels_request_spec.rb +37 -0
- data/spec/models/deployment_notification_spec.rb +73 -0
- data/spec/models/deployment_with_spec.rb +43 -0
- data/spec/models/developer_metric_id_spec.rb +25 -0
- data/spec/models/developer_metrics_request_spec.rb +67 -0
- data/spec/models/developer_summary_spec.rb +55 -0
- data/spec/models/developer_updates_spec.rb +61 -0
- data/spec/models/diff_releases_request_spec.rb +37 -0
- data/spec/models/diffed_releases_include_spec.rb +37 -0
- data/spec/models/diffed_releases_spec.rb +37 -0
- data/spec/models/filter_code_checks_request_spec.rb +85 -0
- data/spec/models/filter_commits_request_spec.rb +83 -0
- data/spec/models/filter_contributors_request_spec.rb +65 -0
- data/spec/models/filter_deployments_request_spec.rb +103 -0
- data/spec/models/filter_environments_request_spec.rb +55 -0
- data/spec/models/filter_jira_common_spec.rb +67 -0
- data/spec/models/filter_jira_stuff_spec.rb +97 -0
- data/spec/models/filter_jira_stuff_with_spec.rb +43 -0
- data/spec/models/filter_labels_request_spec.rb +37 -0
- data/spec/models/filter_pull_requests_request_spec.rb +121 -0
- data/spec/models/filter_releases_request_spec.rb +79 -0
- data/spec/models/filter_repositories_request_spec.rb +61 -0
- data/spec/models/filtered_code_check_run_prs_stats_spec.rb +97 -0
- data/spec/models/filtered_code_check_run_spec.rb +67 -0
- data/spec/models/filtered_code_check_run_total_stats_spec.rb +97 -0
- data/spec/models/filtered_code_check_runs_spec.rb +37 -0
- data/spec/models/filtered_deployment_spec.rb +91 -0
- data/spec/models/filtered_deployments_include_spec.rb +37 -0
- data/spec/models/filtered_deployments_spec.rb +37 -0
- data/spec/models/filtered_environment_spec.rb +49 -0
- data/spec/models/filtered_jira_stuff_spec.rb +73 -0
- data/spec/models/filtered_label_spec.rb +49 -0
- data/spec/models/filtered_release_spec.rb +103 -0
- data/spec/models/for_set_code_checks_jira_spec.rb +73 -0
- data/spec/models/for_set_code_checks_spec.rb +73 -0
- data/spec/models/for_set_deployments_spec.rb +91 -0
- data/spec/models/for_set_developers_spec.rb +67 -0
- data/spec/models/for_set_pull_requests_spec.rb +85 -0
- data/spec/models/generic_error_spec.rb +55 -0
- data/spec/models/get_deployment_labels200_response_spec.rb +31 -0
- data/spec/models/get_jira_issues_include_spec.rb +25 -0
- data/spec/models/get_jira_issues_request_spec.rb +43 -0
- data/spec/models/get_jira_issues_response_include_spec.rb +37 -0
- data/spec/models/get_jira_issues_response_spec.rb +37 -0
- data/spec/models/get_pull_requests_request_spec.rb +43 -0
- data/spec/models/get_releases_request_spec.rb +37 -0
- data/spec/models/goal_metric_params_spec.rb +31 -0
- data/spec/models/goal_metric_params_threshold_spec.rb +28 -0
- data/spec/models/goal_template_create_request_spec.rb +55 -0
- data/spec/models/goal_template_metric_spec.rb +28 -0
- data/spec/models/goal_template_spec.rb +61 -0
- data/spec/models/goal_template_update_request_spec.rb +49 -0
- data/spec/models/histogram_scale_spec.rb +25 -0
- data/spec/models/included_deployments_spec.rb +31 -0
- data/spec/models/included_jira_issues_spec.rb +31 -0
- data/spec/models/included_native_user_spec.rb +31 -0
- data/spec/models/included_native_users_spec.rb +31 -0
- data/spec/models/installation_progress_spec.rb +55 -0
- data/spec/models/interquartile_spec.rb +37 -0
- data/spec/models/invalid_request_error_all_of_spec.rb +31 -0
- data/spec/models/invalid_request_error_spec.rb +61 -0
- data/spec/models/invitation_check_result_spec.rb +47 -0
- data/spec/models/invitation_link_spec.rb +31 -0
- data/spec/models/invited_user_spec.rb +37 -0
- data/spec/models/jira_comment_spec.rb +43 -0
- data/spec/models/jira_epic_all_of_spec.rb +43 -0
- data/spec/models/jira_epic_child_all_of_spec.rb +37 -0
- data/spec/models/jira_epic_child_spec.rb +145 -0
- data/spec/models/jira_epic_issue_common_spec.rb +133 -0
- data/spec/models/jira_epic_spec.rb +151 -0
- data/spec/models/jira_filter_return_spec.rb +25 -0
- data/spec/models/jira_filter_spec.rb +73 -0
- data/spec/models/jira_filter_with_spec.rb +43 -0
- data/spec/models/jira_histogram_definition_spec.rb +49 -0
- data/spec/models/jira_histograms_request_spec.rb +109 -0
- data/spec/models/jira_installation_spec.rb +37 -0
- data/spec/models/jira_issue_all_of_spec.rb +37 -0
- data/spec/models/jira_issue_spec.rb +145 -0
- data/spec/models/jira_issue_type_spec.rb +67 -0
- data/spec/models/jira_label_spec.rb +49 -0
- data/spec/models/jira_metric_id_spec.rb +25 -0
- data/spec/models/jira_metrics_request_spec.rb +127 -0
- data/spec/models/jira_priority_spec.rb +49 -0
- data/spec/models/jira_project_spec.rb +67 -0
- data/spec/models/jira_projects_request_spec.rb +37 -0
- data/spec/models/jira_status_category_spec.rb +25 -0
- data/spec/models/jira_status_spec.rb +43 -0
- data/spec/models/jira_user_spec.rb +53 -0
- data/spec/models/linked_jira_issue_spec.rb +55 -0
- data/spec/models/listed_token_spec.rb +43 -0
- data/spec/models/logical_deployment_rules_spec.rb +37 -0
- data/spec/models/logical_pr_rules_spec.rb +37 -0
- data/spec/models/logical_repository_get_request_spec.rb +37 -0
- data/spec/models/logical_repository_request_spec.rb +61 -0
- data/spec/models/logical_repository_spec.rb +55 -0
- data/spec/models/mapped_jira_identity_change_spec.rb +37 -0
- data/spec/models/mapped_jira_identity_spec.rb +49 -0
- data/spec/models/match_identities_request_spec.rb +37 -0
- data/spec/models/matched_identity_spec.rb +43 -0
- data/spec/models/matched_identity_to_spec.rb +25 -0
- data/spec/models/notified_deployments_inner_spec.rb +37 -0
- data/spec/models/notify_deployments200_response_spec.rb +31 -0
- data/spec/models/organization_spec.rb +43 -0
- data/spec/models/paginate_pull_requests_request_spec.rb +37 -0
- data/spec/models/patch_token_request_spec.rb +31 -0
- data/spec/models/product_feature_parameters_spec.rb +28 -0
- data/spec/models/product_feature_spec.rb +37 -0
- data/spec/models/pull_request_event_spec.rb +25 -0
- data/spec/models/pull_request_histogram_definition_spec.rb +49 -0
- data/spec/models/pull_request_histograms_request_spec.rb +79 -0
- data/spec/models/pull_request_label_spec.rb +43 -0
- data/spec/models/pull_request_metric_id_spec.rb +25 -0
- data/spec/models/pull_request_metrics_request_spec.rb +85 -0
- data/spec/models/pull_request_numbers_spec.rb +37 -0
- data/spec/models/pull_request_pagination_plan_spec.rb +31 -0
- data/spec/models/pull_request_participant_spec.rb +41 -0
- data/spec/models/pull_request_set_include_spec.rb +37 -0
- data/spec/models/pull_request_set_spec.rb +37 -0
- data/spec/models/pull_request_spec.rb +199 -0
- data/spec/models/pull_request_stage_spec.rb +25 -0
- data/spec/models/pull_request_with_spec.rb +67 -0
- data/spec/models/release_diff_spec.rb +43 -0
- data/spec/models/release_match_request_spec.rb +61 -0
- data/spec/models/release_match_setting_spec.rb +55 -0
- data/spec/models/release_match_strategy_spec.rb +25 -0
- data/spec/models/release_metric_id_spec.rb +25 -0
- data/spec/models/release_metrics_request_for_inner_spec.rb +28 -0
- data/spec/models/release_metrics_request_spec.rb +103 -0
- data/spec/models/release_names_spec.rb +37 -0
- data/spec/models/release_notification_spec.rb +61 -0
- data/spec/models/release_notification_status_spec.rb +25 -0
- data/spec/models/release_pair_spec.rb +37 -0
- data/spec/models/release_set_include_spec.rb +43 -0
- data/spec/models/release_set_spec.rb +37 -0
- data/spec/models/release_with_spec.rb +43 -0
- data/spec/models/released_pull_request_author_spec.rb +25 -0
- data/spec/models/released_pull_request_spec.rb +67 -0
- data/spec/models/repository_set_create_request_spec.rb +43 -0
- data/spec/models/repository_set_list_item_spec.rb +55 -0
- data/spec/models/repository_set_with_name_spec.rb +43 -0
- data/spec/models/set_mapped_jira_identities_request_spec.rb +37 -0
- data/spec/models/share_spec.rb +43 -0
- data/spec/models/stage_timings_spec.rb +55 -0
- data/spec/models/table_fetching_progress_spec.rb +43 -0
- data/spec/models/team_create_request_spec.rb +49 -0
- data/spec/models/team_spec.rb +49 -0
- data/spec/models/team_update_request_spec.rb +43 -0
- data/spec/models/user_spec.rb +79 -0
- data/spec/models/versions_spec.rb +37 -0
- data/spec/models/with_both_jira_and_jiragroups_spec.rb +37 -0
- data/spec/models/work_type_get_request_spec.rb +37 -0
- data/spec/models/work_type_put_request_spec.rb +37 -0
- data/spec/models/work_type_rule_spec.rb +37 -0
- data/spec/models/work_type_spec.rb +43 -0
- data/spec/spec_helper.rb +108 -0
- metadata +1000 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Athenian::CalculatedLinearMetricValuesValuesInner
|
|
2
|
+
|
|
3
|
+
## Class instance methods
|
|
4
|
+
|
|
5
|
+
### `openapi_one_of`
|
|
6
|
+
|
|
7
|
+
Returns the list of classes defined in oneOf.
|
|
8
|
+
|
|
9
|
+
#### Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'athenian'
|
|
13
|
+
|
|
14
|
+
Athenian::CalculatedLinearMetricValuesValuesInner.openapi_one_of
|
|
15
|
+
# =>
|
|
16
|
+
# [
|
|
17
|
+
# :'Float',
|
|
18
|
+
# :'Object',
|
|
19
|
+
# :'String'
|
|
20
|
+
# ]
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### build
|
|
24
|
+
|
|
25
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
26
|
+
|
|
27
|
+
#### Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'athenian'
|
|
31
|
+
|
|
32
|
+
Athenian::CalculatedLinearMetricValuesValuesInner.build(data)
|
|
33
|
+
# => #<Float:0x00007fdd4aab02a0>
|
|
34
|
+
|
|
35
|
+
Athenian::CalculatedLinearMetricValuesValuesInner.build(data_that_doesnt_match)
|
|
36
|
+
# => nil
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
#### Parameters
|
|
40
|
+
|
|
41
|
+
| Name | Type | Description |
|
|
42
|
+
| ---- | ---- | ----------- |
|
|
43
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
44
|
+
|
|
45
|
+
#### Return type
|
|
46
|
+
|
|
47
|
+
- `Float`
|
|
48
|
+
- `Object`
|
|
49
|
+
- `String`
|
|
50
|
+
- `nil` (if no type matches)
|
|
51
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Athenian::CalculatedPullRequestHistogram
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_for** | [**ForSetPullRequests**](ForSetPullRequests.md) | | |
|
|
8
|
+
| **metric** | [**PullRequestMetricID**](PullRequestMetricID.md) | | |
|
|
9
|
+
| **scale** | [**HistogramScale**](HistogramScale.md) | | |
|
|
10
|
+
| **ticks** | [**Array<GoalMetricParamsThreshold>**](GoalMetricParamsThreshold.md) | Series of horizontal bar borders aka X axis. Their count is `len(y) + 1` because there are `N` intervals between `(N + 1)` ticks. | |
|
|
11
|
+
| **frequencies** | [**Array<CalculatedPullRequestHistogramFrequenciesInner>**](CalculatedPullRequestHistogramFrequenciesInner.md) | Series of histogram bar heights aka Y axis. | |
|
|
12
|
+
| **interquartile** | [**Interquartile**](Interquartile.md) | | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'athenian'
|
|
18
|
+
|
|
19
|
+
instance = Athenian::CalculatedPullRequestHistogram.new(
|
|
20
|
+
_for: null,
|
|
21
|
+
metric: null,
|
|
22
|
+
scale: null,
|
|
23
|
+
ticks: null,
|
|
24
|
+
frequencies: null,
|
|
25
|
+
interquartile: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Athenian::CalculatedPullRequestHistogramFrequenciesInner
|
|
2
|
+
|
|
3
|
+
## Class instance methods
|
|
4
|
+
|
|
5
|
+
### `openapi_one_of`
|
|
6
|
+
|
|
7
|
+
Returns the list of classes defined in oneOf.
|
|
8
|
+
|
|
9
|
+
#### Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'athenian'
|
|
13
|
+
|
|
14
|
+
Athenian::CalculatedPullRequestHistogramFrequenciesInner.openapi_one_of
|
|
15
|
+
# =>
|
|
16
|
+
# [
|
|
17
|
+
# :'Float',
|
|
18
|
+
# :'String'
|
|
19
|
+
# ]
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### build
|
|
23
|
+
|
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
25
|
+
|
|
26
|
+
#### Example
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'athenian'
|
|
30
|
+
|
|
31
|
+
Athenian::CalculatedPullRequestHistogramFrequenciesInner.build(data)
|
|
32
|
+
# => #<Float:0x00007fdd4aab02a0>
|
|
33
|
+
|
|
34
|
+
Athenian::CalculatedPullRequestHistogramFrequenciesInner.build(data_that_doesnt_match)
|
|
35
|
+
# => nil
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
#### Parameters
|
|
39
|
+
|
|
40
|
+
| Name | Type | Description |
|
|
41
|
+
| ---- | ---- | ----------- |
|
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
43
|
+
|
|
44
|
+
#### Return type
|
|
45
|
+
|
|
46
|
+
- `Float`
|
|
47
|
+
- `String`
|
|
48
|
+
- `nil` (if no type matches)
|
|
49
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Athenian::CalculatedPullRequestMetrics
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **calculated** | [**Array<CalculatedPullRequestMetricsItem>**](CalculatedPullRequestMetricsItem.md) | Values of the requested metrics through time. | |
|
|
8
|
+
| **metrics** | [**Array<PullRequestMetricID>**](PullRequestMetricID.md) | Repeats `PullRequestMetricsRequest.metrics`. | |
|
|
9
|
+
| **date_from** | **Date** | Repeats `PullRequestMetricsRequest.date_from`. | |
|
|
10
|
+
| **date_to** | **Date** | Repeats `PullRequestMetricsRequest.date_to`. | |
|
|
11
|
+
| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
|
|
12
|
+
| **granularities** | **Array<String>** | The splits of the specified time range. | |
|
|
13
|
+
| **quantiles** | **Array<Float>** | Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting. | [optional] |
|
|
14
|
+
| **exclude_inactive** | **Boolean** | Repeats `PullRequestMetricsRequest.exclude_inactive`. | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'athenian'
|
|
20
|
+
|
|
21
|
+
instance = Athenian::CalculatedPullRequestMetrics.new(
|
|
22
|
+
calculated: null,
|
|
23
|
+
metrics: null,
|
|
24
|
+
date_from: null,
|
|
25
|
+
date_to: null,
|
|
26
|
+
timezone: null,
|
|
27
|
+
granularities: null,
|
|
28
|
+
quantiles: [0,0.95],
|
|
29
|
+
exclude_inactive: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Athenian::CalculatedPullRequestMetricsItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_for** | [**ForSetPullRequests**](ForSetPullRequests.md) | | |
|
|
8
|
+
| **granularity** | **String** | How often the metrics are reported. The value must satisfy the following regular expression: /^all|(([1-9]\\d* )?(aligned )?(day|week|month|year))$/. \"all\" produces a single interval [`date_from`, `date_to`]. \"aligned week/month/year\" produces intervals cut by calendar week/month/year borders, for example, when `date_from` is `2020-01-15` and `date_to` is `2020-03-10`, the intervals will be `2020-01-15` - `2020-02-01` - `2020-03-01` - `2020-03-10`. | [optional] |
|
|
9
|
+
| **values** | [**Array<CalculatedLinearMetricValues>**](CalculatedLinearMetricValues.md) | The sequence steps from `date_from` till `date_to` by `granularity`. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'athenian'
|
|
15
|
+
|
|
16
|
+
instance = Athenian::CalculatedPullRequestMetricsItem.new(
|
|
17
|
+
_for: null,
|
|
18
|
+
granularity: 2 week,
|
|
19
|
+
values: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Athenian::CalculatedReleaseMetric
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_for** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. | [optional] |
|
|
8
|
+
| **with** | [**ReleaseWith**](ReleaseWith.md) | | [optional] |
|
|
9
|
+
| **jira** | [**JIRAFilter**](JIRAFilter.md) | | [optional] |
|
|
10
|
+
| **matches** | [**Hash<String, ReleaseMatchStrategy>**](ReleaseMatchStrategy.md) | Applied release matching strategies for the repositories in `for`. | |
|
|
11
|
+
| **metrics** | [**Array<ReleaseMetricID>**](ReleaseMetricID.md) | | |
|
|
12
|
+
| **granularity** | **String** | How often the metrics are reported. The value must satisfy the following regular expression: /^all|(([1-9]\\d* )?(aligned )?(day|week|month|year))$/. \"all\" produces a single interval [`date_from`, `date_to`]. \"aligned week/month/year\" produces intervals cut by calendar week/month/year borders, for example, when `date_from` is `2020-01-15` and `date_to` is `2020-03-10`, the intervals will be `2020-01-15` - `2020-02-01` - `2020-03-01` - `2020-03-10`. | |
|
|
13
|
+
| **values** | [**Array<CalculatedLinearMetricValues>**](CalculatedLinearMetricValues.md) | The sequence steps from `date_from` till `date_to` by `granularity`. | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'athenian'
|
|
19
|
+
|
|
20
|
+
instance = Athenian::CalculatedReleaseMetric.new(
|
|
21
|
+
_for: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
|
|
22
|
+
with: null,
|
|
23
|
+
jira: null,
|
|
24
|
+
matches: null,
|
|
25
|
+
metrics: null,
|
|
26
|
+
granularity: 2 week,
|
|
27
|
+
values: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Athenian::CodeBypassingPRsMeasurement
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date** | **Date** | Commits were pushed beginning with this date. They were not pushed later than +granularity. | |
|
|
8
|
+
| **bypassed_commits** | **Integer** | Number of commits that bypassed PRs in the time interval. | |
|
|
9
|
+
| **bypassed_lines** | **Integer** | Number of changed (added + removed) lines that bypassed PRs in the time interval. | |
|
|
10
|
+
| **total_commits** | **Integer** | Overall number of commits in the time interval. | |
|
|
11
|
+
| **total_lines** | **Integer** | Overall number of changed (added + removed) lines in the time interval. | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'athenian'
|
|
17
|
+
|
|
18
|
+
instance = Athenian::CodeBypassingPRsMeasurement.new(
|
|
19
|
+
date: null,
|
|
20
|
+
bypassed_commits: null,
|
|
21
|
+
bypassed_lines: null,
|
|
22
|
+
total_commits: null,
|
|
23
|
+
total_lines: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Athenian::CodeCheckHistogramDefinition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **metric** | [**CodeCheckMetricID**](CodeCheckMetricID.md) | | |
|
|
8
|
+
| **scale** | [**HistogramScale**](HistogramScale.md) | | [optional] |
|
|
9
|
+
| **bins** | **Integer** | Number of bars in the histogram. 0 or null means automatic. | [optional] |
|
|
10
|
+
| **ticks** | [**Array<GoalMetricParamsThreshold>**](GoalMetricParamsThreshold.md) | Alternatively to `bins` and `scale`, set the X axis bar borders manually. Only one of two may be specified. The ticks are automatically prepended the distribution minimum and appended the distribution maximum. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'athenian'
|
|
16
|
+
|
|
17
|
+
instance = Athenian::CodeCheckHistogramDefinition.new(
|
|
18
|
+
metric: null,
|
|
19
|
+
scale: null,
|
|
20
|
+
bins: null,
|
|
21
|
+
ticks: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Athenian::CodeCheckHistogramsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_for** | [**Array<ForSetCodeChecks>**](ForSetCodeChecks.md) | Sets of developers and repositories for which to calculate the histograms. The aggregation is `AND` between repositories and developers. The aggregation is `OR` inside both repositories and developers. | |
|
|
8
|
+
| **histograms** | [**Array<CodeCheckHistogramDefinition>**](CodeCheckHistogramDefinition.md) | Histogram parameters for each wanted topic. | |
|
|
9
|
+
| **date_from** | **Date** | Date from when to start measuring the distribution. | |
|
|
10
|
+
| **date_to** | **Date** | Date until which to measure the distribution. | |
|
|
11
|
+
| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
|
|
12
|
+
| **quantiles** | **Array<Float>** | Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting. | [optional] |
|
|
13
|
+
| **split_by_check_runs** | **Boolean** | Calculate histograms separately for each number of check runs in suite. | [optional] |
|
|
14
|
+
| **account** | **Integer** | Session account ID. | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'athenian'
|
|
20
|
+
|
|
21
|
+
instance = Athenian::CodeCheckHistogramsRequest.new(
|
|
22
|
+
_for: null,
|
|
23
|
+
histograms: null,
|
|
24
|
+
date_from: null,
|
|
25
|
+
date_to: null,
|
|
26
|
+
timezone: null,
|
|
27
|
+
quantiles: [0,0.95],
|
|
28
|
+
split_by_check_runs: null,
|
|
29
|
+
account: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Athenian::CodeCheckMetricsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_for** | [**Array<ForSetCodeChecks>**](ForSetCodeChecks.md) | Sets of developers and repositories for which to calculate the metrics. The aggregation is `AND` between repositories and developers. The aggregation is `OR` inside both repositories and developers. | |
|
|
8
|
+
| **metrics** | [**Array<CodeCheckMetricID>**](CodeCheckMetricID.md) | Requested metric identifiers. | |
|
|
9
|
+
| **date_from** | **Date** | Date from when to start measuring the metrics. | |
|
|
10
|
+
| **date_to** | **Date** | Date until which to measure the metrics. | |
|
|
11
|
+
| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
|
|
12
|
+
| **granularities** | **Array<String>** | The splits of the specified time range. | |
|
|
13
|
+
| **quantiles** | **Array<Float>** | Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting. | [optional] |
|
|
14
|
+
| **account** | **Integer** | Session account ID. | |
|
|
15
|
+
| **split_by_check_runs** | **Boolean** | Calculate metrics separately for each number of check runs in suite. | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'athenian'
|
|
21
|
+
|
|
22
|
+
instance = Athenian::CodeCheckMetricsRequest.new(
|
|
23
|
+
_for: null,
|
|
24
|
+
metrics: null,
|
|
25
|
+
date_from: null,
|
|
26
|
+
date_to: null,
|
|
27
|
+
timezone: null,
|
|
28
|
+
granularities: null,
|
|
29
|
+
quantiles: [0,0.95],
|
|
30
|
+
account: null,
|
|
31
|
+
split_by_check_runs: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Athenian::CodeCheckRunStatistics
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **count** | **Integer** | Number of executions with respect to `date_from` and `date_to`. | |
|
|
8
|
+
| **successes** | **Integer** | Number of successful executions with respect to `date_from` and `date_to`. | |
|
|
9
|
+
| **critical** | **Boolean** | This code check dominated the overall check suite execution time at least once. | |
|
|
10
|
+
| **mean_execution_time** | [**CodeCheckRunStatisticsMeanExecutionTime**](CodeCheckRunStatisticsMeanExecutionTime.md) | | |
|
|
11
|
+
| **stddev_execution_time** | [**CodeCheckRunStatisticsStddevExecutionTime**](CodeCheckRunStatisticsStddevExecutionTime.md) | | |
|
|
12
|
+
| **median_execution_time** | [**CodeCheckRunStatisticsMedianExecutionTime**](CodeCheckRunStatisticsMedianExecutionTime.md) | | |
|
|
13
|
+
| **skips** | **Integer** | Number of times this check run was skipped. | |
|
|
14
|
+
| **flaky_count** | **Integer** | Number of times this check run appeared flaky: it both failed and succeeded for the same commit. | |
|
|
15
|
+
| **count_timeline** | **Array<Integer>** | Number of executions through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. | |
|
|
16
|
+
| **successes_timeline** | **Array<Integer>** | Number of successful executions through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. | |
|
|
17
|
+
| **mean_execution_time_timeline** | **Array<String>** | Average elapsed execution time through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. | |
|
|
18
|
+
| **median_execution_time_timeline** | **Array<String>** | Median elapsed execution time through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. | |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'athenian'
|
|
24
|
+
|
|
25
|
+
instance = Athenian::CodeCheckRunStatistics.new(
|
|
26
|
+
count: null,
|
|
27
|
+
successes: null,
|
|
28
|
+
critical: null,
|
|
29
|
+
mean_execution_time: null,
|
|
30
|
+
stddev_execution_time: null,
|
|
31
|
+
median_execution_time: null,
|
|
32
|
+
skips: null,
|
|
33
|
+
flaky_count: null,
|
|
34
|
+
count_timeline: null,
|
|
35
|
+
successes_timeline: null,
|
|
36
|
+
mean_execution_time_timeline: null,
|
|
37
|
+
median_execution_time_timeline: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Athenian::CodeCheckRunStatisticsMeanExecutionTime
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'athenian'
|
|
12
|
+
|
|
13
|
+
instance = Athenian::CodeCheckRunStatisticsMeanExecutionTime.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Athenian::CodeCheckRunStatisticsMedianExecutionTime
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'athenian'
|
|
12
|
+
|
|
13
|
+
instance = Athenian::CodeCheckRunStatisticsMedianExecutionTime.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Athenian::CodeCheckRunStatisticsStddevExecutionTime
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'athenian'
|
|
12
|
+
|
|
13
|
+
instance = Athenian::CodeCheckRunStatisticsStddevExecutionTime.new()
|
|
14
|
+
```
|
|
15
|
+
|
data/docs/CodeFilter.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Athenian::CodeFilter
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account** | **Integer** | Session account ID. | |
|
|
8
|
+
| **date_from** | **Date** | Commits must be made later than or equal to this date. | |
|
|
9
|
+
| **date_to** | **Date** | Commits must be made earlier than or equal to this date. | |
|
|
10
|
+
| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
|
|
11
|
+
| **_in** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. | |
|
|
12
|
+
| **with_author** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
|
|
13
|
+
| **with_committer** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
|
|
14
|
+
| **granularity** | **String** | How often the metrics are reported. The value must satisfy the following regular expression: /^all|(([1-9]\\d* )?(aligned )?(day|week|month|year))$/. \"all\" produces a single interval [`date_from`, `date_to`]. \"aligned week/month/year\" produces intervals cut by calendar week/month/year borders, for example, when `date_from` is `2020-01-15` and `date_to` is `2020-03-10`, the intervals will be `2020-01-15` - `2020-02-01` - `2020-03-01` - `2020-03-10`. | |
|
|
15
|
+
| **only_default_branch** | **Boolean** | Consider only commits that are accessible from the head of the default branch. For example, if your workflow includes PR-ing feature branches, you rebase and merge them and don't delete afterward, `bypassing_prs` will report the commits in those feature branches unless you set `only_default_branch` to `true`. | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'athenian'
|
|
21
|
+
|
|
22
|
+
instance = Athenian::CodeFilter.new(
|
|
23
|
+
account: null,
|
|
24
|
+
date_from: null,
|
|
25
|
+
date_to: null,
|
|
26
|
+
timezone: null,
|
|
27
|
+
_in: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
|
|
28
|
+
with_author: ["github.com/vmarkovtsev","github.com/dpordomingo"],
|
|
29
|
+
with_committer: ["github.com/vmarkovtsev","github.com/dpordomingo"],
|
|
30
|
+
granularity: 2 week,
|
|
31
|
+
only_default_branch: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
data/docs/Commit.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Athenian::Commit
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **author** | [**CommitSignature**](CommitSignature.md) | | |
|
|
8
|
+
| **children** | **Array<String>** | Hashes of the children. Exists only if `property == everything`. Note: the direction is from HEAD to the root, i.e. reversed compared to Git. | [optional] |
|
|
9
|
+
| **committer** | [**CommitSignature**](CommitSignature.md) | | |
|
|
10
|
+
| **deployments** | **Array<String>** | Deployments of the commit. | [optional] |
|
|
11
|
+
| **files_changed** | **Integer** | Number of files changed in this PR. | |
|
|
12
|
+
| **hash** | **String** | Git commit hash. | |
|
|
13
|
+
| **message** | **String** | Commit message. | |
|
|
14
|
+
| **repository** | **String** | Repository name which uniquely identifies any repository in any service provider. The format matches the repository URL without the protocol part. No \".git\" should be appended. We support a special syntax for repository sets: \"{reposet id}\" adds all the repositories from the given set. | |
|
|
15
|
+
| **size_added** | **Integer** | Overall number of lines added. | |
|
|
16
|
+
| **size_removed** | **Integer** | Overall number of lines removed. | |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'athenian'
|
|
22
|
+
|
|
23
|
+
instance = Athenian::Commit.new(
|
|
24
|
+
author: null,
|
|
25
|
+
children: null,
|
|
26
|
+
committer: null,
|
|
27
|
+
deployments: null,
|
|
28
|
+
files_changed: null,
|
|
29
|
+
hash: null,
|
|
30
|
+
message: null,
|
|
31
|
+
repository: github.com/athenianco/athenian-webapp,
|
|
32
|
+
size_added: null,
|
|
33
|
+
size_removed: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Athenian::CommitSignature
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **login** | **String** | User name which uniquely identifies any developer on any service provider. The format matches the profile URL without the protocol part. | [optional] |
|
|
8
|
+
| **name** | **String** | Git signature name. | [optional] |
|
|
9
|
+
| **email** | **String** | Git signature email. | [optional] |
|
|
10
|
+
| **timestamp** | **Time** | When the corresponding action happened in UTC. | |
|
|
11
|
+
| **timezone** | **Float** | Timezone offset of the action timestamp (in hours). | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'athenian'
|
|
17
|
+
|
|
18
|
+
instance = Athenian::CommitSignature.new(
|
|
19
|
+
login: github.com/vmarkovtsev,
|
|
20
|
+
name: null,
|
|
21
|
+
email: null,
|
|
22
|
+
timestamp: null,
|
|
23
|
+
timezone: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/CommitsList.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Athenian::CommitsList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<Commit>**](Commit.md) | | |
|
|
8
|
+
| **include** | [**CommitsListInclude**](CommitsListInclude.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'athenian'
|
|
14
|
+
|
|
15
|
+
instance = Athenian::CommitsList.new(
|
|
16
|
+
data: null,
|
|
17
|
+
include: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Athenian::CommitsListInclude
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **deployments** | [**Hash<String, DeploymentNotification>**](DeploymentNotification.md) | Mapping deployment names to their details. | [optional] |
|
|
8
|
+
| **users** | [**Hash<String, IncludedNativeUser>**](IncludedNativeUser.md) | Mapping user native (e.g., GitHub) login ID -> user details. The users are mentioned in the PRs from \"PullRequestSet.data\" or in the commits from \"FilterCommitsRequest.data\". | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'athenian'
|
|
14
|
+
|
|
15
|
+
instance = Athenian::CommitsListInclude.new(
|
|
16
|
+
deployments: null,
|
|
17
|
+
users: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/Contributor.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Athenian::Contributor
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **login** | **String** | User name which uniquely identifies any developer on any service provider. The format matches the profile URL without the protocol part. | |
|
|
8
|
+
| **name** | **String** | Full name of the contributor. | [optional] |
|
|
9
|
+
| **email** | **String** | Email of the conributor. | [optional] |
|
|
10
|
+
| **picture** | **String** | Avatar URL of the contributor. | [optional] |
|
|
11
|
+
| **jira_user** | **String** | Mapped JIRA user name. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'athenian'
|
|
17
|
+
|
|
18
|
+
instance = Athenian::Contributor.new(
|
|
19
|
+
login: github.com/vmarkovtsev,
|
|
20
|
+
name: null,
|
|
21
|
+
email: null,
|
|
22
|
+
picture: null,
|
|
23
|
+
jira_user: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Athenian::ContributorIdentity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **emails** | **Array<String>** | Email addresses belonging to the person. | [optional] |
|
|
8
|
+
| **names** | **Array<String>** | The person is known as each of these full names. The format is arbitrary. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'athenian'
|
|
14
|
+
|
|
15
|
+
instance = Athenian::ContributorIdentity.new(
|
|
16
|
+
emails: null,
|
|
17
|
+
names: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Athenian::CreateTokenRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account** | **Integer** | Account ID. | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'athenian'
|
|
14
|
+
|
|
15
|
+
instance = Athenian::CreateTokenRequest.new(
|
|
16
|
+
account: null,
|
|
17
|
+
name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|