241 lines
11 KiB
JSON
241 lines
11 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "pipeline upload",
|
|
"version": "version not set"
|
|
},
|
|
"schemes": ["http", "https"],
|
|
"paths": {
|
|
"/apis/v2beta1/pipelines/upload": {
|
|
"post": {
|
|
"operationId": "UploadPipeline",
|
|
"consumes": ["multipart/form-data"],
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/v2beta1Pipeline"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "uploadfile",
|
|
"in": "formData",
|
|
"required": true,
|
|
"type": "file",
|
|
"description": "The pipeline to upload. Maximum size of 32MB is supported."
|
|
},
|
|
{
|
|
"name": "name",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": ["PipelineUploadService"]
|
|
}
|
|
},
|
|
"/apis/v2beta1/pipelines/upload_version": {
|
|
"post": {
|
|
"operationId": "UploadPipelineVersion",
|
|
"consumes": ["multipart/form-data"],
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/v2beta1PipelineVersion"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "uploadfile",
|
|
"in": "formData",
|
|
"required": true,
|
|
"type": "file",
|
|
"description": "The pipeline to upload. Maximum size of 32MB is supported."
|
|
},
|
|
{
|
|
"name": "name",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "pipelineid",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": ["PipelineUploadService"]
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"v2beta1Pipeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pipeline_id": {
|
|
"type": "string",
|
|
"description": "Output. Unique pipeline ID. Generated by API server."
|
|
},
|
|
"display_name": {
|
|
"type": "string",
|
|
"description": "Required input field. Pipeline name provided by user."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional input field. A short description of the pipeline."
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output. Creation time of the pipeline."
|
|
},
|
|
"namespace": {
|
|
"type": "string",
|
|
"description": "Input. A namespace this pipeline belongs to.\nCauses error if user is not authorized to access the specified namespace.\nIf not specified in CreatePipeline, default namespace is used."
|
|
},
|
|
"error": {
|
|
"$ref": "#/definitions/googlerpcStatus",
|
|
"description": "In case any error happens retrieving a pipeline field, only pipeline ID,\nand the error message is returned. Client has the flexibility of choosing\nhow to handle the error. This is especially useful during listing call."
|
|
}
|
|
}
|
|
},
|
|
"v2beta1PipelineVersion": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pipeline_id": {
|
|
"type": "string",
|
|
"description": "Required input field. Unique ID of the parent pipeline."
|
|
},
|
|
"pipeline_version_id": {
|
|
"type": "string",
|
|
"description": "Output. Unique pipeline version ID. Generated by API server."
|
|
},
|
|
"display_name": {
|
|
"type": "string",
|
|
"description": "Required input field. Pipeline version name provided by user."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional input field. Short description of the pipeline version."
|
|
},
|
|
"created_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output. Creation time of the pipeline version."
|
|
},
|
|
"package_url": {
|
|
"$ref": "#/definitions/v2beta1Url",
|
|
"description": "Input. Required. The URL to the source of the pipeline version.\nThis is required when creating the pipeine version through\nCreatePipelineVersion API."
|
|
},
|
|
"code_source_url": {
|
|
"type": "string",
|
|
"description": "Input. Optional. The URL to the code source of the pipeline version.\nThe code is usually the Python definition of the pipeline and potentially\nrelated the component definitions. This allows users to trace back to how\nthe pipeline YAML was created."
|
|
},
|
|
"pipeline_spec": {
|
|
"type": "object",
|
|
"description": "Output. The pipeline spec for the pipeline version."
|
|
},
|
|
"error": {
|
|
"$ref": "#/definitions/googlerpcStatus",
|
|
"description": "In case any error happens retrieving a pipeline version field, only\npipeline ID, pipeline version ID, and the error message are returned. \nClient has the flexibility of choosing how to handle the error. \nThis is especially useful during List() calls."
|
|
}
|
|
}
|
|
},
|
|
"v2beta1Url": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pipeline_url": {
|
|
"type": "string",
|
|
"description": "URL of the pipeline version definition."
|
|
}
|
|
}
|
|
},
|
|
"googlerpcStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]."
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
|
|
},
|
|
"details": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/protobufAny"
|
|
},
|
|
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
|
|
}
|
|
},
|
|
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors)."
|
|
},
|
|
"protobufAny": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type_url": {
|
|
"type": "string",
|
|
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"format": "byte",
|
|
"description": "Must be a valid serialized protocol buffer of the above specified type."
|
|
}
|
|
},
|
|
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := \u0026pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }"
|
|
}
|
|
},
|
|
"securityDefinitions": {
|
|
"Bearer": {
|
|
"type": "apiKey",
|
|
"name": "authorization",
|
|
"in": "header"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
]
|
|
}
|