OAPI: rename pkg/api/flamenco-manager.yaml
to flamenco-openapi.yaml
Rename `pkg/api/flamenco-manager.yaml` to `flamenco-openapi.yaml`, to distinguish the OpenAPI definition file from the Flamenco Manager configuration file of the same name (but in a different directory). No functional changes.
This commit is contained in:
parent
0242f2d217
commit
744fabea78
4
Makefile
4
Makefile
@ -61,7 +61,7 @@ generate-py:
|
|||||||
# See https://openapi-generator.tech/docs/generators/python for the options.
|
# See https://openapi-generator.tech/docs/generators/python for the options.
|
||||||
java -jar addon/openapi-generator-cli.jar \
|
java -jar addon/openapi-generator-cli.jar \
|
||||||
generate \
|
generate \
|
||||||
-i pkg/api/flamenco-manager.yaml \
|
-i pkg/api/flamenco-openapi.yaml \
|
||||||
-g python \
|
-g python \
|
||||||
-o addon/ \
|
-o addon/ \
|
||||||
--package-name "${PY_API_PKG_NAME}" \
|
--package-name "${PY_API_PKG_NAME}" \
|
||||||
@ -88,7 +88,7 @@ generate-js:
|
|||||||
# things don't work properly.
|
# things don't work properly.
|
||||||
java -jar addon/openapi-generator-cli.jar \
|
java -jar addon/openapi-generator-cli.jar \
|
||||||
generate \
|
generate \
|
||||||
-i pkg/api/flamenco-manager.yaml \
|
-i pkg/api/flamenco-openapi.yaml \
|
||||||
-g javascript \
|
-g javascript \
|
||||||
-o web/_tmp-manager-api-javascript \
|
-o web/_tmp-manager-api-javascript \
|
||||||
--http-user-agent "Flamenco/${OAPI_VERSION} / webbrowser" \
|
--http-user-agent "Flamenco/${OAPI_VERSION} / webbrowser" \
|
||||||
|
@ -58,10 +58,10 @@ more.
|
|||||||
## Generating the OpenAPI/Swagger API
|
## Generating the OpenAPI/Swagger API
|
||||||
|
|
||||||
Some code is generated from the OpenAPI specs in
|
Some code is generated from the OpenAPI specs in
|
||||||
`pkg/api/flamenco-manager.yaml`. The generated code is committed to Git, so that
|
`pkg/api/flamenco-openapi.yaml`. The generated code is committed to Git, so that
|
||||||
after a checkout you shouldn't need to re-run the generator to build Flamenco.
|
after a checkout you shouldn't need to re-run the generator to build Flamenco.
|
||||||
|
|
||||||
After changing `pkg/api/flamenco-manager.yaml`, run `make generate` to generate
|
After changing `pkg/api/flamenco-openapi.yaml`, run `make generate` to generate
|
||||||
the code, then commit to Git.
|
the code, then commit to Git.
|
||||||
|
|
||||||
The JavaScript and Python generator is made in Java, so it requires a JRE/JDK to
|
The JavaScript and Python generator is made in Java, so it requires a JRE/JDK to
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Package api_impl implements the OpenAPI API from pkg/api/flamenco-manager.yaml.
|
// Package api_impl implements the OpenAPI API from pkg/api/flamenco-openapi.yaml.
|
||||||
package api_impl
|
package api_impl
|
||||||
|
|
||||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Package api_impl implements the OpenAPI API from pkg/api/flamenco-manager.yaml.
|
// Package api_impl implements the OpenAPI API from pkg/api/flamenco-openapi.yaml.
|
||||||
package api_impl
|
package api_impl
|
||||||
|
|
||||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Package api_impl implements the OpenAPI API from pkg/api/flamenco-manager.yaml.
|
// Package api_impl implements the OpenAPI API from pkg/api/flamenco-openapi.yaml.
|
||||||
package api_impl
|
package api_impl
|
||||||
|
|
||||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Package api_impl implements the OpenAPI API from pkg/api/flamenco-manager.yaml.
|
// Package api_impl implements the OpenAPI API from pkg/api/flamenco-openapi.yaml.
|
||||||
package api_impl
|
package api_impl
|
||||||
|
|
||||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
package api
|
package api
|
||||||
|
|
||||||
//go:generate oapi-codegen -generate types,skip-prune -o openapi_types.gen.go -package api flamenco-manager.yaml
|
//go:generate oapi-codegen -generate types,skip-prune -o openapi_types.gen.go -package api flamenco-openapi.yaml
|
||||||
//go:generate oapi-codegen -generate server,skip-prune -o openapi_server.gen.go -package api flamenco-manager.yaml
|
//go:generate oapi-codegen -generate server,skip-prune -o openapi_server.gen.go -package api flamenco-openapi.yaml
|
||||||
//go:generate oapi-codegen -generate spec,skip-prune -o openapi_spec.gen.go -package api flamenco-manager.yaml
|
//go:generate oapi-codegen -generate spec,skip-prune -o openapi_spec.gen.go -package api flamenco-openapi.yaml
|
||||||
//go:generate oapi-codegen -generate client,skip-prune -o openapi_client.gen.go -package api flamenco-manager.yaml
|
//go:generate oapi-codegen -generate client,skip-prune -o openapi_client.gen.go -package api flamenco-openapi.yaml
|
||||||
|
@ -42,7 +42,7 @@ export default {
|
|||||||
|
|
||||||
const vueComponent = this;
|
const vueComponent = this;
|
||||||
const options = {
|
const options = {
|
||||||
// See pkg/api/flamenco-manager.yaml, schemas Job and SocketIOJobUpdate.
|
// See pkg/api/flamenco-openapi.yaml, schemas Job and SocketIOJobUpdate.
|
||||||
columns: [
|
columns: [
|
||||||
// Useful for debugging when there are many similar jobs:
|
// Useful for debugging when there are many similar jobs:
|
||||||
// { title: "ID", field: "id", headerSort: false, formatter: (cell) => cell.getData().id.substr(0, 8), },
|
// { title: "ID", field: "id", headerSort: false, formatter: (cell) => cell.getData().id.substr(0, 8), },
|
||||||
|
@ -45,7 +45,7 @@ export default {
|
|||||||
|
|
||||||
const vueComponent = this;
|
const vueComponent = this;
|
||||||
const options = {
|
const options = {
|
||||||
// See pkg/api/flamenco-manager.yaml, schemas Task and TaskUpdate.
|
// See pkg/api/flamenco-openapi.yaml, schemas Task and TaskUpdate.
|
||||||
columns: [
|
columns: [
|
||||||
// Useful for debugging when there are many similar tasks:
|
// Useful for debugging when there are many similar tasks:
|
||||||
// { title: "ID", field: "id", headerSort: false, formatter: (cell) => cell.getData().id.substr(0, 8), },
|
// { title: "ID", field: "id", headerSort: false, formatter: (cell) => cell.getData().id.substr(0, 8), },
|
||||||
|
Loading…
x
Reference in New Issue
Block a user