README
¶
FOASCLI
FOASCLI is a Go-based CLI tool that provides commands for generating the Federated OpenAPI specification and the API changelog.
Build From Source
Fetch Source
git clone https://github.com/mongodb/openapi.git
cd openapi/tools/cli
Build
To build foascli, run:
make build
The resulting foascli binary is placed in ./bin.
Usage
To get a list of available commands, run foascli help.
Setup Environment
To set up the development environment, run:
make setup
Run tests
To run unit and e2e tests, run:
make lint && unit-test && e2e-test
Contributing
See our CONTRIBUTING.md guide.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
openapi
Package openapi is a generated GoMock package.
|
Package openapi is a generated GoMock package. |
|
openapi/filter
Package filter is a generated GoMock package.
|
Package filter is a generated GoMock package. |
|
pkg
|
|
|
apiversion
Package apiversion exposes API version parsing utilities for use outside the cli module.
|
Package apiversion exposes API version parsing utilities for use outside the cli module. |
|
openapi
Package openapi provides public interfaces for loading and saving OpenAPI specifications.
|
Package openapi provides public interfaces for loading and saving OpenAPI specifications. |
|
test
|
|
Click to show internal directories.
Click to hide internal directories.