swagger: '2.0'
info:
description: Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. For more information, please see https://argo-workflows.readthedocs.io/en/latest/
title: Argo Workflows ArchivedWorkflowService EventSourceService API
version: 3.6.0
host: localhost:2746
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
security:
- BearerToken: []
tags:
- name: EventSourceService
paths:
/api/v1/event-sources/{namespace}:
get:
tags:
- EventSourceService
operationId: EventSourceService_ListEventSources
parameters:
- type: string
name: namespace
in: path
required: true
- type: string
description: 'A selector to restrict the list of returned objects by their labels.
Defaults to everything.
+optional.'
name: listOptions.labelSelector
in: query
- type: string
description: 'A selector to restrict the list of returned objects by their fields.
Defaults to everything.
+optional.'
name: listOptions.fieldSelector
in: query
- type: boolean
description: 'Watch for changes to the described resources and return them as a stream of
add, update, and remove notifications. Specify resourceVersion.
+optional.'
name: listOptions.watch
in: query
- type: boolean
description: 'allowWatchBookmarks requests watch events with type "BOOKMARK".
Servers that do not implement bookmarks may ignore this flag and
bookmarks are sent at the server''s discretion. Clients should not
assume bookmarks are returned at any specific interval, nor may they
assume the server will send any BOOKMARK event during a session.
If this is not a watch, this field is ignored.
+optional.'
name: listOptions.allowWatchBookmarks
in: query
- type: string
description: 'resourceVersion sets a constraint on what resource versions a request may be served from.
See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
details.
Defaults to unset
+optional'
name: listOptions.resourceVersion
in: query
- type: string
description: 'resourceVersionMatch determines how resourceVersion is applied to list calls.
It is highly recommended that resourceVersionMatch be set for list calls where
resourceVersion is set
See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
details.
Defaults to unset
+optional'
name: listOptions.resourceVersionMatch
in: query
- type: string
format: int64
description: 'Timeout for the list/watch call.
This limits the duration of the call, regardless of any activity or inactivity.
+optional.'
name: listOptions.timeoutSeconds
in: query
- type: string
format: int64
description: 'limit is a maximum number of responses to return for a list call. If more items exist, the
server will set the `continue` field on the list metadata to a value that can be used with the
same initial query to retrieve the next set of results. Setting a limit may return fewer than
the requested amount of items (up to zero items) in the event all requested objects are
filtered out and clients should only use the presence of the continue field to determine whether
more results are available. Servers may choose not to support the limit argument and will return
all of the available results. If limit is specified and the continue field is empty, clients may
assume that no more results are available. This field is not supported if watch is true.
The server guarantees that the objects returned when using continue will be identical to issuing
a single list call without a limit - that is, no objects created, modified, or deleted after the
first request is issued will be included in any subsequent continued requests. This is sometimes
referred to as a consistent snapshot, and ensures that a client that is using limit to receive
smaller chunks of a very large result can ensure they see all possible objects. If objects are
updated during a chunked list the version of the object that was present at the time the first list
result was calculated is returned.'
name: listOptions.limit
in: query
- type: string
description: 'The continue option should be set when retrieving more results from the server. Since this value is
server defined, clients may only use the continue value from a previous query result with identical
query parameters (except for the value of continue) and the server may reject a continue value it
does not recognize. If the specified continue value is no longer valid whether due to expiration
(generally five to fifteen minutes) or a configuration change on the server, the server will
respond with a 410 ResourceExpired error together with a continue token. If the client needs a
consistent list, it must restart their list without the continue field. Otherwise, the client may
send another list request with the token received with the 410 error, the server will respond with
a list starting from the next key, but from the latest snapshot, which is inconsistent from the
previous list results - objects that are created, modified, or deleted after the first list request
will be included in the response, as long as their keys are after the "next key".
This field is not supported when watch is true. Clients may start a watch from the last
resourceVersion value returned by the server and not miss any modifications.'
name: listOptions.continue
in: query
- type: boolean
description: "`sendInitialEvents=true` may be set together with `watch=true`.\nIn that case, the watch stream will begin with synthetic events to\nproduce the current state of objects in the collection. Once all such\nevents have been sent, a synthetic \"Bookmark\" event will be sent.\nThe bookmark will report the ResourceVersion (RV) corresponding to the\nset of objects, and be marked with `\"io.k8s.initial-events-end\": \"true\"` annotation.\nAfterwards, the watch stream will proceed as usual, sending watch events\ncorresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch`\noption to also be set. The semantic of the watch request is as following:\n- `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward\ncompatibility reasons) and to false otherwise.\n+optional"
name: listOptions.sendInitialEvents
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSourceList'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- EventSourceService
operationId: EventSourceService_CreateEventSource
parameters:
- type: string
name: namespace
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/eventsource.CreateEventSourceRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1/event-sources/{namespace}/{name}:
get:
tags:
- EventSourceService
operationId: EventSourceService_GetEventSource
parameters:
- type: string
name: namespace
in: path
required: true
- type: string
name: name
in: path
required: true
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
tags:
- EventSourceService
operationId: EventSourceService_UpdateEventSource
parameters:
- type: string
name: namespace
in: path
required: true
- type: string
name: name
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/eventsource.UpdateEventSourceRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- EventSourceService
operationId: EventSourceService_DeleteEventSource
parameters:
- type: string
name: namespace
in: path
required: true
- type: string
name: name
in: path
required: true
- type: string
format: int64
description: 'The duration in seconds before the object should be deleted. Value must be non-negative integer.
The value zero indicates delete immediately. If this value is nil, the default grace period for the
specified type will be used.
Defaults to a per object value if not specified. zero means delete immediately.
+optional.'
name: deleteOptions.gracePeriodSeconds
in: query
- type: string
description: 'Specifies the target UID.
+optional.'
name: deleteOptions.preconditions.uid
in: query
- type: string
description: 'Specifies the target ResourceVersion
+optional.'
name: deleteOptions.preconditions.resourceVersion
in: query
- type: boolean
description: 'Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7.
Should the dependent objects be orphaned. If true/false, the "orphan"
finalizer will be added to/removed from the object''s finalizers list.
Either this field or PropagationPolicy may be set, but not both.
+optional.'
name: deleteOptions.orphanDependents
in: query
- type: string
description: 'Whether and how garbage collection will be performed.
Either this field or OrphanDependents may be set, but not both.
The default policy is decided by the existing finalizer set in the
metadata.finalizers and the resource-specific default policy.
Acceptable values are: ''Orphan'' - orphan the dependents; ''Background'' -
allow the garbage collector to delete the dependents in the background;
''Foreground'' - a cascading policy that deletes all dependents in the
foreground.
+optional.'
name: deleteOptions.propagationPolicy
in: query
- type: array
items:
type: string
collectionFormat: multi
description: 'When present, indicates that modifications should not be
persisted. An invalid or unrecognized dryRun directive will
result in an error response and no further processing of the
request. Valid values are:
- All: all dry run stages will be processed
+optional
+listType=atomic.'
name: deleteOptions.dryRun
in: query
- type: boolean
description: 'if set to true, it will trigger an unsafe deletion of the resource in
case the normal deletion flow fails with a corrupt object error.
A resource is considered corrupt if it can not be retrieved from
the underlying storage successfully because of a) its data can
not be transformed e.g. decryption failure, or b) it fails
to decode into an object.
NOTE: unsafe deletion ignores finalizer constraints, skips
precondition checks, and removes the object from the storage.
WARNING: This may potentially break the cluster if the workload
associated with the resource being unsafe-deleted relies on normal
deletion flow. Use only if you REALLY know what you are doing.
The default value is false, and the user must opt in to enable it
+optional.'
name: deleteOptions.ignoreStoreReadErrorWithClusterBreakingPotential
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/eventsource.EventSourceDeletedResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1/stream/event-sources/{namespace}:
get:
tags:
- EventSourceService
operationId: EventSourceService_WatchEventSources
parameters:
- type: string
name: namespace
in: path
required: true
- type: string
description: 'A selector to restrict the list of returned objects by their labels.
Defaults to everything.
+optional.'
name: listOptions.labelSelector
in: query
- type: string
description: 'A selector to restrict the list of returned objects by their fields.
Defaults to everything.
+optional.'
name: listOptions.fieldSelector
in: query
- type: boolean
description: 'Watch for changes to the described resources and return them as a stream of
add, update, and remove notifications. Specify resourceVersion.
+optional.'
name: listOptions.watch
in: query
- type: boolean
description: 'allowWatchBookmarks requests watch events with type "BOOKMARK".
Servers that do not implement bookmarks may ignore this flag and
bookmarks are sent at the server''s discretion. Clients should not
assume bookmarks are returned at any specific interval, nor may they
assume the server will send any BOOKMARK event during a session.
If this is not a watch, this field is ignored.
+optional.'
name: listOptions.allowWatchBookmarks
in: query
- type: string
description: 'resourceVersion sets a constraint on what resource versions a request may be served from.
See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
details.
Defaults to unset
+optional'
name: listOptions.resourceVersion
in: query
- type: string
description: 'resourceVersionMatch determines how resourceVersion is applied to list calls.
It is highly recommended that resourceVersionMatch be set for list calls where
resourceVersion is set
See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
details.
Defaults to unset
+optional'
name: listOptions.resourceVersionMatch
in: query
- type: string
format: int64
description: 'Timeout for the list/watch call.
This limits the duration of the call, regardless of any activity or inactivity.
+optional.'
name: listOptions.timeoutSeconds
in: query
- type: string
format: int64
description: 'limit is a maximum number of responses to return for a list call. If more items exist, the
server will set the `continue` field on the list metadata to a value that can be used with the
same initial query to retrieve the next set of results. Setting a limit may return fewer than
the requested amount of items (up to zero items) in the event all requested objects are
filtered out and clients should only use the presence of the continue field to determine whether
more results are available. Servers may choose not to support the limit argument and will return
all of the available results. If limit is specified and the continue field is empty, clients may
assume that no more results are available. This field is not supported if watch is true.
The server guarantees that the objects returned when using continue will be identical to issuing
a single list call without a limit - that is, no objects created, modified, or deleted after the
first request is issued will be included in any subsequent continued requests. This is sometimes
referred to as a consistent snapshot, and ensures that a client that is using limit to receive
smaller chunks of a very large result can ensure they see all possible objects. If objects are
updated during a chunked list the version of the object that was present at the time the first list
result was calculated is returned.'
name: listOptions.limit
in: query
- type: string
description: 'The continue option should be set when retrieving more results from the server. Since this value is
server defined, clients may only use the continue value from a previous query result with identical
query parameters (except for the value of continue) and the server may reject a continue value it
does not recognize. If the specified continue value is no longer valid whether due to expiration
(generally five to fifteen minutes) or a configuration change on the server, the server will
respond with a 410 ResourceExpired error together with a continue token. If the client needs a
consistent list, it must restart their list without the continue field. Otherwise, the client may
send another list request with the token received with the 410 error, the server will respond with
a list starting from the next key, but from the latest snapshot, which is inconsistent from the
previous list results - objects that are created, modified, or deleted after the first list request
will be included in the response, as long as their keys are after the "next key".
This field is not supported when watch is true. Clients may start a watch from the last
resourceVersion value returned by the server and not miss any modifications.'
name: listOptions.continue
in: query
- type: boolean
description: "`sendInitialEvents=true` may be set together with `watch=true`.\nIn that case, the watch stream will begin with synthetic events to\nproduce the current state of objects in the collection. Once all such\nevents have been sent, a synthetic \"Bookmark\" event will be sent.\nThe bookmark will report the ResourceVersion (RV) corresponding to the\nset of objects, and be marked with `\"io.k8s.initial-events-end\": \"true\"` annotation.\nAfterwards, the watch stream will proceed as usual, sending watch events\ncorresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch`\noption to also be set. The semantic of the watch request is as following:\n- `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward\ncompatibility reasons) and to false otherwise.\n+optional"
name: listOptions.sendInitialEvents
in: query
responses:
'200':
description: A successful response.(streaming responses)
schema:
type: object
title: Stream result of eventsource.EventSourceWatchEvent
properties:
error:
$ref: '#/definitions/grpc.gateway.runtime.StreamError'
result:
$ref: '#/definitions/eventsource.EventSourceWatchEvent'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1/stream/event-sources/{namespace}/logs:
get:
tags:
- EventSourceService
operationId: EventSourceService_EventSourcesLogs
parameters:
- type: string
name: namespace
in: path
required: true
- type: string
description: optional - only return entries for this event source.
name: name
in: query
- type: string
description: optional - only return entries for this event source type (e.g. `webhook`).
name: eventSourceType
in: query
- type: string
description: optional - only return entries for this event name (e.g. `example`).
name: eventName
in: query
- type: string
description: optional - only return entries where `msg` matches this regular expression.
name: grep
in: query
- type: string
description: 'The container for which to stream logs. Defaults to only container if there is one container in the pod.
+optional.'
name: podLogOptions.container
in: query
- type: boolean
description: 'Follow the log stream of the pod. Defaults to false.
+optional.'
name: podLogOptions.follow
in: query
- type: boolean
description: 'Return previous terminated container logs. Defaults to false.
+optional.'
name: podLogOptions.previous
in: query
- type: string
format: int64
description: 'A relative time in seconds before the current time from which to show logs. If this value
precedes the time a pod was started, only logs since the pod start will be returned.
If this value is in the future, no logs will be returned.
Only one of sinceSeconds or sinceTime may be specified.
+optional.'
name: podLogOptions.sinceSeconds
in: query
- type: string
format: int64
description: 'Represents seconds of UTC time since Unix epoch
1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
9999-12-31T23:59:59Z inclusive.'
name: podLogOptions.sinceTime.seconds
in: query
- type: integer
format: int32
description: 'Non-negative fractions of a second at nanosecond resolution. Negative
second values with fractions must still have non-negative nanos values
that count forward in time. Must be from 0 to 999,999,999
inclusive. This field may be limited in precision depending on context.'
name: podLogOptions.sinceTime.nanos
in: query
- type: boolean
description: 'If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line
of log output. Defaults to false.
+optional.'
name: podLogOptions.timestamps
in: query
- type: string
format: int64
description: 'If set, the number of lines from the end of the logs to show. If not specified,
logs are shown from the creation of the container or sinceSeconds or sinceTime.
Note that when "TailLines" is specified, "Stream" can only be set to nil or "All".
+optional.'
name: podLogOptions.tailLines
in: query
- type: string
format: int64
description: 'If set, the number of bytes to read from the server before terminating the
log output. This may not display a complete final line of logging, and may return
slightly more or slightly less than the specified limit.
+optional.'
name: podLogOptions.limitBytes
in: query
- type: boolean
description: 'insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the
serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver
and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real
kubelet. If the kubelet is configured to verify the apiserver''s TLS credentials, it does not mean the
connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept
the actual log data coming from the real kubelet).
+optional.'
name: podLogOptions.insecureSkipTLSVerifyBackend
in: query
- type: string
description: 'Specify which container log stream to return to the client.
Acceptable values are "All", "Stdout" and "Stderr". If not specified, "All" is used, and both stdout and stderr
are returned interleaved.
Note that when "TailLines" is specified, "Stream" can only be set to nil or "All".
+featureGate=PodLogsQuerySplitStreams
+optional.'
name: podLogOptions.stream
in: query
responses:
'200':
description: A successful response.(streaming responses)
schema:
type: object
title: Stream result of eventsource.LogEntry
properties:
error:
$ref: '#/definitions/grpc.gateway.runtime.StreamError'
result:
$ref: '#/definitions/eventsource.LogEntry'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
definitions:
github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.WebhookEventSource:
type: object
title: CalendarEventSource describes an HTTP based EventSource
properties:
filter:
title: 'Filter
+optional'
$ref: '#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSourceFilter'
webhookContext:
$ref: '#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.WebhookContext'
grpc.gateway.runtime.StreamError:
type: object
properties:
details:
type: array
items:
$ref: '#/definitions/google.protobuf.Any'
grpc_code:
type: integer
http_code:
type: integer
http_status:
type: string
message:
type: string
github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.SNSEventSource:
type: object
title: SNSEventSource refers to event-source for AWS SNS related events
properties:
accessKey:
title: AccessKey refers K8s secret containing aws access key
$ref: '#/definitions/io.k8s.api.core.v1.SecretKeySelector'
endpoint:
type: string
title: 'Endpoint configures connection to a specific SNS endpoint instead of Amazons servers
+optional'
filter:
title: 'Filter
+optional'
$ref: '#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSourceFilter'
metadata:
type: object
title: 'Metadata holds the user defined metadata which will passed along the event payload.
+optional'
additionalProperties:
type: string
region:
type: string
title: Region is AWS region
roleARN:
type: string
title: 'RoleARN is the Amazon Resource Name (ARN) of the role to assume.
+optional'
secretKey:
title: SecretKey refers K8s secret containing aws secret key
$ref: '#/definitions/io.k8s.api.core.v1.SecretKeySelector'
topicArn:
type: string
title: TopicArn
validateSignature:
type: boolean
title: 'ValidateSignature is boolean that can be set to true for SNS signature verification
+optional'
webhook:
title: Webhook configuration for http server
$ref: '#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.WebhookContext'
io.k8s.api.core.v1.ScaleIOVolumeSource:
description: ScaleIOVolumeSource represents a persistent ScaleIO volume
type: object
required:
- gateway
- system
- secretRef
properties:
fsType:
description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
type: string
gateway:
description: gateway is the host address of the ScaleIO API Gateway.
type: string
protectionDomain:
description: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
type: string
readOnly:
description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
description: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
$ref: '#/definitions/io.k8s.api.core.v1.LocalObjectReference'
sslEnabled:
description: sslEnabled Flag enable/disable SSL communication with Gateway, default false
type: boolean
storageMode:
description: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
type: string
storagePool:
description: storagePool is the ScaleIO Storage Pool associated with the protection domain.
type: string
system:
description: system is the name of the storage system as configured in ScaleIO.
type: string
volumeName:
description: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
type: string
io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource:
description: Represents a Photon Controller persistent disk resource.
type: object
required:
- pdID
properties:
fsType:
description: fsType is the filesystem ty
# --- truncated at 32 KB (265 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/openapi/argo-workflows-eventsourceservice-api-openapi.yml