Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
fdfddb7
describe the generic api operations as the controller answers them
mathieuancelin Oct 15, 2026
ad2728c
describe the errors, patches and bulk outcomes of the generic api
mathieuancelin Oct 15, 2026
1d50e32
read the hand written schemas and operations of the admin api
mathieuancelin Oct 15, 2026
f29219d
list the hand written files of the openapi document
mathieuancelin Oct 15, 2026
f65e13c
describe the location, tls and proxy settings shared by the entities
mathieuancelin Oct 15, 2026
df09aa9
build the openapi document from the hand written schemas and operations
mathieuancelin Oct 15, 2026
0a4d18f
remove additionalPaths.json, its operations moved to conf/schemas/ope…
mathieuancelin Oct 15, 2026
437f0cb
remove additionalComponents.json, its schemas moved to conf/schemas/o…
mathieuancelin Oct 15, 2026
ec10e50
describe the routes, backends and tcp services in the openapi document
mathieuancelin Oct 15, 2026
30be02f
describe the apis and their subscriptions in the openapi document
mathieuancelin Oct 15, 2026
2c907db
describe the auth modules, jwt verifiers and admins in the openapi do…
mathieuancelin Oct 15, 2026
0dc3aaf
describe the global configuration in the openapi document
mathieuancelin Oct 15, 2026
e0aba46
describe the api keys in the openapi document
mathieuancelin Oct 15, 2026
e1955a8
describe the certificates in the openapi document
mathieuancelin Oct 15, 2026
927ccdd
describe the organizations, teams and service groups in the openapi d…
mathieuancelin Oct 15, 2026
c5bc101
describe the data exporters in the openapi document
mathieuancelin Oct 15, 2026
4a87077
describe the user dashboards and alerts in the openapi document
mathieuancelin Oct 15, 2026
18a7bd0
describe the workflows in the openapi document
mathieuancelin Oct 15, 2026
379a208
describe the remote catalogs in the openapi document
mathieuancelin Oct 15, 2026
80c2f0e
describe the green scores in the openapi document
mathieuancelin Oct 15, 2026
af9fba0
describe the http listeners in the openapi document
mathieuancelin Oct 15, 2026
3cdff63
describe the coraza waf configurations in the openapi document
mathieuancelin Oct 15, 2026
a3a903a
describe the schemas of the pki operations of the admin api
mathieuancelin Oct 15, 2026
25247d9
document the pki operations of the admin api
mathieuancelin Oct 15, 2026
45dfb94
describe the schemas of the cluster operations of the admin api
mathieuancelin Oct 15, 2026
9c6c720
document the cluster operations of the admin api
mathieuancelin Oct 15, 2026
89c5e97
describe the schemas of the tunnel operations of the admin api
mathieuancelin Oct 15, 2026
f9f9198
document the tunnel operations of the admin api
mathieuancelin Oct 15, 2026
26652ee
describe the schemas of the snow monkey operations of the admin api
mathieuancelin Oct 15, 2026
8ef0391
document the snow monkey operations of the admin api
mathieuancelin Oct 15, 2026
519c618
describe the schemas of the export and import operations of the admin…
mathieuancelin Oct 15, 2026
778d2c9
document the export and import operations of the admin api
mathieuancelin Oct 15, 2026
482de2f
describe the schemas of the version and node informations operations …
mathieuancelin Oct 15, 2026
f4eca6d
document the version and node informations operations of the admin api
mathieuancelin Oct 15, 2026
a2ce830
describe the schemas of the events and stats operations of the admin api
mathieuancelin Oct 15, 2026
1035fe9
document the events and stats operations of the admin api
mathieuancelin Oct 15, 2026
c45f87b
describe the schemas of the user analytics operations of the admin api
mathieuancelin Oct 15, 2026
f12fdda
document the user analytics operations of the admin api
mathieuancelin Oct 15, 2026
58f430b
describe the schemas of the plugins and forms operations of the admin…
mathieuancelin Oct 15, 2026
e0449e5
document the plugins and forms operations of the admin api
mathieuancelin Oct 15, 2026
8076834
describe the schemas of the documentation operations of the admin api
mathieuancelin Oct 15, 2026
0cfb82b
document the documentation operations of the admin api
mathieuancelin Oct 15, 2026
c6cf2ec
describe the schemas of the entity graph operations of the admin api
mathieuancelin Oct 15, 2026
f664634
document the entity graph operations of the admin api
mathieuancelin Oct 15, 2026
8f7296b
describe the schemas of the private apps sessions operations of the a…
mathieuancelin Oct 15, 2026
39d85bf
document the private apps sessions operations of the admin api
mathieuancelin Oct 15, 2026
d87b9da
describe the schemas of the api management operations of the admin api
mathieuancelin Oct 15, 2026
67f975a
document the api management operations of the admin api
mathieuancelin Oct 15, 2026
b36fd2a
describe the schemas of the route and draft operations of the admin api
mathieuancelin Oct 15, 2026
95885d8
document the route and draft operations of the admin api
mathieuancelin Oct 15, 2026
53369bb
describe the schemas shared by several operations of the admin api
mathieuancelin Oct 15, 2026
b053270
check the openapi document against a running otoroshi
mathieuancelin Oct 15, 2026
9c77fbb
draft the openapi schema of a new entity
mathieuancelin Oct 15, 2026
d1296a0
leave out of the openapi document a hand written file that cannot be …
mathieuancelin Oct 16, 2026
4940934
check the outage strategy of the snow monkey config now described inline
mathieuancelin Oct 16, 2026
2741201
describe the let's encrypt dedup report of the certificate operations
mathieuancelin Oct 16, 2026
84c8b82
document the renewal, bundle import and let's encrypt dedup of the ce…
mathieuancelin Oct 16, 2026
55e01ff
document the quotas operations of an api key
mathieuancelin Oct 16, 2026
5f500e8
describe the definitions and entities of the resources builder
mathieuancelin Oct 16, 2026
40ee0bc
document the resources builder of the admin api
mathieuancelin Oct 16, 2026
a1c158a
document the discard of every session of an auth module
mathieuancelin Oct 16, 2026
a575560
list the certificates, api keys and resources operations in the opena…
mathieuancelin Oct 16, 2026
2ad269e
require the useful legacy routes in the openapi coverage
mathieuancelin Oct 16, 2026
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
9 changes: 5 additions & 4 deletions otoroshi/app/api/api.scala
Original file line number Diff line number Diff line change
Expand Up @@ -1202,10 +1202,12 @@ class OtoroshiResources(env: Env) {
)
)

lazy val resources = nativeResources ++ env.adminExtensions.resources()
// every resource carries its hand written schema when it has one (conf/schemas/openapi), read once
lazy val resources = (nativeResources ++ env.adminExtensions.resources()).map(r => OpenApiSchemas.carriedBy(env, r))

// the resources of otoroshi and of the admin extensions shipped with it, leaving out the third party extensions
lazy val coreResources = nativeResources ++ env.adminExtensions.coreResources()
lazy val coreResources =
(nativeResources ++ env.adminExtensions.coreResources()).map(r => OpenApiSchemas.carriedBy(env, r))

}

Expand Down Expand Up @@ -2443,8 +2445,7 @@ class GenericApiController(ApiAction: ApiAction, DocAction: DocAction, cc: Contr
// GET /apis/:group/:version/:entity/:id/_template
def schema(group: String, version: String, entity: String) = ApiAction.async { ctx =>
withResource(group, version, entity, ctx) { resource =>
val schema = resource.version.finalSchema(resource.kind, resource.access.clazz)
Ok(schema).vfuture
Ok(resource.version.finalSchema(resource.kind, resource.access.clazz)).vfuture
}
}

Expand Down
Loading
Loading