@itentialopensource/adapter-paragon_job_store
Version:
This adapter integrates with system described as: jobstore/pkg/gen/model.proto.
1,693 lines (1,682 loc) • 153 kB
YAML
openapi: 3.0.0
info:
title: jobstore/pkg/gen/model.proto
description: "\n\n# Copyright\n\nJuniper Networks, Inc. \n1133 Innovation Way Sunnyvale, California 94089 USA \n408-745-2000 \nwww.juniper.net\n\nCopyright © 2021, Juniper Networks, Inc. All rights reserved.\n\nJuniper Networks, the Juniper Networks logo, Juniper, and Junos are registered trademarks of Juniper Networks, Inc. and/or its affiliates in the United States and other countries. All other trademarks may be property of their respective owners.\nJuniper Networks assumes no responsibility for any inaccuracies in this document. Juniper Networks reserves the right to change, modify, transfer, or otherwise revise this publication without notice.\n\n\nThe information in this document is current as of the date on the title page.\n\nYEAR 2000 NOTICE\n\nJuniper Networks hardware and software products are Year 2000 compliant. Junos OS has no known time-related limitations through the year 2038. However, the NTP application is known to have some difficulty in the year 2036.\n\nEND USER LICENSE AGREEMENT\n\nThe Juniper Networks product that is the subject of this technical documentation consists of (or is intended for use with) Juniper Networks software. Use of such software is subject to the terms and conditions of the End User License Agreement (“EULA”) posted at http://www.juniper.net/support/eula.html. By downloading, installing or using such software, you agree to the terms and conditions of that EULA.\n\n\n"
contact: {}
version: '1.0'
servers:
- url: https://{defaultHost}
variables:
defaultHost:
default: www.example.com
paths:
/jobstore/job/{ID}:
put:
tags:
- JobstoreService
summary: JobstoreService_UpdateJob
description: ''
operationId: JobstoreService_UpdateJob
parameters:
- name: ID
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreUpdateJobRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreUpdateJobResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
get:
tags:
- JobstoreService
summary: JobstoreService_GetJob
description: ''
operationId: JobstoreService_GetJob
parameters:
- name: ID
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: detail
in: query
description: if detail is set then reference uuids & child uuids will be returned in the response.
style: form
explode: true
schema:
type: boolean
- name: fields
in: query
description: limit displayed fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: ref_fields
in: query
description: limit displayed reference fields.
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreGetJobResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
delete:
tags:
- JobstoreService
summary: JobstoreService_DeleteJob
description: ''
operationId: JobstoreService_DeleteJob
parameters:
- name: ID
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreDeleteJobResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/bulk-list-job:
post:
tags:
- JobstoreService
summary: JobstoreService_BulkListJob
description: This API can be used to list job based on specification given in request body.
operationId: JobstoreService_BulkListJob
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreListJobRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreListJobResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/bulk-ext-ref-update:
post:
tags:
- JobstoreService
summary: JobstoreService_BulkExtRefUpdate
description: This API can be used to create/delete multiple references for ExtRef table.
operationId: JobstoreService_BulkExtRefUpdate
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreBulkExtRefUpdateRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema: {}
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/bulk-ref-update:
post:
tags:
- JobstoreService
summary: JobstoreService_BulkRefUpdate
description: This API can be used to ADD/DELETE multiple references between two resources.
operationId: JobstoreService_BulkRefUpdate
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreBulkRefUpdateRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreBulkRefUpdateResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/bulk-list-job-purge-policy:
post:
tags:
- JobstoreService
summary: JobstoreService_BulkListJobPurgePolicy
description: This API can be used to list job-purge-policy based on specification given in request body.
operationId: JobstoreService_BulkListJobPurgePolicy
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreListJobPurgePolicyRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreListJobPurgePolicyResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/last-published-notification/{ID}:
put:
tags:
- JobstoreService
summary: JobstoreService_UpdateLastPublishedNotification
description: ''
operationId: JobstoreService_UpdateLastPublishedNotification
parameters:
- name: ID
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreUpdateLastPublishedNotificationRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreUpdateLastPublishedNotificationResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
get:
tags:
- JobstoreService
summary: JobstoreService_GetLastPublishedNotification
description: ''
operationId: JobstoreService_GetLastPublishedNotification
parameters:
- name: ID
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: detail
in: query
description: if detail is set then reference uuids & child uuids will be returned in the response.
style: form
explode: true
schema:
type: boolean
- name: fields
in: query
description: limit displayed fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: ref_fields
in: query
description: limit displayed reference fields.
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreGetLastPublishedNotificationResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
delete:
tags:
- JobstoreService
summary: JobstoreService_DeleteLastPublishedNotification
description: ''
operationId: JobstoreService_DeleteLastPublishedNotification
parameters:
- name: ID
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreDeleteLastPublishedNotificationResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/bulk-list-task:
post:
tags:
- JobstoreService
summary: JobstoreService_BulkListTask
description: This API can be used to list task based on specification given in request body.
operationId: JobstoreService_BulkListTask
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreListTaskRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreListTaskResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/last-published-notification:
post:
tags:
- JobstoreService
summary: JobstoreService_CreateLastPublishedNotification
description: ''
operationId: JobstoreService_CreateLastPublishedNotification
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreCreateLastPublishedNotificationRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreCreateLastPublishedNotificationResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
get:
tags:
- JobstoreService
summary: JobstoreService_ListLastPublishedNotification
description: This API can be used to list last-published-notification based on specification given in query parameters.
operationId: JobstoreService_ListLastPublishedNotification
parameters:
- name: spec.size
in: query
description: Number of items expected to be returned.
style: form
explode: true
schema:
type: string
- name: spec.page_marker
in: query
description: Include only objects with UUID lexically greater than this.
style: form
explode: true
schema:
type: string
- name: spec.detail
in: query
description: Include detail informatoin or not.
style: form
explode: true
schema:
type: boolean
- name: spec.count
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: spec.exclude_shared
in: query
description: Include shared resources or not.
style: form
explode: true
schema:
type: boolean
- name: spec.exclude_hrefs
in: query
description: Exclude href parameters.
style: form
explode: true
schema:
type: boolean
- name: spec.parent_fq_name_str
in: query
description: Filter by parent FQ Name.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.parent_type
in: query
description: Filter by parent type.
style: form
explode: true
schema:
type: string
- name: spec.parent_id
in: query
description: Filter by parent UUIDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.back_ref_id
in: query
description: Filter by backref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.obj_uuids
in: query
description: Filter by UUIDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.fields
in: query
description: limit displayed fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.filters
in: query
description: >-
QueryFilter in string format.
Grpc-gateway doesn't have support for nested structs and maps so
introducing new fields which will take string as input.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.ref_uuids
in: query
description: Filter by ref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.from
in: query
description: Start from items expected to be returned.
style: form
explode: true
schema:
type: string
- name: spec.sortby
in: query
description: Sort by column with ascending or descending by default ascending.
style: form
explode: true
schema:
type: string
- name: spec.operation
in: query
description: Operation determines whether union or interjection.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/baseservicesOperation'
- description: Operation determines whether union or interjection.
- name: spec.tag_filters
in: query
description: Filter by Tag Fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.tag_detail
in: query
description: Include Tag Details or not.
style: form
explode: true
schema:
type: boolean
- name: spec.ref_fields
in: query
description: limit displayed reference fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.ext_ref_uuids
in: query
description: Filter by External Ref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreListLastPublishedNotificationResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/job-purge-policy:
post:
tags:
- JobstoreService
summary: JobstoreService_CreateJobPurgePolicy
description: ''
operationId: JobstoreService_CreateJobPurgePolicy
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreCreateJobPurgePolicyRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreCreateJobPurgePolicyResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
get:
tags:
- JobstoreService
summary: JobstoreService_ListJobPurgePolicy
description: This API can be used to list job-purge-policy based on specification given in query parameters.
operationId: JobstoreService_ListJobPurgePolicy
parameters:
- name: spec.size
in: query
description: Number of items expected to be returned.
style: form
explode: true
schema:
type: string
- name: spec.page_marker
in: query
description: Include only objects with UUID lexically greater than this.
style: form
explode: true
schema:
type: string
- name: spec.detail
in: query
description: Include detail informatoin or not.
style: form
explode: true
schema:
type: boolean
- name: spec.count
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: spec.exclude_shared
in: query
description: Include shared resources or not.
style: form
explode: true
schema:
type: boolean
- name: spec.exclude_hrefs
in: query
description: Exclude href parameters.
style: form
explode: true
schema:
type: boolean
- name: spec.parent_fq_name_str
in: query
description: Filter by parent FQ Name.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.parent_type
in: query
description: Filter by parent type.
style: form
explode: true
schema:
type: string
- name: spec.parent_id
in: query
description: Filter by parent UUIDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.back_ref_id
in: query
description: Filter by backref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.obj_uuids
in: query
description: Filter by UUIDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.fields
in: query
description: limit displayed fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.filters
in: query
description: >-
QueryFilter in string format.
Grpc-gateway doesn't have support for nested structs and maps so
introducing new fields which will take string as input.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.ref_uuids
in: query
description: Filter by ref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.from
in: query
description: Start from items expected to be returned.
style: form
explode: true
schema:
type: string
- name: spec.sortby
in: query
description: Sort by column with ascending or descending by default ascending.
style: form
explode: true
schema:
type: string
- name: spec.operation
in: query
description: Operation determines whether union or interjection.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/baseservicesOperation'
- description: Operation determines whether union or interjection.
- name: spec.tag_filters
in: query
description: Filter by Tag Fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.tag_detail
in: query
description: Include Tag Details or not.
style: form
explode: true
schema:
type: boolean
- name: spec.ref_fields
in: query
description: limit displayed reference fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.ext_ref_uuids
in: query
description: Filter by External Ref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreListJobPurgePolicyResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/task:
post:
tags:
- JobstoreService
summary: JobstoreService_CreateTask
description: ''
operationId: JobstoreService_CreateTask
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreCreateTaskRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreCreateTaskResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
get:
tags:
- JobstoreService
summary: JobstoreService_ListTask
description: This API can be used to list task based on specification given in query parameters.
operationId: JobstoreService_ListTask
parameters:
- name: spec.size
in: query
description: Number of items expected to be returned.
style: form
explode: true
schema:
type: string
- name: spec.page_marker
in: query
description: Include only objects with UUID lexically greater than this.
style: form
explode: true
schema:
type: string
- name: spec.detail
in: query
description: Include detail informatoin or not.
style: form
explode: true
schema:
type: boolean
- name: spec.count
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: spec.exclude_shared
in: query
description: Include shared resources or not.
style: form
explode: true
schema:
type: boolean
- name: spec.exclude_hrefs
in: query
description: Exclude href parameters.
style: form
explode: true
schema:
type: boolean
- name: spec.parent_fq_name_str
in: query
description: Filter by parent FQ Name.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.parent_type
in: query
description: Filter by parent type.
style: form
explode: true
schema:
type: string
- name: spec.parent_id
in: query
description: Filter by parent UUIDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.back_ref_id
in: query
description: Filter by backref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.obj_uuids
in: query
description: Filter by UUIDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.fields
in: query
description: limit displayed fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.filters
in: query
description: >-
QueryFilter in string format.
Grpc-gateway doesn't have support for nested structs and maps so
introducing new fields which will take string as input.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.ref_uuids
in: query
description: Filter by ref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.from
in: query
description: Start from items expected to be returned.
style: form
explode: true
schema:
type: string
- name: spec.sortby
in: query
description: Sort by column with ascending or descending by default ascending.
style: form
explode: true
schema:
type: string
- name: spec.operation
in: query
description: Operation determines whether union or interjection.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/baseservicesOperation'
- description: Operation determines whether union or interjection.
- name: spec.tag_filters
in: query
description: Filter by Tag Fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.tag_detail
in: query
description: Include Tag Details or not.
style: form
explode: true
schema:
type: boolean
- name: spec.ref_fields
in: query
description: limit displayed reference fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.ext_ref_uuids
in: query
description: Filter by External Ref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreListTaskResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/ref-update:
post:
tags:
- JobstoreService
summary: JobstoreService_RefUpdate
description: This API can be used to ADD/DELETE reference between two resources.
operationId: JobstoreService_RefUpdate
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreRefUpdateRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreRefUpdateResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/ext-ref-update:
post:
tags:
- JobstoreService
summary: JobstoreService_ExtRefUpdate
description: This API can be used to create/delete reference for ExtRef table.
operationId: JobstoreService_ExtRefUpdate
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreExtRefUpdateRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema: {}
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/job:
post:
tags:
- JobstoreService
summary: JobstoreService_CreateJob
description: ''
operationId: JobstoreService_CreateJob
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreCreateJobRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreCreateJobResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
get:
tags:
- JobstoreService
summary: JobstoreService_ListJob
description: This API can be used to list job based on specification given in query parameters.
operationId: JobstoreService_ListJob
parameters:
- name: spec.size
in: query
description: Number of items expected to be returned.
style: form
explode: true
schema:
type: string
- name: spec.page_marker
in: query
description: Include only objects with UUID lexically greater than this.
style: form
explode: true
schema:
type: string
- name: spec.detail
in: query
description: Include detail informatoin or not.
style: form
explode: true
schema:
type: boolean
- name: spec.count
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: spec.exclude_shared
in: query
description: Include shared resources or not.
style: form
explode: true
schema:
type: boolean
- name: spec.exclude_hrefs
in: query
description: Exclude href parameters.
style: form
explode: true
schema:
type: boolean
- name: spec.parent_fq_name_str
in: query
description: Filter by parent FQ Name.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.parent_type
in: query
description: Filter by parent type.
style: form
explode: true
schema:
type: string
- name: spec.parent_id
in: query
description: Filter by parent UUIDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.back_ref_id
in: query
description: Filter by backref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.obj_uuids
in: query
description: Filter by UUIDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.fields
in: query
description: limit displayed fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.filters
in: query
description: >-
QueryFilter in string format.
Grpc-gateway doesn't have support for nested structs and maps so
introducing new fields which will take string as input.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.ref_uuids
in: query
description: Filter by ref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.from
in: query
description: Start from items expected to be returned.
style: form
explode: true
schema:
type: string
- name: spec.sortby
in: query
description: Sort by column with ascending or descending by default ascending.
style: form
explode: true
schema:
type: string
- name: spec.operation
in: query
description: Operation determines whether union or interjection.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/baseservicesOperation'
- description: Operation determines whether union or interjection.
- name: spec.tag_filters
in: query
description: Filter by Tag Fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.tag_detail
in: query
description: Include Tag Details or not.
style: form
explode: true
schema:
type: boolean
- name: spec.ref_fields
in: query
description: limit displayed reference fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.ext_ref_uuids
in: query
description: Filter by External Ref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreListJobResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/job-purge-policy/{ID}:
put:
tags:
- JobstoreService
summary: JobstoreService_UpdateJobPurgePolicy
description: ''
operationId: JobstoreService_UpdateJobPurgePolicy
parameters:
- name: ID
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreUpdateJobPurgePolicyRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreUpdateJobPurgePolicyResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
get:
tags:
- JobstoreService
summary: JobstoreService_GetJobPurgePolicy
description: ''
operationId: JobstoreService_GetJobPurgePolicy
parameters:
- name: ID
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: detail
in: query
description: if detail is set then reference uuids & child uuids will be returned in the response.
style: form
explode: true
schema:
type: boolean
- name: fields
in: query
description: limit displayed fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: ref_fields
in: query
description: limit displayed reference fields.
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreGetJobPurgePolicyResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
delete:
tags:
- JobstoreService
summary: JobstoreService_DeleteJobPurgePolicy
description: ''
operationId: JobstoreService_DeleteJobPurgePolicy
parameters:
- name: ID
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreDeleteJobPurgePolicyResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
/jobstore/deleted-resource:
post:
tags:
- JobstoreService
summary: JobstoreService_CreateDeletedResource
description: ''
operationId: JobstoreService_CreateDeletedResource
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreCreateDeletedResourceRequest'
required: true
responses:
'200':
description: A successful response.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/jobstoreCreateDeletedResourceResponse'
default:
description: An unexpected error response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
deprecated: false
get:
tags:
- JobstoreService
summary: JobstoreService_ListDeletedResource
description: This API can be used to list deleted-resource based on specification given in query parameters.
operationId: JobstoreService_ListDeletedResource
parameters:
- name: spec.size
in: query
description: Number of items expected to be returned.
style: form
explode: true
schema:
type: string
- name: spec.page_marker
in: query
description: Include only objects with UUID lexically greater than this.
style: form
explode: true
schema:
type: string
- name: spec.detail
in: query
description: Include detail informatoin or not.
style: form
explode: true
schema:
type: boolean
- name: spec.count
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: spec.exclude_shared
in: query
description: Include shared resources or not.
style: form
explode: true
schema:
type: boolean
- name: spec.exclude_hrefs
in: query
description: Exclude href parameters.
style: form
explode: true
schema:
type: boolean
- name: spec.parent_fq_name_str
in: query
description: Filter by parent FQ Name.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.parent_type
in: query
description: Filter by parent type.
style: form
explode: true
schema:
type: string
- name: spec.parent_id
in: query
description: Filter by parent UUIDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.back_ref_id
in: query
description: Filter by backref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.obj_uuids
in: query
description: Filter by UUIDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.fields
in: query
description: limit displayed fields.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.filters
in: query
description: >-
QueryFilter in string format.
Grpc-gateway doesn't have support for nested structs and maps so
introducing new fields which will take string as input.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.ref_uuids
in: query
description: Filter by ref UUIDss.
style: form
explode: true
schema:
type: array
items:
type: string
- name: spec.from
in: query
description: Start from items expected to be returned.
style: form
explode: true
schema:
type: string
- name: spec.sortby
in: query
description: Sort by column with ascending or descending by default ascending.
style: form
explode: true
schema:
type: string
- name: spec.operation
in: query
description: Operation determines whether union or interjection.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/baseservicesOperation'
- description: Operation determines whether union or interjection.
- name: spec.tag_filters
in: query
description: Filter by Tag Fields.
style: form
explode: true
schema: