omallassi / apis-catalog Goto Github PK

View Code? Open in Web Editor NEW

3.0 2.0 1.0 626 KB

an HTTP backend and CLI to help governing APIs

Rust 99.46% Shell 0.22% Dockerfile 0.31%

apis catalog api-catalog governance

apis-catalog's People

Contributors

Stargazers

Watchers

Forkers

naheedmk

apis-catalog's Issues

It should be possible to know which service implement which APIs as multiple OpenAPI yaml files may be served by a single Service

Being able to filter out some PR

PR usually follows naming convention (e.g. bugfix/ or fix etc...)
it may be possible to filter out some PR

as an example, we take all PRs except the one starting with "SigEvents –"

being able to manage domains, map apis to domains

support multiple git repos

yaml files could be in multiple repos (git for now)

Ability to delete a domain (given its Id)

Get Audience from Specification

Given Audience defined in OpenAPI Spec File, it should be returned by REST APIs and displayed in CLI.

[SERVER] A Domain has a owner

Docker-ize it

move to diesel.rs to access dB and access embedded sqlite (as of today)

keep sqlite access (embedded)

An API belongs to a layer

at least

API Gateway
App Layer
Bizz Layer

CLI should provide CRUD operations on this.

Ability to create layers is out of scope for now (could be based on a config file, server side)

[CLI] Ability to delete a domain per id

Compare domains from the catalog and domains from the yaml

Provide a REST endpoint to purge /metrics

Domain Catalog can have multiple imp

Domain Catalog can be DB based or yaml based

add support of "API reviews"

cf. omallassi/apis-catalog-web#20

Should support multiple repos

in configuration

[stash_config]
base_uri = "https://my_stash/rest/api/1.0/projects/my_proj/repos/my_repo"

should support list of URIs

Monitor # of zally ignore

we use zally but zally-ignore can be set in the yaml. could be interested in monitoring the # and its evolution.

An API is made of multiple specifications

CLI should enable CRUD actions on this part.

Provide API to get # of endpoints per domains / subdomains

based on server OpenAPI attributes

As part of Metrics & Stats , returns the top 3 oldest PR

add configuration ....

cf to use https://github.com/mehcode/config-rs r confy

Support mysql DB (via diesel.rs)

Provide endpoints to return endpoints # per x-audience

[CLI] A Domain has a owner

Information section for API can be filled in

Contact information for the API should be available.