diff --git a/Makefile b/Makefile index 04155bf1..631da3a8 100644 --- a/Makefile +++ b/Makefile @@ -21,6 +21,7 @@ include hack/make/dep_gomajor.mk include hack/make/dep_goreleaser.mk include hack/make/dep_gotestsum.mk include hack/make/dep_hugo.mk +include hack/make/dep_jq.mk include hack/make/dep_mockgen.mk include hack/make/dep_temporal_cli.mk @@ -87,6 +88,15 @@ lint: $(GOLANGCI_LINT) # @HELP Lints the code using golangci-lint. gen-goa: $(GOA) # @HELP Generates Goa assets. goa gen github.com/artefactual-labs/enduro/internal/api/design -o internal/api + @$(MAKE) gen-goa-json-pretty + +gen-goa-json-pretty: goa_http_dir = "internal/api/gen/http" +gen-goa-json-pretty: json_files = $(shell find $(goa_http_dir) -type f -name "*.json" | sort -u) +gen-goa-json-pretty: $(JQ) + @for f in $(json_files); \ + do (cat "$$f" | jq -S '.' >> "$$f".sorted && mv "$$f".sorted "$$f") \ + && echo "Formatting $$f with jq" || exit 1; \ + done clean: # @HELP Cleans temporary files. rm -rf ./build ./dist diff --git a/hack/make/dep_jq.mk b/hack/make/dep_jq.mk new file mode 100644 index 00000000..39ad3e5b --- /dev/null +++ b/hack/make/dep_jq.mk @@ -0,0 +1,32 @@ +$(call _assert_var,MAKEDIR) +$(call _conditional_include,$(MAKEDIR)/base.mk) +$(call _assert_var,UNAME_OS) +$(call _assert_var,UNAME_ARCH) +$(call _assert_var,CACHE_VERSIONS) +$(call _assert_var,CACHE_BIN) + +JQ_VERSION ?= 1.6 + +ifeq ($(UNAME_OS),Darwin) +JQ_OS := osx +JQ_ARCH := -amd64 +endif + +ifeq ($(UNAME_ARCH),x86_64) +ifeq ($(UNAME_OS),Linux) +JQ_OS := linux +JQ_ARCH := 64 +endif +endif + +JQ := $(CACHE_VERSIONS)/jq/$(JQ_VERSION) +$(JQ): + @rm -f $(CACHE_BIN)/jq + @mkdir -p $(CACHE_BIN) + @curl -sSL \ + https://github.com/stedolan/jq/releases/download/jq-$(JQ_VERSION)/jq-$(JQ_OS)$(JQ_ARCH) \ + -o $(CACHE_BIN)/jq + @chmod +x $(CACHE_BIN)/jq + @rm -rf $(dir $(JQ)) + @mkdir -p $(dir $(JQ)) + @touch $(JQ) diff --git a/internal/api/design/collection.go b/internal/api/design/collection.go index f5510ea6..3d33d712 100644 --- a/internal/api/design/collection.go +++ b/internal/api/design/collection.go @@ -21,20 +21,16 @@ var _ = Service("collection", func() { Payload(func() { Attribute("name", String) Attribute("original_id", String) - Attribute("transfer_id", String, func() { - Format(FormatUUID) - }) - Attribute("aip_id", String, func() { - Format(FormatUUID) - }) - Attribute("pipeline_id", String, func() { - Format(FormatUUID) - }) + AttributeUUID("transfer_id", "Identifier of Archivematica tranfser") + AttributeUUID("aip_id", "Identifier of Archivematica AIP") + AttributeUUID("pipeline_id", "Identifier of Archivematica pipeline") Attribute("earliest_created_time", String, func() { Format(FormatDateTime) + Example("e1d563b0-1474-4155-beed-f2d3a12e1529") }) Attribute("latest_created_time", String, func() { Format(FormatDateTime) + Example("e1d563b0-1474-4155-beed-f2d3a12e1529") }) Attribute("status", String, func() { EnumCollectionStatus() @@ -217,22 +213,12 @@ var Collection = Type("Collection", func() { EnumCollectionStatus() Default("new") }) - Attribute("workflow_id", String, "Identifier of processing workflow", func() { - Format(FormatUUID) - }) - Attribute("run_id", String, "Identifier of latest processing workflow run", func() { - Format(FormatUUID) - }) - Attribute("transfer_id", String, "Identifier of Archivematica transfer", func() { - Format(FormatUUID) - }) - Attribute("aip_id", String, "Identifier of Archivematica AIP", func() { - Format(FormatUUID) - }) + AttributeUUID("workflow_id", "Identifier of processing workflow") + AttributeUUID("run_id", "Identifier of latest processing workflow run") + AttributeUUID("transfer_id", "Identifier of Archivematica tranfser") + AttributeUUID("aip_id", "Identifier of Archivematica AIP") Attribute("original_id", String, "Identifier provided by the client") - Attribute("pipeline_id", String, "Identifier of Archivematica pipeline", func() { - Format(FormatUUID) - }) + AttributeUUID("pipeline_id", "Identifier of Archivematica pipeline") Attribute("created_at", String, "Creation datetime", func() { Format(FormatDateTime) }) diff --git a/internal/api/design/design.go b/internal/api/design/design.go index 319af397..359ee1f7 100644 --- a/internal/api/design/design.go +++ b/internal/api/design/design.go @@ -10,11 +10,13 @@ package design import ( . "goa.design/goa/v3/dsl" + "goa.design/goa/v3/expr" cors "goa.design/plugins/v3/cors/dsl" ) var _ = API("enduro", func() { Title("Enduro API") + Randomizer(expr.NewDeterministicRandomizer()) Server("enduro", func() { Services("pipeline", "batch", "collection", "swagger") Host("localhost", func() { diff --git a/internal/api/design/pipeline.go b/internal/api/design/pipeline.go index 0ea16acc..65e93e3c 100644 --- a/internal/api/design/pipeline.go +++ b/internal/api/design/pipeline.go @@ -28,7 +28,7 @@ var _ = Service("pipeline", func() { Method("show", func() { Description("Show pipeline by ID") Payload(func() { - Attribute("id", String, "Identifier of pipeline to show", func() { Format(FormatUUID) }) + AttributeUUID("id", "Identifier of pipeline to show") Required("id") }) Result(StoredPipeline) @@ -42,7 +42,7 @@ var _ = Service("pipeline", func() { Method("processing", func() { Description("List all processing configurations of a pipeline given its ID") Payload(func() { - Attribute("id", String, "Identifier of pipeline", func() { Format(FormatUUID) }) + AttributeUUID("id", "Identifier of pipeline") Required("id") }) Result(ArrayOf(String)) @@ -57,7 +57,7 @@ var _ = Service("pipeline", func() { var Pipeline = Type("Pipeline", func() { Description("Pipeline describes an Archivematica pipeline.") - Attribute("id", String, "Identifier of the pipeline", func() { Format(FormatUUID) }) + AttributeUUID("id", "Identifier of pipeline") Attribute("name", String, "Name of the pipeline") Attribute("capacity", Int64, "Maximum concurrent transfers") Attribute("current", Int64, "Current transfers") diff --git a/internal/api/design/uuid.go b/internal/api/design/uuid.go new file mode 100644 index 00000000..98f6c561 --- /dev/null +++ b/internal/api/design/uuid.go @@ -0,0 +1,34 @@ +// # UUID attributes +// +// Use [AttributeUUID] or [TypedAttributeUUID] to declare UUID attributes. +// +// These attributes produce consistent example UUIDs. +package design + +import ( + . "goa.design/goa/v3/dsl" +) + +// AttributeUUID describes a string typed field that must be a valid UUID. +// The desc is a short description of the field's purpose. +// +// AttributeUUID's example value is a deterministic UUID. +func AttributeUUID(name, desc string) { + Attribute(name, String, desc, func() { + Format(FormatUUID) + Example("d1845cb6-a5ea-474a-9ab8-26f9bcd919f5") + }) +} + +// TypedAttributeUUID describes a [uuid.UUID] typed field. The desc is a short +// description of the field's purpose. +// +// TypedAttributeUUID's example value is a deterministic UUID. +// +// [uuid.UUID]: https://github.com/google/uuid +func TypedAttributeUUID(name, desc string) { + Attribute(name, String, desc, func() { + Meta("struct:field:type", "uuid.UUID", "github.com/google/uuid") + Example("d1845cb6-a5ea-474a-9ab8-26f9bcd919f5") + }) +} diff --git a/internal/api/gen/collection/service.go b/internal/api/gen/collection/service.go index 02a00e05..466bf4b3 100644 --- a/internal/api/gen/collection/service.go +++ b/internal/api/gen/collection/service.go @@ -177,7 +177,7 @@ type EnduroStoredCollection struct { WorkflowID *string // Identifier of latest processing workflow run RunID *string - // Identifier of Archivematica transfer + // Identifier of Archivematica tranfser TransferID *string // Identifier of Archivematica AIP AipID *string @@ -197,10 +197,13 @@ type EnduroStoredCollectionCollection []*EnduroStoredCollection // ListPayload is the payload type of the collection service list method. type ListPayload struct { - Name *string - OriginalID *string - TransferID *string - AipID *string + Name *string + OriginalID *string + // Identifier of Archivematica tranfser + TransferID *string + // Identifier of Archivematica AIP + AipID *string + // Identifier of Archivematica pipeline PipelineID *string EarliestCreatedTime *string LatestCreatedTime *string diff --git a/internal/api/gen/collection/views/view.go b/internal/api/gen/collection/views/view.go index 2da7a302..386404e3 100644 --- a/internal/api/gen/collection/views/view.go +++ b/internal/api/gen/collection/views/view.go @@ -62,7 +62,7 @@ type EnduroStoredCollectionView struct { WorkflowID *string // Identifier of latest processing workflow run RunID *string - // Identifier of Archivematica transfer + // Identifier of Archivematica tranfser TransferID *string // Identifier of Archivematica AIP AipID *string diff --git a/internal/api/gen/http/batch/client/cli.go b/internal/api/gen/http/batch/client/cli.go index 8c4520fa..5b1b3d06 100644 --- a/internal/api/gen/http/batch/client/cli.go +++ b/internal/api/gen/http/batch/client/cli.go @@ -23,7 +23,7 @@ func BuildSubmitPayload(batchSubmitBody string) (*batch.SubmitPayload, error) { { err = json.Unmarshal([]byte(batchSubmitBody), &body) if err != nil { - return nil, fmt.Errorf("invalid JSON for body, \nerror: %s, \nexample of valid JSON:\n%s", err, "'{\n \"completed_dir\": \"Laboriosam odit.\",\n \"path\": \"Laboriosam nam sit nihil.\",\n \"pipeline\": \"Necessitatibus vel aut deleniti quia qui.\",\n \"processing_config\": \"Vel voluptatem.\",\n \"retention_period\": \"Sed perferendis illum illum omnis et officiis.\"\n }'") + return nil, fmt.Errorf("invalid JSON for body, \nerror: %s, \nexample of valid JSON:\n%s", err, "'{\n \"completed_dir\": \"abc123\",\n \"path\": \"abc123\",\n \"pipeline\": \"abc123\",\n \"processing_config\": \"abc123\",\n \"retention_period\": \"abc123\"\n }'") } } v := &batch.SubmitPayload{ diff --git a/internal/api/gen/http/cli/enduro/cli.go b/internal/api/gen/http/cli/enduro/cli.go index 68757e18..80a40b9b 100644 --- a/internal/api/gen/http/cli/enduro/cli.go +++ b/internal/api/gen/http/cli/enduro/cli.go @@ -33,13 +33,13 @@ collection (monitor|list|show|delete|cancel|retry|workflow|download|decide|bulk| // UsageExamples produces an example of a valid invocation of the CLI tool. func UsageExamples() string { - return os.Args[0] + ` pipeline list --name "Similique iure nulla voluptatem." --status true` + "\n" + + return os.Args[0] + ` pipeline list --name "abc123" --status false` + "\n" + os.Args[0] + ` batch submit --body '{ - "completed_dir": "Laboriosam odit.", - "path": "Laboriosam nam sit nihil.", - "pipeline": "Necessitatibus vel aut deleniti quia qui.", - "processing_config": "Vel voluptatem.", - "retention_period": "Sed perferendis illum illum omnis et officiis." + "completed_dir": "abc123", + "path": "abc123", + "pipeline": "abc123", + "processing_config": "abc123", + "retention_period": "abc123" }'` + "\n" + os.Args[0] + ` collection monitor` + "\n" + "" @@ -357,7 +357,7 @@ List all known pipelines -status BOOL: Example: - %[1]s pipeline list --name "Similique iure nulla voluptatem." --status true + %[1]s pipeline list --name "abc123" --status false `, os.Args[0]) } @@ -368,7 +368,7 @@ Show pipeline by ID -id STRING: Identifier of pipeline to show Example: - %[1]s pipeline show --id "74c7cd57-1fd2-11ee-b6e1-7085c27bdeb0" + %[1]s pipeline show --id "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" `, os.Args[0]) } @@ -379,7 +379,7 @@ List all processing configurations of a pipeline given its ID -id STRING: Identifier of pipeline Example: - %[1]s pipeline processing --id "74c7e375-1fd2-11ee-b6e1-7085c27bdeb0" + %[1]s pipeline processing --id "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" `, os.Args[0]) } @@ -406,11 +406,11 @@ Submit a new batch Example: %[1]s batch submit --body '{ - "completed_dir": "Laboriosam odit.", - "path": "Laboriosam nam sit nihil.", - "pipeline": "Necessitatibus vel aut deleniti quia qui.", - "processing_config": "Vel voluptatem.", - "retention_period": "Sed perferendis illum illum omnis et officiis." + "completed_dir": "abc123", + "path": "abc123", + "pipeline": "abc123", + "processing_config": "abc123", + "retention_period": "abc123" }' `, os.Args[0]) } @@ -484,7 +484,7 @@ List all stored collections -cursor STRING: Example: - %[1]s collection list --name "Repellat deleniti ea tenetur." --original-id "Vel laudantium eos fugiat iure sit ea." --transfer-id "74c68231-1fd2-11ee-b6e1-7085c27bdeb0" --aip-id "74c683f1-1fd2-11ee-b6e1-7085c27bdeb0" --pipeline-id "74c685b0-1fd2-11ee-b6e1-7085c27bdeb0" --earliest-created-time "1992-05-18T16:02:20Z" --latest-created-time "1994-06-12T03:33:17Z" --status "done" --cursor "Sapiente sit." + %[1]s collection list --name "abc123" --original-id "abc123" --transfer-id "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" --aip-id "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" --pipeline-id "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" --earliest-created-time "e1d563b0-1474-4155-beed-f2d3a12e1529" --latest-created-time "e1d563b0-1474-4155-beed-f2d3a12e1529" --status "in progress" --cursor "abc123" `, os.Args[0]) } @@ -495,7 +495,7 @@ Show collection by ID -id UINT: Identifier of collection to show Example: - %[1]s collection show --id 17063791353006889558 + %[1]s collection show --id 1 `, os.Args[0]) } @@ -506,7 +506,7 @@ Delete collection by ID -id UINT: Identifier of collection to delete Example: - %[1]s collection delete --id 14411764229641892412 + %[1]s collection delete --id 1 `, os.Args[0]) } @@ -517,7 +517,7 @@ Cancel collection processing by ID -id UINT: Identifier of collection to remove Example: - %[1]s collection cancel --id 12015603943555843617 + %[1]s collection cancel --id 1 `, os.Args[0]) } @@ -528,7 +528,7 @@ Retry collection processing by ID -id UINT: Identifier of collection to retry Example: - %[1]s collection retry --id 8981087617134091722 + %[1]s collection retry --id 1 `, os.Args[0]) } @@ -539,7 +539,7 @@ Retrieve workflow status by ID -id UINT: Identifier of collection to look up Example: - %[1]s collection workflow --id 12987742219284422823 + %[1]s collection workflow --id 1 `, os.Args[0]) } @@ -550,7 +550,7 @@ Download collection by ID -id UINT: Identifier of collection to look up Example: - %[1]s collection download --id 1583021165426467133 + %[1]s collection download --id 1 `, os.Args[0]) } @@ -563,8 +563,8 @@ Make decision for a pending collection by ID Example: %[1]s collection decide --body '{ - "option": "Minus explicabo." - }' --id 986738297372180432 + "option": "abc123" + }' --id 1 `, os.Args[0]) } @@ -576,9 +576,9 @@ Bulk operations (retry, cancel...). Example: %[1]s collection bulk --body '{ - "operation": "retry", - "size": 4225703995272354524, - "status": "new" + "operation": "cancel", + "size": 1, + "status": "in progress" }' `, os.Args[0]) } diff --git a/internal/api/gen/http/collection/client/cli.go b/internal/api/gen/http/collection/client/cli.go index ac4e3a1b..3422d40b 100644 --- a/internal/api/gen/http/collection/client/cli.go +++ b/internal/api/gen/http/collection/client/cli.go @@ -240,7 +240,7 @@ func BuildDecidePayload(collectionDecideBody string, collectionDecideID string) { err = json.Unmarshal([]byte(collectionDecideBody), &body) if err != nil { - return nil, fmt.Errorf("invalid JSON for body, \nerror: %s, \nexample of valid JSON:\n%s", err, "'{\n \"option\": \"Minus explicabo.\"\n }'") + return nil, fmt.Errorf("invalid JSON for body, \nerror: %s, \nexample of valid JSON:\n%s", err, "'{\n \"option\": \"abc123\"\n }'") } } var id uint @@ -269,7 +269,7 @@ func BuildBulkPayload(collectionBulkBody string) (*collection.BulkPayload, error { err = json.Unmarshal([]byte(collectionBulkBody), &body) if err != nil { - return nil, fmt.Errorf("invalid JSON for body, \nerror: %s, \nexample of valid JSON:\n%s", err, "'{\n \"operation\": \"retry\",\n \"size\": 4225703995272354524,\n \"status\": \"new\"\n }'") + return nil, fmt.Errorf("invalid JSON for body, \nerror: %s, \nexample of valid JSON:\n%s", err, "'{\n \"operation\": \"cancel\",\n \"size\": 1,\n \"status\": \"in progress\"\n }'") } if !(body.Operation == "retry" || body.Operation == "cancel" || body.Operation == "abandon") { err = goa.MergeErrors(err, goa.InvalidEnumValueError("body.operation", body.Operation, []any{"retry", "cancel", "abandon"})) diff --git a/internal/api/gen/http/collection/client/types.go b/internal/api/gen/http/collection/client/types.go index 811a9a4d..4d54646c 100644 --- a/internal/api/gen/http/collection/client/types.go +++ b/internal/api/gen/http/collection/client/types.go @@ -53,7 +53,7 @@ type ShowResponseBody struct { WorkflowID *string `form:"workflow_id,omitempty" json:"workflow_id,omitempty" xml:"workflow_id,omitempty"` // Identifier of latest processing workflow run RunID *string `form:"run_id,omitempty" json:"run_id,omitempty" xml:"run_id,omitempty"` - // Identifier of Archivematica transfer + // Identifier of Archivematica tranfser TransferID *string `form:"transfer_id,omitempty" json:"transfer_id,omitempty" xml:"transfer_id,omitempty"` // Identifier of Archivematica AIP AipID *string `form:"aip_id,omitempty" json:"aip_id,omitempty" xml:"aip_id,omitempty"` @@ -260,7 +260,7 @@ type EnduroStoredCollectionResponseBody struct { WorkflowID *string `form:"workflow_id,omitempty" json:"workflow_id,omitempty" xml:"workflow_id,omitempty"` // Identifier of latest processing workflow run RunID *string `form:"run_id,omitempty" json:"run_id,omitempty" xml:"run_id,omitempty"` - // Identifier of Archivematica transfer + // Identifier of Archivematica tranfser TransferID *string `form:"transfer_id,omitempty" json:"transfer_id,omitempty" xml:"transfer_id,omitempty"` // Identifier of Archivematica AIP AipID *string `form:"aip_id,omitempty" json:"aip_id,omitempty" xml:"aip_id,omitempty"` diff --git a/internal/api/gen/http/collection/server/types.go b/internal/api/gen/http/collection/server/types.go index 028fc5d7..86a9bec1 100644 --- a/internal/api/gen/http/collection/server/types.go +++ b/internal/api/gen/http/collection/server/types.go @@ -53,7 +53,7 @@ type ShowResponseBody struct { WorkflowID *string `form:"workflow_id,omitempty" json:"workflow_id,omitempty" xml:"workflow_id,omitempty"` // Identifier of latest processing workflow run RunID *string `form:"run_id,omitempty" json:"run_id,omitempty" xml:"run_id,omitempty"` - // Identifier of Archivematica transfer + // Identifier of Archivematica tranfser TransferID *string `form:"transfer_id,omitempty" json:"transfer_id,omitempty" xml:"transfer_id,omitempty"` // Identifier of Archivematica AIP AipID *string `form:"aip_id,omitempty" json:"aip_id,omitempty" xml:"aip_id,omitempty"` @@ -260,7 +260,7 @@ type EnduroStoredCollectionResponseBody struct { WorkflowID *string `form:"workflow_id,omitempty" json:"workflow_id,omitempty" xml:"workflow_id,omitempty"` // Identifier of latest processing workflow run RunID *string `form:"run_id,omitempty" json:"run_id,omitempty" xml:"run_id,omitempty"` - // Identifier of Archivematica transfer + // Identifier of Archivematica tranfser TransferID *string `form:"transfer_id,omitempty" json:"transfer_id,omitempty" xml:"transfer_id,omitempty"` // Identifier of Archivematica AIP AipID *string `form:"aip_id,omitempty" json:"aip_id,omitempty" xml:"aip_id,omitempty"` diff --git a/internal/api/gen/http/openapi.json b/internal/api/gen/http/openapi.json index 254761a3..17bf17c7 100644 --- a/internal/api/gen/http/openapi.json +++ b/internal/api/gen/http/openapi.json @@ -1 +1,2053 @@ -{"swagger":"2.0","info":{"title":"Enduro API","version":""},"host":"localhost:9000","consumes":["application/json","application/xml","application/gob"],"produces":["application/json","application/xml","application/gob"],"paths":{"/batch":{"get":{"tags":["batch"],"summary":"status batch","description":"Retrieve status of current batch operation.","operationId":"batch#status","responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/BatchStatusResponseBody","required":["running"]}}},"schemes":["http"]},"post":{"tags":["batch"],"summary":"submit batch","description":"Submit a new batch","operationId":"batch#submit","parameters":[{"name":"SubmitRequestBody","in":"body","required":true,"schema":{"$ref":"#/definitions/BatchSubmitRequestBody","required":["path"]}}],"responses":{"202":{"description":"Accepted response.","schema":{"$ref":"#/definitions/BatchSubmitResponseBody","required":["workflow_id","run_id"]}},"400":{"description":"Bad Request response.","schema":{"$ref":"#/definitions/BatchSubmitNotValidResponseBody"}},"409":{"description":"Conflict response.","schema":{"$ref":"#/definitions/BatchSubmitNotAvailableResponseBody"}}},"schemes":["http"]}},"/batch/hints":{"get":{"tags":["batch"],"summary":"hints batch","description":"Retrieve form hints","operationId":"batch#hints","responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/BatchHintsResponseBody"}}},"schemes":["http"]}},"/collection":{"get":{"tags":["collection"],"summary":"list collection","description":"List all stored collections","operationId":"collection#list","parameters":[{"name":"name","in":"query","required":false,"type":"string"},{"name":"original_id","in":"query","required":false,"type":"string"},{"name":"transfer_id","in":"query","required":false,"type":"string","format":"uuid"},{"name":"aip_id","in":"query","required":false,"type":"string","format":"uuid"},{"name":"pipeline_id","in":"query","required":false,"type":"string","format":"uuid"},{"name":"earliest_created_time","in":"query","required":false,"type":"string","format":"date-time"},{"name":"latest_created_time","in":"query","required":false,"type":"string","format":"date-time"},{"name":"status","in":"query","required":false,"type":"string","enum":["new","in progress","done","error","unknown","queued","pending","abandoned"]},{"name":"cursor","in":"query","description":"Pagination cursor","required":false,"type":"string"}],"responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/CollectionListResponseBody","required":["items"]}}},"schemes":["http"]}},"/collection/bulk":{"get":{"tags":["collection"],"summary":"bulk_status collection","description":"Retrieve status of current bulk operation.","operationId":"collection#bulk_status","responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/CollectionBulkStatusResponseBody","required":["running"]}}},"schemes":["http"]},"post":{"tags":["collection"],"summary":"bulk collection","description":"Bulk operations (retry, cancel...).","operationId":"collection#bulk","parameters":[{"name":"BulkRequestBody","in":"body","required":true,"schema":{"$ref":"#/definitions/CollectionBulkRequestBody","required":["operation","status"]}}],"responses":{"202":{"description":"Accepted response.","schema":{"$ref":"#/definitions/CollectionBulkResponseBody","required":["workflow_id","run_id"]}},"400":{"description":"Bad Request response.","schema":{"$ref":"#/definitions/CollectionBulkNotValidResponseBody"}},"409":{"description":"Conflict response.","schema":{"$ref":"#/definitions/CollectionBulkNotAvailableResponseBody"}}},"schemes":["http"]}},"/collection/monitor":{"get":{"tags":["collection"],"summary":"monitor collection","operationId":"collection#monitor","responses":{"101":{"description":"Switching Protocols response.","schema":{"$ref":"#/definitions/CollectionMonitorResponseBody"}}},"schemes":["ws"]}},"/collection/{id}":{"get":{"tags":["collection"],"summary":"show collection","description":"Show collection by ID","operationId":"collection#show","parameters":[{"name":"id","in":"path","description":"Identifier of collection to show","required":true,"type":"integer"}],"responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/CollectionShowResponseBody"}},"404":{"description":"Not Found response.","schema":{"$ref":"#/definitions/CollectionShowNotFoundResponseBody","required":["message","id"]}}},"schemes":["http"]},"delete":{"tags":["collection"],"summary":"delete collection","description":"Delete collection by ID","operationId":"collection#delete","parameters":[{"name":"id","in":"path","description":"Identifier of collection to delete","required":true,"type":"integer"}],"responses":{"204":{"description":"No Content response."},"404":{"description":"Not Found response.","schema":{"$ref":"#/definitions/CollectionDeleteNotFoundResponseBody","required":["message","id"]}}},"schemes":["http"]}},"/collection/{id}/cancel":{"post":{"tags":["collection"],"summary":"cancel collection","description":"Cancel collection processing by ID","operationId":"collection#cancel","parameters":[{"name":"id","in":"path","description":"Identifier of collection to remove","required":true,"type":"integer"}],"responses":{"200":{"description":"OK response."},"400":{"description":"Bad Request response.","schema":{"$ref":"#/definitions/CollectionCancelNotRunningResponseBody"}},"404":{"description":"Not Found response.","schema":{"$ref":"#/definitions/CollectionCancelNotFoundResponseBody","required":["message","id"]}}},"schemes":["http"]}},"/collection/{id}/decision":{"post":{"tags":["collection"],"summary":"decide collection","description":"Make decision for a pending collection by ID","operationId":"collection#decide","parameters":[{"name":"id","in":"path","description":"Identifier of collection to look up","required":true,"type":"integer"},{"name":"object","in":"body","required":true,"schema":{"type":"object","properties":{"option":{"type":"string","description":"Decision option to proceed with","example":"Iure sunt fugiat voluptate."}}}}],"responses":{"200":{"description":"OK response."},"400":{"description":"Bad Request response.","schema":{"$ref":"#/definitions/CollectionDecideNotValidResponseBody"}},"404":{"description":"Not Found response.","schema":{"$ref":"#/definitions/CollectionDecideNotFoundResponseBody","required":["message","id"]}}},"schemes":["http"]}},"/collection/{id}/download":{"get":{"tags":["collection"],"summary":"download collection","description":"Download collection by ID","operationId":"collection#download","parameters":[{"name":"id","in":"path","description":"Identifier of collection to look up","required":true,"type":"integer"}],"responses":{"200":{"description":"OK response.","headers":{"Content-Disposition":{"type":"string"},"Content-Length":{"type":"int64"},"Content-Type":{"type":"string"}}},"404":{"description":"Not Found response.","schema":{"$ref":"#/definitions/CollectionDownloadNotFoundResponseBody","required":["message","id"]}}},"schemes":["http"]}},"/collection/{id}/retry":{"post":{"tags":["collection"],"summary":"retry collection","description":"Retry collection processing by ID","operationId":"collection#retry","parameters":[{"name":"id","in":"path","description":"Identifier of collection to retry","required":true,"type":"integer"}],"responses":{"200":{"description":"OK response."},"400":{"description":"Bad Request response.","schema":{"$ref":"#/definitions/CollectionRetryNotRunningResponseBody"}},"404":{"description":"Not Found response.","schema":{"$ref":"#/definitions/CollectionRetryNotFoundResponseBody","required":["message","id"]}}},"schemes":["http"]}},"/collection/{id}/workflow":{"get":{"tags":["collection"],"summary":"workflow collection","description":"Retrieve workflow status by ID","operationId":"collection#workflow","parameters":[{"name":"id","in":"path","description":"Identifier of collection to look up","required":true,"type":"integer"}],"responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/CollectionWorkflowResponseBody"}},"404":{"description":"Not Found response.","schema":{"$ref":"#/definitions/CollectionWorkflowNotFoundResponseBody","required":["message","id"]}}},"schemes":["http"]}},"/pipeline":{"get":{"tags":["pipeline"],"summary":"list pipeline","description":"List all known pipelines","operationId":"pipeline#list","parameters":[{"name":"name","in":"query","required":false,"type":"string"},{"name":"status","in":"query","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK response.","schema":{"type":"array","items":{"$ref":"#/definitions/EnduroStoredPipelineResponse"}}}},"schemes":["http"]}},"/pipeline/{id}":{"get":{"tags":["pipeline"],"summary":"show pipeline","description":"Show pipeline by ID","operationId":"pipeline#show","parameters":[{"name":"id","in":"path","description":"Identifier of pipeline to show","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/PipelineShowResponseBody"}},"404":{"description":"Not Found response.","schema":{"$ref":"#/definitions/PipelineShowNotFoundResponseBody","required":["message","id"]}}},"schemes":["http"]}},"/pipeline/{id}/processing":{"get":{"tags":["pipeline"],"summary":"processing pipeline","description":"List all processing configurations of a pipeline given its ID","operationId":"pipeline#processing","parameters":[{"name":"id","in":"path","description":"Identifier of pipeline","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"OK response.","schema":{"type":"array","items":{"type":"string","example":"Suscipit distinctio."}}},"404":{"description":"Not Found response.","schema":{"$ref":"#/definitions/PipelineProcessingNotFoundResponseBody","required":["message","id"]}}},"schemes":["http"]}},"/swagger/swagger.json":{"get":{"tags":["swagger"],"summary":"Download internal/api/gen/http/openapi.json","description":"JSON document containing the API swagger definition.","operationId":"swagger#/swagger/swagger.json","responses":{"200":{"description":"File downloaded","schema":{"type":"file"}}},"schemes":["http"]}}},"definitions":{"BatchHintsResponseBody":{"title":"BatchHintsResponseBody","type":"object","properties":{"completed_dirs":{"type":"array","items":{"type":"string","example":"Ab est sed reiciendis ipsum."},"description":"A list of known values of completedDir used by existing watchers.","example":["Saepe quibusdam aut magnam itaque.","Dolor quo.","Vitae suscipit.","Ullam cumque recusandae quae porro corporis."]}},"example":{"completed_dirs":["Rerum voluptatem non quas.","Eos ut ipsum et.","Expedita asperiores et.","Ut quia ut commodi."]}},"BatchStatusResponseBody":{"title":"BatchStatusResponseBody","type":"object","properties":{"run_id":{"type":"string","example":"Tempore nostrum aliquid fugiat optio consequatur."},"running":{"type":"boolean","example":true},"status":{"type":"string","example":"Accusamus possimus fuga esse."},"workflow_id":{"type":"string","example":"Aut itaque et."}},"example":{"run_id":"Enim fuga quam aut sit.","running":true,"status":"Corrupti veniam maiores ducimus in.","workflow_id":"Et laboriosam qui."},"required":["running"]},"BatchSubmitNotAvailableResponseBody":{"title":"Mediatype identifier: application/vnd.goa.error; view=default","type":"object","properties":{"fault":{"type":"boolean","description":"Is the error a server-side fault?","example":true},"id":{"type":"string","description":"ID is a unique identifier for this particular occurrence of the problem.","example":"123abc"},"message":{"type":"string","description":"Message is a human-readable explanation specific to this occurrence of the problem.","example":"parameter 'p' must be an integer"},"name":{"type":"string","description":"Name is the name of this class of errors.","example":"bad_request"},"temporary":{"type":"boolean","description":"Is the error temporary?","example":true},"timeout":{"type":"boolean","description":"Is the error a timeout?","example":true}},"description":"submit_not_available_response_body result type (default view)","example":{"fault":true,"id":"123abc","message":"parameter 'p' must be an integer","name":"bad_request","temporary":false,"timeout":false},"required":["name","id","message","temporary","timeout","fault"]},"BatchSubmitNotValidResponseBody":{"title":"Mediatype identifier: application/vnd.goa.error; view=default","type":"object","properties":{"fault":{"type":"boolean","description":"Is the error a server-side fault?","example":true},"id":{"type":"string","description":"ID is a unique identifier for this particular occurrence of the problem.","example":"123abc"},"message":{"type":"string","description":"Message is a human-readable explanation specific to this occurrence of the problem.","example":"parameter 'p' must be an integer"},"name":{"type":"string","description":"Name is the name of this class of errors.","example":"bad_request"},"temporary":{"type":"boolean","description":"Is the error temporary?","example":false},"timeout":{"type":"boolean","description":"Is the error a timeout?","example":false}},"description":"submit_not_valid_response_body result type (default view)","example":{"fault":true,"id":"123abc","message":"parameter 'p' must be an integer","name":"bad_request","temporary":false,"timeout":false},"required":["name","id","message","temporary","timeout","fault"]},"BatchSubmitRequestBody":{"title":"BatchSubmitRequestBody","type":"object","properties":{"completed_dir":{"type":"string","example":"Sit sint est qui cum nihil quis."},"path":{"type":"string","example":"Dolor quas corrupti."},"pipeline":{"type":"string","example":"Cumque qui facilis omnis."},"processing_config":{"type":"string","example":"Officia voluptate."},"retention_period":{"type":"string","example":"Sit quibusdam quidem consectetur praesentium."}},"example":{"completed_dir":"Esse consectetur aut quis accusamus enim consequatur.","path":"Aperiam velit.","pipeline":"Nobis delectus.","processing_config":"Fuga omnis corporis et sunt.","retention_period":"Consequatur natus illum."},"required":["path"]},"BatchSubmitResponseBody":{"title":"BatchSubmitResponseBody","type":"object","properties":{"run_id":{"type":"string","example":"Iste dolorem."},"workflow_id":{"type":"string","example":"Est iure optio suscipit."}},"example":{"run_id":"Quidem aliquam fuga laborum maiores et.","workflow_id":"Maxime dicta."},"required":["workflow_id","run_id"]},"CollectionBulkNotAvailableResponseBody":{"title":"Mediatype identifier: application/vnd.goa.error; view=default","type":"object","properties":{"fault":{"type":"boolean","description":"Is the error a server-side fault?","example":true},"id":{"type":"string","description":"ID is a unique identifier for this particular occurrence of the problem.","example":"123abc"},"message":{"type":"string","description":"Message is a human-readable explanation specific to this occurrence of the problem.","example":"parameter 'p' must be an integer"},"name":{"type":"string","description":"Name is the name of this class of errors.","example":"bad_request"},"temporary":{"type":"boolean","description":"Is the error temporary?","example":true},"timeout":{"type":"boolean","description":"Is the error a timeout?","example":false}},"description":"bulk_not_available_response_body result type (default view)","example":{"fault":false,"id":"123abc","message":"parameter 'p' must be an integer","name":"bad_request","temporary":false,"timeout":false},"required":["name","id","message","temporary","timeout","fault"]},"CollectionBulkNotValidResponseBody":{"title":"Mediatype identifier: application/vnd.goa.error; view=default","type":"object","properties":{"fault":{"type":"boolean","description":"Is the error a server-side fault?","example":true},"id":{"type":"string","description":"ID is a unique identifier for this particular occurrence of the problem.","example":"123abc"},"message":{"type":"string","description":"Message is a human-readable explanation specific to this occurrence of the problem.","example":"parameter 'p' must be an integer"},"name":{"type":"string","description":"Name is the name of this class of errors.","example":"bad_request"},"temporary":{"type":"boolean","description":"Is the error temporary?","example":false},"timeout":{"type":"boolean","description":"Is the error a timeout?","example":true}},"description":"bulk_not_valid_response_body result type (default view)","example":{"fault":false,"id":"123abc","message":"parameter 'p' must be an integer","name":"bad_request","temporary":true,"timeout":false},"required":["name","id","message","temporary","timeout","fault"]},"CollectionBulkRequestBody":{"title":"CollectionBulkRequestBody","type":"object","properties":{"operation":{"type":"string","example":"abandon","enum":["retry","cancel","abandon"]},"size":{"type":"integer","default":100,"example":8206095306886416010,"format":"int64"},"status":{"type":"string","example":"abandoned","enum":["new","in progress","done","error","unknown","queued","pending","abandoned"]}},"example":{"operation":"cancel","size":18036125241233620415,"status":"unknown"},"required":["operation","status"]},"CollectionBulkResponseBody":{"title":"CollectionBulkResponseBody","type":"object","properties":{"run_id":{"type":"string","example":"Consequatur facere omnis ab nihil magni."},"workflow_id":{"type":"string","example":"Tenetur aut et occaecati harum."}},"example":{"run_id":"Quia fugiat quam iste velit explicabo.","workflow_id":"Consequatur aut adipisci doloribus quas sit vitae."},"required":["workflow_id","run_id"]},"CollectionBulkStatusResponseBody":{"title":"CollectionBulkStatusResponseBody","type":"object","properties":{"closed_at":{"type":"string","example":"2000-12-21T15:12:45Z","format":"date-time"},"run_id":{"type":"string","example":"Magni mollitia et quod aut veritatis numquam."},"running":{"type":"boolean","example":false},"started_at":{"type":"string","example":"2015-02-11T18:18:46Z","format":"date-time"},"status":{"type":"string","example":"Alias maxime architecto molestiae."},"workflow_id":{"type":"string","example":"Assumenda explicabo adipisci."}},"example":{"closed_at":"1990-07-24T22:49:26Z","run_id":"Voluptatem laborum.","running":true,"started_at":"2009-02-06T07:39:29Z","status":"Atque culpa et earum et omnis et.","workflow_id":"Voluptatibus quibusdam quibusdam voluptatem non."},"required":["running"]},"CollectionCancelNotFoundResponseBody":{"title":"CollectionCancelNotFoundResponseBody","type":"object","properties":{"id":{"type":"integer","description":"Identifier of missing collection","example":951410389815766576,"format":"int64"},"message":{"type":"string","description":"Message of error","example":"Architecto magnam asperiores tempora autem."}},"description":"Collection not found","example":{"id":7358593745880113932,"message":"Aliquid consequatur."},"required":["message","id"]},"CollectionCancelNotRunningResponseBody":{"title":"Mediatype identifier: application/vnd.goa.error; view=default","type":"object","properties":{"fault":{"type":"boolean","description":"Is the error a server-side fault?","example":false},"id":{"type":"string","description":"ID is a unique identifier for this particular occurrence of the problem.","example":"123abc"},"message":{"type":"string","description":"Message is a human-readable explanation specific to this occurrence of the problem.","example":"parameter 'p' must be an integer"},"name":{"type":"string","description":"Name is the name of this class of errors.","example":"bad_request"},"temporary":{"type":"boolean","description":"Is the error temporary?","example":false},"timeout":{"type":"boolean","description":"Is the error a timeout?","example":true}},"description":"cancel_not_running_response_body result type (default view)","example":{"fault":true,"id":"123abc","message":"parameter 'p' must be an integer","name":"bad_request","temporary":false,"timeout":true},"required":["name","id","message","temporary","timeout","fault"]},"CollectionDecideNotFoundResponseBody":{"title":"CollectionDecideNotFoundResponseBody","type":"object","properties":{"id":{"type":"integer","description":"Identifier of missing collection","example":15237653089904143505,"format":"int64"},"message":{"type":"string","description":"Message of error","example":"Accusamus distinctio omnis qui."}},"description":"Collection not found","example":{"id":2610080554516588188,"message":"Quia dolor ea."},"required":["message","id"]},"CollectionDecideNotValidResponseBody":{"title":"Mediatype identifier: application/vnd.goa.error; view=default","type":"object","properties":{"fault":{"type":"boolean","description":"Is the error a server-side fault?","example":true},"id":{"type":"string","description":"ID is a unique identifier for this particular occurrence of the problem.","example":"123abc"},"message":{"type":"string","description":"Message is a human-readable explanation specific to this occurrence of the problem.","example":"parameter 'p' must be an integer"},"name":{"type":"string","description":"Name is the name of this class of errors.","example":"bad_request"},"temporary":{"type":"boolean","description":"Is the error temporary?","example":true},"timeout":{"type":"boolean","description":"Is the error a timeout?","example":false}},"description":"decide_not_valid_response_body result type (default view)","example":{"fault":true,"id":"123abc","message":"parameter 'p' must be an integer","name":"bad_request","temporary":true,"timeout":false},"required":["name","id","message","temporary","timeout","fault"]},"CollectionDeleteNotFoundResponseBody":{"title":"CollectionDeleteNotFoundResponseBody","type":"object","properties":{"id":{"type":"integer","description":"Identifier of missing collection","example":2691854561358134026,"format":"int64"},"message":{"type":"string","description":"Message of error","example":"Consequuntur fuga nesciunt ullam quia et."}},"description":"Collection not found","example":{"id":8177308441370769,"message":"Fugit amet facilis."},"required":["message","id"]},"CollectionDownloadNotFoundResponseBody":{"title":"CollectionDownloadNotFoundResponseBody","type":"object","properties":{"id":{"type":"integer","description":"Identifier of missing collection","example":7811120016112005653,"format":"int64"},"message":{"type":"string","description":"Message of error","example":"Voluptatem et est tenetur vel assumenda natus."}},"description":"Collection not found","example":{"id":737223079499073311,"message":"Nam aliquid quos."},"required":["message","id"]},"CollectionListResponseBody":{"title":"CollectionListResponseBody","type":"object","properties":{"items":{"$ref":"#/definitions/EnduroStoredCollectionResponseBodyCollection"},"next_cursor":{"type":"string","example":"Cupiditate ipsam omnis voluptatem cum."}},"example":{"items":[{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"}],"next_cursor":"Voluptatem error adipisci vel rerum."},"required":["items"]},"CollectionMonitorResponseBody":{"title":"Mediatype identifier: application/vnd.enduro.monitor-update; view=default","type":"object","properties":{"id":{"type":"integer","description":"Identifier of collection","example":17512028379679435893,"format":"int64"},"item":{"$ref":"#/definitions/EnduroStoredCollectionResponseBody"},"type":{"type":"string","description":"Type of the event","example":"Voluptatem beatae modi omnis voluptatem et."}},"description":"MonitorResponseBody result type (default view)","example":{"id":9151525906289518085,"item":{"aip_id":"74c66505-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"1992-04-04T11:00:41Z","created_at":"2000-12-20T12:21:46Z","id":15454769769736078970,"name":"Sed tempore voluptatum quo pariatur.","original_id":"Nisi aliquid.","pipeline_id":"74c6668f-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c66289-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"2011-08-25T19:50:57Z","status":"unknown","transfer_id":"74c663d0-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c660e1-1fd2-11ee-b6e1-7085c27bdeb0"},"type":"Aliquam aliquid non tempore vel."},"required":["id","type"]},"CollectionRetryNotFoundResponseBody":{"title":"CollectionRetryNotFoundResponseBody","type":"object","properties":{"id":{"type":"integer","description":"Identifier of missing collection","example":14831543066782228698,"format":"int64"},"message":{"type":"string","description":"Message of error","example":"Id ducimus."}},"description":"Collection not found","example":{"id":8000312645361077467,"message":"Distinctio aspernatur tempora maxime omnis."},"required":["message","id"]},"CollectionRetryNotRunningResponseBody":{"title":"Mediatype identifier: application/vnd.goa.error; view=default","type":"object","properties":{"fault":{"type":"boolean","description":"Is the error a server-side fault?","example":true},"id":{"type":"string","description":"ID is a unique identifier for this particular occurrence of the problem.","example":"123abc"},"message":{"type":"string","description":"Message is a human-readable explanation specific to this occurrence of the problem.","example":"parameter 'p' must be an integer"},"name":{"type":"string","description":"Name is the name of this class of errors.","example":"bad_request"},"temporary":{"type":"boolean","description":"Is the error temporary?","example":true},"timeout":{"type":"boolean","description":"Is the error a timeout?","example":false}},"description":"retry_not_running_response_body result type (default view)","example":{"fault":true,"id":"123abc","message":"parameter 'p' must be an integer","name":"bad_request","temporary":false,"timeout":true},"required":["name","id","message","temporary","timeout","fault"]},"CollectionShowNotFoundResponseBody":{"title":"CollectionShowNotFoundResponseBody","type":"object","properties":{"id":{"type":"integer","description":"Identifier of missing collection","example":9835271868051980153,"format":"int64"},"message":{"type":"string","description":"Message of error","example":"Ipsa dolor deserunt provident provident."}},"description":"Collection not found","example":{"id":6740760545696498930,"message":"Exercitationem atque quo impedit non dicta culpa."},"required":["message","id"]},"CollectionShowResponseBody":{"title":"Mediatype identifier: application/vnd.enduro.stored-collection; view=default","type":"object","properties":{"aip_id":{"type":"string","description":"Identifier of Archivematica AIP","example":"74c85a59-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"completed_at":{"type":"string","description":"Completion datetime","example":"1995-07-06T21:57:28Z","format":"date-time"},"created_at":{"type":"string","description":"Creation datetime","example":"1982-12-23T00:51:34Z","format":"date-time"},"id":{"type":"integer","description":"Identifier of collection","example":17557787113732579557,"format":"int64"},"name":{"type":"string","description":"Name of the collection","example":"Qui numquam totam est."},"original_id":{"type":"string","description":"Identifier provided by the client","example":"Quisquam sed sed hic in."},"pipeline_id":{"type":"string","description":"Identifier of Archivematica pipeline","example":"74c85c70-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"run_id":{"type":"string","description":"Identifier of latest processing workflow run","example":"74c85669-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"started_at":{"type":"string","description":"Start datetime","example":"1977-11-02T07:18:21Z","format":"date-time"},"status":{"type":"string","description":"Status of the collection","default":"new","example":"error","enum":["new","in progress","done","error","unknown","queued","pending","abandoned"]},"transfer_id":{"type":"string","description":"Identifier of Archivematica transfer","example":"74c8584b-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"workflow_id":{"type":"string","description":"Identifier of processing workflow","example":"74c8547d-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"}},"description":"ShowResponseBody result type (default view)","example":{"aip_id":"74c86a59-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"1998-11-15T13:24:26Z","created_at":"1995-01-01T19:38:07Z","id":16726981500754704734,"name":"In laudantium vero sit debitis.","original_id":"Facere molestiae et sunt.","pipeline_id":"74c86c60-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c866c5-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1987-02-13T19:42:16Z","status":"unknown","transfer_id":"74c868a6-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c864ec-1fd2-11ee-b6e1-7085c27bdeb0"},"required":["id","status","created_at"]},"CollectionWorkflowNotFoundResponseBody":{"title":"CollectionWorkflowNotFoundResponseBody","type":"object","properties":{"id":{"type":"integer","description":"Identifier of missing collection","example":16822297729379021847,"format":"int64"},"message":{"type":"string","description":"Message of error","example":"Autem a a odit architecto quisquam nisi."}},"description":"Collection not found","example":{"id":10870541205377463360,"message":"Autem et."},"required":["message","id"]},"CollectionWorkflowResponseBody":{"title":"Mediatype identifier: application/vnd.enduro.collection-workflow-status; view=default","type":"object","properties":{"history":{"$ref":"#/definitions/EnduroCollectionWorkflowHistoryResponseBodyCollection"},"status":{"type":"string","example":"Voluptatum necessitatibus non cum earum quis."}},"description":"WorkflowResponseBody result type (default view)","example":{"history":[{"details":"Consequatur aliquam excepturi dolores dolor magnam tempore.","id":14430854591777067962,"type":"Quo ut eveniet et rerum nemo corporis."},{"details":"Consequatur aliquam excepturi dolores dolor magnam tempore.","id":14430854591777067962,"type":"Quo ut eveniet et rerum nemo corporis."},{"details":"Consequatur aliquam excepturi dolores dolor magnam tempore.","id":14430854591777067962,"type":"Quo ut eveniet et rerum nemo corporis."},{"details":"Consequatur aliquam excepturi dolores dolor magnam tempore.","id":14430854591777067962,"type":"Quo ut eveniet et rerum nemo corporis."}],"status":"Aut omnis iusto modi quis distinctio."}},"EnduroCollectionWorkflowHistoryResponseBody":{"title":"Mediatype identifier: application/vnd.enduro.collection-workflow-history; view=default","type":"object","properties":{"details":{"type":"string","description":"Contents of the event","example":"Voluptatum quibusdam.","format":"binary"},"id":{"type":"integer","description":"Identifier of collection","example":3054458866920097073,"format":"int64"},"type":{"type":"string","description":"Type of the event","example":"Id quasi dolor veritatis voluptatem."}},"description":"WorkflowHistoryEvent describes a history event in Temporal. (default view)","example":{"details":"Est aut explicabo perferendis sunt quas.","id":5532165772958537512,"type":"Animi praesentium."}},"EnduroCollectionWorkflowHistoryResponseBodyCollection":{"title":"Mediatype identifier: application/vnd.enduro.collection-workflow-history; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/EnduroCollectionWorkflowHistoryResponseBody"},"description":"EnduroCollection-Workflow-HistoryCollectionResponseBody is the result type for an array of EnduroCollection-Workflow-HistoryResponseBody (default view)","example":[{"details":"Consequatur aliquam excepturi dolores dolor magnam tempore.","id":14430854591777067962,"type":"Quo ut eveniet et rerum nemo corporis."},{"details":"Consequatur aliquam excepturi dolores dolor magnam tempore.","id":14430854591777067962,"type":"Quo ut eveniet et rerum nemo corporis."}]},"EnduroStoredCollectionResponseBody":{"title":"Mediatype identifier: application/vnd.enduro.stored-collection; view=default","type":"object","properties":{"aip_id":{"type":"string","description":"Identifier of Archivematica AIP","example":"74c831a8-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"completed_at":{"type":"string","description":"Completion datetime","example":"1970-10-15T00:03:22Z","format":"date-time"},"created_at":{"type":"string","description":"Creation datetime","example":"2007-04-29T00:55:57Z","format":"date-time"},"id":{"type":"integer","description":"Identifier of collection","example":12195178451962438920,"format":"int64"},"name":{"type":"string","description":"Name of the collection","example":"At est excepturi dignissimos."},"original_id":{"type":"string","description":"Identifier provided by the client","example":"Quis iure."},"pipeline_id":{"type":"string","description":"Identifier of Archivematica pipeline","example":"74c833c0-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"run_id":{"type":"string","description":"Identifier of latest processing workflow run","example":"74c82d7b-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"started_at":{"type":"string","description":"Start datetime","example":"1978-05-27T01:41:50Z","format":"date-time"},"status":{"type":"string","description":"Status of the collection","default":"new","example":"done","enum":["new","in progress","done","error","unknown","queued","pending","abandoned"]},"transfer_id":{"type":"string","description":"Identifier of Archivematica transfer","example":"74c82fa7-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"workflow_id":{"type":"string","description":"Identifier of processing workflow","example":"74c82b2f-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"}},"description":"StoredCollection describes a collection retrieved by the service. (default view)","example":{"aip_id":"74c8414e-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"1977-12-10T11:31:25Z","created_at":"1999-04-24T03:56:53Z","id":10895205645452708913,"name":"Est voluptate quis sunt.","original_id":"Velit nisi dolorum inventore.","pipeline_id":"74c84309-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c83d99-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1989-12-22T07:05:18Z","status":"in progress","transfer_id":"74c83f81-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c83bc0-1fd2-11ee-b6e1-7085c27bdeb0"},"required":["id","status","created_at"]},"EnduroStoredCollectionResponseBodyCollection":{"title":"Mediatype identifier: application/vnd.enduro.stored-collection; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/EnduroStoredCollectionResponseBody"},"description":"EnduroStored-CollectionCollectionResponseBody is the result type for an array of EnduroStored-CollectionResponseBody (default view)","example":[{"aip_id":"74c66505-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"1992-04-04T11:00:41Z","created_at":"2000-12-20T12:21:46Z","id":15454769769736078970,"name":"Sed tempore voluptatum quo pariatur.","original_id":"Nisi aliquid.","pipeline_id":"74c6668f-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c66289-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"2011-08-25T19:50:57Z","status":"unknown","transfer_id":"74c663d0-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c660e1-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c66505-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"1992-04-04T11:00:41Z","created_at":"2000-12-20T12:21:46Z","id":15454769769736078970,"name":"Sed tempore voluptatum quo pariatur.","original_id":"Nisi aliquid.","pipeline_id":"74c6668f-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c66289-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"2011-08-25T19:50:57Z","status":"unknown","transfer_id":"74c663d0-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c660e1-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c66505-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"1992-04-04T11:00:41Z","created_at":"2000-12-20T12:21:46Z","id":15454769769736078970,"name":"Sed tempore voluptatum quo pariatur.","original_id":"Nisi aliquid.","pipeline_id":"74c6668f-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c66289-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"2011-08-25T19:50:57Z","status":"unknown","transfer_id":"74c663d0-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c660e1-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c66505-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"1992-04-04T11:00:41Z","created_at":"2000-12-20T12:21:46Z","id":15454769769736078970,"name":"Sed tempore voluptatum quo pariatur.","original_id":"Nisi aliquid.","pipeline_id":"74c6668f-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c66289-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"2011-08-25T19:50:57Z","status":"unknown","transfer_id":"74c663d0-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c660e1-1fd2-11ee-b6e1-7085c27bdeb0"}]},"EnduroStoredPipelineResponse":{"title":"Mediatype identifier: application/vnd.enduro.stored-pipeline; view=default","type":"object","properties":{"capacity":{"type":"integer","description":"Maximum concurrent transfers","example":5490808095495946983,"format":"int64"},"current":{"type":"integer","description":"Current transfers","example":5311713486168500071,"format":"int64"},"id":{"type":"string","description":"Identifier of the pipeline","example":"74c8ba37-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"name":{"type":"string","description":"Name of the pipeline","example":"Excepturi iste aperiam laborum suscipit aut."},"status":{"type":"string","example":"Id quae et."}},"description":"StoredPipeline describes a pipeline retrieved by this service. (default view)","example":{"capacity":2222693760767986291,"current":2153194333007283248,"id":"74c8bbe9-1fd2-11ee-b6e1-7085c27bdeb0","name":"Aut consequatur eos provident.","status":"Ad ipsa."},"required":["name"]},"PipelineProcessingNotFoundResponseBody":{"title":"PipelineProcessingNotFoundResponseBody","type":"object","properties":{"id":{"type":"string","description":"Identifier of missing pipeline","example":"Id corrupti quia praesentium."},"message":{"type":"string","description":"Message of error","example":"Harum totam sit inventore impedit voluptates vel."}},"description":"Pipeline not found","example":{"id":"Sed distinctio qui non.","message":"Qui inventore hic voluptates eos."},"required":["message","id"]},"PipelineShowNotFoundResponseBody":{"title":"PipelineShowNotFoundResponseBody","type":"object","properties":{"id":{"type":"string","description":"Identifier of missing pipeline","example":"Molestiae animi et."},"message":{"type":"string","description":"Message of error","example":"Aut quibusdam et ut hic fuga sed."}},"description":"Pipeline not found","example":{"id":"Magnam est veritatis ut autem.","message":"Voluptatem animi est praesentium officiis."},"required":["message","id"]},"PipelineShowResponseBody":{"title":"Mediatype identifier: application/vnd.enduro.stored-pipeline; view=default","type":"object","properties":{"capacity":{"type":"integer","description":"Maximum concurrent transfers","example":393947975496952716,"format":"int64"},"current":{"type":"integer","description":"Current transfers","example":4131578484904641155,"format":"int64"},"id":{"type":"string","description":"Identifier of the pipeline","example":"74c8be2e-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"name":{"type":"string","description":"Name of the pipeline","example":"Beatae dolorem."},"status":{"type":"string","example":"Velit illo nemo fugiat."}},"description":"ShowResponseBody result type (default view)","example":{"capacity":6664446055604236601,"current":7662943385375122421,"id":"74c8bfb6-1fd2-11ee-b6e1-7085c27bdeb0","name":"Molestiae esse consequatur reprehenderit animi veniam.","status":"Omnis ut tenetur dolorum."},"required":["name"]}}} \ No newline at end of file +{ + "consumes": [ + "application/json", + "application/xml", + "application/gob" + ], + "definitions": { + "BatchHintsResponseBody": { + "example": { + "completed_dirs": [ + "abc123" + ] + }, + "properties": { + "completed_dirs": { + "description": "A list of known values of completedDir used by existing watchers.", + "example": [ + "abc123" + ], + "items": { + "example": "abc123", + "type": "string" + }, + "type": "array" + } + }, + "title": "BatchHintsResponseBody", + "type": "object" + }, + "BatchStatusResponseBody": { + "example": { + "run_id": "abc123", + "running": false, + "status": "abc123", + "workflow_id": "abc123" + }, + "properties": { + "run_id": { + "example": "abc123", + "type": "string" + }, + "running": { + "example": false, + "type": "boolean" + }, + "status": { + "example": "abc123", + "type": "string" + }, + "workflow_id": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "running" + ], + "title": "BatchStatusResponseBody", + "type": "object" + }, + "BatchSubmitNotAvailableResponseBody": { + "description": "submit_not_available_response_body result type (default view)", + "example": { + "fault": false, + "id": "123abc", + "message": "parameter 'p' must be an integer", + "name": "bad_request", + "temporary": false, + "timeout": false + }, + "properties": { + "fault": { + "description": "Is the error a server-side fault?", + "example": false, + "type": "boolean" + }, + "id": { + "description": "ID is a unique identifier for this particular occurrence of the problem.", + "example": "123abc", + "type": "string" + }, + "message": { + "description": "Message is a human-readable explanation specific to this occurrence of the problem.", + "example": "parameter 'p' must be an integer", + "type": "string" + }, + "name": { + "description": "Name is the name of this class of errors.", + "example": "bad_request", + "type": "string" + }, + "temporary": { + "description": "Is the error temporary?", + "example": false, + "type": "boolean" + }, + "timeout": { + "description": "Is the error a timeout?", + "example": false, + "type": "boolean" + } + }, + "required": [ + "name", + "id", + "message", + "temporary", + "timeout", + "fault" + ], + "title": "Mediatype identifier: application/vnd.goa.error; view=default", + "type": "object" + }, + "BatchSubmitNotValidResponseBody": { + "description": "submit_not_valid_response_body result type (default view)", + "example": { + "fault": false, + "id": "123abc", + "message": "parameter 'p' must be an integer", + "name": "bad_request", + "temporary": false, + "timeout": false + }, + "properties": { + "fault": { + "description": "Is the error a server-side fault?", + "example": false, + "type": "boolean" + }, + "id": { + "description": "ID is a unique identifier for this particular occurrence of the problem.", + "example": "123abc", + "type": "string" + }, + "message": { + "description": "Message is a human-readable explanation specific to this occurrence of the problem.", + "example": "parameter 'p' must be an integer", + "type": "string" + }, + "name": { + "description": "Name is the name of this class of errors.", + "example": "bad_request", + "type": "string" + }, + "temporary": { + "description": "Is the error temporary?", + "example": false, + "type": "boolean" + }, + "timeout": { + "description": "Is the error a timeout?", + "example": false, + "type": "boolean" + } + }, + "required": [ + "name", + "id", + "message", + "temporary", + "timeout", + "fault" + ], + "title": "Mediatype identifier: application/vnd.goa.error; view=default", + "type": "object" + }, + "BatchSubmitRequestBody": { + "example": { + "completed_dir": "abc123", + "path": "abc123", + "pipeline": "abc123", + "processing_config": "abc123", + "retention_period": "abc123" + }, + "properties": { + "completed_dir": { + "example": "abc123", + "type": "string" + }, + "path": { + "example": "abc123", + "type": "string" + }, + "pipeline": { + "example": "abc123", + "type": "string" + }, + "processing_config": { + "example": "abc123", + "type": "string" + }, + "retention_period": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "path" + ], + "title": "BatchSubmitRequestBody", + "type": "object" + }, + "BatchSubmitResponseBody": { + "example": { + "run_id": "abc123", + "workflow_id": "abc123" + }, + "properties": { + "run_id": { + "example": "abc123", + "type": "string" + }, + "workflow_id": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "workflow_id", + "run_id" + ], + "title": "BatchSubmitResponseBody", + "type": "object" + }, + "CollectionBulkNotAvailableResponseBody": { + "description": "bulk_not_available_response_body result type (default view)", + "example": { + "fault": false, + "id": "123abc", + "message": "parameter 'p' must be an integer", + "name": "bad_request", + "temporary": false, + "timeout": false + }, + "properties": { + "fault": { + "description": "Is the error a server-side fault?", + "example": false, + "type": "boolean" + }, + "id": { + "description": "ID is a unique identifier for this particular occurrence of the problem.", + "example": "123abc", + "type": "string" + }, + "message": { + "description": "Message is a human-readable explanation specific to this occurrence of the problem.", + "example": "parameter 'p' must be an integer", + "type": "string" + }, + "name": { + "description": "Name is the name of this class of errors.", + "example": "bad_request", + "type": "string" + }, + "temporary": { + "description": "Is the error temporary?", + "example": false, + "type": "boolean" + }, + "timeout": { + "description": "Is the error a timeout?", + "example": false, + "type": "boolean" + } + }, + "required": [ + "name", + "id", + "message", + "temporary", + "timeout", + "fault" + ], + "title": "Mediatype identifier: application/vnd.goa.error; view=default", + "type": "object" + }, + "CollectionBulkNotValidResponseBody": { + "description": "bulk_not_valid_response_body result type (default view)", + "example": { + "fault": false, + "id": "123abc", + "message": "parameter 'p' must be an integer", + "name": "bad_request", + "temporary": false, + "timeout": false + }, + "properties": { + "fault": { + "description": "Is the error a server-side fault?", + "example": false, + "type": "boolean" + }, + "id": { + "description": "ID is a unique identifier for this particular occurrence of the problem.", + "example": "123abc", + "type": "string" + }, + "message": { + "description": "Message is a human-readable explanation specific to this occurrence of the problem.", + "example": "parameter 'p' must be an integer", + "type": "string" + }, + "name": { + "description": "Name is the name of this class of errors.", + "example": "bad_request", + "type": "string" + }, + "temporary": { + "description": "Is the error temporary?", + "example": false, + "type": "boolean" + }, + "timeout": { + "description": "Is the error a timeout?", + "example": false, + "type": "boolean" + } + }, + "required": [ + "name", + "id", + "message", + "temporary", + "timeout", + "fault" + ], + "title": "Mediatype identifier: application/vnd.goa.error; view=default", + "type": "object" + }, + "CollectionBulkRequestBody": { + "example": { + "operation": "cancel", + "size": 1, + "status": "in progress" + }, + "properties": { + "operation": { + "enum": [ + "retry", + "cancel", + "abandon" + ], + "example": "cancel", + "type": "string" + }, + "size": { + "default": 100, + "example": 1, + "format": "int64", + "type": "integer" + }, + "status": { + "enum": [ + "new", + "in progress", + "done", + "error", + "unknown", + "queued", + "pending", + "abandoned" + ], + "example": "in progress", + "type": "string" + } + }, + "required": [ + "operation", + "status" + ], + "title": "CollectionBulkRequestBody", + "type": "object" + }, + "CollectionBulkResponseBody": { + "example": { + "run_id": "abc123", + "workflow_id": "abc123" + }, + "properties": { + "run_id": { + "example": "abc123", + "type": "string" + }, + "workflow_id": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "workflow_id", + "run_id" + ], + "title": "CollectionBulkResponseBody", + "type": "object" + }, + "CollectionBulkStatusResponseBody": { + "example": { + "closed_at": "1970-01-01T00:00:01Z", + "run_id": "abc123", + "running": false, + "started_at": "1970-01-01T00:00:01Z", + "status": "abc123", + "workflow_id": "abc123" + }, + "properties": { + "closed_at": { + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "run_id": { + "example": "abc123", + "type": "string" + }, + "running": { + "example": false, + "type": "boolean" + }, + "started_at": { + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "status": { + "example": "abc123", + "type": "string" + }, + "workflow_id": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "running" + ], + "title": "CollectionBulkStatusResponseBody", + "type": "object" + }, + "CollectionCancelNotFoundResponseBody": { + "description": "Collection not found", + "example": { + "id": 1, + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "title": "CollectionCancelNotFoundResponseBody", + "type": "object" + }, + "CollectionCancelNotRunningResponseBody": { + "description": "cancel_not_running_response_body result type (default view)", + "example": { + "fault": false, + "id": "123abc", + "message": "parameter 'p' must be an integer", + "name": "bad_request", + "temporary": false, + "timeout": false + }, + "properties": { + "fault": { + "description": "Is the error a server-side fault?", + "example": false, + "type": "boolean" + }, + "id": { + "description": "ID is a unique identifier for this particular occurrence of the problem.", + "example": "123abc", + "type": "string" + }, + "message": { + "description": "Message is a human-readable explanation specific to this occurrence of the problem.", + "example": "parameter 'p' must be an integer", + "type": "string" + }, + "name": { + "description": "Name is the name of this class of errors.", + "example": "bad_request", + "type": "string" + }, + "temporary": { + "description": "Is the error temporary?", + "example": false, + "type": "boolean" + }, + "timeout": { + "description": "Is the error a timeout?", + "example": false, + "type": "boolean" + } + }, + "required": [ + "name", + "id", + "message", + "temporary", + "timeout", + "fault" + ], + "title": "Mediatype identifier: application/vnd.goa.error; view=default", + "type": "object" + }, + "CollectionDecideNotFoundResponseBody": { + "description": "Collection not found", + "example": { + "id": 1, + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "title": "CollectionDecideNotFoundResponseBody", + "type": "object" + }, + "CollectionDecideNotValidResponseBody": { + "description": "decide_not_valid_response_body result type (default view)", + "example": { + "fault": false, + "id": "123abc", + "message": "parameter 'p' must be an integer", + "name": "bad_request", + "temporary": false, + "timeout": false + }, + "properties": { + "fault": { + "description": "Is the error a server-side fault?", + "example": false, + "type": "boolean" + }, + "id": { + "description": "ID is a unique identifier for this particular occurrence of the problem.", + "example": "123abc", + "type": "string" + }, + "message": { + "description": "Message is a human-readable explanation specific to this occurrence of the problem.", + "example": "parameter 'p' must be an integer", + "type": "string" + }, + "name": { + "description": "Name is the name of this class of errors.", + "example": "bad_request", + "type": "string" + }, + "temporary": { + "description": "Is the error temporary?", + "example": false, + "type": "boolean" + }, + "timeout": { + "description": "Is the error a timeout?", + "example": false, + "type": "boolean" + } + }, + "required": [ + "name", + "id", + "message", + "temporary", + "timeout", + "fault" + ], + "title": "Mediatype identifier: application/vnd.goa.error; view=default", + "type": "object" + }, + "CollectionDeleteNotFoundResponseBody": { + "description": "Collection not found", + "example": { + "id": 1, + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "title": "CollectionDeleteNotFoundResponseBody", + "type": "object" + }, + "CollectionDownloadNotFoundResponseBody": { + "description": "Collection not found", + "example": { + "id": 1, + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "title": "CollectionDownloadNotFoundResponseBody", + "type": "object" + }, + "CollectionListResponseBody": { + "example": { + "items": [ + { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + } + ], + "next_cursor": "abc123" + }, + "properties": { + "items": { + "$ref": "#/definitions/EnduroStoredCollectionResponseBodyCollection" + }, + "next_cursor": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "items" + ], + "title": "CollectionListResponseBody", + "type": "object" + }, + "CollectionMonitorResponseBody": { + "description": "MonitorResponseBody result type (default view)", + "example": { + "id": 1, + "item": { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + }, + "type": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "item": { + "$ref": "#/definitions/EnduroStoredCollectionResponseBody" + }, + "type": { + "description": "Type of the event", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "title": "Mediatype identifier: application/vnd.enduro.monitor-update; view=default", + "type": "object" + }, + "CollectionRetryNotFoundResponseBody": { + "description": "Collection not found", + "example": { + "id": 1, + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "title": "CollectionRetryNotFoundResponseBody", + "type": "object" + }, + "CollectionRetryNotRunningResponseBody": { + "description": "retry_not_running_response_body result type (default view)", + "example": { + "fault": false, + "id": "123abc", + "message": "parameter 'p' must be an integer", + "name": "bad_request", + "temporary": false, + "timeout": false + }, + "properties": { + "fault": { + "description": "Is the error a server-side fault?", + "example": false, + "type": "boolean" + }, + "id": { + "description": "ID is a unique identifier for this particular occurrence of the problem.", + "example": "123abc", + "type": "string" + }, + "message": { + "description": "Message is a human-readable explanation specific to this occurrence of the problem.", + "example": "parameter 'p' must be an integer", + "type": "string" + }, + "name": { + "description": "Name is the name of this class of errors.", + "example": "bad_request", + "type": "string" + }, + "temporary": { + "description": "Is the error temporary?", + "example": false, + "type": "boolean" + }, + "timeout": { + "description": "Is the error a timeout?", + "example": false, + "type": "boolean" + } + }, + "required": [ + "name", + "id", + "message", + "temporary", + "timeout", + "fault" + ], + "title": "Mediatype identifier: application/vnd.goa.error; view=default", + "type": "object" + }, + "CollectionShowNotFoundResponseBody": { + "description": "Collection not found", + "example": { + "id": 1, + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "title": "CollectionShowNotFoundResponseBody", + "type": "object" + }, + "CollectionShowResponseBody": { + "description": "ShowResponseBody result type (default view)", + "example": { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + }, + "properties": { + "aip_id": { + "description": "Identifier of Archivematica AIP", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "completed_at": { + "description": "Completion datetime", + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Creation datetime", + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "Identifier of collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "name": { + "description": "Name of the collection", + "example": "abc123", + "type": "string" + }, + "original_id": { + "description": "Identifier provided by the client", + "example": "abc123", + "type": "string" + }, + "pipeline_id": { + "description": "Identifier of Archivematica pipeline", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "run_id": { + "description": "Identifier of latest processing workflow run", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "started_at": { + "description": "Start datetime", + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "status": { + "default": "new", + "description": "Status of the collection", + "enum": [ + "new", + "in progress", + "done", + "error", + "unknown", + "queued", + "pending", + "abandoned" + ], + "example": "in progress", + "type": "string" + }, + "transfer_id": { + "description": "Identifier of Archivematica tranfser", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "workflow_id": { + "description": "Identifier of processing workflow", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "id", + "status", + "created_at" + ], + "title": "Mediatype identifier: application/vnd.enduro.stored-collection; view=default", + "type": "object" + }, + "CollectionWorkflowNotFoundResponseBody": { + "description": "Collection not found", + "example": { + "id": 1, + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "title": "CollectionWorkflowNotFoundResponseBody", + "type": "object" + }, + "CollectionWorkflowResponseBody": { + "description": "WorkflowResponseBody result type (default view)", + "example": { + "history": [ + { + "details": "abc123", + "id": 1, + "type": "abc123" + } + ], + "status": "abc123" + }, + "properties": { + "history": { + "$ref": "#/definitions/EnduroCollectionWorkflowHistoryResponseBodyCollection" + }, + "status": { + "example": "abc123", + "type": "string" + } + }, + "title": "Mediatype identifier: application/vnd.enduro.collection-workflow-status; view=default", + "type": "object" + }, + "EnduroCollectionWorkflowHistoryResponseBody": { + "description": "WorkflowHistoryEvent describes a history event in Temporal. (default view)", + "example": { + "details": "abc123", + "id": 1, + "type": "abc123" + }, + "properties": { + "details": { + "description": "Contents of the event", + "example": "abc123", + "format": "binary", + "type": "string" + }, + "id": { + "description": "Identifier of collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Type of the event", + "example": "abc123", + "type": "string" + } + }, + "title": "Mediatype identifier: application/vnd.enduro.collection-workflow-history; view=default", + "type": "object" + }, + "EnduroCollectionWorkflowHistoryResponseBodyCollection": { + "description": "EnduroCollection-Workflow-HistoryCollectionResponseBody is the result type for an array of EnduroCollection-Workflow-HistoryResponseBody (default view)", + "example": [ + { + "details": "abc123", + "id": 1, + "type": "abc123" + } + ], + "items": { + "$ref": "#/definitions/EnduroCollectionWorkflowHistoryResponseBody" + }, + "title": "Mediatype identifier: application/vnd.enduro.collection-workflow-history; type=collection; view=default", + "type": "array" + }, + "EnduroStoredCollectionResponseBody": { + "description": "StoredCollection describes a collection retrieved by the service. (default view)", + "example": { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + }, + "properties": { + "aip_id": { + "description": "Identifier of Archivematica AIP", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "completed_at": { + "description": "Completion datetime", + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Creation datetime", + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "Identifier of collection", + "example": 1, + "format": "int64", + "type": "integer" + }, + "name": { + "description": "Name of the collection", + "example": "abc123", + "type": "string" + }, + "original_id": { + "description": "Identifier provided by the client", + "example": "abc123", + "type": "string" + }, + "pipeline_id": { + "description": "Identifier of Archivematica pipeline", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "run_id": { + "description": "Identifier of latest processing workflow run", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "started_at": { + "description": "Start datetime", + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "status": { + "default": "new", + "description": "Status of the collection", + "enum": [ + "new", + "in progress", + "done", + "error", + "unknown", + "queued", + "pending", + "abandoned" + ], + "example": "in progress", + "type": "string" + }, + "transfer_id": { + "description": "Identifier of Archivematica tranfser", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "workflow_id": { + "description": "Identifier of processing workflow", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "id", + "status", + "created_at" + ], + "title": "Mediatype identifier: application/vnd.enduro.stored-collection; view=default", + "type": "object" + }, + "EnduroStoredCollectionResponseBodyCollection": { + "description": "EnduroStored-CollectionCollectionResponseBody is the result type for an array of EnduroStored-CollectionResponseBody (default view)", + "example": [ + { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + } + ], + "items": { + "$ref": "#/definitions/EnduroStoredCollectionResponseBody" + }, + "title": "Mediatype identifier: application/vnd.enduro.stored-collection; type=collection; view=default", + "type": "array" + }, + "EnduroStoredPipelineResponse": { + "description": "StoredPipeline describes a pipeline retrieved by this service. (default view)", + "example": { + "capacity": 1, + "current": 1, + "id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "name": "abc123", + "status": "abc123" + }, + "properties": { + "capacity": { + "description": "Maximum concurrent transfers", + "example": 1, + "format": "int64", + "type": "integer" + }, + "current": { + "description": "Current transfers", + "example": 1, + "format": "int64", + "type": "integer" + }, + "id": { + "description": "Identifier of pipeline", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the pipeline", + "example": "abc123", + "type": "string" + }, + "status": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "Mediatype identifier: application/vnd.enduro.stored-pipeline; view=default", + "type": "object" + }, + "PipelineProcessingNotFoundResponseBody": { + "description": "Pipeline not found", + "example": { + "id": "abc123", + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing pipeline", + "example": "abc123", + "type": "string" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "title": "PipelineProcessingNotFoundResponseBody", + "type": "object" + }, + "PipelineShowNotFoundResponseBody": { + "description": "Pipeline not found", + "example": { + "id": "abc123", + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing pipeline", + "example": "abc123", + "type": "string" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "title": "PipelineShowNotFoundResponseBody", + "type": "object" + }, + "PipelineShowResponseBody": { + "description": "ShowResponseBody result type (default view)", + "example": { + "capacity": 1, + "current": 1, + "id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "name": "abc123", + "status": "abc123" + }, + "properties": { + "capacity": { + "description": "Maximum concurrent transfers", + "example": 1, + "format": "int64", + "type": "integer" + }, + "current": { + "description": "Current transfers", + "example": 1, + "format": "int64", + "type": "integer" + }, + "id": { + "description": "Identifier of pipeline", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the pipeline", + "example": "abc123", + "type": "string" + }, + "status": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "Mediatype identifier: application/vnd.enduro.stored-pipeline; view=default", + "type": "object" + } + }, + "host": "localhost:9000", + "info": { + "title": "Enduro API", + "version": "" + }, + "paths": { + "/batch": { + "get": { + "description": "Retrieve status of current batch operation.", + "operationId": "batch#status", + "responses": { + "200": { + "description": "OK response.", + "schema": { + "$ref": "#/definitions/BatchStatusResponseBody", + "required": [ + "running" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "status batch", + "tags": [ + "batch" + ] + }, + "post": { + "description": "Submit a new batch", + "operationId": "batch#submit", + "parameters": [ + { + "in": "body", + "name": "SubmitRequestBody", + "required": true, + "schema": { + "$ref": "#/definitions/BatchSubmitRequestBody", + "required": [ + "path" + ] + } + } + ], + "responses": { + "202": { + "description": "Accepted response.", + "schema": { + "$ref": "#/definitions/BatchSubmitResponseBody", + "required": [ + "workflow_id", + "run_id" + ] + } + }, + "400": { + "description": "Bad Request response.", + "schema": { + "$ref": "#/definitions/BatchSubmitNotValidResponseBody" + } + }, + "409": { + "description": "Conflict response.", + "schema": { + "$ref": "#/definitions/BatchSubmitNotAvailableResponseBody" + } + } + }, + "schemes": [ + "http" + ], + "summary": "submit batch", + "tags": [ + "batch" + ] + } + }, + "/batch/hints": { + "get": { + "description": "Retrieve form hints", + "operationId": "batch#hints", + "responses": { + "200": { + "description": "OK response.", + "schema": { + "$ref": "#/definitions/BatchHintsResponseBody" + } + } + }, + "schemes": [ + "http" + ], + "summary": "hints batch", + "tags": [ + "batch" + ] + } + }, + "/collection": { + "get": { + "description": "List all stored collections", + "operationId": "collection#list", + "parameters": [ + { + "in": "query", + "name": "name", + "required": false, + "type": "string" + }, + { + "in": "query", + "name": "original_id", + "required": false, + "type": "string" + }, + { + "description": "Identifier of Archivematica tranfser", + "format": "uuid", + "in": "query", + "name": "transfer_id", + "required": false, + "type": "string" + }, + { + "description": "Identifier of Archivematica AIP", + "format": "uuid", + "in": "query", + "name": "aip_id", + "required": false, + "type": "string" + }, + { + "description": "Identifier of Archivematica pipeline", + "format": "uuid", + "in": "query", + "name": "pipeline_id", + "required": false, + "type": "string" + }, + { + "format": "date-time", + "in": "query", + "name": "earliest_created_time", + "required": false, + "type": "string" + }, + { + "format": "date-time", + "in": "query", + "name": "latest_created_time", + "required": false, + "type": "string" + }, + { + "enum": [ + "new", + "in progress", + "done", + "error", + "unknown", + "queued", + "pending", + "abandoned" + ], + "in": "query", + "name": "status", + "required": false, + "type": "string" + }, + { + "description": "Pagination cursor", + "in": "query", + "name": "cursor", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK response.", + "schema": { + "$ref": "#/definitions/CollectionListResponseBody", + "required": [ + "items" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "list collection", + "tags": [ + "collection" + ] + } + }, + "/collection/bulk": { + "get": { + "description": "Retrieve status of current bulk operation.", + "operationId": "collection#bulk_status", + "responses": { + "200": { + "description": "OK response.", + "schema": { + "$ref": "#/definitions/CollectionBulkStatusResponseBody", + "required": [ + "running" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "bulk_status collection", + "tags": [ + "collection" + ] + }, + "post": { + "description": "Bulk operations (retry, cancel...).", + "operationId": "collection#bulk", + "parameters": [ + { + "in": "body", + "name": "BulkRequestBody", + "required": true, + "schema": { + "$ref": "#/definitions/CollectionBulkRequestBody", + "required": [ + "operation", + "status" + ] + } + } + ], + "responses": { + "202": { + "description": "Accepted response.", + "schema": { + "$ref": "#/definitions/CollectionBulkResponseBody", + "required": [ + "workflow_id", + "run_id" + ] + } + }, + "400": { + "description": "Bad Request response.", + "schema": { + "$ref": "#/definitions/CollectionBulkNotValidResponseBody" + } + }, + "409": { + "description": "Conflict response.", + "schema": { + "$ref": "#/definitions/CollectionBulkNotAvailableResponseBody" + } + } + }, + "schemes": [ + "http" + ], + "summary": "bulk collection", + "tags": [ + "collection" + ] + } + }, + "/collection/monitor": { + "get": { + "operationId": "collection#monitor", + "responses": { + "101": { + "description": "Switching Protocols response.", + "schema": { + "$ref": "#/definitions/CollectionMonitorResponseBody" + } + } + }, + "schemes": [ + "ws" + ], + "summary": "monitor collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}": { + "delete": { + "description": "Delete collection by ID", + "operationId": "collection#delete", + "parameters": [ + { + "description": "Identifier of collection to delete", + "in": "path", + "name": "id", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "No Content response." + }, + "404": { + "description": "Not Found response.", + "schema": { + "$ref": "#/definitions/CollectionDeleteNotFoundResponseBody", + "required": [ + "message", + "id" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "delete collection", + "tags": [ + "collection" + ] + }, + "get": { + "description": "Show collection by ID", + "operationId": "collection#show", + "parameters": [ + { + "description": "Identifier of collection to show", + "in": "path", + "name": "id", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK response.", + "schema": { + "$ref": "#/definitions/CollectionShowResponseBody" + } + }, + "404": { + "description": "Not Found response.", + "schema": { + "$ref": "#/definitions/CollectionShowNotFoundResponseBody", + "required": [ + "message", + "id" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "show collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}/cancel": { + "post": { + "description": "Cancel collection processing by ID", + "operationId": "collection#cancel", + "parameters": [ + { + "description": "Identifier of collection to remove", + "in": "path", + "name": "id", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK response." + }, + "400": { + "description": "Bad Request response.", + "schema": { + "$ref": "#/definitions/CollectionCancelNotRunningResponseBody" + } + }, + "404": { + "description": "Not Found response.", + "schema": { + "$ref": "#/definitions/CollectionCancelNotFoundResponseBody", + "required": [ + "message", + "id" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "cancel collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}/decision": { + "post": { + "description": "Make decision for a pending collection by ID", + "operationId": "collection#decide", + "parameters": [ + { + "description": "Identifier of collection to look up", + "in": "path", + "name": "id", + "required": true, + "type": "integer" + }, + { + "in": "body", + "name": "object", + "required": true, + "schema": { + "properties": { + "option": { + "description": "Decision option to proceed with", + "example": "abc123", + "type": "string" + } + }, + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "OK response." + }, + "400": { + "description": "Bad Request response.", + "schema": { + "$ref": "#/definitions/CollectionDecideNotValidResponseBody" + } + }, + "404": { + "description": "Not Found response.", + "schema": { + "$ref": "#/definitions/CollectionDecideNotFoundResponseBody", + "required": [ + "message", + "id" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "decide collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}/download": { + "get": { + "description": "Download collection by ID", + "operationId": "collection#download", + "parameters": [ + { + "description": "Identifier of collection to look up", + "in": "path", + "name": "id", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK response.", + "headers": { + "Content-Disposition": { + "type": "string" + }, + "Content-Length": { + "type": "int64" + }, + "Content-Type": { + "type": "string" + } + } + }, + "404": { + "description": "Not Found response.", + "schema": { + "$ref": "#/definitions/CollectionDownloadNotFoundResponseBody", + "required": [ + "message", + "id" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "download collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}/retry": { + "post": { + "description": "Retry collection processing by ID", + "operationId": "collection#retry", + "parameters": [ + { + "description": "Identifier of collection to retry", + "in": "path", + "name": "id", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK response." + }, + "400": { + "description": "Bad Request response.", + "schema": { + "$ref": "#/definitions/CollectionRetryNotRunningResponseBody" + } + }, + "404": { + "description": "Not Found response.", + "schema": { + "$ref": "#/definitions/CollectionRetryNotFoundResponseBody", + "required": [ + "message", + "id" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "retry collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}/workflow": { + "get": { + "description": "Retrieve workflow status by ID", + "operationId": "collection#workflow", + "parameters": [ + { + "description": "Identifier of collection to look up", + "in": "path", + "name": "id", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK response.", + "schema": { + "$ref": "#/definitions/CollectionWorkflowResponseBody" + } + }, + "404": { + "description": "Not Found response.", + "schema": { + "$ref": "#/definitions/CollectionWorkflowNotFoundResponseBody", + "required": [ + "message", + "id" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "workflow collection", + "tags": [ + "collection" + ] + } + }, + "/pipeline": { + "get": { + "description": "List all known pipelines", + "operationId": "pipeline#list", + "parameters": [ + { + "in": "query", + "name": "name", + "required": false, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "status", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK response.", + "schema": { + "items": { + "$ref": "#/definitions/EnduroStoredPipelineResponse" + }, + "type": "array" + } + } + }, + "schemes": [ + "http" + ], + "summary": "list pipeline", + "tags": [ + "pipeline" + ] + } + }, + "/pipeline/{id}": { + "get": { + "description": "Show pipeline by ID", + "operationId": "pipeline#show", + "parameters": [ + { + "description": "Identifier of pipeline to show", + "format": "uuid", + "in": "path", + "name": "id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK response.", + "schema": { + "$ref": "#/definitions/PipelineShowResponseBody" + } + }, + "404": { + "description": "Not Found response.", + "schema": { + "$ref": "#/definitions/PipelineShowNotFoundResponseBody", + "required": [ + "message", + "id" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "show pipeline", + "tags": [ + "pipeline" + ] + } + }, + "/pipeline/{id}/processing": { + "get": { + "description": "List all processing configurations of a pipeline given its ID", + "operationId": "pipeline#processing", + "parameters": [ + { + "description": "Identifier of pipeline", + "format": "uuid", + "in": "path", + "name": "id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK response.", + "schema": { + "items": { + "example": "abc123", + "type": "string" + }, + "type": "array" + } + }, + "404": { + "description": "Not Found response.", + "schema": { + "$ref": "#/definitions/PipelineProcessingNotFoundResponseBody", + "required": [ + "message", + "id" + ] + } + } + }, + "schemes": [ + "http" + ], + "summary": "processing pipeline", + "tags": [ + "pipeline" + ] + } + }, + "/swagger/swagger.json": { + "get": { + "description": "JSON document containing the API swagger definition.", + "operationId": "swagger#/swagger/swagger.json", + "responses": { + "200": { + "description": "File downloaded", + "schema": { + "type": "file" + } + } + }, + "schemes": [ + "http" + ], + "summary": "Download internal/api/gen/http/openapi.json", + "tags": [ + "swagger" + ] + } + } + }, + "produces": [ + "application/json", + "application/xml", + "application/gob" + ], + "swagger": "2.0" +} diff --git a/internal/api/gen/http/openapi.yaml b/internal/api/gen/http/openapi.yaml index 71f0e0c8..111df67b 100644 --- a/internal/api/gen/http/openapi.yaml +++ b/internal/api/gen/http/openapi.yaml @@ -92,16 +92,19 @@ paths: type: string - name: transfer_id in: query + description: Identifier of Archivematica tranfser required: false type: string format: uuid - name: aip_id in: query + description: Identifier of Archivematica AIP required: false type: string format: uuid - name: pipeline_id in: query + description: Identifier of Archivematica pipeline required: false type: string format: uuid @@ -244,7 +247,7 @@ paths: option: type: string description: Decision option to proceed with - example: Iure sunt fugiat voluptate. + example: abc123 responses: "200": description: OK response. @@ -486,7 +489,7 @@ paths: type: array items: type: string - example: Suscipit distinctio. + example: abc123 "404": description: Not Found response. schema: @@ -519,40 +522,34 @@ definitions: type: array items: type: string - example: Ab est sed reiciendis ipsum. + example: abc123 description: A list of known values of completedDir used by existing watchers. example: - - Saepe quibusdam aut magnam itaque. - - Dolor quo. - - Vitae suscipit. - - Ullam cumque recusandae quae porro corporis. + - abc123 example: completed_dirs: - - Rerum voluptatem non quas. - - Eos ut ipsum et. - - Expedita asperiores et. - - Ut quia ut commodi. + - abc123 BatchStatusResponseBody: title: BatchStatusResponseBody type: object properties: run_id: type: string - example: Tempore nostrum aliquid fugiat optio consequatur. + example: abc123 running: type: boolean - example: true + example: false status: type: string - example: Accusamus possimus fuga esse. + example: abc123 workflow_id: type: string - example: Aut itaque et. + example: abc123 example: - run_id: Enim fuga quam aut sit. - running: true - status: Corrupti veniam maiores ducimus in. - workflow_id: Et laboriosam qui. + run_id: abc123 + running: false + status: abc123 + workflow_id: abc123 required: - running BatchSubmitNotAvailableResponseBody: @@ -562,7 +559,7 @@ definitions: fault: type: boolean description: Is the error a server-side fault? - example: true + example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. @@ -578,14 +575,14 @@ definitions: temporary: type: boolean description: Is the error temporary? - example: true + example: false timeout: type: boolean description: Is the error a timeout? - example: true + example: false description: submit_not_available_response_body result type (default view) example: - fault: true + fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request @@ -605,7 +602,7 @@ definitions: fault: type: boolean description: Is the error a server-side fault? - example: true + example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. @@ -628,7 +625,7 @@ definitions: example: false description: submit_not_valid_response_body result type (default view) example: - fault: true + fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request @@ -647,25 +644,25 @@ definitions: properties: completed_dir: type: string - example: Sit sint est qui cum nihil quis. + example: abc123 path: type: string - example: Dolor quas corrupti. + example: abc123 pipeline: type: string - example: Cumque qui facilis omnis. + example: abc123 processing_config: type: string - example: Officia voluptate. + example: abc123 retention_period: type: string - example: Sit quibusdam quidem consectetur praesentium. + example: abc123 example: - completed_dir: Esse consectetur aut quis accusamus enim consequatur. - path: Aperiam velit. - pipeline: Nobis delectus. - processing_config: Fuga omnis corporis et sunt. - retention_period: Consequatur natus illum. + completed_dir: abc123 + path: abc123 + pipeline: abc123 + processing_config: abc123 + retention_period: abc123 required: - path BatchSubmitResponseBody: @@ -674,13 +671,13 @@ definitions: properties: run_id: type: string - example: Iste dolorem. + example: abc123 workflow_id: type: string - example: Est iure optio suscipit. + example: abc123 example: - run_id: Quidem aliquam fuga laborum maiores et. - workflow_id: Maxime dicta. + run_id: abc123 + workflow_id: abc123 required: - workflow_id - run_id @@ -691,7 +688,7 @@ definitions: fault: type: boolean description: Is the error a server-side fault? - example: true + example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. @@ -707,7 +704,7 @@ definitions: temporary: type: boolean description: Is the error temporary? - example: true + example: false timeout: type: boolean description: Is the error a timeout? @@ -734,7 +731,7 @@ definitions: fault: type: boolean description: Is the error a server-side fault? - example: true + example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. @@ -754,14 +751,14 @@ definitions: timeout: type: boolean description: Is the error a timeout? - example: true + example: false description: bulk_not_valid_response_body result type (default view) example: fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request - temporary: true + temporary: false timeout: false required: - name @@ -776,7 +773,7 @@ definitions: properties: operation: type: string - example: abandon + example: cancel enum: - retry - cancel @@ -784,11 +781,11 @@ definitions: size: type: integer default: 100 - example: 8206095306886416010 + example: 1 format: int64 status: type: string - example: abandoned + example: in progress enum: - new - in progress @@ -800,8 +797,8 @@ definitions: - abandoned example: operation: cancel - size: 18036125241233620415 - status: unknown + size: 1 + status: in progress required: - operation - status @@ -811,13 +808,13 @@ definitions: properties: run_id: type: string - example: Consequatur facere omnis ab nihil magni. + example: abc123 workflow_id: type: string - example: Tenetur aut et occaecati harum. + example: abc123 example: - run_id: Quia fugiat quam iste velit explicabo. - workflow_id: Consequatur aut adipisci doloribus quas sit vitae. + run_id: abc123 + workflow_id: abc123 required: - workflow_id - run_id @@ -827,31 +824,31 @@ definitions: properties: closed_at: type: string - example: "2000-12-21T15:12:45Z" + example: "1970-01-01T00:00:01Z" format: date-time run_id: type: string - example: Magni mollitia et quod aut veritatis numquam. + example: abc123 running: type: boolean example: false started_at: type: string - example: "2015-02-11T18:18:46Z" + example: "1970-01-01T00:00:01Z" format: date-time status: type: string - example: Alias maxime architecto molestiae. + example: abc123 workflow_id: type: string - example: Assumenda explicabo adipisci. + example: abc123 example: - closed_at: "1990-07-24T22:49:26Z" - run_id: Voluptatem laborum. - running: true - started_at: "2009-02-06T07:39:29Z" - status: Atque culpa et earum et omnis et. - workflow_id: Voluptatibus quibusdam quibusdam voluptatem non. + closed_at: "1970-01-01T00:00:01Z" + run_id: abc123 + running: false + started_at: "1970-01-01T00:00:01Z" + status: abc123 + workflow_id: abc123 required: - running CollectionCancelNotFoundResponseBody: @@ -861,16 +858,16 @@ definitions: id: type: integer description: Identifier of missing collection - example: 951410389815766576 + example: 1 format: int64 message: type: string description: Message of error - example: Architecto magnam asperiores tempora autem. + example: abc123 description: Collection not found example: - id: 7358593745880113932 - message: Aliquid consequatur. + id: 1 + message: abc123 required: - message - id @@ -901,15 +898,15 @@ definitions: timeout: type: boolean description: Is the error a timeout? - example: true + example: false description: cancel_not_running_response_body result type (default view) example: - fault: true + fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request temporary: false - timeout: true + timeout: false required: - name - id @@ -924,16 +921,16 @@ definitions: id: type: integer description: Identifier of missing collection - example: 15237653089904143505 + example: 1 format: int64 message: type: string description: Message of error - example: Accusamus distinctio omnis qui. + example: abc123 description: Collection not found example: - id: 2610080554516588188 - message: Quia dolor ea. + id: 1 + message: abc123 required: - message - id @@ -944,7 +941,7 @@ definitions: fault: type: boolean description: Is the error a server-side fault? - example: true + example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. @@ -960,18 +957,18 @@ definitions: temporary: type: boolean description: Is the error temporary? - example: true + example: false timeout: type: boolean description: Is the error a timeout? example: false description: decide_not_valid_response_body result type (default view) example: - fault: true + fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request - temporary: true + temporary: false timeout: false required: - name @@ -987,16 +984,16 @@ definitions: id: type: integer description: Identifier of missing collection - example: 2691854561358134026 + example: 1 format: int64 message: type: string description: Message of error - example: Consequuntur fuga nesciunt ullam quia et. + example: abc123 description: Collection not found example: - id: 8177308441370769 - message: Fugit amet facilis. + id: 1 + message: abc123 required: - message - id @@ -1007,16 +1004,16 @@ definitions: id: type: integer description: Identifier of missing collection - example: 7811120016112005653 + example: 1 format: int64 message: type: string description: Message of error - example: Voluptatem et est tenetur vel assumenda natus. + example: abc123 description: Collection not found example: - id: 737223079499073311 - message: Nam aliquid quos. + id: 1 + message: abc123 required: - message - id @@ -1028,58 +1025,22 @@ definitions: $ref: '#/definitions/EnduroStoredCollectionResponseBodyCollection' next_cursor: type: string - example: Cupiditate ipsam omnis voluptatem cum. + example: abc123 example: items: - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - next_cursor: Voluptatem error adipisci vel rerum. + - aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + next_cursor: abc123 required: - items CollectionMonitorResponseBody: @@ -1089,31 +1050,31 @@ definitions: id: type: integer description: Identifier of collection - example: 17512028379679435893 + example: 1 format: int64 item: $ref: '#/definitions/EnduroStoredCollectionResponseBody' type: type: string description: Type of the event - example: Voluptatem beatae modi omnis voluptatem et. + example: abc123 description: MonitorResponseBody result type (default view) example: - id: 9151525906289518085 + id: 1 item: - aip_id: 74c66505-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "1992-04-04T11:00:41Z" - created_at: "2000-12-20T12:21:46Z" - id: 15454769769736078970 - name: Sed tempore voluptatum quo pariatur. - original_id: Nisi aliquid. - pipeline_id: 74c6668f-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c66289-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "2011-08-25T19:50:57Z" - status: unknown - transfer_id: 74c663d0-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c660e1-1fd2-11ee-b6e1-7085c27bdeb0 - type: Aliquam aliquid non tempore vel. + aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + type: abc123 required: - id - type @@ -1124,16 +1085,16 @@ definitions: id: type: integer description: Identifier of missing collection - example: 14831543066782228698 + example: 1 format: int64 message: type: string description: Message of error - example: Id ducimus. + example: abc123 description: Collection not found example: - id: 8000312645361077467 - message: Distinctio aspernatur tempora maxime omnis. + id: 1 + message: abc123 required: - message - id @@ -1144,7 +1105,7 @@ definitions: fault: type: boolean description: Is the error a server-side fault? - example: true + example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. @@ -1160,19 +1121,19 @@ definitions: temporary: type: boolean description: Is the error temporary? - example: true + example: false timeout: type: boolean description: Is the error a timeout? example: false description: retry_not_running_response_body result type (default view) example: - fault: true + fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request temporary: false - timeout: true + timeout: false required: - name - id @@ -1187,16 +1148,16 @@ definitions: id: type: integer description: Identifier of missing collection - example: 9835271868051980153 + example: 1 format: int64 message: type: string description: Message of error - example: Ipsa dolor deserunt provident provident. + example: abc123 description: Collection not found example: - id: 6740760545696498930 - message: Exercitationem atque quo impedit non dicta culpa. + id: 1 + message: abc123 required: - message - id @@ -1207,51 +1168,51 @@ definitions: aip_id: type: string description: Identifier of Archivematica AIP - example: 74c85a59-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid completed_at: type: string description: Completion datetime - example: "1995-07-06T21:57:28Z" + example: "1970-01-01T00:00:01Z" format: date-time created_at: type: string description: Creation datetime - example: "1982-12-23T00:51:34Z" + example: "1970-01-01T00:00:01Z" format: date-time id: type: integer description: Identifier of collection - example: 17557787113732579557 + example: 1 format: int64 name: type: string description: Name of the collection - example: Qui numquam totam est. + example: abc123 original_id: type: string description: Identifier provided by the client - example: Quisquam sed sed hic in. + example: abc123 pipeline_id: type: string description: Identifier of Archivematica pipeline - example: 74c85c70-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid run_id: type: string description: Identifier of latest processing workflow run - example: 74c85669-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid started_at: type: string description: Start datetime - example: "1977-11-02T07:18:21Z" + example: "1970-01-01T00:00:01Z" format: date-time status: type: string description: Status of the collection default: new - example: error + example: in progress enum: - new - in progress @@ -1263,28 +1224,28 @@ definitions: - abandoned transfer_id: type: string - description: Identifier of Archivematica transfer - example: 74c8584b-1fd2-11ee-b6e1-7085c27bdeb0 + description: Identifier of Archivematica tranfser + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid workflow_id: type: string description: Identifier of processing workflow - example: 74c8547d-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid description: ShowResponseBody result type (default view) example: - aip_id: 74c86a59-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "1998-11-15T13:24:26Z" - created_at: "1995-01-01T19:38:07Z" - id: 16726981500754704734 - name: In laudantium vero sit debitis. - original_id: Facere molestiae et sunt. - pipeline_id: 74c86c60-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c866c5-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1987-02-13T19:42:16Z" - status: unknown - transfer_id: 74c868a6-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c864ec-1fd2-11ee-b6e1-7085c27bdeb0 + aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 required: - id - status @@ -1296,16 +1257,16 @@ definitions: id: type: integer description: Identifier of missing collection - example: 16822297729379021847 + example: 1 format: int64 message: type: string description: Message of error - example: Autem a a odit architecto quisquam nisi. + example: abc123 description: Collection not found example: - id: 10870541205377463360 - message: Autem et. + id: 1 + message: abc123 required: - message - id @@ -1317,23 +1278,14 @@ definitions: $ref: '#/definitions/EnduroCollectionWorkflowHistoryResponseBodyCollection' status: type: string - example: Voluptatum necessitatibus non cum earum quis. + example: abc123 description: WorkflowResponseBody result type (default view) example: history: - - details: Consequatur aliquam excepturi dolores dolor magnam tempore. - id: 14430854591777067962 - type: Quo ut eveniet et rerum nemo corporis. - - details: Consequatur aliquam excepturi dolores dolor magnam tempore. - id: 14430854591777067962 - type: Quo ut eveniet et rerum nemo corporis. - - details: Consequatur aliquam excepturi dolores dolor magnam tempore. - id: 14430854591777067962 - type: Quo ut eveniet et rerum nemo corporis. - - details: Consequatur aliquam excepturi dolores dolor magnam tempore. - id: 14430854591777067962 - type: Quo ut eveniet et rerum nemo corporis. - status: Aut omnis iusto modi quis distinctio. + - details: abc123 + id: 1 + type: abc123 + status: abc123 EnduroCollectionWorkflowHistoryResponseBody: title: 'Mediatype identifier: application/vnd.enduro.collection-workflow-history; view=default' type: object @@ -1341,22 +1293,22 @@ definitions: details: type: string description: Contents of the event - example: Voluptatum quibusdam. + example: abc123 format: binary id: type: integer description: Identifier of collection - example: 3054458866920097073 + example: 1 format: int64 type: type: string description: Type of the event - example: Id quasi dolor veritatis voluptatem. + example: abc123 description: WorkflowHistoryEvent describes a history event in Temporal. (default view) example: - details: Est aut explicabo perferendis sunt quas. - id: 5532165772958537512 - type: Animi praesentium. + details: abc123 + id: 1 + type: abc123 EnduroCollectionWorkflowHistoryResponseBodyCollection: title: 'Mediatype identifier: application/vnd.enduro.collection-workflow-history; type=collection; view=default' type: array @@ -1364,12 +1316,9 @@ definitions: $ref: '#/definitions/EnduroCollectionWorkflowHistoryResponseBody' description: EnduroCollection-Workflow-HistoryCollectionResponseBody is the result type for an array of EnduroCollection-Workflow-HistoryResponseBody (default view) example: - - details: Consequatur aliquam excepturi dolores dolor magnam tempore. - id: 14430854591777067962 - type: Quo ut eveniet et rerum nemo corporis. - - details: Consequatur aliquam excepturi dolores dolor magnam tempore. - id: 14430854591777067962 - type: Quo ut eveniet et rerum nemo corporis. + - details: abc123 + id: 1 + type: abc123 EnduroStoredCollectionResponseBody: title: 'Mediatype identifier: application/vnd.enduro.stored-collection; view=default' type: object @@ -1377,51 +1326,51 @@ definitions: aip_id: type: string description: Identifier of Archivematica AIP - example: 74c831a8-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid completed_at: type: string description: Completion datetime - example: "1970-10-15T00:03:22Z" + example: "1970-01-01T00:00:01Z" format: date-time created_at: type: string description: Creation datetime - example: "2007-04-29T00:55:57Z" + example: "1970-01-01T00:00:01Z" format: date-time id: type: integer description: Identifier of collection - example: 12195178451962438920 + example: 1 format: int64 name: type: string description: Name of the collection - example: At est excepturi dignissimos. + example: abc123 original_id: type: string description: Identifier provided by the client - example: Quis iure. + example: abc123 pipeline_id: type: string description: Identifier of Archivematica pipeline - example: 74c833c0-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid run_id: type: string description: Identifier of latest processing workflow run - example: 74c82d7b-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid started_at: type: string description: Start datetime - example: "1978-05-27T01:41:50Z" + example: "1970-01-01T00:00:01Z" format: date-time status: type: string description: Status of the collection default: new - example: done + example: in progress enum: - new - in progress @@ -1433,28 +1382,28 @@ definitions: - abandoned transfer_id: type: string - description: Identifier of Archivematica transfer - example: 74c82fa7-1fd2-11ee-b6e1-7085c27bdeb0 + description: Identifier of Archivematica tranfser + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid workflow_id: type: string description: Identifier of processing workflow - example: 74c82b2f-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid description: StoredCollection describes a collection retrieved by the service. (default view) example: - aip_id: 74c8414e-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "1977-12-10T11:31:25Z" - created_at: "1999-04-24T03:56:53Z" - id: 10895205645452708913 - name: Est voluptate quis sunt. - original_id: Velit nisi dolorum inventore. - pipeline_id: 74c84309-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c83d99-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1989-12-22T07:05:18Z" + aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" status: in progress - transfer_id: 74c83f81-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c83bc0-1fd2-11ee-b6e1-7085c27bdeb0 + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 required: - id - status @@ -1466,54 +1415,18 @@ definitions: $ref: '#/definitions/EnduroStoredCollectionResponseBody' description: EnduroStored-CollectionCollectionResponseBody is the result type for an array of EnduroStored-CollectionResponseBody (default view) example: - - aip_id: 74c66505-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "1992-04-04T11:00:41Z" - created_at: "2000-12-20T12:21:46Z" - id: 15454769769736078970 - name: Sed tempore voluptatum quo pariatur. - original_id: Nisi aliquid. - pipeline_id: 74c6668f-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c66289-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "2011-08-25T19:50:57Z" - status: unknown - transfer_id: 74c663d0-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c660e1-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c66505-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "1992-04-04T11:00:41Z" - created_at: "2000-12-20T12:21:46Z" - id: 15454769769736078970 - name: Sed tempore voluptatum quo pariatur. - original_id: Nisi aliquid. - pipeline_id: 74c6668f-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c66289-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "2011-08-25T19:50:57Z" - status: unknown - transfer_id: 74c663d0-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c660e1-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c66505-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "1992-04-04T11:00:41Z" - created_at: "2000-12-20T12:21:46Z" - id: 15454769769736078970 - name: Sed tempore voluptatum quo pariatur. - original_id: Nisi aliquid. - pipeline_id: 74c6668f-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c66289-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "2011-08-25T19:50:57Z" - status: unknown - transfer_id: 74c663d0-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c660e1-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c66505-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "1992-04-04T11:00:41Z" - created_at: "2000-12-20T12:21:46Z" - id: 15454769769736078970 - name: Sed tempore voluptatum quo pariatur. - original_id: Nisi aliquid. - pipeline_id: 74c6668f-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c66289-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "2011-08-25T19:50:57Z" - status: unknown - transfer_id: 74c663d0-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c660e1-1fd2-11ee-b6e1-7085c27bdeb0 + - aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 EnduroStoredPipelineResponse: title: 'Mediatype identifier: application/vnd.enduro.stored-pipeline; view=default' type: object @@ -1521,32 +1434,32 @@ definitions: capacity: type: integer description: Maximum concurrent transfers - example: 5490808095495946983 + example: 1 format: int64 current: type: integer description: Current transfers - example: 5311713486168500071 + example: 1 format: int64 id: type: string - description: Identifier of the pipeline - example: 74c8ba37-1fd2-11ee-b6e1-7085c27bdeb0 + description: Identifier of pipeline + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid name: type: string description: Name of the pipeline - example: Excepturi iste aperiam laborum suscipit aut. + example: abc123 status: type: string - example: Id quae et. + example: abc123 description: StoredPipeline describes a pipeline retrieved by this service. (default view) example: - capacity: 2222693760767986291 - current: 2153194333007283248 - id: 74c8bbe9-1fd2-11ee-b6e1-7085c27bdeb0 - name: Aut consequatur eos provident. - status: Ad ipsa. + capacity: 1 + current: 1 + id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + name: abc123 + status: abc123 required: - name PipelineProcessingNotFoundResponseBody: @@ -1556,15 +1469,15 @@ definitions: id: type: string description: Identifier of missing pipeline - example: Id corrupti quia praesentium. + example: abc123 message: type: string description: Message of error - example: Harum totam sit inventore impedit voluptates vel. + example: abc123 description: Pipeline not found example: - id: Sed distinctio qui non. - message: Qui inventore hic voluptates eos. + id: abc123 + message: abc123 required: - message - id @@ -1575,15 +1488,15 @@ definitions: id: type: string description: Identifier of missing pipeline - example: Molestiae animi et. + example: abc123 message: type: string description: Message of error - example: Aut quibusdam et ut hic fuga sed. + example: abc123 description: Pipeline not found example: - id: Magnam est veritatis ut autem. - message: Voluptatem animi est praesentium officiis. + id: abc123 + message: abc123 required: - message - id @@ -1594,31 +1507,31 @@ definitions: capacity: type: integer description: Maximum concurrent transfers - example: 393947975496952716 + example: 1 format: int64 current: type: integer description: Current transfers - example: 4131578484904641155 + example: 1 format: int64 id: type: string - description: Identifier of the pipeline - example: 74c8be2e-1fd2-11ee-b6e1-7085c27bdeb0 + description: Identifier of pipeline + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid name: type: string description: Name of the pipeline - example: Beatae dolorem. + example: abc123 status: type: string - example: Velit illo nemo fugiat. + example: abc123 description: ShowResponseBody result type (default view) example: - capacity: 6664446055604236601 - current: 7662943385375122421 - id: 74c8bfb6-1fd2-11ee-b6e1-7085c27bdeb0 - name: Molestiae esse consequatur reprehenderit animi veniam. - status: Omnis ut tenetur dolorum. + capacity: 1 + current: 1 + id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + name: abc123 + status: abc123 required: - name diff --git a/internal/api/gen/http/openapi3.json b/internal/api/gen/http/openapi3.json index c44542a1..c1ddac02 100644 --- a/internal/api/gen/http/openapi3.json +++ b/internal/api/gen/http/openapi3.json @@ -1 +1,1656 @@ -{"openapi":"3.0.3","info":{"title":"Enduro API","version":"1.0"},"servers":[{"url":"http://localhost:9000"}],"paths":{"/batch":{"get":{"tags":["batch"],"summary":"status batch","description":"Retrieve status of current batch operation.","operationId":"batch#status","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchStatusResult"},"example":{"run_id":"Illo impedit vero.","running":true,"status":"Illum excepturi magni quidem.","workflow_id":"Vel sint ducimus officia labore eius qui."}}}}}},"post":{"tags":["batch"],"summary":"submit batch","description":"Submit a new batch","operationId":"batch#submit","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitRequestBody"},"example":{"completed_dir":"Laboriosam odit.","path":"Laboriosam nam sit nihil.","pipeline":"Necessitatibus vel aut deleniti quia qui.","processing_config":"Vel voluptatem.","retention_period":"Sed perferendis illum illum omnis et officiis."}}}},"responses":{"202":{"description":"Accepted response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResult"},"example":{"run_id":"Debitis rerum.","workflow_id":"Velit possimus et ea aut harum."}}}},"400":{"description":"not_valid: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"not_available: Conflict response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/batch/hints":{"get":{"tags":["batch"],"summary":"hints batch","description":"Retrieve form hints","operationId":"batch#hints","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchHintsResult"},"example":{"completed_dirs":["Quo illo natus et.","Eaque suscipit in cum et quia facere."]}}}}}}},"/collection":{"get":{"tags":["collection"],"summary":"list collection","description":"List all stored collections","operationId":"collection#list","parameters":[{"name":"name","in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"Ullam provident hic."},"example":"Quod magni blanditiis sequi."},{"name":"original_id","in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"Neque velit debitis ducimus minima totam."},"example":"Vero aliquam."},{"name":"transfer_id","in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"74c8f444-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"example":"74c8f57d-1fd2-11ee-b6e1-7085c27bdeb0"},{"name":"aip_id","in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"74c8f6b7-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"example":"74c8f7e0-1fd2-11ee-b6e1-7085c27bdeb0"},{"name":"pipeline_id","in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"74c8f94e-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"example":"74c8fa84-1fd2-11ee-b6e1-7085c27bdeb0"},{"name":"earliest_created_time","in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"2014-09-01T05:29:40Z","format":"date-time"},"example":"1993-06-19T11:51:33Z"},{"name":"latest_created_time","in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"1976-02-19T04:59:41Z","format":"date-time"},"example":"2006-08-01T15:51:22Z"},{"name":"status","in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"pending","enum":["new","in progress","done","error","unknown","queued","pending","abandoned"]},"example":"pending"},{"name":"cursor","in":"query","description":"Pagination cursor","allowEmptyValue":true,"schema":{"type":"string","description":"Pagination cursor","example":"Officia optio et quibusdam hic quae."},"example":"Fuga aut voluptate est nihil in ut."}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponseBody"},"example":{"items":[{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"}],"next_cursor":"Inventore et officiis ad."}}}}}}},"/collection/bulk":{"get":{"tags":["collection"],"summary":"bulk_status collection","description":"Retrieve status of current bulk operation.","operationId":"collection#bulk_status","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkStatusResult"},"example":{"closed_at":"1972-05-14T21:43:37Z","run_id":"Vitae ad.","running":false,"started_at":"1974-03-03T20:33:17Z","status":"Adipisci officiis eaque architecto.","workflow_id":"Pariatur rerum voluptas iusto."}}}}}},"post":{"tags":["collection"],"summary":"bulk collection","description":"Bulk operations (retry, cancel...).","operationId":"collection#bulk","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRequestBody"},"example":{"operation":"retry","size":4225703995272354524,"status":"new"}}}},"responses":{"202":{"description":"Accepted response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResult"},"example":{"run_id":"Optio reprehenderit cumque rerum sunt hic velit.","workflow_id":"Quibusdam dolore in aliquid."}}}},"400":{"description":"not_valid: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"not_available: Conflict response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/collection/monitor":{"get":{"tags":["collection"],"summary":"monitor collection","operationId":"collection#monitor","responses":{"101":{"description":"Switching Protocols response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnduroMonitorUpdate"},"example":{"id":7891370028970844776,"item":{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},"type":"Mollitia tenetur voluptatum."}}}}}}},"/collection/{id}":{"delete":{"tags":["collection"],"summary":"delete collection","description":"Delete collection by ID","operationId":"collection#delete","parameters":[{"name":"id","in":"path","description":"Identifier of collection to delete","required":true,"schema":{"type":"integer","description":"Identifier of collection to delete","example":6902768091720524842},"example":18349184252340015779}],"responses":{"204":{"description":"No Content response."},"404":{"description":"not_found: Collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionNotfound"},"example":{"id":6101152394700680766,"message":"Fugit et porro suscipit."}}}}}},"get":{"tags":["collection"],"summary":"show collection","description":"Show collection by ID","operationId":"collection#show","parameters":[{"name":"id","in":"path","description":"Identifier of collection to show","required":true,"schema":{"type":"integer","description":"Identifier of collection to show","example":3443956377255456278},"example":8876636575521251599}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnduroStoredCollection"},"example":{"aip_id":"74c6ba20-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2000-10-04T09:57:15Z","created_at":"2010-07-22T22:55:51Z","id":15148517886629496057,"name":"Amet vero quam.","original_id":"Et consequatur aut enim consequuntur debitis temporibus.","pipeline_id":"74c6bb71-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c6b7b4-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"2014-07-31T20:44:18Z","status":"abandoned","transfer_id":"74c6b8f6-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c6b657-1fd2-11ee-b6e1-7085c27bdeb0"}}}},"404":{"description":"not_found: Collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionNotfound"},"example":{"id":1094484444001815440,"message":"Praesentium et nam."}}}}}}},"/collection/{id}/cancel":{"post":{"tags":["collection"],"summary":"cancel collection","description":"Cancel collection processing by ID","operationId":"collection#cancel","parameters":[{"name":"id","in":"path","description":"Identifier of collection to remove","required":true,"schema":{"type":"integer","description":"Identifier of collection to remove","example":5300588831543103027},"example":130236761498329200}],"responses":{"200":{"description":"OK response."},"400":{"description":"not_running: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found: Collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionNotfound"},"example":{"id":5550828451059843862,"message":"At velit quod et maxime quia."}}}}}}},"/collection/{id}/decision":{"post":{"tags":["collection"],"summary":"decide collection","description":"Make decision for a pending collection by ID","operationId":"collection#decide","parameters":[{"name":"id","in":"path","description":"Identifier of collection to look up","required":true,"schema":{"type":"integer","description":"Identifier of collection to look up","example":4457285347556290353},"example":16836367451314582765}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"option":{"type":"string","description":"Decision option to proceed with","example":"Ut earum."}},"example":{"option":"In non earum voluptas quidem ut sit."}},"example":{"option":"Qui id optio officiis est facere."}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"not_valid: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found: Collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionNotfound"},"example":{"id":17390755426644366260,"message":"Numquam aut dolores et voluptas repellat."}}}}}}},"/collection/{id}/download":{"get":{"tags":["collection"],"summary":"download collection","description":"Download collection by ID","operationId":"collection#download","parameters":[{"name":"id","in":"path","description":"Identifier of collection to look up","required":true,"schema":{"type":"integer","description":"Identifier of collection to look up","example":13985264076619419699},"example":10131890621733502138}],"responses":{"200":{"description":"OK response.","headers":{"Content-Disposition":{"required":true,"schema":{"type":"string","example":"Vitae et saepe reiciendis quia perspiciatis."},"example":"Nemo natus et praesentium voluptatem."},"Content-Length":{"required":true,"schema":{"type":"integer","example":9198655460133316854,"format":"int64"},"example":890283335835053110},"Content-Type":{"required":true,"schema":{"type":"string","example":"Ex officia qui ratione doloribus ut."},"example":"Excepturi architecto illum et consequatur optio corporis."}},"content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"not_found: Collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionNotfound"},"example":{"id":3923434489665488889,"message":"Impedit atque qui praesentium."}}}}}}},"/collection/{id}/retry":{"post":{"tags":["collection"],"summary":"retry collection","description":"Retry collection processing by ID","operationId":"collection#retry","parameters":[{"name":"id","in":"path","description":"Identifier of collection to retry","required":true,"schema":{"type":"integer","description":"Identifier of collection to retry","example":3834985783644764482},"example":4540644571238284304}],"responses":{"200":{"description":"OK response."},"400":{"description":"not_running: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found: Collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionNotfound"},"example":{"id":9720827093168823906,"message":"Repudiandae optio accusamus dolor minus."}}}}}}},"/collection/{id}/workflow":{"get":{"tags":["collection"],"summary":"workflow collection","description":"Retrieve workflow status by ID","operationId":"collection#workflow","parameters":[{"name":"id","in":"path","description":"Identifier of collection to look up","required":true,"schema":{"type":"integer","description":"Identifier of collection to look up","example":9575338825465548751},"example":17105214700194171972}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnduroCollectionWorkflowStatus"},"example":{"history":[{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."},{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."},{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."},{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."}],"status":"Fugiat officia repellat."}}}},"404":{"description":"not_found: Collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionNotfound"},"example":{"id":15910226027846952295,"message":"Distinctio dolorem cum optio non a."}}}}}}},"/pipeline":{"get":{"tags":["pipeline"],"summary":"list pipeline","description":"List all known pipelines","operationId":"pipeline#list","parameters":[{"name":"name","in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"Quo est iure sequi aliquam eligendi."},"example":"Rerum ut qui et."},{"name":"status","in":"query","allowEmptyValue":true,"schema":{"type":"boolean","default":false,"example":false},"example":true}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnduroStoredPipeline"},"example":[{"capacity":8406108818872523115,"current":1737602466879989319,"id":"74c5f141-1fd2-11ee-b6e1-7085c27bdeb0","name":"Eius perferendis et corrupti harum nisi voluptatibus.","status":"Qui explicabo qui error sint."},{"capacity":8406108818872523115,"current":1737602466879989319,"id":"74c5f141-1fd2-11ee-b6e1-7085c27bdeb0","name":"Eius perferendis et corrupti harum nisi voluptatibus.","status":"Qui explicabo qui error sint."},{"capacity":8406108818872523115,"current":1737602466879989319,"id":"74c5f141-1fd2-11ee-b6e1-7085c27bdeb0","name":"Eius perferendis et corrupti harum nisi voluptatibus.","status":"Qui explicabo qui error sint."}]},"example":[{"capacity":8406108818872523115,"current":1737602466879989319,"id":"74c5f141-1fd2-11ee-b6e1-7085c27bdeb0","name":"Eius perferendis et corrupti harum nisi voluptatibus.","status":"Qui explicabo qui error sint."},{"capacity":8406108818872523115,"current":1737602466879989319,"id":"74c5f141-1fd2-11ee-b6e1-7085c27bdeb0","name":"Eius perferendis et corrupti harum nisi voluptatibus.","status":"Qui explicabo qui error sint."},{"capacity":8406108818872523115,"current":1737602466879989319,"id":"74c5f141-1fd2-11ee-b6e1-7085c27bdeb0","name":"Eius perferendis et corrupti harum nisi voluptatibus.","status":"Qui explicabo qui error sint."},{"capacity":8406108818872523115,"current":1737602466879989319,"id":"74c5f141-1fd2-11ee-b6e1-7085c27bdeb0","name":"Eius perferendis et corrupti harum nisi voluptatibus.","status":"Qui explicabo qui error sint."}]}}}}}},"/pipeline/{id}":{"get":{"tags":["pipeline"],"summary":"show pipeline","description":"Show pipeline by ID","operationId":"pipeline#show","parameters":[{"name":"id","in":"path","description":"Identifier of pipeline to show","required":true,"schema":{"type":"string","description":"Identifier of pipeline to show","example":"74c905a5-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"example":"74c906f2-1fd2-11ee-b6e1-7085c27bdeb0"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnduroStoredPipeline"},"example":{"capacity":6519501965408371640,"current":7650363469056154510,"id":"74c7d69d-1fd2-11ee-b6e1-7085c27bdeb0","name":"Aut vel quisquam aut.","status":"Et harum."}}}},"404":{"description":"not_found: Pipeline not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineNotFound"},"example":{"id":"Minus nobis.","message":"Incidunt quia."}}}}}}},"/pipeline/{id}/processing":{"get":{"tags":["pipeline"],"summary":"processing pipeline","description":"List all processing configurations of a pipeline given its ID","operationId":"pipeline#processing","parameters":[{"name":"id","in":"path","description":"Identifier of pipeline","required":true,"schema":{"type":"string","description":"Identifier of pipeline","example":"74c908d2-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"example":"74c90a0a-1fd2-11ee-b6e1-7085c27bdeb0"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","example":"Ducimus aut at optio."},"example":["Iste numquam rem quo eligendi.","Est autem magnam porro in.","Amet architecto non repudiandae neque dolorem."]},"example":["Et minus reprehenderit nobis ratione perferendis debitis.","Autem molestias repellendus nihil.","Ut magni dolorem minus ut.","Aliquam nostrum laborum impedit quo magnam."]}}},"404":{"description":"not_found: Pipeline not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineNotFound"},"example":{"id":"Ab consectetur.","message":"Fugit ipsam."}}}}}}},"/swagger/swagger.json":{"get":{"tags":["swagger"],"summary":"Download internal/api/gen/http/openapi.json","description":"JSON document containing the API swagger definition.","operationId":"swagger#/swagger/swagger.json","responses":{"200":{"description":"File downloaded"}}}}},"components":{"schemas":{"BatchHintsResult":{"type":"object","properties":{"completed_dirs":{"type":"array","items":{"type":"string","example":"Eos consequuntur aliquam culpa."},"description":"A list of known values of completedDir used by existing watchers.","example":["Perspiciatis aperiam est optio repellendus.","Consequatur mollitia.","Tempora quia aperiam saepe quos distinctio deserunt.","Voluptas ut cupiditate expedita distinctio qui aut."]}},"example":{"completed_dirs":["Quis aut sint recusandae eum et et.","Eius odio eos hic et."]}},"BatchResult":{"type":"object","properties":{"run_id":{"type":"string","example":"Vitae fugit quis tempore animi ad ab."},"workflow_id":{"type":"string","example":"Deserunt a enim cum ad quasi qui."}},"example":{"run_id":"Velit aperiam nemo dolorem.","workflow_id":"Beatae blanditiis qui et ut recusandae id."},"required":["workflow_id","run_id"]},"BatchStatusResult":{"type":"object","properties":{"run_id":{"type":"string","example":"Cumque in qui voluptas et culpa beatae."},"running":{"type":"boolean","example":true},"status":{"type":"string","example":"Et rem et."},"workflow_id":{"type":"string","example":"Minima sunt."}},"example":{"run_id":"Commodi ea.","running":false,"status":"Suscipit tempore est quisquam ratione.","workflow_id":"In perferendis maiores aperiam praesentium voluptatum."},"required":["running"]},"BulkRequestBody":{"type":"object","properties":{"operation":{"type":"string","example":"retry","enum":["retry","cancel","abandon"]},"size":{"type":"integer","default":100,"example":11486195732644611448},"status":{"type":"string","example":"error","enum":["new","in progress","done","error","unknown","queued","pending","abandoned"]}},"example":{"operation":"retry","size":8043946392141519475,"status":"queued"},"required":["operation","status"]},"BulkStatusResult":{"type":"object","properties":{"closed_at":{"type":"string","example":"2009-03-17T21:19:05Z","format":"date-time"},"run_id":{"type":"string","example":"Reiciendis quae praesentium."},"running":{"type":"boolean","example":true},"started_at":{"type":"string","example":"1990-10-26T11:38:26Z","format":"date-time"},"status":{"type":"string","example":"Et magnam."},"workflow_id":{"type":"string","example":"Molestiae alias qui."}},"example":{"closed_at":"1984-10-02T03:20:21Z","run_id":"Ad animi quia ut.","running":true,"started_at":"1989-09-09T08:36:56Z","status":"Assumenda doloremque.","workflow_id":"Quia consequuntur modi nobis hic."},"required":["running"]},"CollectionNotfound":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of missing collection","example":2027358448008122767},"message":{"type":"string","description":"Message of error","example":"Distinctio vero quis."}},"description":"Collection not found","example":{"id":5951986551772317924,"message":"Voluptatem asperiores nobis maiores."},"required":["message","id"]},"EnduroCollectionWorkflowHistory":{"type":"object","properties":{"details":{"type":"string","description":"Contents of the event","example":"Dolorem nulla quod sed fuga ipsam necessitatibus.","format":"binary"},"id":{"type":"integer","description":"Identifier of collection","example":12390213551385939615},"type":{"type":"string","description":"Type of the event","example":"Dolore neque voluptas quasi deserunt excepturi tempora."}},"description":"WorkflowHistoryEvent describes a history event in Temporal.","example":{"details":"Praesentium asperiores commodi earum neque est.","id":10336837935106508770,"type":"Magnam animi adipisci debitis aut."}},"EnduroCollectionWorkflowHistoryCollection":{"type":"array","items":{"$ref":"#/components/schemas/EnduroCollectionWorkflowHistory"},"example":[{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."},{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."},{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."},{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."}]},"EnduroCollectionWorkflowStatus":{"type":"object","properties":{"history":{"$ref":"#/components/schemas/EnduroCollectionWorkflowHistoryCollection"},"status":{"type":"string","example":"Iure unde expedita rem rem quia qui."}},"example":{"history":[{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."},{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."},{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."},{"details":"In quis sed.","id":2015423930972900414,"type":"Enim esse aut accusantium deleniti beatae voluptas."}],"status":"Illum nisi."}},"EnduroMonitorUpdate":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of collection","example":8328444150931638539},"item":{"$ref":"#/components/schemas/EnduroStoredCollection"},"type":{"type":"string","description":"Type of the event","example":"Quia ducimus est consequuntur."}},"example":{"id":11444306754916384419,"item":{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},"type":"Quo omnis neque recusandae."},"required":["id","type"]},"EnduroStoredCollection":{"type":"object","properties":{"aip_id":{"type":"string","description":"Identifier of Archivematica AIP","example":"74c8d480-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"completed_at":{"type":"string","description":"Completion datetime","example":"2014-09-05T06:13:17Z","format":"date-time"},"created_at":{"type":"string","description":"Creation datetime","example":"1974-07-28T19:08:58Z","format":"date-time"},"id":{"type":"integer","description":"Identifier of collection","example":13274364832877317318},"name":{"type":"string","description":"Name of the collection","example":"Aspernatur rerum."},"original_id":{"type":"string","description":"Identifier provided by the client","example":"Possimus dolores ea voluptatum unde laborum temporibus."},"pipeline_id":{"type":"string","description":"Identifier of Archivematica pipeline","example":"74c8d5ba-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"run_id":{"type":"string","description":"Identifier of latest processing workflow run","example":"74c8d1fe-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"started_at":{"type":"string","description":"Start datetime","example":"2014-04-05T03:43:54Z","format":"date-time"},"status":{"type":"string","description":"Status of the collection","default":"new","example":"in progress","enum":["new","in progress","done","error","unknown","queued","pending","abandoned"]},"transfer_id":{"type":"string","description":"Identifier of Archivematica transfer","example":"74c8d335-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"workflow_id":{"type":"string","description":"Identifier of processing workflow","example":"74c8d0a5-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"}},"description":"StoredCollection describes a collection retrieved by the service.","example":{"aip_id":"74c8de4c-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"1980-12-20T11:42:22Z","created_at":"2004-04-26T10:09:21Z","id":6450261145143832540,"name":"Aperiam eius maxime eum et et.","original_id":"Magni numquam deserunt officia.","pipeline_id":"74c8df6b-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c8dbe4-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1972-09-20T09:42:05Z","status":"abandoned","transfer_id":"74c8dd1c-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c8daaa-1fd2-11ee-b6e1-7085c27bdeb0"},"required":["id","status","created_at"]},"EnduroStoredCollectionCollection":{"type":"array","items":{"$ref":"#/components/schemas/EnduroStoredCollection"},"example":[{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"}]},"EnduroStoredPipeline":{"type":"object","properties":{"capacity":{"type":"integer","description":"Maximum concurrent transfers","example":1823829890965386700,"format":"int64"},"current":{"type":"integer","description":"Current transfers","example":3880544084422320312,"format":"int64"},"id":{"type":"string","description":"Identifier of the pipeline","example":"74c8ee0d-1fd2-11ee-b6e1-7085c27bdeb0","format":"uuid"},"name":{"type":"string","description":"Name of the pipeline","example":"Dolores qui unde est."},"status":{"type":"string","example":"Modi est nobis sit."}},"description":"StoredPipeline describes a pipeline retrieved by this service.","example":{"capacity":5308951979130794190,"current":5228065542663504565,"id":"74c8ef7d-1fd2-11ee-b6e1-7085c27bdeb0","name":"Nobis autem voluptate.","status":"Ut corrupti velit enim."},"required":["name"]},"Error":{"type":"object","properties":{"fault":{"type":"boolean","description":"Is the error a server-side fault?","example":true},"id":{"type":"string","description":"ID is a unique identifier for this particular occurrence of the problem.","example":"123abc"},"message":{"type":"string","description":"Message is a human-readable explanation specific to this occurrence of the problem.","example":"parameter 'p' must be an integer"},"name":{"type":"string","description":"Name is the name of this class of errors.","example":"bad_request"},"temporary":{"type":"boolean","description":"Is the error temporary?","example":true},"timeout":{"type":"boolean","description":"Is the error a timeout?","example":false}},"example":{"fault":true,"id":"123abc","message":"parameter 'p' must be an integer","name":"bad_request","temporary":false,"timeout":false},"required":["name","id","message","temporary","timeout","fault"]},"ListResponseBody":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/EnduroStoredCollectionCollection"},"next_cursor":{"type":"string","example":"Vel quam."}},"example":{"items":[{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"},{"aip_id":"74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0","completed_at":"2014-01-26T22:52:33Z","created_at":"2006-09-07T19:48:15Z","id":5273261262554249024,"name":"Iusto laudantium assumenda.","original_id":"Voluptatem eum et rerum.","pipeline_id":"74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0","run_id":"74c5b818-1fd2-11ee-b6e1-7085c27bdeb0","started_at":"1986-05-13T23:32:21Z","status":"unknown","transfer_id":"74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0","workflow_id":"74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0"}],"next_cursor":"Voluptatem porro omnis."},"required":["items"]},"PipelineNotFound":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of missing pipeline","example":"Vel nesciunt quo consequuntur quis nisi."},"message":{"type":"string","description":"Message of error","example":"Distinctio illum."}},"description":"Pipeline not found","example":{"id":"Voluptatibus ea ut repellendus similique minima et.","message":"At beatae quidem illo ducimus et."},"required":["message","id"]},"SubmitRequestBody":{"type":"object","properties":{"completed_dir":{"type":"string","example":"Illum illum tenetur."},"path":{"type":"string","example":"Ut aspernatur et voluptatem quibusdam facilis."},"pipeline":{"type":"string","example":"A veritatis vel eos."},"processing_config":{"type":"string","example":"Sunt ut."},"retention_period":{"type":"string","example":"Voluptates nulla autem et perspiciatis libero voluptas."}},"example":{"completed_dir":"Necessitatibus voluptas mollitia dolore.","path":"Voluptates et molestiae eum et occaecati.","pipeline":"Et et eligendi voluptatem.","processing_config":"Fugiat a officiis ipsum.","retention_period":"Qui rerum asperiores qui."},"required":["path"]}}},"tags":[{"name":"batch","description":"The batch service manages batches of collections."},{"name":"collection","description":"The collection service manages packages being transferred to Archivematica."},{"name":"pipeline","description":"The pipeline service manages Archivematica pipelines."},{"name":"swagger","description":"The swagger service serves the API swagger definition."}]} \ No newline at end of file +{ + "components": { + "schemas": { + "BatchHintsResult": { + "example": { + "completed_dirs": [ + "abc123" + ] + }, + "properties": { + "completed_dirs": { + "description": "A list of known values of completedDir used by existing watchers.", + "example": [ + "abc123" + ], + "items": { + "example": "abc123", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchResult": { + "example": { + "run_id": "abc123", + "workflow_id": "abc123" + }, + "properties": { + "run_id": { + "example": "abc123", + "type": "string" + }, + "workflow_id": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "workflow_id", + "run_id" + ], + "type": "object" + }, + "BatchStatusResult": { + "example": { + "run_id": "abc123", + "running": false, + "status": "abc123", + "workflow_id": "abc123" + }, + "properties": { + "run_id": { + "example": "abc123", + "type": "string" + }, + "running": { + "example": false, + "type": "boolean" + }, + "status": { + "example": "abc123", + "type": "string" + }, + "workflow_id": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "running" + ], + "type": "object" + }, + "BulkRequestBody": { + "example": { + "operation": "cancel", + "size": 1, + "status": "in progress" + }, + "properties": { + "operation": { + "enum": [ + "retry", + "cancel", + "abandon" + ], + "example": "cancel", + "type": "string" + }, + "size": { + "default": 100, + "example": 1, + "type": "integer" + }, + "status": { + "enum": [ + "new", + "in progress", + "done", + "error", + "unknown", + "queued", + "pending", + "abandoned" + ], + "example": "in progress", + "type": "string" + } + }, + "required": [ + "operation", + "status" + ], + "type": "object" + }, + "BulkStatusResult": { + "example": { + "closed_at": "1970-01-01T00:00:01Z", + "run_id": "abc123", + "running": false, + "started_at": "1970-01-01T00:00:01Z", + "status": "abc123", + "workflow_id": "abc123" + }, + "properties": { + "closed_at": { + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "run_id": { + "example": "abc123", + "type": "string" + }, + "running": { + "example": false, + "type": "boolean" + }, + "started_at": { + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "status": { + "example": "abc123", + "type": "string" + }, + "workflow_id": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "running" + ], + "type": "object" + }, + "CollectionNotfound": { + "description": "Collection not found", + "example": { + "id": 1, + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing collection", + "example": 1, + "type": "integer" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "type": "object" + }, + "EnduroCollectionWorkflowHistory": { + "description": "WorkflowHistoryEvent describes a history event in Temporal.", + "example": { + "details": "abc123", + "id": 1, + "type": "abc123" + }, + "properties": { + "details": { + "description": "Contents of the event", + "example": "abc123", + "format": "binary", + "type": "string" + }, + "id": { + "description": "Identifier of collection", + "example": 1, + "type": "integer" + }, + "type": { + "description": "Type of the event", + "example": "abc123", + "type": "string" + } + }, + "type": "object" + }, + "EnduroCollectionWorkflowHistoryCollection": { + "example": [ + { + "details": "abc123", + "id": 1, + "type": "abc123" + } + ], + "items": { + "$ref": "#/components/schemas/EnduroCollectionWorkflowHistory" + }, + "type": "array" + }, + "EnduroCollectionWorkflowStatus": { + "example": { + "history": [ + { + "details": "abc123", + "id": 1, + "type": "abc123" + } + ], + "status": "abc123" + }, + "properties": { + "history": { + "$ref": "#/components/schemas/EnduroCollectionWorkflowHistoryCollection" + }, + "status": { + "example": "abc123", + "type": "string" + } + }, + "type": "object" + }, + "EnduroMonitorUpdate": { + "example": { + "id": 1, + "item": { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + }, + "type": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of collection", + "example": 1, + "type": "integer" + }, + "item": { + "$ref": "#/components/schemas/EnduroStoredCollection" + }, + "type": { + "description": "Type of the event", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "EnduroStoredCollection": { + "description": "StoredCollection describes a collection retrieved by the service.", + "example": { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + }, + "properties": { + "aip_id": { + "description": "Identifier of Archivematica AIP", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "completed_at": { + "description": "Completion datetime", + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Creation datetime", + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "Identifier of collection", + "example": 1, + "type": "integer" + }, + "name": { + "description": "Name of the collection", + "example": "abc123", + "type": "string" + }, + "original_id": { + "description": "Identifier provided by the client", + "example": "abc123", + "type": "string" + }, + "pipeline_id": { + "description": "Identifier of Archivematica pipeline", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "run_id": { + "description": "Identifier of latest processing workflow run", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "started_at": { + "description": "Start datetime", + "example": "1970-01-01T00:00:01Z", + "format": "date-time", + "type": "string" + }, + "status": { + "default": "new", + "description": "Status of the collection", + "enum": [ + "new", + "in progress", + "done", + "error", + "unknown", + "queued", + "pending", + "abandoned" + ], + "example": "in progress", + "type": "string" + }, + "transfer_id": { + "description": "Identifier of Archivematica tranfser", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "workflow_id": { + "description": "Identifier of processing workflow", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "id", + "status", + "created_at" + ], + "type": "object" + }, + "EnduroStoredCollectionCollection": { + "example": [ + { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + } + ], + "items": { + "$ref": "#/components/schemas/EnduroStoredCollection" + }, + "type": "array" + }, + "EnduroStoredPipeline": { + "description": "StoredPipeline describes a pipeline retrieved by this service.", + "example": { + "capacity": 1, + "current": 1, + "id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "name": "abc123", + "status": "abc123" + }, + "properties": { + "capacity": { + "description": "Maximum concurrent transfers", + "example": 1, + "format": "int64", + "type": "integer" + }, + "current": { + "description": "Current transfers", + "example": 1, + "format": "int64", + "type": "integer" + }, + "id": { + "description": "Identifier of pipeline", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the pipeline", + "example": "abc123", + "type": "string" + }, + "status": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "Error": { + "example": { + "fault": false, + "id": "123abc", + "message": "parameter 'p' must be an integer", + "name": "bad_request", + "temporary": false, + "timeout": false + }, + "properties": { + "fault": { + "description": "Is the error a server-side fault?", + "example": false, + "type": "boolean" + }, + "id": { + "description": "ID is a unique identifier for this particular occurrence of the problem.", + "example": "123abc", + "type": "string" + }, + "message": { + "description": "Message is a human-readable explanation specific to this occurrence of the problem.", + "example": "parameter 'p' must be an integer", + "type": "string" + }, + "name": { + "description": "Name is the name of this class of errors.", + "example": "bad_request", + "type": "string" + }, + "temporary": { + "description": "Is the error temporary?", + "example": false, + "type": "boolean" + }, + "timeout": { + "description": "Is the error a timeout?", + "example": false, + "type": "boolean" + } + }, + "required": [ + "name", + "id", + "message", + "temporary", + "timeout", + "fault" + ], + "type": "object" + }, + "ListResponseBody": { + "example": { + "items": [ + { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + } + ], + "next_cursor": "abc123" + }, + "properties": { + "items": { + "$ref": "#/components/schemas/EnduroStoredCollectionCollection" + }, + "next_cursor": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "items" + ], + "type": "object" + }, + "PipelineNotFound": { + "description": "Pipeline not found", + "example": { + "id": "abc123", + "message": "abc123" + }, + "properties": { + "id": { + "description": "Identifier of missing pipeline", + "example": "abc123", + "type": "string" + }, + "message": { + "description": "Message of error", + "example": "abc123", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "type": "object" + }, + "SubmitRequestBody": { + "example": { + "completed_dir": "abc123", + "path": "abc123", + "pipeline": "abc123", + "processing_config": "abc123", + "retention_period": "abc123" + }, + "properties": { + "completed_dir": { + "example": "abc123", + "type": "string" + }, + "path": { + "example": "abc123", + "type": "string" + }, + "pipeline": { + "example": "abc123", + "type": "string" + }, + "processing_config": { + "example": "abc123", + "type": "string" + }, + "retention_period": { + "example": "abc123", + "type": "string" + } + }, + "required": [ + "path" + ], + "type": "object" + } + } + }, + "info": { + "title": "Enduro API", + "version": "1.0" + }, + "openapi": "3.0.3", + "paths": { + "/batch": { + "get": { + "description": "Retrieve status of current batch operation.", + "operationId": "batch#status", + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "run_id": "abc123", + "running": false, + "status": "abc123", + "workflow_id": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/BatchStatusResult" + } + } + }, + "description": "OK response." + } + }, + "summary": "status batch", + "tags": [ + "batch" + ] + }, + "post": { + "description": "Submit a new batch", + "operationId": "batch#submit", + "requestBody": { + "content": { + "application/json": { + "example": { + "completed_dir": "abc123", + "path": "abc123", + "pipeline": "abc123", + "processing_config": "abc123", + "retention_period": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/SubmitRequestBody" + } + } + }, + "required": true + }, + "responses": { + "202": { + "content": { + "application/json": { + "example": { + "run_id": "abc123", + "workflow_id": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/BatchResult" + } + } + }, + "description": "Accepted response." + }, + "400": { + "content": { + "application/vnd.goa.error": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "not_valid: Bad Request response." + }, + "409": { + "content": { + "application/vnd.goa.error": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "not_available: Conflict response." + } + }, + "summary": "submit batch", + "tags": [ + "batch" + ] + } + }, + "/batch/hints": { + "get": { + "description": "Retrieve form hints", + "operationId": "batch#hints", + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "completed_dirs": [ + "abc123" + ] + }, + "schema": { + "$ref": "#/components/schemas/BatchHintsResult" + } + } + }, + "description": "OK response." + } + }, + "summary": "hints batch", + "tags": [ + "batch" + ] + } + }, + "/collection": { + "get": { + "description": "List all stored collections", + "operationId": "collection#list", + "parameters": [ + { + "allowEmptyValue": true, + "example": "abc123", + "in": "query", + "name": "name", + "schema": { + "example": "abc123", + "type": "string" + } + }, + { + "allowEmptyValue": true, + "example": "abc123", + "in": "query", + "name": "original_id", + "schema": { + "example": "abc123", + "type": "string" + } + }, + { + "allowEmptyValue": true, + "description": "Identifier of Archivematica tranfser", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "in": "query", + "name": "transfer_id", + "schema": { + "description": "Identifier of Archivematica tranfser", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + } + }, + { + "allowEmptyValue": true, + "description": "Identifier of Archivematica AIP", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "in": "query", + "name": "aip_id", + "schema": { + "description": "Identifier of Archivematica AIP", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + } + }, + { + "allowEmptyValue": true, + "description": "Identifier of Archivematica pipeline", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "in": "query", + "name": "pipeline_id", + "schema": { + "description": "Identifier of Archivematica pipeline", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + } + }, + { + "allowEmptyValue": true, + "example": "e1d563b0-1474-4155-beed-f2d3a12e1529", + "in": "query", + "name": "earliest_created_time", + "schema": { + "example": "e1d563b0-1474-4155-beed-f2d3a12e1529", + "format": "date-time", + "type": "string" + } + }, + { + "allowEmptyValue": true, + "example": "e1d563b0-1474-4155-beed-f2d3a12e1529", + "in": "query", + "name": "latest_created_time", + "schema": { + "example": "e1d563b0-1474-4155-beed-f2d3a12e1529", + "format": "date-time", + "type": "string" + } + }, + { + "allowEmptyValue": true, + "example": "in progress", + "in": "query", + "name": "status", + "schema": { + "enum": [ + "new", + "in progress", + "done", + "error", + "unknown", + "queued", + "pending", + "abandoned" + ], + "example": "in progress", + "type": "string" + } + }, + { + "allowEmptyValue": true, + "description": "Pagination cursor", + "example": "abc123", + "in": "query", + "name": "cursor", + "schema": { + "description": "Pagination cursor", + "example": "abc123", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "items": [ + { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + } + ], + "next_cursor": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/ListResponseBody" + } + } + }, + "description": "OK response." + } + }, + "summary": "list collection", + "tags": [ + "collection" + ] + } + }, + "/collection/bulk": { + "get": { + "description": "Retrieve status of current bulk operation.", + "operationId": "collection#bulk_status", + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "closed_at": "1970-01-01T00:00:01Z", + "run_id": "abc123", + "running": false, + "started_at": "1970-01-01T00:00:01Z", + "status": "abc123", + "workflow_id": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/BulkStatusResult" + } + } + }, + "description": "OK response." + } + }, + "summary": "bulk_status collection", + "tags": [ + "collection" + ] + }, + "post": { + "description": "Bulk operations (retry, cancel...).", + "operationId": "collection#bulk", + "requestBody": { + "content": { + "application/json": { + "example": { + "operation": "cancel", + "size": 1, + "status": "in progress" + }, + "schema": { + "$ref": "#/components/schemas/BulkRequestBody" + } + } + }, + "required": true + }, + "responses": { + "202": { + "content": { + "application/json": { + "example": { + "run_id": "abc123", + "workflow_id": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/BatchResult" + } + } + }, + "description": "Accepted response." + }, + "400": { + "content": { + "application/vnd.goa.error": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "not_valid: Bad Request response." + }, + "409": { + "content": { + "application/vnd.goa.error": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "not_available: Conflict response." + } + }, + "summary": "bulk collection", + "tags": [ + "collection" + ] + } + }, + "/collection/monitor": { + "get": { + "operationId": "collection#monitor", + "responses": { + "101": { + "content": { + "application/json": { + "example": { + "id": 1, + "item": { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + }, + "type": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/EnduroMonitorUpdate" + } + } + }, + "description": "Switching Protocols response." + } + }, + "summary": "monitor collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}": { + "delete": { + "description": "Delete collection by ID", + "operationId": "collection#delete", + "parameters": [ + { + "description": "Identifier of collection to delete", + "example": 1, + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Identifier of collection to delete", + "example": 1, + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content response." + }, + "404": { + "content": { + "application/json": { + "example": { + "id": 1, + "message": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/CollectionNotfound" + } + } + }, + "description": "not_found: Collection not found" + } + }, + "summary": "delete collection", + "tags": [ + "collection" + ] + }, + "get": { + "description": "Show collection by ID", + "operationId": "collection#show", + "parameters": [ + { + "description": "Identifier of collection to show", + "example": 1, + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Identifier of collection to show", + "example": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "aip_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "completed_at": "1970-01-01T00:00:01Z", + "created_at": "1970-01-01T00:00:01Z", + "id": 1, + "name": "abc123", + "original_id": "abc123", + "pipeline_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "run_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "started_at": "1970-01-01T00:00:01Z", + "status": "in progress", + "transfer_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "workflow_id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5" + }, + "schema": { + "$ref": "#/components/schemas/EnduroStoredCollection" + } + } + }, + "description": "OK response." + }, + "404": { + "content": { + "application/json": { + "example": { + "id": 1, + "message": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/CollectionNotfound" + } + } + }, + "description": "not_found: Collection not found" + } + }, + "summary": "show collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}/cancel": { + "post": { + "description": "Cancel collection processing by ID", + "operationId": "collection#cancel", + "parameters": [ + { + "description": "Identifier of collection to remove", + "example": 1, + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Identifier of collection to remove", + "example": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "OK response." + }, + "400": { + "content": { + "application/vnd.goa.error": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "not_running: Bad Request response." + }, + "404": { + "content": { + "application/json": { + "example": { + "id": 1, + "message": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/CollectionNotfound" + } + } + }, + "description": "not_found: Collection not found" + } + }, + "summary": "cancel collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}/decision": { + "post": { + "description": "Make decision for a pending collection by ID", + "operationId": "collection#decide", + "parameters": [ + { + "description": "Identifier of collection to look up", + "example": 1, + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Identifier of collection to look up", + "example": 1, + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "example": { + "option": "abc123" + }, + "schema": { + "example": { + "option": "abc123" + }, + "properties": { + "option": { + "description": "Decision option to proceed with", + "example": "abc123", + "type": "string" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK response." + }, + "400": { + "content": { + "application/vnd.goa.error": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "not_valid: Bad Request response." + }, + "404": { + "content": { + "application/json": { + "example": { + "id": 1, + "message": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/CollectionNotfound" + } + } + }, + "description": "not_found: Collection not found" + } + }, + "summary": "decide collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}/download": { + "get": { + "description": "Download collection by ID", + "operationId": "collection#download", + "parameters": [ + { + "description": "Identifier of collection to look up", + "example": 1, + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Identifier of collection to look up", + "example": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "description": "OK response.", + "headers": { + "Content-Disposition": { + "example": "abc123", + "required": true, + "schema": { + "example": "abc123", + "type": "string" + } + }, + "Content-Length": { + "example": 1, + "required": true, + "schema": { + "example": 1, + "format": "int64", + "type": "integer" + } + }, + "Content-Type": { + "example": "abc123", + "required": true, + "schema": { + "example": "abc123", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/json": { + "example": { + "id": 1, + "message": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/CollectionNotfound" + } + } + }, + "description": "not_found: Collection not found" + } + }, + "summary": "download collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}/retry": { + "post": { + "description": "Retry collection processing by ID", + "operationId": "collection#retry", + "parameters": [ + { + "description": "Identifier of collection to retry", + "example": 1, + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Identifier of collection to retry", + "example": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "OK response." + }, + "400": { + "content": { + "application/vnd.goa.error": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "not_running: Bad Request response." + }, + "404": { + "content": { + "application/json": { + "example": { + "id": 1, + "message": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/CollectionNotfound" + } + } + }, + "description": "not_found: Collection not found" + } + }, + "summary": "retry collection", + "tags": [ + "collection" + ] + } + }, + "/collection/{id}/workflow": { + "get": { + "description": "Retrieve workflow status by ID", + "operationId": "collection#workflow", + "parameters": [ + { + "description": "Identifier of collection to look up", + "example": 1, + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Identifier of collection to look up", + "example": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "history": [ + { + "details": "abc123", + "id": 1, + "type": "abc123" + } + ], + "status": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/EnduroCollectionWorkflowStatus" + } + } + }, + "description": "OK response." + }, + "404": { + "content": { + "application/json": { + "example": { + "id": 1, + "message": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/CollectionNotfound" + } + } + }, + "description": "not_found: Collection not found" + } + }, + "summary": "workflow collection", + "tags": [ + "collection" + ] + } + }, + "/pipeline": { + "get": { + "description": "List all known pipelines", + "operationId": "pipeline#list", + "parameters": [ + { + "allowEmptyValue": true, + "example": "abc123", + "in": "query", + "name": "name", + "schema": { + "example": "abc123", + "type": "string" + } + }, + { + "allowEmptyValue": true, + "example": false, + "in": "query", + "name": "status", + "schema": { + "default": false, + "example": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": [ + { + "capacity": 1, + "current": 1, + "id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "name": "abc123", + "status": "abc123" + } + ], + "schema": { + "example": [ + { + "capacity": 1, + "current": 1, + "id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "name": "abc123", + "status": "abc123" + } + ], + "items": { + "$ref": "#/components/schemas/EnduroStoredPipeline" + }, + "type": "array" + } + } + }, + "description": "OK response." + } + }, + "summary": "list pipeline", + "tags": [ + "pipeline" + ] + } + }, + "/pipeline/{id}": { + "get": { + "description": "Show pipeline by ID", + "operationId": "pipeline#show", + "parameters": [ + { + "description": "Identifier of pipeline to show", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Identifier of pipeline to show", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "capacity": 1, + "current": 1, + "id": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "name": "abc123", + "status": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/EnduroStoredPipeline" + } + } + }, + "description": "OK response." + }, + "404": { + "content": { + "application/json": { + "example": { + "id": "abc123", + "message": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/PipelineNotFound" + } + } + }, + "description": "not_found: Pipeline not found" + } + }, + "summary": "show pipeline", + "tags": [ + "pipeline" + ] + } + }, + "/pipeline/{id}/processing": { + "get": { + "description": "List all processing configurations of a pipeline given its ID", + "operationId": "pipeline#processing", + "parameters": [ + { + "description": "Identifier of pipeline", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Identifier of pipeline", + "example": "d1845cb6-a5ea-474a-9ab8-26f9bcd919f5", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": [ + "abc123" + ], + "schema": { + "example": [ + "abc123" + ], + "items": { + "example": "abc123", + "type": "string" + }, + "type": "array" + } + } + }, + "description": "OK response." + }, + "404": { + "content": { + "application/json": { + "example": { + "id": "abc123", + "message": "abc123" + }, + "schema": { + "$ref": "#/components/schemas/PipelineNotFound" + } + } + }, + "description": "not_found: Pipeline not found" + } + }, + "summary": "processing pipeline", + "tags": [ + "pipeline" + ] + } + }, + "/swagger/swagger.json": { + "get": { + "description": "JSON document containing the API swagger definition.", + "operationId": "swagger#/swagger/swagger.json", + "responses": { + "200": { + "description": "File downloaded" + } + }, + "summary": "Download internal/api/gen/http/openapi.json", + "tags": [ + "swagger" + ] + } + } + }, + "servers": [ + { + "url": "http://localhost:9000" + } + ], + "tags": [ + { + "description": "The batch service manages batches of collections.", + "name": "batch" + }, + { + "description": "The collection service manages packages being transferred to Archivematica.", + "name": "collection" + }, + { + "description": "The pipeline service manages Archivematica pipelines.", + "name": "pipeline" + }, + { + "description": "The swagger service serves the API swagger definition.", + "name": "swagger" + } + ] +} diff --git a/internal/api/gen/http/openapi3.yaml b/internal/api/gen/http/openapi3.yaml index 78b0bb01..fd3e7f06 100644 --- a/internal/api/gen/http/openapi3.yaml +++ b/internal/api/gen/http/openapi3.yaml @@ -20,10 +20,10 @@ paths: schema: $ref: '#/components/schemas/BatchStatusResult' example: - run_id: Illo impedit vero. - running: true - status: Illum excepturi magni quidem. - workflow_id: Vel sint ducimus officia labore eius qui. + run_id: abc123 + running: false + status: abc123 + workflow_id: abc123 post: tags: - batch @@ -37,11 +37,11 @@ paths: schema: $ref: '#/components/schemas/SubmitRequestBody' example: - completed_dir: Laboriosam odit. - path: Laboriosam nam sit nihil. - pipeline: Necessitatibus vel aut deleniti quia qui. - processing_config: Vel voluptatem. - retention_period: Sed perferendis illum illum omnis et officiis. + completed_dir: abc123 + path: abc123 + pipeline: abc123 + processing_config: abc123 + retention_period: abc123 responses: "202": description: Accepted response. @@ -50,8 +50,8 @@ paths: schema: $ref: '#/components/schemas/BatchResult' example: - run_id: Debitis rerum. - workflow_id: Velit possimus et ea aut harum. + run_id: abc123 + workflow_id: abc123 "400": description: 'not_valid: Bad Request response.' content: @@ -80,8 +80,7 @@ paths: $ref: '#/components/schemas/BatchHintsResult' example: completed_dirs: - - Quo illo natus et. - - Eaque suscipit in cum et quia facere. + - abc123 /collection: get: tags: @@ -95,61 +94,67 @@ paths: allowEmptyValue: true schema: type: string - example: Ullam provident hic. - example: Quod magni blanditiis sequi. + example: abc123 + example: abc123 - name: original_id in: query allowEmptyValue: true schema: type: string - example: Neque velit debitis ducimus minima totam. - example: Vero aliquam. + example: abc123 + example: abc123 - name: transfer_id in: query + description: Identifier of Archivematica tranfser allowEmptyValue: true schema: type: string - example: 74c8f444-1fd2-11ee-b6e1-7085c27bdeb0 + description: Identifier of Archivematica tranfser + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid - example: 74c8f57d-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 - name: aip_id in: query + description: Identifier of Archivematica AIP allowEmptyValue: true schema: type: string - example: 74c8f6b7-1fd2-11ee-b6e1-7085c27bdeb0 + description: Identifier of Archivematica AIP + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid - example: 74c8f7e0-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 - name: pipeline_id in: query + description: Identifier of Archivematica pipeline allowEmptyValue: true schema: type: string - example: 74c8f94e-1fd2-11ee-b6e1-7085c27bdeb0 + description: Identifier of Archivematica pipeline + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid - example: 74c8fa84-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 - name: earliest_created_time in: query allowEmptyValue: true schema: type: string - example: "2014-09-01T05:29:40Z" + example: e1d563b0-1474-4155-beed-f2d3a12e1529 format: date-time - example: "1993-06-19T11:51:33Z" + example: e1d563b0-1474-4155-beed-f2d3a12e1529 - name: latest_created_time in: query allowEmptyValue: true schema: type: string - example: "1976-02-19T04:59:41Z" + example: e1d563b0-1474-4155-beed-f2d3a12e1529 format: date-time - example: "2006-08-01T15:51:22Z" + example: e1d563b0-1474-4155-beed-f2d3a12e1529 - name: status in: query allowEmptyValue: true schema: type: string - example: pending + example: in progress enum: - new - in progress @@ -159,7 +164,7 @@ paths: - queued - pending - abandoned - example: pending + example: in progress - name: cursor in: query description: Pagination cursor @@ -167,8 +172,8 @@ paths: schema: type: string description: Pagination cursor - example: Officia optio et quibusdam hic quae. - example: Fuga aut voluptate est nihil in ut. + example: abc123 + example: abc123 responses: "200": description: OK response. @@ -178,55 +183,19 @@ paths: $ref: '#/components/schemas/ListResponseBody' example: items: - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - next_cursor: Inventore et officiis ad. + - aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + next_cursor: abc123 /collection/{id}: delete: tags: @@ -242,8 +211,8 @@ paths: schema: type: integer description: Identifier of collection to delete - example: 6902768091720524842 - example: 18349184252340015779 + example: 1 + example: 1 responses: "204": description: No Content response. @@ -254,8 +223,8 @@ paths: schema: $ref: '#/components/schemas/CollectionNotfound' example: - id: 6101152394700680766 - message: Fugit et porro suscipit. + id: 1 + message: abc123 get: tags: - collection @@ -270,8 +239,8 @@ paths: schema: type: integer description: Identifier of collection to show - example: 3443956377255456278 - example: 8876636575521251599 + example: 1 + example: 1 responses: "200": description: OK response. @@ -280,18 +249,18 @@ paths: schema: $ref: '#/components/schemas/EnduroStoredCollection' example: - aip_id: 74c6ba20-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2000-10-04T09:57:15Z" - created_at: "2010-07-22T22:55:51Z" - id: 15148517886629496057 - name: Amet vero quam. - original_id: Et consequatur aut enim consequuntur debitis temporibus. - pipeline_id: 74c6bb71-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c6b7b4-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "2014-07-31T20:44:18Z" - status: abandoned - transfer_id: 74c6b8f6-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c6b657-1fd2-11ee-b6e1-7085c27bdeb0 + aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 "404": description: 'not_found: Collection not found' content: @@ -299,8 +268,8 @@ paths: schema: $ref: '#/components/schemas/CollectionNotfound' example: - id: 1094484444001815440 - message: Praesentium et nam. + id: 1 + message: abc123 /collection/{id}/cancel: post: tags: @@ -316,8 +285,8 @@ paths: schema: type: integer description: Identifier of collection to remove - example: 5300588831543103027 - example: 130236761498329200 + example: 1 + example: 1 responses: "200": description: OK response. @@ -334,8 +303,8 @@ paths: schema: $ref: '#/components/schemas/CollectionNotfound' example: - id: 5550828451059843862 - message: At velit quod et maxime quia. + id: 1 + message: abc123 /collection/{id}/decision: post: tags: @@ -351,8 +320,8 @@ paths: schema: type: integer description: Identifier of collection to look up - example: 4457285347556290353 - example: 16836367451314582765 + example: 1 + example: 1 requestBody: required: true content: @@ -363,11 +332,11 @@ paths: option: type: string description: Decision option to proceed with - example: Ut earum. + example: abc123 example: - option: In non earum voluptas quidem ut sit. + option: abc123 example: - option: Qui id optio officiis est facere. + option: abc123 responses: "200": description: OK response. @@ -384,8 +353,8 @@ paths: schema: $ref: '#/components/schemas/CollectionNotfound' example: - id: 17390755426644366260 - message: Numquam aut dolores et voluptas repellat. + id: 1 + message: abc123 /collection/{id}/download: get: tags: @@ -401,8 +370,8 @@ paths: schema: type: integer description: Identifier of collection to look up - example: 13985264076619419699 - example: 10131890621733502138 + example: 1 + example: 1 responses: "200": description: OK response. @@ -411,21 +380,21 @@ paths: required: true schema: type: string - example: Vitae et saepe reiciendis quia perspiciatis. - example: Nemo natus et praesentium voluptatem. + example: abc123 + example: abc123 Content-Length: required: true schema: type: integer - example: 9198655460133316854 + example: 1 format: int64 - example: 890283335835053110 + example: 1 Content-Type: required: true schema: type: string - example: Ex officia qui ratione doloribus ut. - example: Excepturi architecto illum et consequatur optio corporis. + example: abc123 + example: abc123 content: application/json: schema: @@ -438,8 +407,8 @@ paths: schema: $ref: '#/components/schemas/CollectionNotfound' example: - id: 3923434489665488889 - message: Impedit atque qui praesentium. + id: 1 + message: abc123 /collection/{id}/retry: post: tags: @@ -455,8 +424,8 @@ paths: schema: type: integer description: Identifier of collection to retry - example: 3834985783644764482 - example: 4540644571238284304 + example: 1 + example: 1 responses: "200": description: OK response. @@ -473,8 +442,8 @@ paths: schema: $ref: '#/components/schemas/CollectionNotfound' example: - id: 9720827093168823906 - message: Repudiandae optio accusamus dolor minus. + id: 1 + message: abc123 /collection/{id}/workflow: get: tags: @@ -490,8 +459,8 @@ paths: schema: type: integer description: Identifier of collection to look up - example: 9575338825465548751 - example: 17105214700194171972 + example: 1 + example: 1 responses: "200": description: OK response. @@ -501,19 +470,10 @@ paths: $ref: '#/components/schemas/EnduroCollectionWorkflowStatus' example: history: - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - status: Fugiat officia repellat. + - details: abc123 + id: 1 + type: abc123 + status: abc123 "404": description: 'not_found: Collection not found' content: @@ -521,8 +481,8 @@ paths: schema: $ref: '#/components/schemas/CollectionNotfound' example: - id: 15910226027846952295 - message: Distinctio dolorem cum optio non a. + id: 1 + message: abc123 /collection/bulk: get: tags: @@ -538,12 +498,12 @@ paths: schema: $ref: '#/components/schemas/BulkStatusResult' example: - closed_at: "1972-05-14T21:43:37Z" - run_id: Vitae ad. + closed_at: "1970-01-01T00:00:01Z" + run_id: abc123 running: false - started_at: "1974-03-03T20:33:17Z" - status: Adipisci officiis eaque architecto. - workflow_id: Pariatur rerum voluptas iusto. + started_at: "1970-01-01T00:00:01Z" + status: abc123 + workflow_id: abc123 post: tags: - collection @@ -557,9 +517,9 @@ paths: schema: $ref: '#/components/schemas/BulkRequestBody' example: - operation: retry - size: 4225703995272354524 - status: new + operation: cancel + size: 1 + status: in progress responses: "202": description: Accepted response. @@ -568,8 +528,8 @@ paths: schema: $ref: '#/components/schemas/BatchResult' example: - run_id: Optio reprehenderit cumque rerum sunt hic velit. - workflow_id: Quibusdam dolore in aliquid. + run_id: abc123 + workflow_id: abc123 "400": description: 'not_valid: Bad Request response.' content: @@ -596,21 +556,21 @@ paths: schema: $ref: '#/components/schemas/EnduroMonitorUpdate' example: - id: 7891370028970844776 + id: 1 item: - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - type: Mollitia tenetur voluptatum. + aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + type: abc123 /pipeline: get: tags: @@ -624,8 +584,8 @@ paths: allowEmptyValue: true schema: type: string - example: Quo est iure sequi aliquam eligendi. - example: Rerum ut qui et. + example: abc123 + example: abc123 - name: status in: query allowEmptyValue: true @@ -633,7 +593,7 @@ paths: type: boolean default: false example: false - example: true + example: false responses: "200": description: OK response. @@ -644,42 +604,17 @@ paths: items: $ref: '#/components/schemas/EnduroStoredPipeline' example: - - capacity: 8406108818872523115 - current: 1737602466879989319 - id: 74c5f141-1fd2-11ee-b6e1-7085c27bdeb0 - name: Eius perferendis et corrupti harum nisi voluptatibus. - status: Qui explicabo qui error sint. - - capacity: 8406108818872523115 - current: 1737602466879989319 - id: 74c5f141-1fd2-11ee-b6e1-7085c27bdeb0 - name: Eius perferendis et corrupti harum nisi voluptatibus. - status: Qui explicabo qui error sint. - - capacity: 8406108818872523115 - current: 1737602466879989319 - id: 74c5f141-1fd2-11ee-b6e1-7085c27bdeb0 - name: Eius perferendis et corrupti harum nisi voluptatibus. - status: Qui explicabo qui error sint. + - capacity: 1 + current: 1 + id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + name: abc123 + status: abc123 example: - - capacity: 8406108818872523115 - current: 1737602466879989319 - id: 74c5f141-1fd2-11ee-b6e1-7085c27bdeb0 - name: Eius perferendis et corrupti harum nisi voluptatibus. - status: Qui explicabo qui error sint. - - capacity: 8406108818872523115 - current: 1737602466879989319 - id: 74c5f141-1fd2-11ee-b6e1-7085c27bdeb0 - name: Eius perferendis et corrupti harum nisi voluptatibus. - status: Qui explicabo qui error sint. - - capacity: 8406108818872523115 - current: 1737602466879989319 - id: 74c5f141-1fd2-11ee-b6e1-7085c27bdeb0 - name: Eius perferendis et corrupti harum nisi voluptatibus. - status: Qui explicabo qui error sint. - - capacity: 8406108818872523115 - current: 1737602466879989319 - id: 74c5f141-1fd2-11ee-b6e1-7085c27bdeb0 - name: Eius perferendis et corrupti harum nisi voluptatibus. - status: Qui explicabo qui error sint. + - capacity: 1 + current: 1 + id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + name: abc123 + status: abc123 /pipeline/{id}: get: tags: @@ -695,9 +630,9 @@ paths: schema: type: string description: Identifier of pipeline to show - example: 74c905a5-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid - example: 74c906f2-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 responses: "200": description: OK response. @@ -706,11 +641,11 @@ paths: schema: $ref: '#/components/schemas/EnduroStoredPipeline' example: - capacity: 6519501965408371640 - current: 7650363469056154510 - id: 74c7d69d-1fd2-11ee-b6e1-7085c27bdeb0 - name: Aut vel quisquam aut. - status: Et harum. + capacity: 1 + current: 1 + id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + name: abc123 + status: abc123 "404": description: 'not_found: Pipeline not found' content: @@ -718,8 +653,8 @@ paths: schema: $ref: '#/components/schemas/PipelineNotFound' example: - id: Minus nobis. - message: Incidunt quia. + id: abc123 + message: abc123 /pipeline/{id}/processing: get: tags: @@ -735,9 +670,9 @@ paths: schema: type: string description: Identifier of pipeline - example: 74c908d2-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid - example: 74c90a0a-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 responses: "200": description: OK response. @@ -747,16 +682,11 @@ paths: type: array items: type: string - example: Ducimus aut at optio. + example: abc123 example: - - Iste numquam rem quo eligendi. - - Est autem magnam porro in. - - Amet architecto non repudiandae neque dolorem. + - abc123 example: - - Et minus reprehenderit nobis ratione perferendis debitis. - - Autem molestias repellendus nihil. - - Ut magni dolorem minus ut. - - Aliquam nostrum laborum impedit quo magnam. + - abc123 "404": description: 'not_found: Pipeline not found' content: @@ -764,8 +694,8 @@ paths: schema: $ref: '#/components/schemas/PipelineNotFound' example: - id: Ab consectetur. - message: Fugit ipsam. + id: abc123 + message: abc123 /swagger/swagger.json: get: tags: @@ -785,29 +715,25 @@ components: type: array items: type: string - example: Eos consequuntur aliquam culpa. + example: abc123 description: A list of known values of completedDir used by existing watchers. example: - - Perspiciatis aperiam est optio repellendus. - - Consequatur mollitia. - - Tempora quia aperiam saepe quos distinctio deserunt. - - Voluptas ut cupiditate expedita distinctio qui aut. + - abc123 example: completed_dirs: - - Quis aut sint recusandae eum et et. - - Eius odio eos hic et. + - abc123 BatchResult: type: object properties: run_id: type: string - example: Vitae fugit quis tempore animi ad ab. + example: abc123 workflow_id: type: string - example: Deserunt a enim cum ad quasi qui. + example: abc123 example: - run_id: Velit aperiam nemo dolorem. - workflow_id: Beatae blanditiis qui et ut recusandae id. + run_id: abc123 + workflow_id: abc123 required: - workflow_id - run_id @@ -816,21 +742,21 @@ components: properties: run_id: type: string - example: Cumque in qui voluptas et culpa beatae. + example: abc123 running: type: boolean - example: true + example: false status: type: string - example: Et rem et. + example: abc123 workflow_id: type: string - example: Minima sunt. + example: abc123 example: - run_id: Commodi ea. + run_id: abc123 running: false - status: Suscipit tempore est quisquam ratione. - workflow_id: In perferendis maiores aperiam praesentium voluptatum. + status: abc123 + workflow_id: abc123 required: - running BulkRequestBody: @@ -838,7 +764,7 @@ components: properties: operation: type: string - example: retry + example: cancel enum: - retry - cancel @@ -846,10 +772,10 @@ components: size: type: integer default: 100 - example: 11486195732644611448 + example: 1 status: type: string - example: error + example: in progress enum: - new - in progress @@ -860,9 +786,9 @@ components: - pending - abandoned example: - operation: retry - size: 8043946392141519475 - status: queued + operation: cancel + size: 1 + status: in progress required: - operation - status @@ -871,31 +797,31 @@ components: properties: closed_at: type: string - example: "2009-03-17T21:19:05Z" + example: "1970-01-01T00:00:01Z" format: date-time run_id: type: string - example: Reiciendis quae praesentium. + example: abc123 running: type: boolean - example: true + example: false started_at: type: string - example: "1990-10-26T11:38:26Z" + example: "1970-01-01T00:00:01Z" format: date-time status: type: string - example: Et magnam. + example: abc123 workflow_id: type: string - example: Molestiae alias qui. + example: abc123 example: - closed_at: "1984-10-02T03:20:21Z" - run_id: Ad animi quia ut. - running: true - started_at: "1989-09-09T08:36:56Z" - status: Assumenda doloremque. - workflow_id: Quia consequuntur modi nobis hic. + closed_at: "1970-01-01T00:00:01Z" + run_id: abc123 + running: false + started_at: "1970-01-01T00:00:01Z" + status: abc123 + workflow_id: abc123 required: - running CollectionNotfound: @@ -904,15 +830,15 @@ components: id: type: integer description: Identifier of missing collection - example: 2027358448008122767 + example: 1 message: type: string description: Message of error - example: Distinctio vero quis. + example: abc123 description: Collection not found example: - id: 5951986551772317924 - message: Voluptatem asperiores nobis maiores. + id: 1 + message: abc123 required: - message - id @@ -922,38 +848,29 @@ components: details: type: string description: Contents of the event - example: Dolorem nulla quod sed fuga ipsam necessitatibus. + example: abc123 format: binary id: type: integer description: Identifier of collection - example: 12390213551385939615 + example: 1 type: type: string description: Type of the event - example: Dolore neque voluptas quasi deserunt excepturi tempora. + example: abc123 description: WorkflowHistoryEvent describes a history event in Temporal. example: - details: Praesentium asperiores commodi earum neque est. - id: 10336837935106508770 - type: Magnam animi adipisci debitis aut. + details: abc123 + id: 1 + type: abc123 EnduroCollectionWorkflowHistoryCollection: type: array items: $ref: '#/components/schemas/EnduroCollectionWorkflowHistory' example: - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. + - details: abc123 + id: 1 + type: abc123 EnduroCollectionWorkflowStatus: type: object properties: @@ -961,51 +878,42 @@ components: $ref: '#/components/schemas/EnduroCollectionWorkflowHistoryCollection' status: type: string - example: Iure unde expedita rem rem quia qui. + example: abc123 example: history: - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - - details: In quis sed. - id: 2015423930972900414 - type: Enim esse aut accusantium deleniti beatae voluptas. - status: Illum nisi. + - details: abc123 + id: 1 + type: abc123 + status: abc123 EnduroMonitorUpdate: type: object properties: id: type: integer description: Identifier of collection - example: 8328444150931638539 + example: 1 item: $ref: '#/components/schemas/EnduroStoredCollection' type: type: string description: Type of the event - example: Quia ducimus est consequuntur. + example: abc123 example: - id: 11444306754916384419 + id: 1 item: - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - type: Quo omnis neque recusandae. + aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + type: abc123 required: - id - type @@ -1015,44 +923,44 @@ components: aip_id: type: string description: Identifier of Archivematica AIP - example: 74c8d480-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid completed_at: type: string description: Completion datetime - example: "2014-09-05T06:13:17Z" + example: "1970-01-01T00:00:01Z" format: date-time created_at: type: string description: Creation datetime - example: "1974-07-28T19:08:58Z" + example: "1970-01-01T00:00:01Z" format: date-time id: type: integer description: Identifier of collection - example: 13274364832877317318 + example: 1 name: type: string description: Name of the collection - example: Aspernatur rerum. + example: abc123 original_id: type: string description: Identifier provided by the client - example: Possimus dolores ea voluptatum unde laborum temporibus. + example: abc123 pipeline_id: type: string description: Identifier of Archivematica pipeline - example: 74c8d5ba-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid run_id: type: string description: Identifier of latest processing workflow run - example: 74c8d1fe-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid started_at: type: string description: Start datetime - example: "2014-04-05T03:43:54Z" + example: "1970-01-01T00:00:01Z" format: date-time status: type: string @@ -1070,28 +978,28 @@ components: - abandoned transfer_id: type: string - description: Identifier of Archivematica transfer - example: 74c8d335-1fd2-11ee-b6e1-7085c27bdeb0 + description: Identifier of Archivematica tranfser + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid workflow_id: type: string description: Identifier of processing workflow - example: 74c8d0a5-1fd2-11ee-b6e1-7085c27bdeb0 + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid description: StoredCollection describes a collection retrieved by the service. example: - aip_id: 74c8de4c-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "1980-12-20T11:42:22Z" - created_at: "2004-04-26T10:09:21Z" - id: 6450261145143832540 - name: Aperiam eius maxime eum et et. - original_id: Magni numquam deserunt officia. - pipeline_id: 74c8df6b-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c8dbe4-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1972-09-20T09:42:05Z" - status: abandoned - transfer_id: 74c8dd1c-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c8daaa-1fd2-11ee-b6e1-7085c27bdeb0 + aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 required: - id - status @@ -1101,62 +1009,50 @@ components: items: $ref: '#/components/schemas/EnduroStoredCollection' example: - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 + - aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 EnduroStoredPipeline: type: object properties: capacity: type: integer description: Maximum concurrent transfers - example: 1823829890965386700 + example: 1 format: int64 current: type: integer description: Current transfers - example: 3880544084422320312 + example: 1 format: int64 id: type: string - description: Identifier of the pipeline - example: 74c8ee0d-1fd2-11ee-b6e1-7085c27bdeb0 + description: Identifier of pipeline + example: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 format: uuid name: type: string description: Name of the pipeline - example: Dolores qui unde est. + example: abc123 status: type: string - example: Modi est nobis sit. + example: abc123 description: StoredPipeline describes a pipeline retrieved by this service. example: - capacity: 5308951979130794190 - current: 5228065542663504565 - id: 74c8ef7d-1fd2-11ee-b6e1-7085c27bdeb0 - name: Nobis autem voluptate. - status: Ut corrupti velit enim. + capacity: 1 + current: 1 + id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + name: abc123 + status: abc123 required: - name Error: @@ -1165,7 +1061,7 @@ components: fault: type: boolean description: Is the error a server-side fault? - example: true + example: false id: type: string description: ID is a unique identifier for this particular occurrence of the problem. @@ -1181,13 +1077,13 @@ components: temporary: type: boolean description: Is the error temporary? - example: true + example: false timeout: type: boolean description: Is the error a timeout? example: false example: - fault: true + fault: false id: 123abc message: parameter 'p' must be an integer name: bad_request @@ -1207,58 +1103,22 @@ components: $ref: '#/components/schemas/EnduroStoredCollectionCollection' next_cursor: type: string - example: Vel quam. + example: abc123 example: items: - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - - aip_id: 74c5baf8-1fd2-11ee-b6e1-7085c27bdeb0 - completed_at: "2014-01-26T22:52:33Z" - created_at: "2006-09-07T19:48:15Z" - id: 5273261262554249024 - name: Iusto laudantium assumenda. - original_id: Voluptatem eum et rerum. - pipeline_id: 74c5bc49-1fd2-11ee-b6e1-7085c27bdeb0 - run_id: 74c5b818-1fd2-11ee-b6e1-7085c27bdeb0 - started_at: "1986-05-13T23:32:21Z" - status: unknown - transfer_id: 74c5b9a1-1fd2-11ee-b6e1-7085c27bdeb0 - workflow_id: 74c5a1c6-1fd2-11ee-b6e1-7085c27bdeb0 - next_cursor: Voluptatem porro omnis. + - aip_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + completed_at: "1970-01-01T00:00:01Z" + created_at: "1970-01-01T00:00:01Z" + id: 1 + name: abc123 + original_id: abc123 + pipeline_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + run_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + started_at: "1970-01-01T00:00:01Z" + status: in progress + transfer_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + workflow_id: d1845cb6-a5ea-474a-9ab8-26f9bcd919f5 + next_cursor: abc123 required: - items PipelineNotFound: @@ -1267,15 +1127,15 @@ components: id: type: string description: Identifier of missing pipeline - example: Vel nesciunt quo consequuntur quis nisi. + example: abc123 message: type: string description: Message of error - example: Distinctio illum. + example: abc123 description: Pipeline not found example: - id: Voluptatibus ea ut repellendus similique minima et. - message: At beatae quidem illo ducimus et. + id: abc123 + message: abc123 required: - message - id @@ -1284,25 +1144,25 @@ components: properties: completed_dir: type: string - example: Illum illum tenetur. + example: abc123 path: type: string - example: Ut aspernatur et voluptatem quibusdam facilis. + example: abc123 pipeline: type: string - example: A veritatis vel eos. + example: abc123 processing_config: type: string - example: Sunt ut. + example: abc123 retention_period: type: string - example: Voluptates nulla autem et perspiciatis libero voluptas. + example: abc123 example: - completed_dir: Necessitatibus voluptas mollitia dolore. - path: Voluptates et molestiae eum et occaecati. - pipeline: Et et eligendi voluptatem. - processing_config: Fugiat a officiis ipsum. - retention_period: Qui rerum asperiores qui. + completed_dir: abc123 + path: abc123 + pipeline: abc123 + processing_config: abc123 + retention_period: abc123 required: - path tags: diff --git a/internal/api/gen/http/pipeline/client/types.go b/internal/api/gen/http/pipeline/client/types.go index 4bd44876..52354f98 100644 --- a/internal/api/gen/http/pipeline/client/types.go +++ b/internal/api/gen/http/pipeline/client/types.go @@ -21,7 +21,7 @@ type ListResponseBody []*EnduroStoredPipelineResponse // ShowResponseBody is the type of the "pipeline" service "show" endpoint HTTP // response body. type ShowResponseBody struct { - // Identifier of the pipeline + // Identifier of pipeline ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` // Name of the pipeline Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"` @@ -52,7 +52,7 @@ type ProcessingNotFoundResponseBody struct { // EnduroStoredPipelineResponse is used to define fields on response body types. type EnduroStoredPipelineResponse struct { - // Identifier of the pipeline + // Identifier of pipeline ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` // Name of the pipeline Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"` diff --git a/internal/api/gen/http/pipeline/server/types.go b/internal/api/gen/http/pipeline/server/types.go index e51052ce..e96b2b03 100644 --- a/internal/api/gen/http/pipeline/server/types.go +++ b/internal/api/gen/http/pipeline/server/types.go @@ -20,7 +20,7 @@ type ListResponseBody []*EnduroStoredPipelineResponse // ShowResponseBody is the type of the "pipeline" service "show" endpoint HTTP // response body. type ShowResponseBody struct { - // Identifier of the pipeline + // Identifier of pipeline ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` // Name of the pipeline Name string `form:"name" json:"name" xml:"name"` @@ -51,7 +51,7 @@ type ProcessingNotFoundResponseBody struct { // EnduroStoredPipelineResponse is used to define fields on response body types. type EnduroStoredPipelineResponse struct { - // Identifier of the pipeline + // Identifier of pipeline ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` // Name of the pipeline Name string `form:"name" json:"name" xml:"name"` diff --git a/internal/api/gen/pipeline/service.go b/internal/api/gen/pipeline/service.go index b2eac203..b42e3b71 100644 --- a/internal/api/gen/pipeline/service.go +++ b/internal/api/gen/pipeline/service.go @@ -36,7 +36,7 @@ var MethodNames = [3]string{"list", "show", "processing"} // EnduroStoredPipeline is the result type of the pipeline service show method. type EnduroStoredPipeline struct { - // Identifier of the pipeline + // Identifier of pipeline ID *string // Name of the pipeline Name string diff --git a/internal/api/gen/pipeline/views/view.go b/internal/api/gen/pipeline/views/view.go index c4edbbfe..4c812bc9 100644 --- a/internal/api/gen/pipeline/views/view.go +++ b/internal/api/gen/pipeline/views/view.go @@ -23,7 +23,7 @@ type EnduroStoredPipeline struct { // EnduroStoredPipelineView is a type that runs validations on a projected type. type EnduroStoredPipelineView struct { - // Identifier of the pipeline + // Identifier of pipeline ID *string // Name of the pipeline Name *string