api

README

deps.cloud API and SDK definitions

• API - application programming interface
• SDK - software development kit

This repository contains all API definitions and associated language SDKs available for the deps.cloud ecosystem. APIs are defined using Google's Protocol Buffers. Using gRPC, we're able to code generate client libraries. This repository currently produces 3 libraries:

Tech	Source	Package
npm	nodejs source	@depscloud/api
pip	python source	depscloud_api (coming soon!)
go mod		github.com/depscloud/api

Getting Started with Go

To install:

go get -u github.com/depscloud/api

Usage:

package main

import (
    "crypto/tls"

    "github.com/depscloud/api/v1alpha/extractor"
    "github.com/depscloud/api/v1alpha/tracker"

    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials"
)

func main() {
    target := "api.deps.cloud:443"
    creds := credentials.NewTLS(&tls.Config{})

    conn, _ := grpc.Dial(target, grpc.WithTransportCredentials(creds))
    defer conn.Close()

    sourceService := tracker.NewSourceServiceClient(conn)
    moduleService := tracker.NewModuleServiceClient(conn)
    dependencyService := tracker.NewDependencyServiceClient(conn)
}

Support

Join our mailing list to get access to virtual events and ask any questions there.

We also have a Slack channel.

Release Checks

License Checks

Documentation

Index

• Variables

Variables

var (
	// ErrModuleNotFound occurs when a module cannot be found in the graph
	ErrModuleNotFound = status.Error(codes.NotFound, "failed to locate module")
	// ErrPartialDeletion occurs when a partial deletion occurs during Put
	ErrPartialDeletion = status.Error(codes.Internal, "failed to delete removed edges")
	// ErrPartialInsertion occurs when a partial insertion occurs during Put
	ErrPartialInsertion = status.Error(codes.Internal, "failed to insert new edges")
	// ErrUnimplemented occurs when a method has not yet been implemented
	ErrUnimplemented = status.Error(codes.Unimplemented, "unimplemented")
	// ErrUnsupported occurs when calling a rw method on a read only service
	ErrUnsupported = status.Error(codes.NotFound, "read only")
)