Home

Welcome to the registry wiki! This is home for documentation of new features, work-in-progress, and discussion of general project goals.

Discussion

• Analyzing APIs at Scale: Why do we need an API registry?
• Analyzing APIs in Public API Collections: Where can we find collections of API descriptions?
• Why did we make an API for registering APIs?
• API Registry Applications: What can we do with an API registry?
• Design Foundations of the Registry: AIPs, Protocol Buffers, and gRPC

Project Organization

• Project Repos: The Registry project is organized across several open-source repositories.
• Project Protos: The Registry API and applications use data structures and methods that are described with the Protocol Buffers language.
• registry (the Registry Tool) is an opinionated command-line tool for working with an API registry.

Registry Architecture

• Schema for an API Registry: What types and relationships are represented in an API Registry?

Wiki Structure

Pages in this wiki are generally unstructured, but there are two types of information that we present in a regular form.

• The registry tool and its subcommands are described on pages with names matching the subcommands.
• Schemas for registry contents are described on pages with names beginning with "Schema", e.g. Schema for an API Registry.