Skip to content

DataliftHQ/admiral-openapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

admiral-openapi

OpenAPI specifications for the Admiral API. Use these specs to generate HTTP clients, explore endpoints, or integrate with API tooling.

Documentation

View Interactive API Docs

Files

File Version
openapi.v3.yaml OpenAPI 3.1
openapi.swagger.yaml OpenAPI 2.0 (Swagger)

Usage

Raw URLs

https://raw.githubusercontent.com/DataliftHQ/admiral-openapi/master/openapi.v3.yaml
https://raw.githubusercontent.com/DataliftHQ/admiral-openapi/master/openapi.swagger.yaml

Client Generation

Go (oapi-codegen) - uses OpenAPI 2.0:

go install github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@latest
oapi-codegen -package api openapi.swagger.yaml > api/client.go

Go (openapi-generator) - uses OpenAPI 3.1:

openapi-generator-cli generate -i openapi.v3.yaml -g go -o ./client/go

TypeScript:

openapi-generator-cli generate -i openapi.v3.yaml -g typescript-fetch -o ./client/ts

Python:

openapi-generator-cli generate -i openapi.v3.yaml -g python -o ./client/python

Feedback

Found an issue or have a suggestion? Open an issue.

About

OpenAPI specifications for the Admiral API

Topics

Resources

Stars

Watchers

Forks