From c7c3680392ce68a6fcb1eaf602bff8de280a2107 Mon Sep 17 00:00:00 2001 From: Cherry Wang Date: Tue, 22 Oct 2024 11:26:03 +0800 Subject: [PATCH] fix: Move API document files from openapi/v3 to openapi Signed-off-by: Cherry Wang --- Jenkinsfile | 2 +- openapi/{v3 => }/README.md | 0 openapi/{v3 => }/core-command.yaml | 4 ++-- openapi/{v3 => }/core-data.yaml | 4 ++-- openapi/{v3 => }/core-keeper.yaml | 4 ++-- openapi/{v3 => }/core-metadata.yaml | 4 ++-- openapi/{v3 => }/support-cron-scheduler.yaml | 4 ++-- openapi/{v3 => }/support-notifications.yaml | 4 ++-- openapi/{v3 => }/support-scheduler.yaml | 4 ++-- 9 files changed, 15 insertions(+), 15 deletions(-) rename openapi/{v3 => }/README.md (100%) rename openapi/{v3 => }/core-command.yaml (99%) rename openapi/{v3 => }/core-data.yaml (99%) rename openapi/{v3 => }/core-keeper.yaml (99%) rename openapi/{v3 => }/core-metadata.yaml (99%) rename openapi/{v3 => }/support-cron-scheduler.yaml (99%) rename openapi/{v3 => }/support-notifications.yaml (99%) rename openapi/{v3 => }/support-scheduler.yaml (99%) diff --git a/Jenkinsfile b/Jenkinsfile index a7868f03e5..69fe77f604 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -21,5 +21,5 @@ edgeXBuildGoParallel( testScript: 'make test', buildScript: 'make build', publishSwaggerDocs: true, - swaggerApiFolders: ['openapi/v3'] + swaggerApiFolders: ['openapi'] ) diff --git a/openapi/v3/README.md b/openapi/README.md similarity index 100% rename from openapi/v3/README.md rename to openapi/README.md diff --git a/openapi/v3/core-command.yaml b/openapi/core-command.yaml similarity index 99% rename from openapi/v3/core-command.yaml rename to openapi/core-command.yaml index 8a23ec20ed..212c883399 100644 --- a/openapi/v3/core-command.yaml +++ b/openapi/core-command.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: Edgex Foundry - Core Command API description: This is the definition of the API for the Core Command service in the EdgeX Foundry IOT microservice platform. Core Command is responsible for storing command definitions and also for executing those commands as reads and writes against target devices. - version: 3.2.0 + version: 4.0.0 servers: - url: http://localhost:59882/api/v3 @@ -879,7 +879,7 @@ paths: $ref: '#/components/schemas/VersionResponse' example: apiVersion: "v3" - version: 3.1.0 + version: 4.0.0 serviceName: "core-command" '500': description: "Interval Server Error" diff --git a/openapi/v3/core-data.yaml b/openapi/core-data.yaml similarity index 99% rename from openapi/v3/core-data.yaml rename to openapi/core-data.yaml index c3e4060204..93daa20322 100644 --- a/openapi/v3/core-data.yaml +++ b/openapi/core-data.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: Edgex Foundry - Core Data API description: This is the definition of the API for the Core Data service in the EdgeX Foundry IOT microservice platform. Core Data is responsible for storing event and reading data ingested from edge devices in the environment. - version: 3.2.0 + version: 4.0.0 servers: - url: http://localhost:59880/api/v3 @@ -1957,7 +1957,7 @@ paths: $ref: '#/components/schemas/VersionResponse' example: apiVersion: "v3" - version: 3.1.0 + version: 4.0.0 serviceName: "core-data" '500': description: "Interval Server Error" diff --git a/openapi/v3/core-keeper.yaml b/openapi/core-keeper.yaml similarity index 99% rename from openapi/v3/core-keeper.yaml rename to openapi/core-keeper.yaml index 713dbc8727..3202676ca8 100644 --- a/openapi/v3/core-keeper.yaml +++ b/openapi/core-keeper.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: Edgex Foundry - Core Keeper API description: This is the definition of the API for the Core Keeper service in the EdgeX Foundry IOT microservice platform. - version: 3.2.0 + version: 4.0.0 servers: - url: http://localhost:59890/api/v3 @@ -943,7 +943,7 @@ paths: $ref: '#/components/schemas/VersionResponse' example: apiVersion: "v3" - version: "3.1.0" + version: "4.0.0" '500': description: "Interval Server Error" content: diff --git a/openapi/v3/core-metadata.yaml b/openapi/core-metadata.yaml similarity index 99% rename from openapi/v3/core-metadata.yaml rename to openapi/core-metadata.yaml index 3c95e82652..eb7db62f2e 100644 --- a/openapi/v3/core-metadata.yaml +++ b/openapi/core-metadata.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: Edgex Foundry - Core Metadata API description: "This is the definition of the API for the Core Metadata service in the EdgeX Foundry IOT microservice platform. Core Metadata is responsible for all information related to provisioned devices and their associated services." - version: 3.2.0 + version: 4.0.0 servers: - url: 'http://localhost:59881/api/v3' description: URL for local development and testing @@ -4298,7 +4298,7 @@ paths: $ref: '#/components/schemas/VersionResponse' example: apiVersion: "v3" - version: 3.1.0 + version: 4.0.0 serviceName: "core-metadata" '500': description: "Internal Server Error" diff --git a/openapi/v3/support-cron-scheduler.yaml b/openapi/support-cron-scheduler.yaml similarity index 99% rename from openapi/v3/support-cron-scheduler.yaml rename to openapi/support-cron-scheduler.yaml index 949ba86c69..b87b151617 100644 --- a/openapi/v3/support-cron-scheduler.yaml +++ b/openapi/support-cron-scheduler.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: Edgex Foundry - Support Cron Scheduler API description: This is the definition of the API for the Support Cron Scheduler service in the EdgeX Foundry IOT microservice platform. Support Cron Scheduler provides functionality for scheduling different actions in the EdgeX Foundry platform. - version: 3.2.0 + version: 4.0.0 servers: - url: http://localhost:59863/api/v3 @@ -1343,7 +1343,7 @@ paths: $ref: '#/components/schemas/VersionResponse' example: apiVersion: "v3" - version: 3.2.0 + version: 4.0.0 serviceName: "support-cron-scheduler" '500': description: "Internal Server Error" diff --git a/openapi/v3/support-notifications.yaml b/openapi/support-notifications.yaml similarity index 99% rename from openapi/v3/support-notifications.yaml rename to openapi/support-notifications.yaml index 9afa415835..9bcda0b604 100644 --- a/openapi/v3/support-notifications.yaml +++ b/openapi/support-notifications.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: Edgex Foundry - Support Notifications API description: This is the definition of the API for the Support Notifications service in the EdgeX Foundry IOT microservice platform. Support Notifications provides functionality for sending notifications via email/REST from the EdgeX Foundry platform. - version: 3.2.0 + version: 4.0.0 servers: - url: http://localhost:59860/api/v3 @@ -2346,7 +2346,7 @@ paths: $ref: '#/components/schemas/VersionResponse' example: apiVersion: "v3" - version: 3.1.0 + version: 4.0.0 serviceName: "support-notifications" '500': description: "Interval Server Error" diff --git a/openapi/v3/support-scheduler.yaml b/openapi/support-scheduler.yaml similarity index 99% rename from openapi/v3/support-scheduler.yaml rename to openapi/support-scheduler.yaml index 0a0aa593da..abb25c34b2 100644 --- a/openapi/v3/support-scheduler.yaml +++ b/openapi/support-scheduler.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: Edgex Foundry - Support Scheduler API description: This is the definition of the API for the Support Scheduler service in the EdgeX Foundry IOT microservice platform. Support Scheduler provides functionality for scheduling different actions in the EdgeX Foundry platform. - version: 3.2.0 + version: 4.0.0 servers: - url: http://localhost:59861/api/v3 @@ -1007,7 +1007,7 @@ paths: $ref: '#/components/schemas/VersionResponse' example: apiVersion: "v3" - version: 3.1.0 + version: 4.0.0 serviceName: "support-scheduler" '500': description: "Interval Server Error"