Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: rm swagger (openapiv2) self hosted api docs in favor of public api docs #1241

Merged
merged 4 commits into from
Dec 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

<div align="center">
<h4>
<a href="https://flipt.io/docs/getting_started/">Documentation</a> |
<a href="https://www.flipt.io/docs/introduction">Documentation</a> |
<a href="#features">Features</a> |
<a href="#values">Values</a> |
<a href="#integration">Integration</a> |
Expand Down Expand Up @@ -144,12 +144,13 @@ Checkout the [integration docs](https://flipt.io/docs/integration/) for more inf

Flipt is equipped with a fully functional REST API. In fact, the Flipt UI is completely backed by this same API. This means that anything that can be done in the Flipt UI can also be done via the REST API.

The [Flipt REST API](https://flipt.io/docs/api/) can also be used with any language that can make HTTP requests.
The [Flipt REST API](https://www.flipt.io/docs/reference/overview) can also be used with any language that can make HTTP requests.

### Official REST Client Libraries

- [Node/TypeScript](https://github.com/flipt-io/flipt-node)
- [Java](https://github.com/flipt-io/flipt-java)
- [Rust](https://github.com/flipt-io/flipt-rust)

:exclamation: Offical REST clients in more languages coming soon.

Expand Down Expand Up @@ -204,13 +205,9 @@ The server code is licensed under the [GPL 3.0 License](https://spdx.org/license

See [LICENSE](LICENSE).

## Sponsors

If you use Flipt at your company, please consider [becoming a sponsor](https://github.com/sponsors/markphelps) today.

## Community

For help and discussion around Flipt, feature flag best practices, and more, join us on [Discord](https://discord.gg/kRhEqG2TEZ).
For help and discussion around Flipt, feature flag best practices, and more, join us on [Discord](https://www.flipt.io/discord).

## Feedback

Expand Down
5 changes: 0 additions & 5 deletions buf.gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,3 @@ plugins:
- paths=source_relative
- grpc_api_configuration=rpc/flipt/flipt.yaml
strategy: all
- name: openapiv2
out: swagger
opt:
- grpc_api_configuration=rpc/flipt/flipt.yaml
strategy: all
1 change: 0 additions & 1 deletion codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ ignore:
- "rpc/flipt/flipt.pb.*"
- "examples"
- "ui"
- "swagger"
- "_tools"
4 changes: 0 additions & 4 deletions internal/cmd/http.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import (
"go.flipt.io/flipt/internal/gateway"
"go.flipt.io/flipt/internal/info"
"go.flipt.io/flipt/rpc/flipt"
"go.flipt.io/flipt/swagger"
"go.flipt.io/flipt/ui"
"go.uber.org/zap"
"google.golang.org/grpc"
Expand Down Expand Up @@ -109,9 +108,6 @@ func NewHTTPServer(
})

if cfg.UI.Enabled {
s := http.FS(swagger.Docs)
r.Mount("/docs", http.StripPrefix("/docs/", http.FileServer(s)))

u, err := fs.Sub(ui.UI, "dist")
if err != nil {
return nil, fmt.Errorf("mounting UI: %w", err)
Expand Down
Loading