From 744fabea78f3e034c32a9dc2a893def430cb509d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Thu, 19 May 2022 15:22:37 +0200 Subject: [PATCH] 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. --- Makefile | 4 ++-- README.md | 4 ++-- internal/manager/api_impl/api_impl.go | 2 +- internal/manager/api_impl/meta.go | 2 +- internal/manager/api_impl/openapi_auth.go | 2 +- internal/manager/api_impl/openapi_auth_test.go | 2 +- pkg/api/{flamenco-manager.yaml => flamenco-openapi.yaml} | 0 pkg/api/generate.go | 8 ++++---- web/app/src/components/JobsTable.vue | 2 +- web/app/src/components/TasksTable.vue | 2 +- 10 files changed, 14 insertions(+), 14 deletions(-) rename pkg/api/{flamenco-manager.yaml => flamenco-openapi.yaml} (100%) diff --git a/Makefile b/Makefile index f69fcdf8..0f3ead56 100644 --- a/Makefile +++ b/Makefile @@ -61,7 +61,7 @@ generate-py: # See https://openapi-generator.tech/docs/generators/python for the options. java -jar addon/openapi-generator-cli.jar \ generate \ - -i pkg/api/flamenco-manager.yaml \ + -i pkg/api/flamenco-openapi.yaml \ -g python \ -o addon/ \ --package-name "${PY_API_PKG_NAME}" \ @@ -88,7 +88,7 @@ generate-js: # things don't work properly. java -jar addon/openapi-generator-cli.jar \ generate \ - -i pkg/api/flamenco-manager.yaml \ + -i pkg/api/flamenco-openapi.yaml \ -g javascript \ -o web/_tmp-manager-api-javascript \ --http-user-agent "Flamenco/${OAPI_VERSION} / webbrowser" \ diff --git a/README.md b/README.md index 865662e9..3951e358 100644 --- a/README.md +++ b/README.md @@ -58,10 +58,10 @@ more. ## Generating the OpenAPI/Swagger API 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 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 JavaScript and Python generator is made in Java, so it requires a JRE/JDK to diff --git a/internal/manager/api_impl/api_impl.go b/internal/manager/api_impl/api_impl.go index 858d4219..37646b9e 100644 --- a/internal/manager/api_impl/api_impl.go +++ b/internal/manager/api_impl/api_impl.go @@ -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 // SPDX-License-Identifier: GPL-3.0-or-later diff --git a/internal/manager/api_impl/meta.go b/internal/manager/api_impl/meta.go index e84650bd..54d32928 100644 --- a/internal/manager/api_impl/meta.go +++ b/internal/manager/api_impl/meta.go @@ -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 // SPDX-License-Identifier: GPL-3.0-or-later diff --git a/internal/manager/api_impl/openapi_auth.go b/internal/manager/api_impl/openapi_auth.go index 94c0aa0c..ec294f72 100644 --- a/internal/manager/api_impl/openapi_auth.go +++ b/internal/manager/api_impl/openapi_auth.go @@ -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 // SPDX-License-Identifier: GPL-3.0-or-later diff --git a/internal/manager/api_impl/openapi_auth_test.go b/internal/manager/api_impl/openapi_auth_test.go index 69ceb6e6..e8cd3832 100644 --- a/internal/manager/api_impl/openapi_auth_test.go +++ b/internal/manager/api_impl/openapi_auth_test.go @@ -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 // SPDX-License-Identifier: GPL-3.0-or-later diff --git a/pkg/api/flamenco-manager.yaml b/pkg/api/flamenco-openapi.yaml similarity index 100% rename from pkg/api/flamenco-manager.yaml rename to pkg/api/flamenco-openapi.yaml diff --git a/pkg/api/generate.go b/pkg/api/generate.go index 960708ef..68343402 100644 --- a/pkg/api/generate.go +++ b/pkg/api/generate.go @@ -1,7 +1,7 @@ // SPDX-License-Identifier: GPL-3.0-or-later 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 server,skip-prune -o openapi_server.gen.go -package api flamenco-manager.yaml -//go:generate oapi-codegen -generate spec,skip-prune -o openapi_spec.gen.go -package api flamenco-manager.yaml -//go:generate oapi-codegen -generate client,skip-prune -o openapi_client.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-openapi.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-openapi.yaml diff --git a/web/app/src/components/JobsTable.vue b/web/app/src/components/JobsTable.vue index 20511abc..413145eb 100644 --- a/web/app/src/components/JobsTable.vue +++ b/web/app/src/components/JobsTable.vue @@ -42,7 +42,7 @@ export default { const vueComponent = this; const options = { - // See pkg/api/flamenco-manager.yaml, schemas Job and SocketIOJobUpdate. + // See pkg/api/flamenco-openapi.yaml, schemas Job and SocketIOJobUpdate. columns: [ // Useful for debugging when there are many similar jobs: // { title: "ID", field: "id", headerSort: false, formatter: (cell) => cell.getData().id.substr(0, 8), }, diff --git a/web/app/src/components/TasksTable.vue b/web/app/src/components/TasksTable.vue index 6b4aad36..e2edf6a5 100644 --- a/web/app/src/components/TasksTable.vue +++ b/web/app/src/components/TasksTable.vue @@ -45,7 +45,7 @@ export default { const vueComponent = this; const options = { - // See pkg/api/flamenco-manager.yaml, schemas Task and TaskUpdate. + // See pkg/api/flamenco-openapi.yaml, schemas Task and TaskUpdate. columns: [ // Useful for debugging when there are many similar tasks: // { title: "ID", field: "id", headerSort: false, formatter: (cell) => cell.getData().id.substr(0, 8), },