Clearly Defined
Helping FOSS projects be more successful through clearly defined project data.
Go to siteClearly Defined API Integrations
Build and run workflows using the Clearly Defined API. Use 1000s of source-available triggers and actions across 2,500+ apps. Or write custom code to integrate any app or API in seconds.
Trusted by 1,000,000+ developers from startups to Fortune 500 companies
Overview#
The Clearly Defined API offers a way to interact with the Clearly Defined service, which curates and shares data about the clarity of licenses and security of open source components. You can retrieve detailed information about software components' licenses, scores for clarity, and metadata. On Pipedream, you can harness this API to automate checking the compliance and security of software dependencies, notify pertinent stakeholders about the status of components, and integrate with other tools for a seamless open source governance process.
import { axios } from "@pipedream/platform"
export default defineComponent({
props: {
clearly_defined: {
type: "app",
app: "clearly_defined",
}
},
async run({steps, $}) {
return await axios($, {
url: `https://${this.clearly_defined.$auth.environment}.clearlydefined.io/definitions`,
})
},
})
Choose an API to Connect with Clearly Defined API#
1-24of2,500+apps by most popular
Example Use Cases#
Automate License Compliance Checks: Set up a Pipedream workflow that triggers on a schedule to check the licenses of dependencies used in your project. If it finds dependencies with unclear licenses, it can send alerts to Slack or another communication platform used by your team.
Enrich Continuous Integration/Deployment (CI/CD) Processes: Use Pipedream to integrate the Clearly Defined API into your CI/CD pipeline. Before deployment, trigger a workflow to verify that all open source components are up to the defined standards and block the deployment if necessary.
Maintain a Database of Component Licenses: Create a Pipedream workflow to query the Clearly Defined API periodically for your projects' dependencies. Store the results in a database, such as Google Sheets or Airtable, to maintain a live catalog of licenses and security statuses for auditing or reporting purposes.
Popular Clearly Defined Integrations#
Popular Clearly Defined Actions#
Request the creation of a resource. See the documentation
Gets the coordinates for all definitions that match the given pattern in the specified part of the definition. See the documentation
Get all the harvested data for a component revision. See the documentation
Authentication#
Name Slug: clearly_definedClearly Defined uses API keys for authentication. When you connect your Clearly Defined account, Pipedream securely stores the keys so you can easily authenticate to Clearly Defined APIs in both code and no-code steps.
Trusted by 1,000,000+ developers from startups to Fortune 500 companies