Skip to content

Commit

Permalink
fix: Move API document files from openapi/v3 to openapi
Browse files Browse the repository at this point in the history
Signed-off-by: Cherry Wang <[email protected]>
  • Loading branch information
cherrycl committed Oct 22, 2024
1 parent b42af75 commit c7c3680
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ edgeXBuildGoParallel(
testScript: 'make test',
buildScript: 'make build',
publishSwaggerDocs: true,
swaggerApiFolders: ['openapi/v3']
swaggerApiFolders: ['openapi']
)
File renamed without changes.
4 changes: 2 additions & 2 deletions openapi/v3/core-command.yaml → openapi/core-command.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions openapi/v3/core-data.yaml → openapi/core-data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions openapi/v3/core-keeper.yaml → openapi/core-keeper.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions openapi/v3/core-metadata.yaml → openapi/core-metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down

0 comments on commit c7c3680

Please sign in to comment.