Skip to content

OpenAPI Specification for proposed Swift Package Registry web service

Notifications You must be signed in to change notification settings

mattt/swift-package-registry-oas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Swift Package Registry - OpenAPI Specification

This project generates an OpenAPI (v3) Specification describing the endpoints of the proposed Swift package registry interface It uses OpenAPIKit to construct and verify the specification in Swift.

Rendered documentation from the latest build of the specification can be found here.

Requirements

  • Swift 5.3+
  • Node v14+
  • npm

Usage

Build and run the generate executable to print the specification to stdout.

$ swift run generate

Run the following command to generate a static HTML reference in the dist directory:

$ make

About

OpenAPI Specification for proposed Swift Package Registry web service

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published