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
data/docs/FilterApi.md
ADDED
|
@@ -0,0 +1,832 @@
|
|
|
1
|
+
# Athenian::FilterApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.athenian.co/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**diff_releases**](FilterApi.md#diff_releases) | **POST** /diff/releases | Find releases between the two given ones per repository. |
|
|
8
|
+
| [**filter_code_checks**](FilterApi.md#filter_code_checks) | **POST** /filter/code_checks | Find code check runs that match the specified query. [What a code check run is exactly.](https://docs.github.com/en/rest/guides/getting-started-with-the-checks-api#about-check-runs) |
|
|
9
|
+
| [**filter_commits**](FilterApi.md#filter_commits) | **POST** /filter/commits | Find commits that match the specified query. |
|
|
10
|
+
| [**filter_contributors**](FilterApi.md#filter_contributors) | **POST** /filter/contributors | Find developers that made an action within the given timeframe. |
|
|
11
|
+
| [**filter_deployments**](FilterApi.md#filter_deployments) | **POST** /filter/deployments | List the deployments that satisfy the provided filters. We accept new deployment notifications at `/events/deployments`. |
|
|
12
|
+
| [**filter_environments**](FilterApi.md#filter_environments) | **POST** /filter/environments | List the deployment environments. |
|
|
13
|
+
| [**filter_jira_stuff**](FilterApi.md#filter_jira_stuff) | **POST** /filter/jira | Find various JIRA entities relevant to the specified date interval. |
|
|
14
|
+
| [**filter_labels**](FilterApi.md#filter_labels) | **POST** /filter/labels | Find labels used in the given repositories. |
|
|
15
|
+
| [**filter_prs**](FilterApi.md#filter_prs) | **POST** /filter/pull_requests | List pull requests that satisfy the query. |
|
|
16
|
+
| [**filter_releases**](FilterApi.md#filter_releases) | **POST** /filter/releases | Find releases that were published in the given time fram in the given repositories. |
|
|
17
|
+
| [**filter_repositories**](FilterApi.md#filter_repositories) | **POST** /filter/repositories | Find repositories that were updated within the given timeframe. |
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## diff_releases
|
|
21
|
+
|
|
22
|
+
> <DiffedReleases> diff_releases(opts)
|
|
23
|
+
|
|
24
|
+
Find releases between the two given ones per repository.
|
|
25
|
+
|
|
26
|
+
### Examples
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'time'
|
|
30
|
+
require 'athenian'
|
|
31
|
+
# setup authorization
|
|
32
|
+
Athenian.configure do |config|
|
|
33
|
+
# Configure API key authorization: apiKeyAuth
|
|
34
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
35
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
36
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
37
|
+
|
|
38
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
39
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
api_instance = Athenian::FilterApi.new
|
|
43
|
+
opts = {
|
|
44
|
+
body: Athenian::DiffReleasesRequest.new({account: 37, borders: { key: [Athenian::ReleasePair.new({old: 'old_example', new: 'new_example'})]}}) # DiffReleasesRequest |
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
begin
|
|
48
|
+
# Find releases between the two given ones per repository.
|
|
49
|
+
result = api_instance.diff_releases(opts)
|
|
50
|
+
p result
|
|
51
|
+
rescue Athenian::ApiError => e
|
|
52
|
+
puts "Error when calling FilterApi->diff_releases: #{e}"
|
|
53
|
+
end
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
#### Using the diff_releases_with_http_info variant
|
|
57
|
+
|
|
58
|
+
This returns an Array which contains the response data, status code and headers.
|
|
59
|
+
|
|
60
|
+
> <Array(<DiffedReleases>, Integer, Hash)> diff_releases_with_http_info(opts)
|
|
61
|
+
|
|
62
|
+
```ruby
|
|
63
|
+
begin
|
|
64
|
+
# Find releases between the two given ones per repository.
|
|
65
|
+
data, status_code, headers = api_instance.diff_releases_with_http_info(opts)
|
|
66
|
+
p status_code # => 2xx
|
|
67
|
+
p headers # => { ... }
|
|
68
|
+
p data # => <DiffedReleases>
|
|
69
|
+
rescue Athenian::ApiError => e
|
|
70
|
+
puts "Error when calling FilterApi->diff_releases_with_http_info: #{e}"
|
|
71
|
+
end
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Parameters
|
|
75
|
+
|
|
76
|
+
| Name | Type | Description | Notes |
|
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
|
78
|
+
| **body** | [**DiffReleasesRequest**](DiffReleasesRequest.md) | | [optional] |
|
|
79
|
+
|
|
80
|
+
### Return type
|
|
81
|
+
|
|
82
|
+
[**DiffedReleases**](DiffedReleases.md)
|
|
83
|
+
|
|
84
|
+
### Authorization
|
|
85
|
+
|
|
86
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
87
|
+
|
|
88
|
+
### HTTP request headers
|
|
89
|
+
|
|
90
|
+
- **Content-Type**: application/json
|
|
91
|
+
- **Accept**: application/json
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
## filter_code_checks
|
|
95
|
+
|
|
96
|
+
> <FilteredCodeCheckRuns> filter_code_checks(opts)
|
|
97
|
+
|
|
98
|
+
Find code check runs that match the specified query. [What a code check run is exactly.](https://docs.github.com/en/rest/guides/getting-started-with-the-checks-api#about-check-runs)
|
|
99
|
+
|
|
100
|
+
### Examples
|
|
101
|
+
|
|
102
|
+
```ruby
|
|
103
|
+
require 'time'
|
|
104
|
+
require 'athenian'
|
|
105
|
+
# setup authorization
|
|
106
|
+
Athenian.configure do |config|
|
|
107
|
+
# Configure API key authorization: apiKeyAuth
|
|
108
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
109
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
110
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
111
|
+
|
|
112
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
113
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
api_instance = Athenian::FilterApi.new
|
|
117
|
+
opts = {
|
|
118
|
+
body: Athenian::FilterCodeChecksRequest.new({_in: ["github.com/athenianco/athenian-webapp", "github.com/athenianco/athenian-api"], date_from: Date.today, date_to: Date.today, account: 37}) # FilterCodeChecksRequest |
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
begin
|
|
122
|
+
# Find code check runs that match the specified query. [What a code check run is exactly.](https://docs.github.com/en/rest/guides/getting-started-with-the-checks-api#about-check-runs)
|
|
123
|
+
result = api_instance.filter_code_checks(opts)
|
|
124
|
+
p result
|
|
125
|
+
rescue Athenian::ApiError => e
|
|
126
|
+
puts "Error when calling FilterApi->filter_code_checks: #{e}"
|
|
127
|
+
end
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
#### Using the filter_code_checks_with_http_info variant
|
|
131
|
+
|
|
132
|
+
This returns an Array which contains the response data, status code and headers.
|
|
133
|
+
|
|
134
|
+
> <Array(<FilteredCodeCheckRuns>, Integer, Hash)> filter_code_checks_with_http_info(opts)
|
|
135
|
+
|
|
136
|
+
```ruby
|
|
137
|
+
begin
|
|
138
|
+
# Find code check runs that match the specified query. [What a code check run is exactly.](https://docs.github.com/en/rest/guides/getting-started-with-the-checks-api#about-check-runs)
|
|
139
|
+
data, status_code, headers = api_instance.filter_code_checks_with_http_info(opts)
|
|
140
|
+
p status_code # => 2xx
|
|
141
|
+
p headers # => { ... }
|
|
142
|
+
p data # => <FilteredCodeCheckRuns>
|
|
143
|
+
rescue Athenian::ApiError => e
|
|
144
|
+
puts "Error when calling FilterApi->filter_code_checks_with_http_info: #{e}"
|
|
145
|
+
end
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Parameters
|
|
149
|
+
|
|
150
|
+
| Name | Type | Description | Notes |
|
|
151
|
+
| ---- | ---- | ----------- | ----- |
|
|
152
|
+
| **body** | [**FilterCodeChecksRequest**](FilterCodeChecksRequest.md) | | [optional] |
|
|
153
|
+
|
|
154
|
+
### Return type
|
|
155
|
+
|
|
156
|
+
[**FilteredCodeCheckRuns**](FilteredCodeCheckRuns.md)
|
|
157
|
+
|
|
158
|
+
### Authorization
|
|
159
|
+
|
|
160
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
161
|
+
|
|
162
|
+
### HTTP request headers
|
|
163
|
+
|
|
164
|
+
- **Content-Type**: application/json
|
|
165
|
+
- **Accept**: application/json
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
## filter_commits
|
|
169
|
+
|
|
170
|
+
> <CommitsList> filter_commits(opts)
|
|
171
|
+
|
|
172
|
+
Find commits that match the specified query.
|
|
173
|
+
|
|
174
|
+
### Examples
|
|
175
|
+
|
|
176
|
+
```ruby
|
|
177
|
+
require 'time'
|
|
178
|
+
require 'athenian'
|
|
179
|
+
# setup authorization
|
|
180
|
+
Athenian.configure do |config|
|
|
181
|
+
# Configure API key authorization: apiKeyAuth
|
|
182
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
183
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
184
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
185
|
+
|
|
186
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
187
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
api_instance = Athenian::FilterApi.new
|
|
191
|
+
opts = {
|
|
192
|
+
body: Athenian::FilterCommitsRequest.new({account: 37, date_from: Date.today, date_to: Date.today, _in: ["github.com/athenianco/athenian-webapp", "github.com/athenianco/athenian-api"], property: 'bypassing_prs'}) # FilterCommitsRequest |
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
begin
|
|
196
|
+
# Find commits that match the specified query.
|
|
197
|
+
result = api_instance.filter_commits(opts)
|
|
198
|
+
p result
|
|
199
|
+
rescue Athenian::ApiError => e
|
|
200
|
+
puts "Error when calling FilterApi->filter_commits: #{e}"
|
|
201
|
+
end
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
#### Using the filter_commits_with_http_info variant
|
|
205
|
+
|
|
206
|
+
This returns an Array which contains the response data, status code and headers.
|
|
207
|
+
|
|
208
|
+
> <Array(<CommitsList>, Integer, Hash)> filter_commits_with_http_info(opts)
|
|
209
|
+
|
|
210
|
+
```ruby
|
|
211
|
+
begin
|
|
212
|
+
# Find commits that match the specified query.
|
|
213
|
+
data, status_code, headers = api_instance.filter_commits_with_http_info(opts)
|
|
214
|
+
p status_code # => 2xx
|
|
215
|
+
p headers # => { ... }
|
|
216
|
+
p data # => <CommitsList>
|
|
217
|
+
rescue Athenian::ApiError => e
|
|
218
|
+
puts "Error when calling FilterApi->filter_commits_with_http_info: #{e}"
|
|
219
|
+
end
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Parameters
|
|
223
|
+
|
|
224
|
+
| Name | Type | Description | Notes |
|
|
225
|
+
| ---- | ---- | ----------- | ----- |
|
|
226
|
+
| **body** | [**FilterCommitsRequest**](FilterCommitsRequest.md) | | [optional] |
|
|
227
|
+
|
|
228
|
+
### Return type
|
|
229
|
+
|
|
230
|
+
[**CommitsList**](CommitsList.md)
|
|
231
|
+
|
|
232
|
+
### Authorization
|
|
233
|
+
|
|
234
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
235
|
+
|
|
236
|
+
### HTTP request headers
|
|
237
|
+
|
|
238
|
+
- **Content-Type**: application/json
|
|
239
|
+
- **Accept**: application/json
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
## filter_contributors
|
|
243
|
+
|
|
244
|
+
> <Array<DeveloperSummary>> filter_contributors(opts)
|
|
245
|
+
|
|
246
|
+
Find developers that made an action within the given timeframe.
|
|
247
|
+
|
|
248
|
+
### Examples
|
|
249
|
+
|
|
250
|
+
```ruby
|
|
251
|
+
require 'time'
|
|
252
|
+
require 'athenian'
|
|
253
|
+
# setup authorization
|
|
254
|
+
Athenian.configure do |config|
|
|
255
|
+
# Configure API key authorization: apiKeyAuth
|
|
256
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
257
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
258
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
259
|
+
|
|
260
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
261
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
api_instance = Athenian::FilterApi.new
|
|
265
|
+
opts = {
|
|
266
|
+
body: Athenian::FilterContributorsRequest.new({account: 37, date_from: Date.today, date_to: Date.today}) # FilterContributorsRequest |
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
begin
|
|
270
|
+
# Find developers that made an action within the given timeframe.
|
|
271
|
+
result = api_instance.filter_contributors(opts)
|
|
272
|
+
p result
|
|
273
|
+
rescue Athenian::ApiError => e
|
|
274
|
+
puts "Error when calling FilterApi->filter_contributors: #{e}"
|
|
275
|
+
end
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
#### Using the filter_contributors_with_http_info variant
|
|
279
|
+
|
|
280
|
+
This returns an Array which contains the response data, status code and headers.
|
|
281
|
+
|
|
282
|
+
> <Array(<Array<DeveloperSummary>>, Integer, Hash)> filter_contributors_with_http_info(opts)
|
|
283
|
+
|
|
284
|
+
```ruby
|
|
285
|
+
begin
|
|
286
|
+
# Find developers that made an action within the given timeframe.
|
|
287
|
+
data, status_code, headers = api_instance.filter_contributors_with_http_info(opts)
|
|
288
|
+
p status_code # => 2xx
|
|
289
|
+
p headers # => { ... }
|
|
290
|
+
p data # => <Array<DeveloperSummary>>
|
|
291
|
+
rescue Athenian::ApiError => e
|
|
292
|
+
puts "Error when calling FilterApi->filter_contributors_with_http_info: #{e}"
|
|
293
|
+
end
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
### Parameters
|
|
297
|
+
|
|
298
|
+
| Name | Type | Description | Notes |
|
|
299
|
+
| ---- | ---- | ----------- | ----- |
|
|
300
|
+
| **body** | [**FilterContributorsRequest**](FilterContributorsRequest.md) | | [optional] |
|
|
301
|
+
|
|
302
|
+
### Return type
|
|
303
|
+
|
|
304
|
+
[**Array<DeveloperSummary>**](DeveloperSummary.md)
|
|
305
|
+
|
|
306
|
+
### Authorization
|
|
307
|
+
|
|
308
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
309
|
+
|
|
310
|
+
### HTTP request headers
|
|
311
|
+
|
|
312
|
+
- **Content-Type**: application/json
|
|
313
|
+
- **Accept**: application/json
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
## filter_deployments
|
|
317
|
+
|
|
318
|
+
> <FilteredDeployments> filter_deployments(opts)
|
|
319
|
+
|
|
320
|
+
List the deployments that satisfy the provided filters. We accept new deployment notifications at `/events/deployments`.
|
|
321
|
+
|
|
322
|
+
### Examples
|
|
323
|
+
|
|
324
|
+
```ruby
|
|
325
|
+
require 'time'
|
|
326
|
+
require 'athenian'
|
|
327
|
+
# setup authorization
|
|
328
|
+
Athenian.configure do |config|
|
|
329
|
+
# Configure API key authorization: apiKeyAuth
|
|
330
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
331
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
332
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
333
|
+
|
|
334
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
335
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
336
|
+
end
|
|
337
|
+
|
|
338
|
+
api_instance = Athenian::FilterApi.new
|
|
339
|
+
opts = {
|
|
340
|
+
body: Athenian::FilterDeploymentsRequest.new({date_from: Date.today, date_to: Date.today, account: 37}) # FilterDeploymentsRequest |
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
begin
|
|
344
|
+
# List the deployments that satisfy the provided filters. We accept new deployment notifications at `/events/deployments`.
|
|
345
|
+
result = api_instance.filter_deployments(opts)
|
|
346
|
+
p result
|
|
347
|
+
rescue Athenian::ApiError => e
|
|
348
|
+
puts "Error when calling FilterApi->filter_deployments: #{e}"
|
|
349
|
+
end
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
#### Using the filter_deployments_with_http_info variant
|
|
353
|
+
|
|
354
|
+
This returns an Array which contains the response data, status code and headers.
|
|
355
|
+
|
|
356
|
+
> <Array(<FilteredDeployments>, Integer, Hash)> filter_deployments_with_http_info(opts)
|
|
357
|
+
|
|
358
|
+
```ruby
|
|
359
|
+
begin
|
|
360
|
+
# List the deployments that satisfy the provided filters. We accept new deployment notifications at `/events/deployments`.
|
|
361
|
+
data, status_code, headers = api_instance.filter_deployments_with_http_info(opts)
|
|
362
|
+
p status_code # => 2xx
|
|
363
|
+
p headers # => { ... }
|
|
364
|
+
p data # => <FilteredDeployments>
|
|
365
|
+
rescue Athenian::ApiError => e
|
|
366
|
+
puts "Error when calling FilterApi->filter_deployments_with_http_info: #{e}"
|
|
367
|
+
end
|
|
368
|
+
```
|
|
369
|
+
|
|
370
|
+
### Parameters
|
|
371
|
+
|
|
372
|
+
| Name | Type | Description | Notes |
|
|
373
|
+
| ---- | ---- | ----------- | ----- |
|
|
374
|
+
| **body** | [**FilterDeploymentsRequest**](FilterDeploymentsRequest.md) | | [optional] |
|
|
375
|
+
|
|
376
|
+
### Return type
|
|
377
|
+
|
|
378
|
+
[**FilteredDeployments**](FilteredDeployments.md)
|
|
379
|
+
|
|
380
|
+
### Authorization
|
|
381
|
+
|
|
382
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
383
|
+
|
|
384
|
+
### HTTP request headers
|
|
385
|
+
|
|
386
|
+
- **Content-Type**: application/json
|
|
387
|
+
- **Accept**: application/json
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
## filter_environments
|
|
391
|
+
|
|
392
|
+
> <Array<FilteredEnvironment>> filter_environments(opts)
|
|
393
|
+
|
|
394
|
+
List the deployment environments.
|
|
395
|
+
|
|
396
|
+
### Examples
|
|
397
|
+
|
|
398
|
+
```ruby
|
|
399
|
+
require 'time'
|
|
400
|
+
require 'athenian'
|
|
401
|
+
# setup authorization
|
|
402
|
+
Athenian.configure do |config|
|
|
403
|
+
# Configure API key authorization: apiKeyAuth
|
|
404
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
405
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
406
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
407
|
+
|
|
408
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
409
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
410
|
+
end
|
|
411
|
+
|
|
412
|
+
api_instance = Athenian::FilterApi.new
|
|
413
|
+
opts = {
|
|
414
|
+
body: Athenian::FilterEnvironmentsRequest.new({account: 37, date_from: Date.today, date_to: Date.today}) # FilterEnvironmentsRequest |
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
begin
|
|
418
|
+
# List the deployment environments.
|
|
419
|
+
result = api_instance.filter_environments(opts)
|
|
420
|
+
p result
|
|
421
|
+
rescue Athenian::ApiError => e
|
|
422
|
+
puts "Error when calling FilterApi->filter_environments: #{e}"
|
|
423
|
+
end
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
#### Using the filter_environments_with_http_info variant
|
|
427
|
+
|
|
428
|
+
This returns an Array which contains the response data, status code and headers.
|
|
429
|
+
|
|
430
|
+
> <Array(<Array<FilteredEnvironment>>, Integer, Hash)> filter_environments_with_http_info(opts)
|
|
431
|
+
|
|
432
|
+
```ruby
|
|
433
|
+
begin
|
|
434
|
+
# List the deployment environments.
|
|
435
|
+
data, status_code, headers = api_instance.filter_environments_with_http_info(opts)
|
|
436
|
+
p status_code # => 2xx
|
|
437
|
+
p headers # => { ... }
|
|
438
|
+
p data # => <Array<FilteredEnvironment>>
|
|
439
|
+
rescue Athenian::ApiError => e
|
|
440
|
+
puts "Error when calling FilterApi->filter_environments_with_http_info: #{e}"
|
|
441
|
+
end
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
### Parameters
|
|
445
|
+
|
|
446
|
+
| Name | Type | Description | Notes |
|
|
447
|
+
| ---- | ---- | ----------- | ----- |
|
|
448
|
+
| **body** | [**FilterEnvironmentsRequest**](FilterEnvironmentsRequest.md) | | [optional] |
|
|
449
|
+
|
|
450
|
+
### Return type
|
|
451
|
+
|
|
452
|
+
[**Array<FilteredEnvironment>**](FilteredEnvironment.md)
|
|
453
|
+
|
|
454
|
+
### Authorization
|
|
455
|
+
|
|
456
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
457
|
+
|
|
458
|
+
### HTTP request headers
|
|
459
|
+
|
|
460
|
+
- **Content-Type**: application/json
|
|
461
|
+
- **Accept**: application/json
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
## filter_jira_stuff
|
|
465
|
+
|
|
466
|
+
> <FilteredJIRAStuff> filter_jira_stuff(opts)
|
|
467
|
+
|
|
468
|
+
Find various JIRA entities relevant to the specified date interval.
|
|
469
|
+
|
|
470
|
+
### Examples
|
|
471
|
+
|
|
472
|
+
```ruby
|
|
473
|
+
require 'time'
|
|
474
|
+
require 'athenian'
|
|
475
|
+
# setup authorization
|
|
476
|
+
Athenian.configure do |config|
|
|
477
|
+
# Configure API key authorization: apiKeyAuth
|
|
478
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
479
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
480
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
481
|
+
|
|
482
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
483
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
484
|
+
end
|
|
485
|
+
|
|
486
|
+
api_instance = Athenian::FilterApi.new
|
|
487
|
+
opts = {
|
|
488
|
+
body: Athenian::FilterJIRAStuff.new({account: 37, date_from: Date.today, date_to: Date.today, exclude_inactive: false}) # FilterJIRAStuff |
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
begin
|
|
492
|
+
# Find various JIRA entities relevant to the specified date interval.
|
|
493
|
+
result = api_instance.filter_jira_stuff(opts)
|
|
494
|
+
p result
|
|
495
|
+
rescue Athenian::ApiError => e
|
|
496
|
+
puts "Error when calling FilterApi->filter_jira_stuff: #{e}"
|
|
497
|
+
end
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
#### Using the filter_jira_stuff_with_http_info variant
|
|
501
|
+
|
|
502
|
+
This returns an Array which contains the response data, status code and headers.
|
|
503
|
+
|
|
504
|
+
> <Array(<FilteredJIRAStuff>, Integer, Hash)> filter_jira_stuff_with_http_info(opts)
|
|
505
|
+
|
|
506
|
+
```ruby
|
|
507
|
+
begin
|
|
508
|
+
# Find various JIRA entities relevant to the specified date interval.
|
|
509
|
+
data, status_code, headers = api_instance.filter_jira_stuff_with_http_info(opts)
|
|
510
|
+
p status_code # => 2xx
|
|
511
|
+
p headers # => { ... }
|
|
512
|
+
p data # => <FilteredJIRAStuff>
|
|
513
|
+
rescue Athenian::ApiError => e
|
|
514
|
+
puts "Error when calling FilterApi->filter_jira_stuff_with_http_info: #{e}"
|
|
515
|
+
end
|
|
516
|
+
```
|
|
517
|
+
|
|
518
|
+
### Parameters
|
|
519
|
+
|
|
520
|
+
| Name | Type | Description | Notes |
|
|
521
|
+
| ---- | ---- | ----------- | ----- |
|
|
522
|
+
| **body** | [**FilterJIRAStuff**](FilterJIRAStuff.md) | | [optional] |
|
|
523
|
+
|
|
524
|
+
### Return type
|
|
525
|
+
|
|
526
|
+
[**FilteredJIRAStuff**](FilteredJIRAStuff.md)
|
|
527
|
+
|
|
528
|
+
### Authorization
|
|
529
|
+
|
|
530
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
531
|
+
|
|
532
|
+
### HTTP request headers
|
|
533
|
+
|
|
534
|
+
- **Content-Type**: application/json
|
|
535
|
+
- **Accept**: application/json
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
## filter_labels
|
|
539
|
+
|
|
540
|
+
> <Array<FilteredLabel>> filter_labels(opts)
|
|
541
|
+
|
|
542
|
+
Find labels used in the given repositories.
|
|
543
|
+
|
|
544
|
+
### Examples
|
|
545
|
+
|
|
546
|
+
```ruby
|
|
547
|
+
require 'time'
|
|
548
|
+
require 'athenian'
|
|
549
|
+
# setup authorization
|
|
550
|
+
Athenian.configure do |config|
|
|
551
|
+
# Configure API key authorization: apiKeyAuth
|
|
552
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
553
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
554
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
555
|
+
|
|
556
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
557
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
558
|
+
end
|
|
559
|
+
|
|
560
|
+
api_instance = Athenian::FilterApi.new
|
|
561
|
+
opts = {
|
|
562
|
+
body: Athenian::FilterLabelsRequest.new({account: 37}) # FilterLabelsRequest |
|
|
563
|
+
}
|
|
564
|
+
|
|
565
|
+
begin
|
|
566
|
+
# Find labels used in the given repositories.
|
|
567
|
+
result = api_instance.filter_labels(opts)
|
|
568
|
+
p result
|
|
569
|
+
rescue Athenian::ApiError => e
|
|
570
|
+
puts "Error when calling FilterApi->filter_labels: #{e}"
|
|
571
|
+
end
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
#### Using the filter_labels_with_http_info variant
|
|
575
|
+
|
|
576
|
+
This returns an Array which contains the response data, status code and headers.
|
|
577
|
+
|
|
578
|
+
> <Array(<Array<FilteredLabel>>, Integer, Hash)> filter_labels_with_http_info(opts)
|
|
579
|
+
|
|
580
|
+
```ruby
|
|
581
|
+
begin
|
|
582
|
+
# Find labels used in the given repositories.
|
|
583
|
+
data, status_code, headers = api_instance.filter_labels_with_http_info(opts)
|
|
584
|
+
p status_code # => 2xx
|
|
585
|
+
p headers # => { ... }
|
|
586
|
+
p data # => <Array<FilteredLabel>>
|
|
587
|
+
rescue Athenian::ApiError => e
|
|
588
|
+
puts "Error when calling FilterApi->filter_labels_with_http_info: #{e}"
|
|
589
|
+
end
|
|
590
|
+
```
|
|
591
|
+
|
|
592
|
+
### Parameters
|
|
593
|
+
|
|
594
|
+
| Name | Type | Description | Notes |
|
|
595
|
+
| ---- | ---- | ----------- | ----- |
|
|
596
|
+
| **body** | [**FilterLabelsRequest**](FilterLabelsRequest.md) | | [optional] |
|
|
597
|
+
|
|
598
|
+
### Return type
|
|
599
|
+
|
|
600
|
+
[**Array<FilteredLabel>**](FilteredLabel.md)
|
|
601
|
+
|
|
602
|
+
### Authorization
|
|
603
|
+
|
|
604
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
605
|
+
|
|
606
|
+
### HTTP request headers
|
|
607
|
+
|
|
608
|
+
- **Content-Type**: application/json
|
|
609
|
+
- **Accept**: application/json
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
## filter_prs
|
|
613
|
+
|
|
614
|
+
> <PullRequestSet> filter_prs(opts)
|
|
615
|
+
|
|
616
|
+
List pull requests that satisfy the query.
|
|
617
|
+
|
|
618
|
+
### Examples
|
|
619
|
+
|
|
620
|
+
```ruby
|
|
621
|
+
require 'time'
|
|
622
|
+
require 'athenian'
|
|
623
|
+
# setup authorization
|
|
624
|
+
Athenian.configure do |config|
|
|
625
|
+
# Configure API key authorization: apiKeyAuth
|
|
626
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
627
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
628
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
629
|
+
|
|
630
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
631
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
632
|
+
end
|
|
633
|
+
|
|
634
|
+
api_instance = Athenian::FilterApi.new
|
|
635
|
+
opts = {
|
|
636
|
+
filter_pull_requests_request: Athenian::FilterPullRequestsRequest.new({account: 37, date_from: Date.today, date_to: Date.today, _in: ["github.com/athenianco/athenian-webapp", "github.com/athenianco/athenian-api"], exclude_inactive: false}) # FilterPullRequestsRequest |
|
|
637
|
+
}
|
|
638
|
+
|
|
639
|
+
begin
|
|
640
|
+
# List pull requests that satisfy the query.
|
|
641
|
+
result = api_instance.filter_prs(opts)
|
|
642
|
+
p result
|
|
643
|
+
rescue Athenian::ApiError => e
|
|
644
|
+
puts "Error when calling FilterApi->filter_prs: #{e}"
|
|
645
|
+
end
|
|
646
|
+
```
|
|
647
|
+
|
|
648
|
+
#### Using the filter_prs_with_http_info variant
|
|
649
|
+
|
|
650
|
+
This returns an Array which contains the response data, status code and headers.
|
|
651
|
+
|
|
652
|
+
> <Array(<PullRequestSet>, Integer, Hash)> filter_prs_with_http_info(opts)
|
|
653
|
+
|
|
654
|
+
```ruby
|
|
655
|
+
begin
|
|
656
|
+
# List pull requests that satisfy the query.
|
|
657
|
+
data, status_code, headers = api_instance.filter_prs_with_http_info(opts)
|
|
658
|
+
p status_code # => 2xx
|
|
659
|
+
p headers # => { ... }
|
|
660
|
+
p data # => <PullRequestSet>
|
|
661
|
+
rescue Athenian::ApiError => e
|
|
662
|
+
puts "Error when calling FilterApi->filter_prs_with_http_info: #{e}"
|
|
663
|
+
end
|
|
664
|
+
```
|
|
665
|
+
|
|
666
|
+
### Parameters
|
|
667
|
+
|
|
668
|
+
| Name | Type | Description | Notes |
|
|
669
|
+
| ---- | ---- | ----------- | ----- |
|
|
670
|
+
| **filter_pull_requests_request** | [**FilterPullRequestsRequest**](FilterPullRequestsRequest.md) | | [optional] |
|
|
671
|
+
|
|
672
|
+
### Return type
|
|
673
|
+
|
|
674
|
+
[**PullRequestSet**](PullRequestSet.md)
|
|
675
|
+
|
|
676
|
+
### Authorization
|
|
677
|
+
|
|
678
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
679
|
+
|
|
680
|
+
### HTTP request headers
|
|
681
|
+
|
|
682
|
+
- **Content-Type**: application/json
|
|
683
|
+
- **Accept**: application/json
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
## filter_releases
|
|
687
|
+
|
|
688
|
+
> <ReleaseSet> filter_releases(opts)
|
|
689
|
+
|
|
690
|
+
Find releases that were published in the given time fram in the given repositories.
|
|
691
|
+
|
|
692
|
+
### Examples
|
|
693
|
+
|
|
694
|
+
```ruby
|
|
695
|
+
require 'time'
|
|
696
|
+
require 'athenian'
|
|
697
|
+
# setup authorization
|
|
698
|
+
Athenian.configure do |config|
|
|
699
|
+
# Configure API key authorization: apiKeyAuth
|
|
700
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
701
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
702
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
703
|
+
|
|
704
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
705
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
706
|
+
end
|
|
707
|
+
|
|
708
|
+
api_instance = Athenian::FilterApi.new
|
|
709
|
+
opts = {
|
|
710
|
+
body: Athenian::FilterReleasesRequest.new({account: 37, date_from: Date.today, date_to: Date.today}) # FilterReleasesRequest |
|
|
711
|
+
}
|
|
712
|
+
|
|
713
|
+
begin
|
|
714
|
+
# Find releases that were published in the given time fram in the given repositories.
|
|
715
|
+
result = api_instance.filter_releases(opts)
|
|
716
|
+
p result
|
|
717
|
+
rescue Athenian::ApiError => e
|
|
718
|
+
puts "Error when calling FilterApi->filter_releases: #{e}"
|
|
719
|
+
end
|
|
720
|
+
```
|
|
721
|
+
|
|
722
|
+
#### Using the filter_releases_with_http_info variant
|
|
723
|
+
|
|
724
|
+
This returns an Array which contains the response data, status code and headers.
|
|
725
|
+
|
|
726
|
+
> <Array(<ReleaseSet>, Integer, Hash)> filter_releases_with_http_info(opts)
|
|
727
|
+
|
|
728
|
+
```ruby
|
|
729
|
+
begin
|
|
730
|
+
# Find releases that were published in the given time fram in the given repositories.
|
|
731
|
+
data, status_code, headers = api_instance.filter_releases_with_http_info(opts)
|
|
732
|
+
p status_code # => 2xx
|
|
733
|
+
p headers # => { ... }
|
|
734
|
+
p data # => <ReleaseSet>
|
|
735
|
+
rescue Athenian::ApiError => e
|
|
736
|
+
puts "Error when calling FilterApi->filter_releases_with_http_info: #{e}"
|
|
737
|
+
end
|
|
738
|
+
```
|
|
739
|
+
|
|
740
|
+
### Parameters
|
|
741
|
+
|
|
742
|
+
| Name | Type | Description | Notes |
|
|
743
|
+
| ---- | ---- | ----------- | ----- |
|
|
744
|
+
| **body** | [**FilterReleasesRequest**](FilterReleasesRequest.md) | | [optional] |
|
|
745
|
+
|
|
746
|
+
### Return type
|
|
747
|
+
|
|
748
|
+
[**ReleaseSet**](ReleaseSet.md)
|
|
749
|
+
|
|
750
|
+
### Authorization
|
|
751
|
+
|
|
752
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
753
|
+
|
|
754
|
+
### HTTP request headers
|
|
755
|
+
|
|
756
|
+
- **Content-Type**: application/json
|
|
757
|
+
- **Accept**: application/json
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
## filter_repositories
|
|
761
|
+
|
|
762
|
+
> Array<String> filter_repositories(opts)
|
|
763
|
+
|
|
764
|
+
Find repositories that were updated within the given timeframe.
|
|
765
|
+
|
|
766
|
+
### Examples
|
|
767
|
+
|
|
768
|
+
```ruby
|
|
769
|
+
require 'time'
|
|
770
|
+
require 'athenian'
|
|
771
|
+
# setup authorization
|
|
772
|
+
Athenian.configure do |config|
|
|
773
|
+
# Configure API key authorization: apiKeyAuth
|
|
774
|
+
config.api_key['apiKeyAuth'] = 'YOUR API KEY'
|
|
775
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
776
|
+
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
|
|
777
|
+
|
|
778
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
779
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
780
|
+
end
|
|
781
|
+
|
|
782
|
+
api_instance = Athenian::FilterApi.new
|
|
783
|
+
opts = {
|
|
784
|
+
body: Athenian::FilterRepositoriesRequest.new({account: 37, date_from: Date.today, date_to: Date.today}) # FilterRepositoriesRequest |
|
|
785
|
+
}
|
|
786
|
+
|
|
787
|
+
begin
|
|
788
|
+
# Find repositories that were updated within the given timeframe.
|
|
789
|
+
result = api_instance.filter_repositories(opts)
|
|
790
|
+
p result
|
|
791
|
+
rescue Athenian::ApiError => e
|
|
792
|
+
puts "Error when calling FilterApi->filter_repositories: #{e}"
|
|
793
|
+
end
|
|
794
|
+
```
|
|
795
|
+
|
|
796
|
+
#### Using the filter_repositories_with_http_info variant
|
|
797
|
+
|
|
798
|
+
This returns an Array which contains the response data, status code and headers.
|
|
799
|
+
|
|
800
|
+
> <Array(Array<String>, Integer, Hash)> filter_repositories_with_http_info(opts)
|
|
801
|
+
|
|
802
|
+
```ruby
|
|
803
|
+
begin
|
|
804
|
+
# Find repositories that were updated within the given timeframe.
|
|
805
|
+
data, status_code, headers = api_instance.filter_repositories_with_http_info(opts)
|
|
806
|
+
p status_code # => 2xx
|
|
807
|
+
p headers # => { ... }
|
|
808
|
+
p data # => Array<String>
|
|
809
|
+
rescue Athenian::ApiError => e
|
|
810
|
+
puts "Error when calling FilterApi->filter_repositories_with_http_info: #{e}"
|
|
811
|
+
end
|
|
812
|
+
```
|
|
813
|
+
|
|
814
|
+
### Parameters
|
|
815
|
+
|
|
816
|
+
| Name | Type | Description | Notes |
|
|
817
|
+
| ---- | ---- | ----------- | ----- |
|
|
818
|
+
| **body** | [**FilterRepositoriesRequest**](FilterRepositoriesRequest.md) | | [optional] |
|
|
819
|
+
|
|
820
|
+
### Return type
|
|
821
|
+
|
|
822
|
+
**Array<String>**
|
|
823
|
+
|
|
824
|
+
### Authorization
|
|
825
|
+
|
|
826
|
+
[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
|
|
827
|
+
|
|
828
|
+
### HTTP request headers
|
|
829
|
+
|
|
830
|
+
- **Content-Type**: application/json
|
|
831
|
+
- **Accept**: application/json
|
|
832
|
+
|