Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed JobTarget OpenAPI definition #3585

Merged
merged 1 commit into from
Aug 23, 2022
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,47 @@ info:
name: Eclipse Public License 2.0
url: https://www.eclipse.org/legal/epl-2.0

paths: {}
paths: { }

components:
parameters:
targetId:
name: targetId
in: path
description: The ID of the Job Target on which to perform the operation
description: The entity ID of the on which perform the operations
schema:
$ref: '../openapi.yaml#/components/schemas/kapuaId'
required: true
schemas:
jobTargetCreator:
allOf:
- $ref: '../openapi.yaml#/components/schemas/kapuaUpdatableEntityCreator'
- type: object
properties:
jobId:
allOf:
- $ref: '../openapi.yaml#/components/schemas/kapuaId'
- description: The ID of the Job to attach the target to
jobTargetId:
allOf:
- $ref: '../openapi.yaml#/components/schemas/kapuaId'
- description: The ID of the Device to attach the target to
example:
type: jobTargetCreator
jobId: auSoU2ph1bY
jobTargetId: JMQdKuPgUjE
jobTarget:
allOf:
- $ref: '../openapi.yaml#/components/schemas/kapuaUpdatableEntity'
- $ref: '#/components/schemas/jobTargetCreator'
- type: object
properties:
status:
$ref: '#/components/schemas/jobTargetStatus'
stepIndex:
type: integer
statusMessage:
type: string
example:
type: jobTarget
id: Y-vYl9TKaf8
Expand All @@ -40,18 +65,6 @@ components:
jobTargetId: VBk_ZDZSOV0
status: PROCESS_OK
stepIndex: 0
jobTargetCreator:
allOf:
- $ref: '../openapi.yaml#/components/schemas/kapuaUpdatableEntityCreator'
- type: object
properties:
jobTargetId:
allOf:
- $ref: '../openapi.yaml#/components/schemas/kapuaId'
- description: The ID of the Device to attach the target to
example:
type: jobTargetCreator
jobTargetId: JMQdKuPgUjE
jobTargetListResult:
allOf:
- $ref: '../openapi.yaml#/components/schemas/kapuaListResult'
Expand All @@ -78,3 +91,11 @@ components:
jobTargetId: VBk_ZDZSOV0
status: PROCESS_OK
stepIndex: 0
jobTargetStatus:
type: string
enum:
- PROCESS_OK
- PROCESS_FAILED
- PROCESS_AWAITING
- AWAITING_COMPLETION
- NOTIFIED_COMPLETION