Ion Channel Mulch API

Base URL: /v1, Version: 0.0.3

Get some really good info on software

Default response content-types: application/json
Schemes: https

Summary

Tag: Repositories

Operation Description
GET /repository/getRepository

Return code respositories

Tag: Dependencies

Operation Description
GET /dependency/getDependencies

Return dependencies of given package and type.

GET /dependency/getVersionsForDependency

Return known versions for dependency.

GET /dependency/getLatestVersionForDependency

Return latest version of given package and type.

POST /dependency/resolveDependenciesInFile

Resolve dependencies in a uploaded file.

Tag: Mail

Operation Description
GET /mail/getMessageCounts

Return basic statistics for message counts per project

GET /mail/getMessage

Return mail messages based on search parameters

Tag: Community

Operation Description
GET /community/getMetadata

Return metadata of a project

GET /community/getTeamContributions

Return data about the project development team.

GET /community/getLeadActivity

Return data about the communications activity of the project lead.

GET /community/getProjectActivity

Return basic statistics for project activity

Paths

Return data about the communications activity of the project lead.

GET /community/getLeadActivity

Tags: Community

Return data about the communications activity of the project lead.

project

The unique name of the project to search with

query string

Uses default content-types: application/json

200 OK

An object containing a summary of the project lead activity

400 Bad Request

Invalid parameters provided

404 Not Found

No project found

default

Unexpected error

Return metadata of a project

GET /community/getMetadata

Tags: Community

Return metadata of a project. With parameters get counts for all messages

project

The unique name of the project to search with

query string

Uses default content-types: application/json

200 OK

An object containing the list of message counts

400 Bad Request

Invalid parameters provided

404 Not Found

No project found

default

Unexpected error

Return basic statistics for project activity

GET /community/getProjectActivity

Tags: Community

Return basic statistics for PushEvents per project.

project

The unique name of the project to search with

query string
provider

Optional provider where project is hosted

query string

Uses default content-types: application/json

200 OK

An object containing project activity for differents time spans

400 Bad Request

Invalid parameters provided

404 Not Found

No project found

default

Unexpected error

Return data about the project development team.

GET /community/getTeamContributions

Tags: Community

Return data about the project development team.

project

The unique name of the project to search with

query string

Uses default content-types: application/json

200 OK

An object containing the list of team members and their activity

400 Bad Request

Invalid parameters provided

404 Not Found

No project found

default

Unexpected error

Return dependencies of given package and type.

GET /dependency/getDependencies

Tags: Dependencies

Return dependencies of given package and type.

name

The name of the dependency

query string
type

The type of dependency

query string , x ∈ { rubygems , npm , mvn , pypi }

Uses default content-types: application/json

200 OK

An object containing the list of dependencies

400 Bad Request

Invalid parameters provided

404 Not Found

No project found

default

Unexpected error

Return latest version of given package and type.

GET /dependency/getLatestVersionForDependency

Tags: Dependencies

Return latest version of given package and type.

name

The name of the dependency

query string
type

The type of dependency

query string , x ∈ { rubygems , npm , mvn , pypi }

Uses default content-types: application/json

200 OK

An object containing the single dependency version

400 Bad Request

Invalid parameters provided

404 Not Found

No package found

default

Unexpected error

Return known versions for dependency.

GET /dependency/getVersionsForDependency

Tags: Dependencies

Return known versions for dependency.

name

The name of the dependency

query string
type

The type of dependency

query string , x ∈ { rubygems , npm , mvn , pypi }

Uses default content-types: application/json

200 OK

An object containing the list of versions

400 Bad Request

Invalid parameters provided

404 Not Found

No project found

default

Unexpected error

Resolve dependencies in a uploaded file.

POST /dependency/resolveDependenciesInFile

Tags: Dependencies

Resolve dependencies in a uploaded file.

multipart/form-data

file

The file uploaded

formData file

Uses default content-types: application/json

200 OK

An object containing the list of dependencies

404 Not Found

Incorrect file format

default

Unexpected error

Return mail messages based on search parameters

GET /mail/getMessage

Tags: Mail

Return mail messages based on search paramateres

project

The project name

query string
email_to

The email to address. Can also contain full names

query string
body

The body of the email

query string
subject

The subject of the email

query string
email_from

The email from address. Call also contain full names

query string

Uses default content-types: application/json

200 OK

An object containing the mail message

400 Bad Request

Invalid parameters provided

404 Not Found

No project found

default

Unexpected error

Return basic statistics for message counts per project

GET /mail/getMessageCounts

Tags: Mail

Return basic statistics for message counts per project. With parameters get counts for all messages

project

The unique name of the project to search with

query string

Uses default content-types: application/json

200 OK

An object containing the list of message counts

400 Bad Request

Invalid parameters provided

404 Not Found

No project found

default

Unexpected error

Return code respositories

GET /repository/getRepository

Tags: Repositories

Return code respositories based on query parameters

name

The name of the repository

query string
type

Repository type (github, bitbucket, ...)

query string

Uses default content-types: application/json

200 OK

An object containing a respository

400 Bad Request

Invalid parameters provided

404 Not Found

No project found

default

Unexpected error

Schema definitions

Dependency: string[]

string

DependencyLatestVersion: object

timestamps: Timestamps
links: Links
meta: Meta
version: string

latest version for specified dependency

DependencyMetadata: object

data: DependencyMetadataResult
timestamps: Timestamps
links: Links
meta: Meta

DependencyMetadataResult: object

name: string

Name of the dependency

version: string

Version of the dependency

type: string

Type of dependency

platform: string

Dependency platform

checksum: string

Checksum of dependency

created_at: string

Date and time the dependency was added to the database

dependencies: object[]

DependencyVersionList: object

data: string[]
string
timestamps: Timestamps
links: Links
meta: Meta

Error: object

code: integer (int32)
message: string
fields: string

LeadActivity: object

username: string

Username of project lead

commits: integer (int32)

Number of issue related events by the lead committer.

Mail: object

data: object[]
timestamps: Timestamps
links: Links
meta: Meta

MailResult: object

mbox_name: string

The name of mailbox the mail was collected from

body: string

The mail body

date_time: string

The time of the mail

subject: string

The subject of the mail

email_to: string

The email 'to' field

mbox_index: integer

The message index in the mbox

email_from: string

The email 'from' field

MessageCounts: object

data: MessageCountsResult
timestamps: Timestamps
links: Links
meta: Meta

MessageCountsResult: object

last_day: integer

Message counts from previous day starting ranging from 00:00:00 to 23:59:59 (UTC)

last_week: integer

Message counts from previous week starting Sunday 00:00:00 to Sunday 23:59:59 (UTC)

last_month: integer

Message counts from previous month starting the first day of month at 00:00:00 to last day of the month at 23:59:59 (UTC)

last_6_months: integer

Message counts counting back 6 months from current day

Meta: object

copyright: string

Copyright info

authors: string

Authors

version: string

API version

last_update: string

Last update of source data (optional)

ProjectActivity: object

data: ProjectActivityResult
timestamps: Timestamps
links: Links
meta: Meta

ProjectActivityResult: object

last_day: integer

Message counts from previous day starting ranging from 00:00:00 to 23:59:59 (UTC)

last_week: integer

Message counts from previous week starting Sunday 00:00:00 to Sunday 23:59:59 (UTC)

last_month: integer

Message counts from previous month starting the first day of month at 00:00:00 to last day of the month at 23:59:59 (UTC)

last_6_months: integer

Message counts counting back 6 months from current day

ProjectMetadata: object

project: string

Unique name of the project

bug_database: string

Location of bug tracker

category: string

Software category

created: string

Software creation date

description: string

Long description of the project

download_page: string

Location to download software releases

homepage: string

Project home page

license: string

Software license for the project

mailing_list: string

Location to find various mailing lists of project

mail_lists: string[]

Unique names for the mailing lists associated with the project

string
programming_language: string

Programming language of project

pmc: string

Apache committee

repository: string

Repository of software. Chooses first from a list

shortdesc: string

Short description of project

timestamps: Timestamps
links: Links
meta: Meta

ProjectTeamContributions: object

data: object[]

Contributions to the project broken down by member

timestamps: Timestamps
links: Links
meta: Meta

RepositoryMetadata: object

data: RepositoryMetadataResult
timestamps: Timestamps
links: Links
meta: Meta

RepositoryMetadataResult: object

id: string

Id of respository

name: string

Name of respoistory

full_name: string

Owner or organiation and the repository name

owner_login: string

Login name of owner of the repository

owner_id: string

Id of owner of the repository

owner_type: string

Owner type

owner_site_admin: boolean

Is the owner a site admin?

description: string

Description of the repository

fork: boolean

Is the repository a fork?

homepage: string

Homepage of the repository

language: string

List of languages of the repository

forks_count: integer

Number of forks for the repository

stargazers_count: integer

Number of stargazers of the repository

watchers_count: integer

Number of watchers for the repository

size: integer

Size of the repository

default_branch: string

The default branch of the repository

open_issues_count: integer

Number of open issues for the respository

has_issues: boolean

Does the repository have issues?

has_wiki: boolean

Does the repository have a wiki?

has_pages: boolean

Does the respository have pages (website) hosted with github?

has_downloads: boolean

Does the repository have downloads?

pushed_at: string

Date and time of the last push to the repository

created_at: string

Date and time when the repository was created

updated_at: string

Date and time when the repository was updated

api_created_at: string

Date and time the entry for mulch api was created

api_updated_at: string

Date and time the entry for mulch api was updated

TeamContribution: object

username: string

Username of person

commits: integer (int32)

Number of commits in the last 12 months by this user

Timestamps: object

created: string

Time the object was created

updated: string

Time the object was last updated