From 1b831b95c7a47a1aac9c57be3eada2f4f8743739 Mon Sep 17 00:00:00 2001 From: Wolfgang Werner Date: Tue, 22 May 2018 13:36:03 +0200 Subject: [PATCH 1/5] Add version numbers to output --- .gitignore | 7 + .../deepoove/swagger/diff/SwaggerDiff.java | 7 + .../swagger/diff/output/HtmlRender.java | 413 +- .../swagger/diff/output/MarkdownRender.java | 8 +- src/main/resources/new-swagger.json | 10164 +++++++++++++++ src/main/resources/old-swagger.json | 10344 ++++++++++++++++ .../com/deepoove/swagger/test/CLITest.java | 2 +- 7 files changed, 20728 insertions(+), 217 deletions(-) create mode 100644 src/main/resources/new-swagger.json create mode 100644 src/main/resources/old-swagger.json diff --git a/.gitignore b/.gitignore index 82f1c837..618c6c87 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,10 @@ # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml hs_err_pid* /target/ +.idea +swagger-diff.iml +testDiff.html +testDiff.md +testDeprecatedApi.html +testNewApi.html + diff --git a/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java b/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java index 42140546..8d9ec0e0 100644 --- a/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java +++ b/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java @@ -249,4 +249,11 @@ public List getChangedEndpoints() { return changedEndpoints; } + public String getOldVersion() { + return oldSpecSwagger.getInfo().getVersion(); + } + + public String getNewVersion() { + return newSpecSwagger.getInfo().getVersion(); + } } diff --git a/src/main/java/com/deepoove/swagger/diff/output/HtmlRender.java b/src/main/java/com/deepoove/swagger/diff/output/HtmlRender.java index 5a841201..1b8af372 100644 --- a/src/main/java/com/deepoove/swagger/diff/output/HtmlRender.java +++ b/src/main/java/com/deepoove/swagger/diff/output/HtmlRender.java @@ -1,226 +1,213 @@ package com.deepoove.swagger.diff.output; -import static j2html.TagCreator.body; -import static j2html.TagCreator.del; -import static j2html.TagCreator.div; -import static j2html.TagCreator.rawHtml; -import static j2html.TagCreator.document; -import static j2html.TagCreator.h1; -import static j2html.TagCreator.h2; -import static j2html.TagCreator.h3; -import static j2html.TagCreator.head; -import static j2html.TagCreator.header; -import static j2html.TagCreator.hr; -import static j2html.TagCreator.script; -import static j2html.TagCreator.a; -import static j2html.TagCreator.html; -import static j2html.TagCreator.li; -import static j2html.TagCreator.link; -import static j2html.TagCreator.meta; -import static j2html.TagCreator.ol; -import static j2html.TagCreator.span; -import static j2html.TagCreator.title; -import static j2html.TagCreator.ul; - -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; - import com.deepoove.swagger.diff.SwaggerDiff; -import com.deepoove.swagger.diff.model.ChangedEndpoint; -import com.deepoove.swagger.diff.model.ChangedOperation; -import com.deepoove.swagger.diff.model.ChangedParameter; -import com.deepoove.swagger.diff.model.ElProperty; -import com.deepoove.swagger.diff.model.Endpoint; - +import com.deepoove.swagger.diff.model.*; import io.swagger.models.HttpMethod; import io.swagger.models.parameters.Parameter; import io.swagger.models.properties.Property; import j2html.tags.ContainerTag; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; + +import static j2html.TagCreator.*; + public class HtmlRender implements Render { - + private String title; private String linkCss; - - public HtmlRender() { - this("Api Change Log", "http://deepoove.com/swagger-diff/stylesheets/demo.css"); - } - public HtmlRender(String title, String linkCss) { - this.title = title; - this.linkCss = linkCss; - } - - - public String render(SwaggerDiff diff) { - List newEndpoints = diff.getNewEndpoints(); - ContainerTag ol_newEndpoint = ol_newEndpoint(newEndpoints); - - List missingEndpoints = diff.getMissingEndpoints(); - ContainerTag ol_missingEndpoint = ol_missingEndpoint(missingEndpoints); - - List changedEndpoints = diff.getChangedEndpoints(); - ContainerTag ol_changed = ol_changed(changedEndpoints); - - return reanderHtml(ol_newEndpoint, ol_missingEndpoint, ol_changed); - } - - public String reanderHtml(ContainerTag ol_new, ContainerTag ol_miss, ContainerTag ol_changed){ - ContainerTag html = html().attr("lang", "en").with( - head().with( - meta().withCharset("utf-8"), - title(title), - script(rawHtml("function showHide(id){if(document.getElementById(id).style.display==\'none\'){document.getElementById(id).style.display=\'block\';document.getElementById(\'btn_\'+id).innerHTML=\'⇑\';}else{document.getElementById(id).style.display=\'none\';document.getElementById(\'btn_\'+id).innerHTML=\'⇓\';}return true;}")).withType("text/javascript"), - link().withRel("stylesheet").withHref(linkCss) - ), - body().with( - header().with(h1(title)), - div().withClass("article").with( - div_headArticle("What's New", "new", ol_new), - div_headArticle("What's Deprecated", "deprecated", ol_miss), - div_headArticle("What's Changed", "changed", ol_changed) - ) - ) - ); - - return document().render() + html.render(); - } - - private ContainerTag div_headArticle(final String title, final String type, final ContainerTag ol) { - return div().with(h2(title).with(a(rawHtml("⇑")).withId("btn_" + type).withClass("showhide").withHref("#").attr("onClick", "javascript:showHide('" + type + "');")), hr(), ol); - } - - private ContainerTag ol_newEndpoint(List endpoints) { - if (null == endpoints) return ol().withId("new"); - ContainerTag ol = ol().withId("new"); - for (Endpoint endpoint : endpoints) { - ol.with(li_newEndpoint(endpoint.getMethod().toString(), - endpoint.getPathUrl(), endpoint.getSummary())); - } - return ol; - } - - private ContainerTag li_newEndpoint(String method, String path, - String desc) { - return li().with(span(method).withClass(method)).withText(path + " ") - .with(span(null == desc ? "" : desc)); - } - - private ContainerTag ol_missingEndpoint(List endpoints) { - if (null == endpoints) return ol().withId("deprecated"); - ContainerTag ol = ol().withId("deprecated"); - for (Endpoint endpoint : endpoints) { - ol.with(li_missingEndpoint(endpoint.getMethod().toString(), - endpoint.getPathUrl(), endpoint.getSummary())); - } - return ol; - } - - private ContainerTag li_missingEndpoint(String method, String path, - String desc) { - return li().with(span(method).withClass(method), - del().withText(path)).with(span(null == desc ? "" : " " + desc)); - } - - private ContainerTag ol_changed(List changedEndpoints){ - if (null == changedEndpoints) return ol().withId("changed"); - ContainerTag ol = ol().withId("changed"); - for (ChangedEndpoint changedEndpoint:changedEndpoints){ - String pathUrl = changedEndpoint.getPathUrl(); - Map changedOperations = changedEndpoint.getChangedOperations(); - for (Entry entry : changedOperations.entrySet()){ - String method = entry.getKey().toString(); - ChangedOperation changedOperation = entry.getValue(); - String desc = changedOperation.getSummary(); - - ContainerTag ul_detail = ul().withClass("detail"); - if (changedOperation.isDiffParam()){ - ul_detail.with(li().with(h3("Parameter")).with(ul_param(changedOperation))); - } - if (changedOperation.isDiffProp()){ - ul_detail.with(li().with(h3("Return Type")).with(ul_response(changedOperation))); - } - ol.with(li().with(span(method).withClass(method)).withText(pathUrl + " ").with(span(null == desc ? "" : desc)) - .with(ul_detail)); - } - } - return ol; - } - - private ContainerTag ul_response(ChangedOperation changedOperation) { - List addProps = changedOperation.getAddProps(); - List delProps = changedOperation.getMissingProps(); - ContainerTag ul = ul().withClass("change response"); - for (ElProperty prop : addProps){ - ul.with(li_addProp(prop)); - } - for (ElProperty prop : delProps){ - ul.with(li_missingProp(prop)); - } - return ul; - } - - private ContainerTag li_missingProp(ElProperty prop) { - Property property = prop.getProperty(); - return li().withClass("missing").withText("Delete").with(del(prop.getEl())).with(span(null == property.getDescription() ? "" : ("//" + property.getDescription())).withClass("comment")); - } - - private ContainerTag li_addProp(ElProperty prop) { - Property property = prop.getProperty(); - return li().withText("Add " + prop.getEl()).with(span(null == property.getDescription() ? "" : ("//" + property.getDescription())).withClass("comment")); - } - - private ContainerTag ul_param(ChangedOperation changedOperation) { - List addParameters = changedOperation.getAddParameters(); - List delParameters = changedOperation.getMissingParameters(); - List changedParameters = changedOperation.getChangedParameter(); - ContainerTag ul = ul().withClass("change param"); - for (Parameter param : addParameters){ - ul.with(li_addParam(param)); - } - for (ChangedParameter param : changedParameters){ - List increased = param.getIncreased(); - for (ElProperty prop : increased){ - ul.with(li_addProp(prop)); - } - } - for (ChangedParameter param : changedParameters){ - boolean changeRequired = param.isChangeRequired(); - boolean changeDescription = param.isChangeDescription(); - if (changeRequired || changeDescription) - ul.with(li_changedParam(param)); - } - for (ChangedParameter param : changedParameters){ - List missing = param.getMissing(); - for (ElProperty prop : missing){ - ul.with(li_missingProp(prop)); - } - } - for (Parameter param : delParameters){ - ul.with(li_missingParam(param)); - } - return ul; - } - - private ContainerTag li_addParam(Parameter param){ - return li().withText("Add " + param.getName()).with(span(null == param.getDescription() ? "" : ("//" + param.getDescription())).withClass("comment")); - } - private ContainerTag li_missingParam(Parameter param){ - return li().withClass("missing").with(span("Delete")).with(del(param.getName())).with(span(null == param.getDescription() ? "" : ("//" + param.getDescription())).withClass("comment")); - } - private ContainerTag li_changedParam(ChangedParameter changeParam){ - boolean changeRequired = changeParam.isChangeRequired(); - boolean changeDescription = changeParam.isChangeDescription(); - Parameter rightParam = changeParam.getRightParameter(); - Parameter leftParam = changeParam.getLeftParameter(); - ContainerTag li = li().withText(rightParam.getName()); - if (changeRequired){ - li.withText(" change into " + (rightParam.getRequired() ? "required" : "not required")); - } - if (changeDescription){ - li.withText(" Notes ").with(del(leftParam.getDescription()).withClass("comment")).withText(" change into ").with(span(span(null == rightParam.getDescription() ? "" : rightParam.getDescription()).withClass("comment"))); - } - return li; - } + + public HtmlRender() { + this("Api Change Log", "http://deepoove.com/swagger-diff/stylesheets/demo.css"); + } + + public HtmlRender(String title, String linkCss) { + this.title = title; + this.linkCss = linkCss; + } + + + public String render(SwaggerDiff diff) { + List newEndpoints = diff.getNewEndpoints(); + ContainerTag ol_newEndpoint = ol_newEndpoint(newEndpoints); + + List missingEndpoints = diff.getMissingEndpoints(); + ContainerTag ol_missingEndpoint = ol_missingEndpoint(missingEndpoints); + + List changedEndpoints = diff.getChangedEndpoints(); + ContainerTag ol_changed = ol_changed(changedEndpoints); + + ContainerTag p_versions = p_versions(diff.getOldVersion(), diff.getNewVersion()); + + return renderHtml(ol_newEndpoint, ol_missingEndpoint, ol_changed, p_versions); + } + + public String renderHtml(ContainerTag ol_new, ContainerTag ol_miss, ContainerTag ol_changed, ContainerTag p_versions) { + ContainerTag html = html().attr("lang", "en").with( + head().with( + meta().withCharset("utf-8"), + title(title), + script(rawHtml("function showHide(id){if(document.getElementById(id).style.display==\'none\'){document.getElementById(id).style.display=\'block\';document.getElementById(\'btn_\'+id).innerHTML=\'⇑\';}else{document.getElementById(id).style.display=\'none\';document.getElementById(\'btn_\'+id).innerHTML=\'⇓\';}return true;}")).withType("text/javascript"), + link().withRel("stylesheet").withHref(linkCss) + ), + body().with( + header().with(h1(title)), + div().withClass("article").with( + div_headArticle("Versions", "versions", p_versions), + div_headArticle("What's New", "new", ol_new), + div_headArticle("What's Deprecated", "deprecated", ol_miss), + div_headArticle("What's Changed", "changed", ol_changed) + ) + ) + ); + + return document().render() + html.render(); + } + + private ContainerTag div_headArticle(final String title, final String type, final ContainerTag ol) { + return div().with(h2(title).with(a(rawHtml("⇑")).withId("btn_" + type).withClass("showhide").withHref("#").attr("onClick", "javascript:showHide('" + type + "');")), hr(), ol); + } + + private ContainerTag p_versions(String oldVersion, String newVersion) { + ContainerTag p = p().withId("versions"); + p.withText("Changes from " + oldVersion + " to " + newVersion + "."); + return p; + } + + private ContainerTag ol_newEndpoint(List endpoints) { + if (null == endpoints) return ol().withId("new"); + ContainerTag ol = ol().withId("new"); + for (Endpoint endpoint : endpoints) { + ol.with(li_newEndpoint(endpoint.getMethod().toString(), + endpoint.getPathUrl(), endpoint.getSummary())); + } + return ol; + } + + private ContainerTag li_newEndpoint(String method, String path, + String desc) { + return li().with(span(method).withClass(method)).withText(path + " ") + .with(span(null == desc ? "" : desc)); + } + + private ContainerTag ol_missingEndpoint(List endpoints) { + if (null == endpoints) return ol().withId("deprecated"); + ContainerTag ol = ol().withId("deprecated"); + for (Endpoint endpoint : endpoints) { + ol.with(li_missingEndpoint(endpoint.getMethod().toString(), + endpoint.getPathUrl(), endpoint.getSummary())); + } + return ol; + } + + private ContainerTag li_missingEndpoint(String method, String path, + String desc) { + return li().with(span(method).withClass(method), + del().withText(path)).with(span(null == desc ? "" : " " + desc)); + } + + private ContainerTag ol_changed(List changedEndpoints) { + if (null == changedEndpoints) return ol().withId("changed"); + ContainerTag ol = ol().withId("changed"); + for (ChangedEndpoint changedEndpoint : changedEndpoints) { + String pathUrl = changedEndpoint.getPathUrl(); + Map changedOperations = changedEndpoint.getChangedOperations(); + for (Entry entry : changedOperations.entrySet()) { + String method = entry.getKey().toString(); + ChangedOperation changedOperation = entry.getValue(); + String desc = changedOperation.getSummary(); + + ContainerTag ul_detail = ul().withClass("detail"); + if (changedOperation.isDiffParam()) { + ul_detail.with(li().with(h3("Parameter")).with(ul_param(changedOperation))); + } + if (changedOperation.isDiffProp()) { + ul_detail.with(li().with(h3("Return Type")).with(ul_response(changedOperation))); + } + ol.with(li().with(span(method).withClass(method)).withText(pathUrl + " ").with(span(null == desc ? "" : desc)) + .with(ul_detail)); + } + } + return ol; + } + + private ContainerTag ul_response(ChangedOperation changedOperation) { + List addProps = changedOperation.getAddProps(); + List delProps = changedOperation.getMissingProps(); + ContainerTag ul = ul().withClass("change response"); + for (ElProperty prop : addProps) { + ul.with(li_addProp(prop)); + } + for (ElProperty prop : delProps) { + ul.with(li_missingProp(prop)); + } + return ul; + } + + private ContainerTag li_missingProp(ElProperty prop) { + Property property = prop.getProperty(); + return li().withClass("missing").withText("Delete").with(del(prop.getEl())).with(span(null == property.getDescription() ? "" : ("//" + property.getDescription())).withClass("comment")); + } + + private ContainerTag li_addProp(ElProperty prop) { + Property property = prop.getProperty(); + return li().withText("Add " + prop.getEl()).with(span(null == property.getDescription() ? "" : ("//" + property.getDescription())).withClass("comment")); + } + + private ContainerTag ul_param(ChangedOperation changedOperation) { + List addParameters = changedOperation.getAddParameters(); + List delParameters = changedOperation.getMissingParameters(); + List changedParameters = changedOperation.getChangedParameter(); + ContainerTag ul = ul().withClass("change param"); + for (Parameter param : addParameters) { + ul.with(li_addParam(param)); + } + for (ChangedParameter param : changedParameters) { + List increased = param.getIncreased(); + for (ElProperty prop : increased) { + ul.with(li_addProp(prop)); + } + } + for (ChangedParameter param : changedParameters) { + boolean changeRequired = param.isChangeRequired(); + boolean changeDescription = param.isChangeDescription(); + if (changeRequired || changeDescription) + ul.with(li_changedParam(param)); + } + for (ChangedParameter param : changedParameters) { + List missing = param.getMissing(); + for (ElProperty prop : missing) { + ul.with(li_missingProp(prop)); + } + } + for (Parameter param : delParameters) { + ul.with(li_missingParam(param)); + } + return ul; + } + + private ContainerTag li_addParam(Parameter param) { + return li().withText("Add " + param.getName()).with(span(null == param.getDescription() ? "" : ("//" + param.getDescription())).withClass("comment")); + } + + private ContainerTag li_missingParam(Parameter param) { + return li().withClass("missing").with(span("Delete")).with(del(param.getName())).with(span(null == param.getDescription() ? "" : ("//" + param.getDescription())).withClass("comment")); + } + + private ContainerTag li_changedParam(ChangedParameter changeParam) { + boolean changeRequired = changeParam.isChangeRequired(); + boolean changeDescription = changeParam.isChangeDescription(); + Parameter rightParam = changeParam.getRightParameter(); + Parameter leftParam = changeParam.getLeftParameter(); + ContainerTag li = li().withText(rightParam.getName()); + if (changeRequired) { + li.withText(" change into " + (rightParam.getRequired() ? "required" : "not required")); + } + if (changeDescription) { + li.withText(" Notes ").with(del(leftParam.getDescription()).withClass("comment")).withText(" change into ").with(span(span(null == rightParam.getDescription() ? "" : rightParam.getDescription()).withClass("comment"))); + } + return li; + } } diff --git a/src/main/java/com/deepoove/swagger/diff/output/MarkdownRender.java b/src/main/java/com/deepoove/swagger/diff/output/MarkdownRender.java index 22b04dc9..2c2e1cb2 100644 --- a/src/main/java/com/deepoove/swagger/diff/output/MarkdownRender.java +++ b/src/main/java/com/deepoove/swagger/diff/output/MarkdownRender.java @@ -18,6 +18,7 @@ public class MarkdownRender implements Render { final String H3 = "### "; + final String H2 = "## "; final String BLOCKQUOTE = "> "; final String CODE = "`"; final String PRE_CODE = " "; @@ -37,12 +38,13 @@ public String render(SwaggerDiff diff) { List changedEndpoints = diff.getChangedEndpoints(); String ol_changed = ol_changed(changedEndpoints); - return reanderHtml(ol_newEndpoint, ol_missingEndpoint, ol_changed); + return renderHtml(diff.getOldVersion(), diff.getNewVersion(), ol_newEndpoint, ol_missingEndpoint, ol_changed); } - public String reanderHtml(String ol_new, String ol_miss, - String ol_changed) { + public String renderHtml(String oldVersion, String newVersion, String ol_new, String ol_miss, + String ol_changed) { StringBuffer sb = new StringBuffer(); + sb.append(H2).append("Version " + oldVersion + " to " + newVersion).append("\n").append(HR); sb.append(H3).append("What's New").append("\n").append(HR) .append(ol_new).append("\n").append(H3) .append("What's Deprecated").append("\n").append(HR) diff --git a/src/main/resources/new-swagger.json b/src/main/resources/new-swagger.json new file mode 100644 index 00000000..f2bd3dbc --- /dev/null +++ b/src/main/resources/new-swagger.json @@ -0,0 +1,10164 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "ID4i HTTP API", + "version" : "0.7.1", + "title" : "ID4i API", + "termsOfService" : "http://id4i.de", + "contact" : { + "name" : "BlueRain Software GmbH & Co. KG", + "url" : "http://bluerain.de", + "email" : "info@bluerain.de" + }, + "license" : { + "name" : "MIT", + "url" : "https://opensource.org/licenses/MIT" + }, + "x-logo" : { + "backgroundColor" : "#FAFAFA", + "url" : "/static/logo.png" + } + }, + "host" : "backend.id4i.de", + "basePath" : "/", + "tags" : [ { + "name" : "Accounts", + "description" : "User accounts allows people to register for ID4i and login. All permissions and roles for interactive ID4i usage (as opposed to machine-to-machine interactions) are attached to Organizations and User Accounts. The API allows users to register, verify their registration, login and reset their passwords." + }, { + "name" : "Alias", + "description" : "Guid Alias Controller" + }, { + "name" : "Api Keys", + "description" : "Api Key Controller" + }, { + "name" : "Auditing", + "description" : "Auditing services allow to review changes made by users or api keys. Changelog messages can be resolved as plain text or formatted message with parameters." + }, { + "name" : "Billing", + "description" : "Billing Controller" + }, { + "name" : "Collections", + "description" : "Collection Controller" + }, { + "name" : "Guids", + "description" : "Guid Alias Controller" + }, { + "name" : "History", + "description" : "Allows to retrieve a GUID's history and to publish new history items." + }, { + "name" : "Images", + "description" : "Services can use images stored with public visibility. This API allows you to retrieve the stored image by ID." + }, { + "name" : "Meta Information", + "description" : "App Info Controller" + }, { + "name" : "Organizations", + "description" : "Country Controller" + }, { + "name" : "Public Services", + "description" : "Go Controller" + }, { + "name" : "Routing", + "description" : "Routing Controller" + }, { + "name" : "Storage", + "description" : "Document Storage Controller" + }, { + "name" : "Transfer", + "description" : "Id 4n Transfer Controller" + }, { + "name" : "WhoIs", + "description" : "Who Is Controller" + } ], + "consumes" : [ "application/xml", "application/json" ], + "produces" : [ "application/xml", "application/json" ], + "paths" : { + "/account/contractRequired" : { + "get" : { + "tags" : [ "Accounts" ], + "summary" : "Tells you whether your company needs to have a contract with BlueRain to be able to sign up", + "description" : "On production systems, users must confirm that their organization has a valid contract for ID4i usage. It is not required on test and sandbox systems. ", + "operationId" : "isContractRequired", + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "boolean" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/account/password" : { + "post" : { + "tags" : [ "Accounts" ], + "summary" : "Request password reset", + "description" : "Requesting a reset for a new password. ", + "operationId" : "requestPasswordReset", + "parameters" : [ { + "in" : "body", + "name" : "resetRequest", + "description" : "Contains the required information to request a new password.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PasswordResetRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/SimpleMessageResponse" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + }, + "put" : { + "tags" : [ "Accounts" ], + "summary" : "Verify password reset", + "description" : "Setting a new password and verifying the request to set the password.", + "operationId" : "verifyPasswordReset", + "parameters" : [ { + "in" : "body", + "name" : "verificationRequest", + "description" : "Contains the new password and the verification token to set the new password.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PasswordResetVerificationRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/SimpleMessageResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/account/registration" : { + "post" : { + "tags" : [ "Accounts" ], + "summary" : "Register user", + "description" : "Registering a new user.", + "operationId" : "registerUser", + "parameters" : [ { + "in" : "body", + "name" : "userRegistration", + "description" : "The user information about the new created user.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserRegistrationRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/UserRegistrationResponse" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + }, + "put" : { + "tags" : [ "Accounts" ], + "summary" : "Complete registration", + "description" : "Completing a registration e.g. for invited users. Finish registration with a username and a password.", + "operationId" : "completeRegistration", + "parameters" : [ { + "in" : "body", + "name" : "completeRegistration", + "description" : "Contains the verification token, the username and the initial password.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CompleteUserRegistrationRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/account/verification" : { + "post" : { + "tags" : [ "Accounts" ], + "summary" : "Verify registration", + "description" : "Verifies a new user registration.", + "operationId" : "verifyUserRegistration", + "parameters" : [ { + "in" : "body", + "name" : "token", + "description" : "The token for user verification.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RegistrationVerificationTokenPresentation" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/api/v1/apikeys" : { + "get" : { + "tags" : [ "Api Keys" ], + "summary" : "Find API key by organization", + "description" : "Finding all API key assigned to the specified organization in a paginated manner.", + "operationId" : "listAllApiKeysOfOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "query", + "description" : "The namespace of the organization to search in.", + "required" : false, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedApiKeyResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "Api Keys" ], + "summary" : "Create API key", + "description" : "Creation of a new API key.", + "operationId" : "createNewApiKey", + "parameters" : [ { + "in" : "body", + "name" : "creationRequest", + "description" : "API key to be created.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ApiKeyCreationRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ApiKeyPresentation" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/apikeys/privileges" : { + "get" : { + "tags" : [ "Api Keys" ], + "summary" : "List all privileges", + "description" : "Listing all possible API key privileges.", + "operationId" : "listAllApiKeyPrivileges", + "parameters" : [ { + "name" : "id4nConcerning", + "in" : "query", + "description" : "id4nConcerning", + "required" : false, + "type" : "boolean" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ApiKeyPrivilegeInfoResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/apikeys/{key}" : { + "get" : { + "tags" : [ "Api Keys" ], + "summary" : "Show API key", + "description" : "Showing the details of an API key.", + "operationId" : "getApiKey", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "The API key to show.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ApiKeyPresentation" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Api Keys" ], + "summary" : "Update API keys", + "description" : "API keys can be updated with new labels, and be activated and deactivated. The secret or UUID cannot be changed.", + "operationId" : "updateApiKey", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "The API key to be updated.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "apiKeyChange", + "description" : "The new values to apply.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ApiKeyChangeRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Api Keys" ], + "summary" : "Delete API key", + "description" : "Deletion of an API key.", + "operationId" : "deleteApiKey", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "The API key to delete.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/apikeys/{key}/privileges" : { + "get" : { + "tags" : [ "Api Keys" ], + "summary" : "List privileges", + "operationId" : "listApiKeyPrivileges", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ApiKeyPrivilegePaginatedResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "Api Keys" ], + "summary" : "Add privilege", + "operationId" : "addApiKeyPrivilege", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "addApiKeyPrivilegeRequest", + "description" : "addApiKeyPrivilegeRequest", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AddApiKeyPrivilegeRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Api Keys" ], + "summary" : "Remove privilege", + "operationId" : "removeApiKeyPrivilege", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "removeApiKeyPrivilegeRequest", + "description" : "removeApiKeyPrivilegeRequest", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoveApiKeyPrivilegeRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/apikeys/{key}/privileges/{privilege}/id4ns" : { + "get" : { + "tags" : [ "Api Keys" ], + "summary" : "ID4ns of a privilege", + "description" : "Listing ID4ns of a id4n concerning privilege", + "operationId" : "listId4ns", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "name" : "privilege", + "in" : "path", + "description" : "privilege", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Id4nPresentationPaginatedResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "Api Keys" ], + "summary" : "Add ID4ns of a privilege", + "operationId" : "addApiKeyPrivilegeForId4ns", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "name" : "privilege", + "in" : "path", + "description" : "privilege", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "id4ns", + "description" : "id4ns", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Api Keys" ], + "summary" : "Remove id4ns of a privilege", + "operationId" : "removeApiKeyPrivilegeForId4ns", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "name" : "privilege", + "in" : "path", + "description" : "privilege", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "id4ns", + "description" : "id4ns", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/billing/{organizationId}" : { + "get" : { + "tags" : [ "Billing" ], + "summary" : "Get billing amount of services for a given organization", + "operationId" : "getSumForOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The organization to compute the billing information for", + "required" : true, + "type" : "string" + }, { + "name" : "fromDate", + "in" : "query", + "description" : "Billing start date", + "required" : false, + "type" : "string", + "format" : "date-time" + }, { + "name" : "toDate", + "in" : "query", + "description" : "Billing end date", + "required" : false, + "type" : "string", + "format" : "date-time" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ServiceCosts" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/billing/{organizationId}/positions" : { + "get" : { + "tags" : [ "Billing" ], + "summary" : "Get billing positions for a given organization", + "operationId" : "getPositionsForOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The organization to compute the billing information for", + "required" : true, + "type" : "string" + }, { + "name" : "fromDate", + "in" : "query", + "description" : "Billing start date", + "required" : false, + "type" : "string", + "format" : "date-time" + }, { + "name" : "toDate", + "in" : "query", + "description" : "Billing end date", + "required" : false, + "type" : "string", + "format" : "date-time" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BillingPosition" + } + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/changelog/organization/{organizationId}/" : { + "get" : { + "tags" : [ "Auditing" ], + "summary" : "List change log entries of an organization", + "description" : "Listing change log entries of the specified organization id.", + "operationId" : "listOrganizationChangeLog", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace identifying the organization whose change log entries are to be listed", + "required" : true, + "type" : "string" + }, { + "name" : "messageMimeType", + "in" : "query", + "description" : "The Mime-type for the message format that should be returned. e.g. 'text/plain' or 'text/mustache' ", + "required" : false, + "type" : "string", + "default" : "text/mustache" + }, { + "name" : "fromDate", + "in" : "query", + "description" : "From date time as UTC Date-Time format", + "required" : false, + "type" : "string", + "format" : "date-time" + }, { + "name" : "toDate", + "in" : "query", + "description" : "To date time as UTC Date-Time format", + "required" : false, + "type" : "string", + "format" : "date-time" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedChangeLogEntryResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections" : { + "post" : { + "tags" : [ "Collections" ], + "summary" : "Create collection", + "operationId" : "createCollection", + "parameters" : [ { + "in" : "body", + "name" : "createInfo", + "description" : "createInfo", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateCollectionRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Id4n" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/{id4n}" : { + "get" : { + "tags" : [ "Collections" ], + "summary" : "Find collection", + "operationId" : "findCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Collections" ], + "summary" : "Delete collection", + "operationId" : "deleteCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "patch" : { + "tags" : [ "Collections" ], + "summary" : "Update collection", + "description" : "Update collection changing only the given values", + "operationId" : "updateCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "204" : { + "description" : "No Content" + }, + "401" : { + "description" : "Unauthorized" + }, + "403" : { + "description" : "Forbidden" + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/{id4n}/elements" : { + "get" : { + "tags" : [ "Collections" ], + "summary" : "List contents of the collection", + "operationId" : "listElementsOfCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedGuidResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "Collections" ], + "summary" : "Add elements to collection", + "operationId" : "addElementsToCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "listOfGuids", + "description" : "listOfGuids", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Collections" ], + "summary" : "Remove elements from collection", + "operationId" : "removeElementsFromCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "listOfGuids", + "description" : "listOfGuids", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/countries" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "List countries", + "operationId" : "listCountries", + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedCountryResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/documents/{id4n}" : { + "get" : { + "tags" : [ "Storage" ], + "summary" : "List documents", + "description" : "Listing all documents of an id4n", + "operationId" : "listAllDocuments", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedOwnedDocumentResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/documents/{id4n}/{organizationId}" : { + "get" : { + "tags" : [ "Storage" ], + "summary" : "List organization specific documents", + "description" : "Listing documents of an id4n owned by a specified organization", + "operationId" : "listDocuments", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedDocumentResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Storage" ], + "summary" : "Create an empty document for an id4n", + "description" : "The document is created empty, mime-type defaults to text/plain", + "operationId" : "createDocument", + "consumes" : [ "multipart/form-data" ], + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "content", + "in" : "formData", + "description" : "content", + "required" : true, + "type" : "file" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Document" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/documents/{id4n}/{organizationId}/{fileName}" : { + "get" : { + "tags" : [ "Storage" ], + "summary" : "Read document contents", + "operationId" : "readDocument", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "string", + "format" : "byte" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Storage" ], + "summary" : "Delete a document", + "operationId" : "deleteDocument", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ResponseEntity" + } + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata" : { + "get" : { + "tags" : [ "Storage" ], + "summary" : "Retrieve a document (meta-data only, no content)", + "operationId" : "getDocument", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Document" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "patch" : { + "tags" : [ "Storage" ], + "summary" : "Update a document", + "operationId" : "updateDocumentMetadata", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "document", + "description" : "document", + "required" : true, + "schema" : { + "$ref" : "#/definitions/DocumentUpdate" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Document" + } + }, + "204" : { + "description" : "No Content" + }, + "401" : { + "description" : "Unauthorized" + }, + "403" : { + "description" : "Forbidden" + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/guids" : { + "post" : { + "tags" : [ "Guids" ], + "summary" : "Create GUID(s)", + "description" : "Creating one or more GUIDs with a specified length.", + "operationId" : "createGuid", + "parameters" : [ { + "in" : "body", + "name" : "createGUIDInfo", + "description" : "GUID creation model", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateGuidRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/guids/withoutCollection" : { + "get" : { + "tags" : [ "Guids" ], + "summary" : "Retrieve GUIDs not in any collection", + "operationId" : "getGuidsWithoutCollection", + "parameters" : [ { + "name" : "organizationId", + "in" : "query", + "description" : "The namespace of the organization to search GUIDs for", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedResponse«Guid»" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/guids/{id4n}" : { + "get" : { + "tags" : [ "Guids" ], + "summary" : "Retrieve GUID information", + "operationId" : "getGuid", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID number", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Guid" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "patch" : { + "tags" : [ "Guids" ], + "summary" : "Change GUID information.", + "description" : "Allows ownership transfer.", + "operationId" : "updateGuid", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID number", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Guid" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "204" : { + "description" : "No Content" + }, + "401" : { + "description" : "Unauthorized" + }, + "403" : { + "description" : "Forbidden" + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/guids/{id4n}/alias" : { + "get" : { + "tags" : [ "Alias", "Guids" ], + "summary" : "Get all aliases for the given GUID.", + "description" : "Looks up the alias for each alias type (group and single GUID) and returns a map of all aliases found.", + "operationId" : "getGuidAliases", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID to operate on", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/guids/{id4n}/alias/{aliasType}" : { + "post" : { + "tags" : [ "Alias", "Guids" ], + "summary" : "Add alias for GUIDs", + "description" : "Adds or replaces aliases for single GUIDs (alias type item and mapp) or groups of GUIDs (alias types gtin, ean and article)", + "operationId" : "addGuidAlias", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID to operate on", + "required" : true, + "type" : "string" + }, { + "name" : "aliasType", + "in" : "path", + "description" : "Alias type, see the corresponding API model", + "required" : true, + "type" : "string", + "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking", "eclass", "unspsc" ] + }, { + "in" : "body", + "name" : "alias", + "description" : "The alias to add or update", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidAlias" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Alias", "Guids" ], + "summary" : "Remove aliases from GUIDs", + "description" : "Remove the alias of the given type", + "operationId" : "removeGuidAlias", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID to operate on", + "required" : true, + "type" : "string" + }, { + "name" : "aliasType", + "in" : "path", + "description" : "Alias type, see the corresponding API model", + "required" : true, + "type" : "string", + "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking", "eclass", "unspsc" ] + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/history/{id4n}" : { + "get" : { + "tags" : [ "History" ], + "summary" : "List history", + "description" : "Lists the history of a GUID", + "operationId" : "listAll", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "GUID to retrieve the history for", + "required" : true, + "type" : "string" + }, { + "name" : "includePrivate", + "in" : "query", + "description" : "Also return private history entries", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedHistoryItemResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "History" ], + "summary" : "Add history item", + "description" : "Add a new history item", + "operationId" : "addItem", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "GUID to retrieve the history for", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "historyItem", + "description" : "The history item to publish", + "required" : true, + "schema" : { + "$ref" : "#/definitions/HistoryItem" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/history/{id4n}/{organizationId}" : { + "get" : { + "tags" : [ "History" ], + "summary" : "List history", + "description" : "Lists the history of a GUID of the specified organization", + "operationId" : "list", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "GUID to retrieve the history for", + "required" : true, + "type" : "string" + }, { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "includePrivate", + "in" : "query", + "description" : "Also return private history entries", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedHistoryItemResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/history/{id4n}/{organizationId}/{sequenceId}" : { + "get" : { + "tags" : [ "History" ], + "summary" : "Get history item", + "operationId" : "retrieveItem", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "GUID to retrieve the history for", + "required" : true, + "type" : "string" + }, { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "sequenceId", + "in" : "path", + "description" : "sequenceId", + "required" : true, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedHistoryItemResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "patch" : { + "tags" : [ "History" ], + "summary" : "Update history item", + "operationId" : "updateItem", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "GUID to retrieve the history for", + "required" : true, + "type" : "string" + }, { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "sequenceId", + "in" : "path", + "description" : "sequenceId", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "in" : "body", + "name" : "update", + "description" : "update", + "required" : true, + "schema" : { + "$ref" : "#/definitions/HistoryItemUpdate" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/HistoryItem" + } + }, + "204" : { + "description" : "No Content" + }, + "401" : { + "description" : "Unauthorized" + }, + "403" : { + "description" : "Forbidden" + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/history/{id4n}/{organizationId}/{sequenceId}/visibility" : { + "put" : { + "tags" : [ "History" ], + "summary" : "Set history item visibility", + "operationId" : "updateItemVisibility", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "GUID to retrieve the history for", + "required" : true, + "type" : "string" + }, { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "sequenceId", + "in" : "path", + "description" : "sequenceId", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "in" : "body", + "name" : "visibility", + "description" : "History item visibility restrictions", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Visibility" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/HistoryItem" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/id4ns/{id4n}" : { + "get" : { + "tags" : [ "Guids" ], + "summary" : "Retrieve ID4n information", + "description" : "Retrieving basic information about an ID like the type and the creation time.", + "operationId" : "getId4n", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The ID to resolve to", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Id4nPresentation" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/info" : { + "get" : { + "tags" : [ "Meta Information" ], + "summary" : "Retrieve version information about ID4i", + "description" : "Retrieving version information about ID4i.", + "operationId" : "applicationInfo", + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/AppInfoPresentation" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/microstorage/{id4n}/{organization}" : { + "get" : { + "tags" : [ "Storage" ], + "summary" : "Read data from microstorage", + "operationId" : "readFromMicrostorage", + "parameters" : [ { + "name" : "organization", + "in" : "path", + "description" : "organization", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "string", + "format" : "byte" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Storage" ], + "summary" : "Write data to microstorage", + "operationId" : "writeToMicrostorage", + "consumes" : [ "*/*" ], + "parameters" : [ { + "name" : "organization", + "in" : "path", + "description" : "organization", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "Content-Type", + "in" : "header", + "description" : "Content-Type", + "required" : false, + "type" : "string" + }, { + "name" : "Content-Length", + "in" : "header", + "description" : "Content-Length", + "required" : false, + "type" : "integer", + "format" : "int64" + }, { + "in" : "body", + "name" : "body", + "description" : "body", + "required" : false, + "schema" : { + "type" : "string", + "format" : "byte" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations" : { + "post" : { + "tags" : [ "Organizations" ], + "summary" : "Create organization", + "description" : "Creating a new organization.", + "operationId" : "createOrganization", + "parameters" : [ { + "in" : "body", + "name" : "organization", + "description" : "Organization to be created", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Organization" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Organization" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "Find organization by id/namespace", + "description" : "Returns a single organization.", + "operationId" : "findOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace of the organization to be retrieved.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Organization" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Organizations" ], + "summary" : "Update organization", + "operationId" : "updateOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace of the organization to be updated.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "organizationUpdate", + "description" : "Updated organization object", + "required" : true, + "schema" : { + "$ref" : "#/definitions/OrganizationUpdate" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Organization" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Organizations" ], + "summary" : "Delete organization", + "operationId" : "deleteOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace of the organization to be deleted.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/addresses/billing" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "Retrieve billing address", + "operationId" : "findOrganizationBillingAddress", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Organizations" ], + "summary" : "Store billing address", + "operationId" : "updateOrganizationBillingAddress", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "addressResource", + "description" : "addressResource", + "required" : true, + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Organizations" ], + "summary" : "Remove billing address", + "operationId" : "deleteOrganizationBillingAddress", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/addresses/default" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "Retrieve address", + "operationId" : "findOrganizationAddress", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Organizations" ], + "summary" : "Store address", + "operationId" : "updateOrganizationAddress", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "addressResource", + "description" : "addressResource", + "required" : true, + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/collections" : { + "get" : { + "tags" : [ "Collections", "Organizations" ], + "summary" : "Get collections of organization", + "description" : "Retrieving all collections of an organization in a paginated manner.", + "operationId" : "getAllCollectionsOfOrganization", + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace of the organization", + "required" : true, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "Filter by this type", + "required" : false, + "type" : "string", + "enum" : [ "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] + }, { + "name" : "label", + "in" : "query", + "description" : "Filter by this label", + "required" : false, + "type" : "string" + }, { + "name" : "labelPrefix", + "in" : "query", + "description" : "Filter by this label prefix", + "required" : false, + "type" : "string", + "maximum" : 2147483647, + "minimum" : 1 + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedGuidCollection" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/logo" : { + "post" : { + "tags" : [ "Organizations" ], + "summary" : "Update organization logo", + "description" : "Updating an organization logo using a multipart file upload.", + "operationId" : "setOrganizationLogo", + "consumes" : [ "multipart/form-data" ], + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace of the organization where the logo should be updated.", + "required" : true, + "type" : "string" + }, { + "name" : "file", + "in" : "formData", + "description" : "An image containing the new logo.", + "required" : true, + "type" : "file" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PublicImagePresentation" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Organizations" ], + "summary" : "Delete organization logo", + "operationId" : "deleteOrganizationLogo", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace of the organization where the logo should be deleted.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/roles" : { + "get" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "List users and their roles", + "description" : "Listing users and their roles in a paginated manner.", + "operationId" : "getAllOrganizationRoles", + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedUserRolesResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/users" : { + "get" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Find users in organization", + "description" : "Finding users in the specified organization in a paginated manner.", + "operationId" : "getUsersOfOrganization", + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedUserPresentationResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/users/invite" : { + "post" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Invite Users", + "operationId" : "inviteUsers", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace of the organization where users should be invited", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "invitationList", + "description" : "invitationList", + "required" : true, + "schema" : { + "$ref" : "#/definitions/OrganizationUserInvitationListRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/users/{username}/roles" : { + "get" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Get user roles by username", + "operationId" : "getUserRoles", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace of the organization", + "required" : true, + "type" : "string" + }, { + "name" : "username", + "in" : "path", + "description" : "username", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedStringResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Add role(s) to user", + "operationId" : "addUserRoles", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace of the organization", + "required" : true, + "type" : "string" + }, { + "name" : "username", + "in" : "path", + "description" : "username", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "changeRoleRequest", + "description" : "changeRoleRequest", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ChangeRoleRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Remove role(s) from user", + "operationId" : "removeUserRoles", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The namespace of the organization", + "required" : true, + "type" : "string" + }, { + "name" : "username", + "in" : "path", + "description" : "username", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "changeRoleRequest", + "description" : "changeRoleRequest", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ChangeRoleRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/documents/{id4n}" : { + "get" : { + "tags" : [ "Public Services", "Storage" ], + "summary" : "List organization specific documents", + "description" : "Listing documents of an id4n owned by a specified organization", + "operationId" : "listAllPublicDocuments", + "parameters" : [ { + "name" : "organizationId", + "in" : "query", + "description" : "organizationId", + "required" : false, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedOwnedDocumentResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/documents/{id4n}/{organizationId}" : { + "get" : { + "tags" : [ "Public Services", "Storage" ], + "summary" : "List organization specific documents", + "description" : "Listing documents of an id4n owned by a specified organization", + "operationId" : "listPublicDocuments", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedDocumentResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/documents/{id4n}/{organizationId}/{fileName}" : { + "get" : { + "tags" : [ "Public Services", "Storage" ], + "summary" : "Read document contents", + "operationId" : "readPublicDocument", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "string", + "format" : "byte" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata" : { + "get" : { + "tags" : [ "Public Services", "Storage" ], + "summary" : "Retrieve a document (meta-data only, no content)", + "operationId" : "getPublicDocument", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "string" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Document" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/history/{id4n}" : { + "get" : { + "tags" : [ "Public Services" ], + "summary" : "Shows the public history of the given GUID", + "description" : "Only contains public history items", + "operationId" : "listPublicHistory", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "GUID to retrieve the history for", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedHistoryItemResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/image/{imageID}" : { + "get" : { + "tags" : [ "Images", "Public Services" ], + "summary" : "Resolve image", + "operationId" : "resolveImageUsingGET", + "parameters" : [ { + "name" : "imageID", + "in" : "path", + "description" : "The id of the image to be resolved.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "string", + "format" : "byte" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/organizations/{organizationId}" : { + "get" : { + "tags" : [ "Public Services" ], + "summary" : "Read public organization information", + "operationId" : "readOrganizationInfo", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "Organization ID", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Organization" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/routes/{id4n}" : { + "get" : { + "tags" : [ "Public Services" ], + "summary" : "Retrieve all public routes for a GUID", + "operationId" : "getWebRoutes", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Route" + } + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/roles" : { + "get" : { + "tags" : [ "Accounts" ], + "summary" : "List roles", + "description" : "Listing of roles.", + "operationId" : "listAllRoles", + "parameters" : [ { + "name" : "privilege", + "in" : "query", + "description" : "If specified the roles will be filtered containing that privilege.", + "required" : false, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/RoleResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/routingfiles/{id4n}" : { + "get" : { + "tags" : [ "Routing" ], + "summary" : "Retrieve routing file", + "operationId" : "getRoutingFile", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "organizationId", + "in" : "query", + "description" : "organizationId", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/RoutingFile" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Routing" ], + "summary" : "Store routing file", + "operationId" : "updateRoutingFile", + "parameters" : [ { + "in" : "body", + "name" : "rfr", + "description" : "rfr", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RoutingFileRequest" + } + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/routingfiles/{id4n}/routes" : { + "get" : { + "tags" : [ "Routing" ], + "summary" : "Retrieve all web routes", + "description" : "Retrieves public and private web routes and interpolates them", + "operationId" : "getAllWebRoutes", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Route" + } + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/routingfiles/{id4n}/routes/{type}" : { + "get" : { + "tags" : [ "Routing" ], + "summary" : "Retrieve current route of a GUID (or ID4N)", + "operationId" : "getRoute", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "type", + "in" : "path", + "description" : "The type of route you want to have", + "required" : true, + "type" : "string" + }, { + "name" : "privateRoutes", + "in" : "query", + "description" : "privateRoutes", + "required" : false, + "type" : "boolean" + }, { + "name" : "publicRoutes", + "in" : "query", + "description" : "publicRoutes", + "required" : false, + "type" : "boolean" + }, { + "name" : "interpolate", + "in" : "query", + "description" : "interpolate", + "required" : false, + "type" : "boolean" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Route" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/search/guids" : { + "get" : { + "tags" : [ "Alias" ], + "summary" : "Search for GUIDs by alias", + "operationId" : "searchByAlias", + "parameters" : [ { + "name" : "alias", + "in" : "query", + "description" : "The alias to search for", + "required" : true, + "type" : "string" + }, { + "name" : "aliasType", + "in" : "query", + "description" : "Alias type type to search for", + "required" : true, + "type" : "string", + "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking", "eclass", "unspsc" ] + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedGuidResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/search/guids/aliases/types" : { + "get" : { + "tags" : [ "Alias" ], + "summary" : "List all supported alias types", + "description" : "Retrieve this list to find out all alias types to use with alias search and change operations", + "operationId" : "getGuidAliasTypes", + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking", "eclass", "unspsc" ] + } + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/transfers/{id4n}/receiveInfo" : { + "get" : { + "tags" : [ "Transfer" ], + "summary" : "Show transfer information", + "operationId" : "getReceiveInfo", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The ID4N to retrieve information about", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/TransferReceiveInfo" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Transfer" ], + "summary" : "Transfer a GUID or collection, obtaining it (i.e. becoming the holder) and if allowed also taking ownership", + "description" : "Taking ownership can be forbidden by a previous owner. See methods prepare and getInfo", + "operationId" : "receive", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "This ID4N identifies the object to take hold of", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "Required information to receive an id4n object", + "required" : true, + "schema" : { + "$ref" : "#/definitions/TransferReceiveInfo" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/transfers/{id4n}/sendInfo" : { + "get" : { + "tags" : [ "Transfer" ], + "summary" : "Show transfer preparation information", + "operationId" : "getSendInfo", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The ID4N to retrieve information about", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/TransferSendInfo" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Transfer" ], + "summary" : "Prepare an object for transfer", + "operationId" : "prepare", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The ID4N to prepare for transfer", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "Transfer preparation status", + "required" : true, + "schema" : { + "$ref" : "#/definitions/TransferSendInfo" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/user/organizations" : { + "get" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Retrieve organizations of user", + "operationId" : "getOrganizationsOfUser", + "parameters" : [ { + "name" : "role", + "in" : "query", + "description" : "role", + "required" : false, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedOrganizationResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/users" : { + "get" : { + "tags" : [ "Accounts" ], + "summary" : "Find users", + "operationId" : "findUsers", + "parameters" : [ { + "name" : "usernamePrefix", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedUserPresentationResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/users/{username}" : { + "get" : { + "tags" : [ "Accounts" ], + "summary" : "Find by username", + "operationId" : "findUserByUsername", + "parameters" : [ { + "name" : "username", + "in" : "path", + "description" : "username", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/UserPresentation" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/go/{guid}" : { + "get" : { + "tags" : [ "Public Services" ], + "summary" : "Forward", + "description" : "Forwarding to the designated route defined in the routing,", + "operationId" : "go", + "parameters" : [ { + "name" : "guid", + "in" : "path", + "description" : "guid", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/login" : { + "post" : { + "tags" : [ "Accounts" ], + "description" : "ID4i API Login", + "operationId" : "login", + "parameters" : [ { + "in" : "body", + "name" : "account-credentials", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccountCredentials" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/whois/{id4n}" : { + "get" : { + "tags" : [ "Public Services", "WhoIs" ], + "summary" : "Resolve owner of id4n", + "operationId" : "resolveWhoIsEntry", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/WhoIsResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + } + }, + "securityDefinitions" : { + "Authorization" : { + "type" : "apiKey", + "name" : "Authorization", + "in" : "header" + } + }, + "definitions" : { + "AccountCredentials" : { + "type" : "object", + "properties" : { + "login" : { + "type" : "string" + }, + "password" : { + "type" : "string" + } + }, + "title" : "AccountCredentials" + }, + "AddApiKeyPrivilegeRequest" : { + "type" : "object", + "required" : [ "privilege" ], + "properties" : { + "privilege" : { + "type" : "string" + } + }, + "title" : "AddApiKeyPrivilegeRequest" + }, + "ApiError" : { + "type" : "object", + "required" : [ "code", "errorList", "message" ], + "properties" : { + "code" : { + "type" : "string", + "enum" : [ "ERR_REGISTRATION_VERIFICATION_NO_TOKEN", "ERR_REGISTRATION_VERIFICATION_INVALID_TOKEN", "ERR_REGISTRATION_VERIFICATION_EXPIRED_TOKEN", "ERR_AUTHENTICATION_NO_TOKEN", "ERR_AUTHENTICATION_INVALID_TOKEN", "ERR_AUTHENTICATION_EXPIRED_TOKEN", "ERR_AUTHENTICATION_FAILED", "ERR_AUTHORIZATION_MISSING_PRIVILEGES", "ERR_AUTHORIZATION_FORBIDDEN", "ERR_AUTHORIZATION_REQUIRE_USER", "ERR_INPUT_VALIDATION_FAILED", "ERR_FIELD_INPUT_VALIDATION_FAILED", "ERR_VALIDATION_CONSTRAINT_FAILED", "ERR_INPUT_NOT_READABLE", "ERR_INVALID_INPUT_PARAMETER", "ERR_GUID_CREATION", "ERR_INVALID_ID4N_OBJECT_TYPE", "ERR_COLLECTION_UPDATE_DENIED", "ERR_ENTITY_NOT_FOUND", "ERR_ENTITY_TOO_BIG", "ERR_DUPLICATE", "ERR_INTERNAL", "ERR_UNKNOWN", "ERR_INVALID_ORGANIZATION_USERROLE", "ERR_ORGANIZATION_ROLE_INCONSISTENCY", "ERR_ORGANIZATION_NOT_DELETABLE", "ERR_USER_ALREADY_IN_ORGANIZATION", "ERR_USER_INVITATION_NEEDS_MINIMUM_ONE_ROLE", "ERR_USER_INVITATION_SPECIFY_EMAIL_OR_USERNAME", "ERR_USER_DEACTIVATED", "ERR_LANGUAGE_NOT_SUPPORTED", "ERR_EMAIL_MISSING_TEMPLATE_PARAM", "ERR_EMAIL_TEMPLATE_NOT_AVAILABLE", "ERR_EMAIL_PREPARATION_FAILED", "ERR_IMAGE_CONVERSION", "ERR_UPLOAD_TOO_LARGE", "ERR_INVALID_ALIAS_TYPE", "ERR_INVALID_URI_TEMPLATE", "ERR_INVALID_URI_TEMPLATE_VARIABLE", "ERR_INVALID_NAMESPACE", "ERR_NAMESPACE_ALREADY_EXISTS", "ERR_INSECURE_PASSWORD", "ERR_TRANSFER_DENIED", "ERR_INVALID_PHYSICAL_STATE" ] + }, + "errorList" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ApiError" + } + }, + "message" : { + "type" : "string" + } + }, + "title" : "ApiError" + }, + "ApiKeyChangeRequest" : { + "type" : "object", + "required" : [ "newLabel" ], + "properties" : { + "active" : { + "type" : "boolean" + }, + "newLabel" : { + "type" : "string", + "minLength" : 5, + "maxLength" : 50 + } + }, + "title" : "ApiKeyChangeRequest" + }, + "ApiKeyCreationRequest" : { + "type" : "object", + "required" : [ "label", "organizationId", "secret" ], + "properties" : { + "label" : { + "type" : "string", + "minLength" : 5, + "maxLength" : 50 + }, + "organizationId" : { + "type" : "string", + "example" : "de.acme", + "allowEmptyValue" : false + }, + "secret" : { + "type" : "string", + "minLength" : 10, + "maxLength" : 500 + } + }, + "title" : "ApiKeyCreationRequest" + }, + "ApiKeyPresentation" : { + "type" : "object", + "required" : [ "active", "createdAt", "createdBy", "key", "label", "organizationId" ], + "properties" : { + "active" : { + "type" : "boolean", + "example" : true, + "description" : "Whether this API key is active", + "allowEmptyValue" : false + }, + "createdAt" : { + "type" : "integer", + "format" : "int64", + "example" : 1517232722, + "description" : "The UTC unix timestamp of when this api key has been created", + "allowEmptyValue" : false + }, + "createdBy" : { + "type" : "string", + "example" : "user123", + "allowEmptyValue" : false + }, + "key" : { + "type" : "string", + "example" : "39978f49-6ff1-4147-bf0f-9910185084b7", + "description" : "The api key identifier", + "allowEmptyValue" : false + }, + "label" : { + "type" : "string", + "example" : "My Api Key", + "description" : "The label / name of the api key", + "allowEmptyValue" : false + }, + "organizationId" : { + "type" : "string", + "example" : 10, + "description" : "The organization namespace this api key belongs to", + "allowEmptyValue" : false + } + }, + "title" : "ApiKeyPresentation" + }, + "ApiKeyPrivilege" : { + "type" : "object", + "required" : [ "id4nAssociated", "privilege" ], + "properties" : { + "id4nAssociated" : { + "type" : "boolean" + }, + "privilege" : { + "type" : "string" + } + }, + "title" : "ApiKeyPrivilege" + }, + "ApiKeyPrivilegeInfo" : { + "type" : "object", + "required" : [ "id4nAssociated", "name" ], + "properties" : { + "allowsBillableOperations" : { + "type" : "boolean" + }, + "helpText" : { + "type" : "string" + }, + "id4nAssociated" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + } + }, + "title" : "ApiKeyPrivilegeInfo" + }, + "ApiKeyPrivilegeInfoResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPrivilegeInfo" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "ApiKeyPrivilegeInfoResponse" + }, + "ApiKeyPrivilegePaginatedResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPrivilege" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "ApiKeyPrivilegePaginatedResponse" + }, + "AppInfoPresentation" : { + "type" : "object", + "properties" : { + "branch" : { + "type" : "string" + }, + "commitTime" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "productionMode" : { + "type" : "boolean" + }, + "revision" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + }, + "title" : "AppInfoPresentation" + }, + "BillingPosition" : { + "type" : "object", + "required" : [ "count", "description", "service", "sum" ], + "properties" : { + "count" : { + "type" : "integer", + "format" : "int64" + }, + "description" : { + "type" : "string" + }, + "service" : { + "type" : "string" + }, + "sum" : { + "type" : "number", + "format" : "float" + } + }, + "title" : "BillingPosition" + }, + "ChangeLogEntry" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "example" : "e100123", + "description" : "The unique id of the changelog entry", + "readOnly" : true, + "allowEmptyValue" : false + }, + "message" : { + "type" : "string", + "example" : "User {{&user}} has changed the title of {{&object}}", + "description" : "The message as template or rendered as plain text", + "readOnly" : true, + "allowEmptyValue" : false + }, + "messageProperties" : { + "type" : "object", + "example" : { + "user" : { + "value" : "a.vratny", + "type" : "user" + }, + "object" : "nearly every object" + }, + "description" : "The values of the properties in the message. May be nested as object with a value field ", + "readOnly" : true, + "allowEmptyValue" : false, + "additionalProperties" : { + "type" : "object" + } + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "example" : 1517232722, + "description" : "The UTC unix timestamp when this change occurred", + "readOnly" : true, + "allowEmptyValue" : false + } + }, + "title" : "ChangeLogEntry", + "description" : "A changelog entry" + }, + "ChangeRoleRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "title" : "ChangeRoleRequest" + }, + "CompleteUserRegistrationRequest" : { + "type" : "object", + "required" : [ "password", "username", "verificationToken" ], + "properties" : { + "verificationToken" : { + "type" : "string" + }, + "username" : { + "type" : "string", + "pattern" : "[a-zA-Z0-9_.-]{6,50}" + }, + "password" : { + "type" : "string", + "minLength" : 8, + "maxLength" : 99 + } + }, + "title" : "CompleteUserRegistrationRequest" + }, + "Country" : { + "type" : "object", + "required" : [ "code", "name" ], + "properties" : { + "code" : { + "type" : "string" + }, + "name" : { + "type" : "string" + } + }, + "title" : "Country" + }, + "CreateCollectionRequest" : { + "type" : "object", + "required" : [ "length", "organizationId", "type" ], + "properties" : { + "label" : { + "type" : "string", + "minLength" : 5, + "maxLength" : 128 + }, + "organizationId" : { + "type" : "string", + "example" : "de.acme", + "allowEmptyValue" : false + }, + "length" : { + "type" : "integer", + "format" : "int32", + "minimum" : 6.0, + "maximum" : 255.0, + "exclusiveMinimum" : false, + "exclusiveMaximum" : false + }, + "type" : { + "type" : "string", + "enum" : [ "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] + } + }, + "title" : "CreateCollectionRequest" + }, + "CreateGuidRequest" : { + "type" : "object", + "required" : [ "count", "length", "organizationId" ], + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "example" : 1, + "description" : "The total number of GUIDs to create", + "allowEmptyValue" : false, + "minimum" : 1.0, + "maximum" : 1000.0, + "exclusiveMinimum" : false, + "exclusiveMaximum" : false + }, + "length" : { + "type" : "integer", + "format" : "int32", + "example" : 40, + "description" : "The charactersequence length of the GUID", + "allowEmptyValue" : false, + "minimum" : 7.0, + "maximum" : 255.0, + "exclusiveMinimum" : false, + "exclusiveMaximum" : false + }, + "organizationId" : { + "type" : "string", + "example" : 123, + "description" : "The namespace of the organization where the generated GUIDs should be assigned.", + "allowEmptyValue" : false + } + }, + "title" : "CreateGuidRequest", + "description" : "GUID creation information" + }, + "Document" : { + "type" : "object", + "properties" : { + "filename" : { + "type" : "string", + "example" : "publicInfo.pdf", + "description" : "File Name", + "allowEmptyValue" : false + }, + "mimeType" : { + "type" : "string", + "example" : "text/plain", + "description" : "Mime Type", + "allowEmptyValue" : false + }, + "visibility" : { + "description" : "Visibility configuration", + "allowEmptyValue" : false, + "$ref" : "#/definitions/Visibility" + } + }, + "title" : "Document" + }, + "DocumentUpdate" : { + "type" : "object", + "properties" : { + "filename" : { + "type" : "string", + "example" : "publicInfo.pdf", + "description" : "File Name", + "allowEmptyValue" : false + }, + "mimeType" : { + "type" : "string", + "example" : "text/plain", + "description" : "Mime Type", + "allowEmptyValue" : false + }, + "visibility" : { + "example" : true, + "description" : "Visibility configuration", + "allowEmptyValue" : false, + "$ref" : "#/definitions/VisibilityUpdate" + } + }, + "title" : "DocumentUpdate" + }, + "File" : { + "type" : "object", + "properties" : { + "absolute" : { + "type" : "boolean" + }, + "absoluteFile" : { + "$ref" : "#/definitions/File" + }, + "absolutePath" : { + "type" : "string" + }, + "canonicalFile" : { + "$ref" : "#/definitions/File" + }, + "canonicalPath" : { + "type" : "string" + }, + "directory" : { + "type" : "boolean" + }, + "file" : { + "type" : "boolean" + }, + "freeSpace" : { + "type" : "integer", + "format" : "int64" + }, + "hidden" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "parent" : { + "type" : "string" + }, + "parentFile" : { + "$ref" : "#/definitions/File" + }, + "path" : { + "type" : "string" + }, + "totalSpace" : { + "type" : "integer", + "format" : "int64" + }, + "usableSpace" : { + "type" : "integer", + "format" : "int64" + } + }, + "title" : "File" + }, + "Guid" : { + "type" : "object", + "properties" : { + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "example" : 1517232722, + "description" : "The UTC unix timestamp of when this GUID has been created", + "readOnly" : true, + "allowEmptyValue" : false + }, + "holderOrganizationId" : { + "type" : "string", + "description" : "Organization namespace of the GUID holder", + "readOnly" : true, + "allowEmptyValue" : false + }, + "id4n" : { + "type" : "string", + "example" : "3THvgrWxqgTFC4", + "description" : "The ID", + "readOnly" : true, + "allowEmptyValue" : false + }, + "ownerOrganizationId" : { + "type" : "string", + "description" : "Organization namespace of the GUID owner", + "readOnly" : true, + "allowEmptyValue" : false + }, + "physicalState" : { + "type" : "string", + "description" : "Physical attachment state of the GUID", + "allowEmptyValue" : false, + "enum" : [ "UNATTACHED", "ATTACHED", "DETACHED" ] + } + }, + "title" : "Guid" + }, + "GuidAlias" : { + "type" : "object", + "required" : [ "alias" ], + "properties" : { + "alias" : { + "type" : "string", + "example" : "alias", + "description" : "An alias", + "allowEmptyValue" : false, + "minLength" : 1, + "maxLength" : 255 + } + }, + "title" : "GuidAlias" + }, + "GuidCollection" : { + "type" : "object", + "properties" : { + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The UTC unix timestamp of when this collection has been created", + "readOnly" : true, + "allowEmptyValue" : false + }, + "holderOrganizationId" : { + "type" : "string", + "description" : "Organization namespace of the holder of the collection", + "allowEmptyValue" : false + }, + "id4n" : { + "type" : "string", + "description" : "The ID", + "readOnly" : true, + "allowEmptyValue" : false + }, + "label" : { + "type" : "string", + "minLength" : 5, + "maxLength" : 128 + }, + "ownerOrganizationId" : { + "type" : "string", + "description" : "Organization namespace of the collection owner", + "readOnly" : true, + "allowEmptyValue" : false + }, + "physicalState" : { + "type" : "string", + "description" : "Physical attachment state of the collection", + "allowEmptyValue" : false, + "enum" : [ "UNATTACHED", "ATTACHED", "DETACHED" ] + }, + "type" : { + "type" : "string", + "readOnly" : true, + "allowEmptyValue" : false, + "enum" : [ "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] + } + }, + "title" : "GuidCollection" + }, + "HistoryItem" : { + "type" : "object", + "required" : [ "organizationId", "type" ], + "properties" : { + "organizationId" : { + "type" : "string", + "example" : 93, + "description" : "Originator of the history item", + "allowEmptyValue" : false + }, + "sequenceId" : { + "type" : "integer", + "format" : "int32", + "example" : 9784, + "description" : "Forms the primary key of the history item together with the GUID and the organizationId", + "readOnly" : true, + "allowEmptyValue" : false + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "example" : 1517232722, + "description" : "History item timestamp", + "readOnly" : true, + "allowEmptyValue" : false + }, + "type" : { + "type" : "string", + "example" : "DISPATCHED", + "description" : "Type of the history item", + "allowEmptyValue" : false, + "enum" : [ "CREATED", "DESTROYED", "RECYCLED", "SHIPMENT_PREPARED", "STORED", "RETRIEVED_FROM_STORAGE", "PACKAGED", "DISPATCHED", "RECEIVED", "REPROCESSING_STARTED", "REPROCESSING_CANCELLED", "REPROCESSING_FINISHED", "DISASSEMBLED", "MAINTENANCE_STARTED", "MAINTENANCE_CANCELLED", "MAINTENANCE_FINISHED", "PRODUCTION_STEP_STARTED", "PRODUCTION_STEP_CANCELLED", "PRODUCTION_STEP_FINISHED" ] + }, + "visibility" : { + "description" : "History item visibility restrictions", + "allowEmptyValue" : false, + "$ref" : "#/definitions/Visibility" + } + }, + "title" : "HistoryItem", + "description" : "GUID history item" + }, + "HistoryItemUpdate" : { + "type" : "object", + "properties" : { + "organizationId" : { + "type" : "string", + "example" : "de.acme", + "description" : "New organization id displayed for this item. If given, must match the holder of GUID and the organization the history item is found under.", + "allowEmptyValue" : false + }, + "visibility" : { + "description" : "History item visibility restrictions", + "allowEmptyValue" : false, + "$ref" : "#/definitions/Visibility" + } + }, + "title" : "HistoryItemUpdate", + "description" : "GUID history item update (diff patch)" + }, + "Id4n" : { + "type" : "object", + "properties" : { + "id4n" : { + "type" : "string", + "example" : "3THvgrWxqgTFC4", + "description" : "The ID", + "allowEmptyValue" : false + } + }, + "title" : "Id4n" + }, + "Id4nPresentation" : { + "type" : "object", + "required" : [ "createdTimestamp", "id4n", "type" ], + "properties" : { + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "example" : 1517232722, + "description" : "The UTC unix timestamp of when this ID has been created", + "readOnly" : true, + "allowEmptyValue" : false + }, + "holderOrganizationId" : { + "type" : "string", + "example" : "de.example", + "description" : "${Id4nPresentation.Guid.holderOrganizationId}", + "readOnly" : true, + "allowEmptyValue" : false + }, + "id4n" : { + "type" : "string", + "example" : "3THvgrWxqgTFC4", + "description" : "The ID", + "readOnly" : true, + "allowEmptyValue" : false + }, + "label" : { + "type" : "string", + "readOnly" : true, + "allowEmptyValue" : false + }, + "ownerOrganizationId" : { + "type" : "string", + "example" : "org.acme", + "description" : "${Id4nPresentation.Guid.ownerOrganizationId}", + "readOnly" : true, + "allowEmptyValue" : false + }, + "type" : { + "type" : "string", + "description" : "The type of ID", + "readOnly" : true, + "allowEmptyValue" : false, + "enum" : [ "GUID", "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] + } + }, + "title" : "Id4nPresentation" + }, + "Id4nPresentationPaginatedResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Id4nPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "Id4nPresentationPaginatedResponse" + }, + "InputStream" : { + "type" : "object", + "title" : "InputStream" + }, + "InputStreamResource" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "file" : { + "$ref" : "#/definitions/File" + }, + "filename" : { + "type" : "string" + }, + "inputStream" : { + "$ref" : "#/definitions/InputStream" + }, + "open" : { + "type" : "boolean" + }, + "readable" : { + "type" : "boolean" + }, + "uri" : { + "$ref" : "#/definitions/URI" + }, + "url" : { + "$ref" : "#/definitions/URL" + } + }, + "title" : "InputStreamResource" + }, + "ListOfId4ns" : { + "type" : "object", + "properties" : { + "id4ns" : { + "type" : "array", + "description" : "A list of id4ns.", + "allowEmptyValue" : false, + "items" : { + "type" : "string" + } + } + }, + "title" : "ListOfId4ns", + "description" : "A list of id4ns" + }, + "Organization" : { + "type" : "object", + "required" : [ "name", "namespace" ], + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64", + "example" : 100, + "description" : "The id of the organization ( Deprecated: Use namespace instead. )", + "readOnly" : true, + "allowEmptyValue" : false + }, + "logoURL" : { + "type" : "string", + "example" : "/api/v1/public/images/abcdef", + "description" : "URL to a logo of the organization", + "readOnly" : true, + "allowEmptyValue" : false + }, + "name" : { + "type" : "string", + "example" : "ACME Inc.", + "description" : "The name of the organization", + "allowEmptyValue" : false, + "minLength" : 3, + "maxLength" : 254 + }, + "namespace" : { + "type" : "string", + "example" : "de.acme", + "description" : "The namespace of the organization", + "allowEmptyValue" : false, + "minLength" : 3, + "maxLength" : 255 + } + }, + "title" : "Organization", + "description" : "An organization" + }, + "OrganizationAddress" : { + "type" : "object", + "required" : [ "city", "countryCode", "firstname", "lastname", "postCode", "street" ], + "properties" : { + "companyName" : { + "type" : "string", + "example" : "ACME Inc.", + "allowEmptyValue" : false, + "minLength" : 0, + "maxLength" : 254 + }, + "firstname" : { + "type" : "string", + "example" : "Max", + "allowEmptyValue" : false, + "minLength" : 2, + "maxLength" : 254 + }, + "lastname" : { + "type" : "string", + "example" : "Muster", + "allowEmptyValue" : false, + "minLength" : 2, + "maxLength" : 254 + }, + "street" : { + "type" : "string", + "example" : "Examplestreet 1", + "allowEmptyValue" : false, + "minLength" : 3, + "maxLength" : 254 + }, + "postCode" : { + "type" : "string", + "example" : 12345, + "allowEmptyValue" : false, + "minLength" : 2, + "maxLength" : 40 + }, + "city" : { + "type" : "string", + "example" : "MyCity", + "allowEmptyValue" : false, + "minLength" : 2, + "maxLength" : 99 + }, + "countryCode" : { + "type" : "string", + "example" : "DE", + "description" : "The ISO 3166 two-letter country code", + "allowEmptyValue" : false, + "minLength" : 0, + "maxLength" : 2 + }, + "countryName" : { + "type" : "string", + "example" : "Germany", + "description" : "The country name", + "readOnly" : true, + "allowEmptyValue" : false + }, + "telephone" : { + "type" : "string", + "example" : "+49 8088 12345", + "description" : "The telephone number e.g.", + "allowEmptyValue" : false, + "minLength" : 0, + "maxLength" : 99 + } + }, + "title" : "OrganizationAddress" + }, + "OrganizationUpdate" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "example" : "ACME Inc.", + "description" : "The name of the organization", + "allowEmptyValue" : false, + "minLength" : 3, + "maxLength" : 254 + }, + "namespace" : { + "type" : "string", + "example" : "de.acme", + "description" : "The namespace of the organization", + "allowEmptyValue" : false, + "minLength" : 3, + "maxLength" : 255 + } + }, + "title" : "OrganizationUpdate", + "description" : "An organization" + }, + "OrganizationUserInvitation" : { + "type" : "object", + "required" : [ "roles" ], + "properties" : { + "email" : { + "type" : "string" + }, + "userName" : { + "type" : "string" + }, + "roles" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "title" : "OrganizationUserInvitation" + }, + "OrganizationUserInvitationListRequest" : { + "type" : "object", + "required" : [ "invitations" ], + "properties" : { + "invitations" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/OrganizationUserInvitation" + } + } + }, + "title" : "OrganizationUserInvitationListRequest" + }, + "OwnedDocument" : { + "type" : "object", + "properties" : { + "filename" : { + "type" : "string", + "example" : "publicInfo.pdf", + "description" : "File Name", + "allowEmptyValue" : false + }, + "mimeType" : { + "type" : "string", + "example" : "text/plain", + "description" : "Mime Type", + "allowEmptyValue" : false + }, + "ownerOrganizationId" : { + "type" : "string", + "example" : "de.bluerain", + "description" : "The organization's namespace which owns the document", + "readOnly" : true, + "allowEmptyValue" : false + }, + "visibility" : { + "description" : "Visibility configuration", + "allowEmptyValue" : false, + "$ref" : "#/definitions/Visibility" + } + }, + "title" : "OwnedDocument" + }, + "PaginatedApiKeyResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedApiKeyResponse" + }, + "PaginatedChangeLogEntryResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ChangeLogEntry" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedChangeLogEntryResponse" + }, + "PaginatedCountryResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Country" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedCountryResponse" + }, + "PaginatedDocumentResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Document" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedDocumentResponse" + }, + "PaginatedGuidCollection" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/GuidCollection" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedGuidCollection" + }, + "PaginatedGuidResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Guid" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedGuidResponse" + }, + "PaginatedHistoryItemResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/HistoryItem" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedHistoryItemResponse" + }, + "PaginatedOrganizationResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Organization" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedOrganizationResponse" + }, + "PaginatedOwnedDocumentResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/OwnedDocument" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedOwnedDocumentResponse" + }, + "PaginatedResponse«ApiKeyPresentation»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«ApiKeyPresentation»" + }, + "PaginatedResponse«ApiKeyPrivilegeInfo»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPrivilegeInfo" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«ApiKeyPrivilegeInfo»" + }, + "PaginatedResponse«ApiKeyPrivilege»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPrivilege" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«ApiKeyPrivilege»" + }, + "PaginatedResponse«ChangeLogEntry»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ChangeLogEntry" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«ChangeLogEntry»" + }, + "PaginatedResponse«Country»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Country" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Country»" + }, + "PaginatedResponse«Document»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Document" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Document»" + }, + "PaginatedResponse«GuidCollection»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/GuidCollection" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«GuidCollection»" + }, + "PaginatedResponse«Guid»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Guid" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Guid»" + }, + "PaginatedResponse«HistoryItem»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/HistoryItem" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«HistoryItem»" + }, + "PaginatedResponse«Id4nPresentation»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Id4nPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Id4nPresentation»" + }, + "PaginatedResponse«Organization»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Organization" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Organization»" + }, + "PaginatedResponse«OwnedDocument»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/OwnedDocument" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«OwnedDocument»" + }, + "PaginatedResponse«Role»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Role" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Role»" + }, + "PaginatedResponse«UserPresentation»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/UserPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«UserPresentation»" + }, + "PaginatedResponse«UserRoles»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/UserRoles" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«UserRoles»" + }, + "PaginatedResponse«string»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "type" : "string" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«string»" + }, + "PaginatedStringResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "type" : "string" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedStringResponse" + }, + "PaginatedUserPresentationResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/UserPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedUserPresentationResponse" + }, + "PaginatedUserRolesResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/UserRoles" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedUserRolesResponse" + }, + "PasswordResetRequest" : { + "type" : "object", + "required" : [ "username" ], + "properties" : { + "username" : { + "type" : "string" + } + }, + "title" : "PasswordResetRequest" + }, + "PasswordResetVerificationRequest" : { + "type" : "object", + "required" : [ "password", "token" ], + "properties" : { + "password" : { + "type" : "string" + }, + "token" : { + "type" : "string" + } + }, + "title" : "PasswordResetVerificationRequest" + }, + "PublicImagePresentation" : { + "type" : "object", + "required" : [ "uri" ], + "properties" : { + "uri" : { + "type" : "string", + "example" : "/api/v1/public/image/bc671c63-4a9b-46e7-8c59-9bbe1917e6cc", + "description" : "The uri/url of the image", + "readOnly" : true, + "allowEmptyValue" : false + } + }, + "title" : "PublicImagePresentation" + }, + "RegistrationVerificationTokenPresentation" : { + "type" : "object", + "required" : [ "token" ], + "properties" : { + "token" : { + "type" : "string" + } + }, + "title" : "RegistrationVerificationTokenPresentation" + }, + "RemoveApiKeyPrivilegeRequest" : { + "type" : "object", + "required" : [ "privilege" ], + "properties" : { + "privilege" : { + "type" : "string" + } + }, + "title" : "RemoveApiKeyPrivilegeRequest" + }, + "ResponseEntity" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "object" + }, + "statusCode" : { + "type" : "string", + "enum" : [ "100", "101", "102", "103", "200", "201", "202", "203", "204", "205", "206", "207", "208", "226", "300", "301", "302", "303", "304", "305", "307", "308", "400", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "415", "416", "417", "418", "419", "420", "421", "422", "423", "424", "426", "428", "429", "431", "451", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511" ] + }, + "statusCodeValue" : { + "type" : "integer", + "format" : "int32" + } + }, + "title" : "ResponseEntity" + }, + "Role" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "privileges" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "title" : "Role" + }, + "RoleResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Role" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "RoleResponse" + }, + "Route" : { + "type" : "object", + "required" : [ "params", "public", "type" ], + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "priority" : { + "type" : "integer", + "format" : "int32" + }, + "public" : { + "type" : "boolean" + }, + "type" : { + "type" : "string" + }, + "validUntil" : { + "type" : "integer", + "format" : "int64" + } + }, + "title" : "Route" + }, + "RoutingFile" : { + "type" : "object", + "required" : [ "routes" ], + "properties" : { + "options" : { + "$ref" : "#/definitions/RoutingOptions" + }, + "routes" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Route" + } + } + }, + "title" : "RoutingFile" + }, + "RoutingFileRequest" : { + "type" : "object", + "required" : [ "routing" ], + "properties" : { + "routing" : { + "$ref" : "#/definitions/RoutingFile" + }, + "organizationId" : { + "type" : "string" + } + }, + "title" : "RoutingFileRequest" + }, + "RoutingOptions" : { + "type" : "object", + "properties" : { + "deleteOutdatedRoutes" : { + "type" : "boolean" + } + }, + "title" : "RoutingOptions" + }, + "ServiceCosts" : { + "type" : "object", + "required" : [ "listing" ], + "properties" : { + "listing" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "float" + } + } + }, + "title" : "ServiceCosts" + }, + "SimpleMessageResponse" : { + "type" : "object", + "required" : [ "message" ], + "properties" : { + "message" : { + "type" : "string" + } + }, + "title" : "SimpleMessageResponse" + }, + "Timestamp" : { + "type" : "object", + "properties" : { + "date" : { + "type" : "integer", + "format" : "int32" + }, + "day" : { + "type" : "integer", + "format" : "int32" + }, + "hours" : { + "type" : "integer", + "format" : "int32" + }, + "minutes" : { + "type" : "integer", + "format" : "int32" + }, + "month" : { + "type" : "integer", + "format" : "int32" + }, + "nanos" : { + "type" : "integer", + "format" : "int32" + }, + "seconds" : { + "type" : "integer", + "format" : "int32" + }, + "time" : { + "type" : "integer", + "format" : "int64" + }, + "timezoneOffset" : { + "type" : "integer", + "format" : "int32" + }, + "year" : { + "type" : "integer", + "format" : "int32" + } + }, + "title" : "Timestamp" + }, + "TransferReceiveInfo" : { + "type" : "object", + "required" : [ "holderOrganizationId" ], + "properties" : { + "holderOrganizationId" : { + "type" : "string", + "example" : "de.id4i", + "description" : "The current holder of the object", + "allowEmptyValue" : false + }, + "keepOwnership" : { + "type" : "boolean", + "example" : true, + "description" : "Keep the public ownership while transferring the object", + "readOnly" : true, + "allowEmptyValue" : false + }, + "nextScanOwnership" : { + "type" : "boolean", + "example" : false, + "description" : "Allow anyone which scans or knows the ID4N to obtain this object", + "readOnly" : true, + "allowEmptyValue" : false + }, + "ownerOrganizationId" : { + "type" : "string", + "example" : "de.bluerain", + "description" : "The current publicly visible owner of the object", + "readOnly" : true, + "allowEmptyValue" : false + }, + "recipientOrganizationIds" : { + "type" : "array", + "example" : [ "de.acme", "com.porsche", "com.example" ], + "description" : "Allow only these organizations to obtain this object", + "readOnly" : true, + "allowEmptyValue" : false, + "items" : { + "type" : "string" + } + } + }, + "title" : "TransferReceiveInfo" + }, + "TransferSendInfo" : { + "type" : "object", + "required" : [ "keepOwnership", "nextScanOwnership", "recipientOrganizationIds" ], + "properties" : { + "holderOrganizationId" : { + "type" : "string", + "example" : "de.id4i", + "description" : "The current holder of the object", + "readOnly" : true, + "allowEmptyValue" : false + }, + "keepOwnership" : { + "type" : "boolean", + "example" : true, + "description" : "Keep the public ownership while transferring the object", + "allowEmptyValue" : false + }, + "nextScanOwnership" : { + "type" : "boolean", + "example" : false, + "description" : "Allow anyone which scans or knows the ID4N to obtain this object", + "allowEmptyValue" : false + }, + "ownerOrganizationId" : { + "type" : "string", + "example" : "de.bluerain", + "description" : "The current publicly visible owner of the object", + "readOnly" : true, + "allowEmptyValue" : false + }, + "recipientOrganizationIds" : { + "type" : "array", + "example" : [ "de.acme", "com.porsche", "de.bluerain" ], + "description" : "Allow only these organizations to obtain this object", + "allowEmptyValue" : false, + "items" : { + "type" : "string" + } + } + }, + "title" : "TransferSendInfo" + }, + "URI" : { + "type" : "object", + "properties" : { + "absolute" : { + "type" : "boolean" + }, + "authority" : { + "type" : "string" + }, + "fragment" : { + "type" : "string" + }, + "host" : { + "type" : "string" + }, + "opaque" : { + "type" : "boolean" + }, + "path" : { + "type" : "string" + }, + "port" : { + "type" : "integer", + "format" : "int32" + }, + "query" : { + "type" : "string" + }, + "rawAuthority" : { + "type" : "string" + }, + "rawFragment" : { + "type" : "string" + }, + "rawPath" : { + "type" : "string" + }, + "rawQuery" : { + "type" : "string" + }, + "rawSchemeSpecificPart" : { + "type" : "string" + }, + "rawUserInfo" : { + "type" : "string" + }, + "scheme" : { + "type" : "string" + }, + "schemeSpecificPart" : { + "type" : "string" + }, + "userInfo" : { + "type" : "string" + } + }, + "title" : "URI" + }, + "URL" : { + "type" : "object", + "properties" : { + "authority" : { + "type" : "string" + }, + "content" : { + "type" : "object" + }, + "defaultPort" : { + "type" : "integer", + "format" : "int32" + }, + "file" : { + "type" : "string" + }, + "host" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "port" : { + "type" : "integer", + "format" : "int32" + }, + "protocol" : { + "type" : "string" + }, + "query" : { + "type" : "string" + }, + "ref" : { + "type" : "string" + }, + "userInfo" : { + "type" : "string" + } + }, + "title" : "URL" + }, + "UserPresentation" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "xml" : { + "name" : "id", + "attribute" : false, + "wrapped" : false + } + }, + "name" : { + "type" : "string" + } + }, + "title" : "UserPresentation" + }, + "UserRegistrationRequest" : { + "type" : "object", + "required" : [ "email", "password", "username" ], + "properties" : { + "username" : { + "type" : "string", + "pattern" : "[a-zA-Z0-9_.-]{6,50}" + }, + "password" : { + "type" : "string", + "minLength" : 8, + "maxLength" : 99 + }, + "email" : { + "type" : "string" + } + }, + "title" : "UserRegistrationRequest" + }, + "UserRegistrationResponse" : { + "type" : "object", + "required" : [ "id" ], + "properties" : { + "email" : { + "type" : "string" + }, + "id" : { + "type" : "integer", + "format" : "int64" + }, + "message" : { + "type" : "string" + }, + "username" : { + "type" : "string" + } + }, + "title" : "UserRegistrationResponse" + }, + "UserRoles" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "user" : { + "$ref" : "#/definitions/UserPresentation" + } + }, + "title" : "UserRoles" + }, + "Visibility" : { + "type" : "object", + "properties" : { + "public" : { + "type" : "boolean", + "example" : true, + "description" : "Document is publicly readable (if ID4N is owned by the same organization)", + "allowEmptyValue" : false + }, + "sharedOrganizationIds" : { + "type" : "array", + "example" : [ "de.acme", "com.porsche", "de.bluerain" ], + "description" : "Document is readable by these organizations (independend of ID4N ownership)", + "allowEmptyValue" : false, + "items" : { + "type" : "string" + } + } + }, + "title" : "Visibility" + }, + "VisibilityUpdate" : { + "type" : "object", + "properties" : { + "public" : { + "type" : "boolean", + "example" : true, + "description" : "Document is publicly readable (if ID4N is owned by the same organization)", + "allowEmptyValue" : false + }, + "sharedWithOrganizationIds" : { + "type" : "array", + "example" : [ 101, 102, 103 ], + "description" : "Document is readable by these organizations (independend of ID4N ownership)", + "allowEmptyValue" : false, + "items" : { + "type" : "string" + } + } + }, + "title" : "VisibilityUpdate" + }, + "WhoIsResponse" : { + "type" : "object", + "properties" : { + "aliases" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "organization" : { + "$ref" : "#/definitions/Organization" + }, + "organizationAddress" : { + "$ref" : "#/definitions/OrganizationAddress" + } + }, + "title" : "WhoIsResponse" + } + } +} \ No newline at end of file diff --git a/src/main/resources/old-swagger.json b/src/main/resources/old-swagger.json new file mode 100644 index 00000000..2626a416 --- /dev/null +++ b/src/main/resources/old-swagger.json @@ -0,0 +1,10344 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "ID4i HTTP API", + "version" : "0.3.3-SNAPSHOT", + "title" : "ID4i API", + "termsOfService" : "http://id4i.de", + "contact" : { + "name" : "BlueRain Software GmbH & Co. KG", + "url" : "http://bluerain.de", + "email" : "info@bluerain.de" + }, + "license" : { + "name" : "MIT", + "url" : "https://opensource.org/licenses/MIT" + }, + "x-logo" : { + "backgroundColor" : "#FAFAFA", + "url" : "/static/logo.png" + } + }, + "host" : "backend.id4i.de", + "basePath" : "/", + "tags" : [ { + "name" : "Accounts", + "description" : "User accounts allows people to register for ID4i and login. All permissions and roles for interactive ID4i usage (as opposed to machine-to-machine interactions) are attached to Organizations and User Accounts. The API allows users to register, verify their registration, login and reset their passwords." + }, { + "name" : "Alias", + "description" : "Guid Alias Controller" + }, { + "name" : "Api Keys", + "description" : "Api Key Controller" + }, { + "name" : "Billing", + "description" : "Billing Controller" + }, { + "name" : "Collections", + "description" : "Collection Controller" + }, { + "name" : "Guids", + "description" : "Guid Alias Controller" + }, { + "name" : "Images", + "description" : "Public Image Controller" + }, { + "name" : "Meta Information", + "description" : "App Info Controller" + }, { + "name" : "Organizations", + "description" : "Country Controller" + }, { + "name" : "Public Services", + "description" : "Go Controller" + }, { + "name" : "Routing", + "description" : "Routing Controller" + }, { + "name" : "Storage", + "description" : "Document Storage Controller" + }, { + "name" : "WhoIs", + "description" : "Who Is Controller" + } ], + "consumes" : [ "application/xml", "application/json" ], + "produces" : [ "application/xml", "application/json" ], + "paths" : { + "/account/password" : { + "post" : { + "tags" : [ "Accounts" ], + "summary" : "Request password reset", + "description" : "Requesting a reset for a new password. ", + "operationId" : "requestPasswordReset", + "parameters" : [ { + "in" : "body", + "name" : "resetRequest", + "description" : "Contains the required information to request a new password.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PasswordResetRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/SimpleMessageResponse" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + }, + "put" : { + "tags" : [ "Accounts" ], + "summary" : "Verify password reset", + "description" : "Setting a new password and verifying the request to set the password.", + "operationId" : "verifyPasswordReset", + "parameters" : [ { + "in" : "body", + "name" : "verificationRequest", + "description" : "Contains the new password and the verification token to set the new password.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PasswordResetVerificationRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/SimpleMessageResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/account/registration" : { + "post" : { + "tags" : [ "Accounts" ], + "summary" : "Register user", + "description" : "Registering a new user.", + "operationId" : "registerUser", + "parameters" : [ { + "in" : "body", + "name" : "userRegistration", + "description" : "The user information about the new created user.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserRegistrationRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/UserRegistrationResponse" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + }, + "put" : { + "tags" : [ "Accounts" ], + "summary" : "Complete registration", + "description" : "Completing a registration e.g. for invited users. Finish registration with a username and a password.", + "operationId" : "completeRegistration", + "parameters" : [ { + "in" : "body", + "name" : "completeRegistration", + "description" : "Contains the verification token, the username and the initial password.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CompleteUserRegistrationRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/account/verification" : { + "post" : { + "tags" : [ "Accounts" ], + "summary" : "Verify registration", + "description" : "Verifies a new user registration.", + "operationId" : "verifyUserRegistration", + "parameters" : [ { + "in" : "body", + "name" : "token", + "description" : "The token for user verification.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RegistrationVerificationTokenPresentation" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/api/v1/apikeys" : { + "get" : { + "tags" : [ "Api Keys" ], + "summary" : "Find API key by organization", + "description" : "Finding all API key assigned to the specified organization in a paginated manner.", + "operationId" : "listAllApiKeysOfOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "query", + "description" : "The id of the organization to search in.", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedApiKeyResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "Api Keys" ], + "summary" : "Create API key", + "description" : "Creation of a new API key.", + "operationId" : "createNewApiKey", + "parameters" : [ { + "in" : "body", + "name" : "creationRequest", + "description" : "API key to be created.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ApiKeyCreationRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ApiKeyPresentation" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/apikeys/privileges" : { + "get" : { + "tags" : [ "Api Keys" ], + "summary" : "List all privileges", + "description" : "Listing all possible API key privileges.", + "operationId" : "listAllApiKeyPrivileges", + "parameters" : [ { + "name" : "id4nConcerning", + "in" : "query", + "description" : "id4nConcerning", + "required" : false, + "type" : "boolean" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ApiKeyPrivilegeInfoResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/apikeys/{key}" : { + "get" : { + "tags" : [ "Api Keys" ], + "summary" : "Show API key", + "description" : "Showing the details of an API key.", + "operationId" : "getApiKey", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "The API key to show.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ApiKeyPresentation" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Api Keys" ], + "summary" : "Update API keys", + "description" : "API keys can be updated with new labels, and be activated and deactivated. The secret or UUID cannot be changed.", + "operationId" : "updateApiKey", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "The API key to be updated.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "apiKeyChange", + "description" : "The new values to apply.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ApiKeyChangeRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Api Keys" ], + "summary" : "Delete API key", + "description" : "Deletion of an API key.", + "operationId" : "deleteApiKey", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "The API key to delete.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/apikeys/{key}/privileges" : { + "get" : { + "tags" : [ "Api Keys" ], + "summary" : "List privileges", + "operationId" : "listApiKeyPrivileges", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ApiKeyPrivilegePaginatedResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "Api Keys" ], + "summary" : "Add privilege", + "operationId" : "addApiKeyPrivilege", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "addApiKeyPrivilegeRequest", + "description" : "addApiKeyPrivilegeRequest", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AddApiKeyPrivilegeRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Api Keys" ], + "summary" : "Remove privilege", + "operationId" : "removeApiKeyPrivilege", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "removeApiKeyPrivilegeRequest", + "description" : "removeApiKeyPrivilegeRequest", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoveApiKeyPrivilegeRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/apikeys/{key}/privileges/{privilege}/id4ns" : { + "get" : { + "tags" : [ "Api Keys" ], + "summary" : "ID4ns of a privilege", + "description" : "Listing ID4ns of a id4n concerning privilege", + "operationId" : "listId4ns", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "name" : "privilege", + "in" : "path", + "description" : "privilege", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Id4nPresentationPaginatedResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "Api Keys" ], + "summary" : "Add ID4ns of a privilege", + "operationId" : "addApiKeyPrivilegeForId4ns", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "name" : "privilege", + "in" : "path", + "description" : "privilege", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "id4ns", + "description" : "id4ns", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Api Keys" ], + "summary" : "Remove id4ns of a privilege", + "operationId" : "removeApiKeyPrivilegeForId4ns", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key", + "required" : true, + "type" : "string" + }, { + "name" : "privilege", + "in" : "path", + "description" : "privilege", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "id4ns", + "description" : "id4ns", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/billing/{organizationId}" : { + "get" : { + "tags" : [ "Billing" ], + "summary" : "Get billing amount of services for a given organization", + "operationId" : "getSumForOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The organization to compute the billing information for", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "fromDate", + "in" : "query", + "description" : "Billing start date", + "required" : false, + "type" : "string", + "format" : "date-time" + }, { + "name" : "toDate", + "in" : "query", + "description" : "Billing end date", + "required" : false, + "type" : "string", + "format" : "date-time" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ServiceCosts" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/billing/{organizationId}/positions" : { + "get" : { + "tags" : [ "Billing" ], + "summary" : "Get billing positions for a given organization", + "operationId" : "getPositionsForOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The organization to compute the billing information for", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "fromDate", + "in" : "query", + "description" : "Billing start date", + "required" : false, + "type" : "string", + "format" : "date-time" + }, { + "name" : "toDate", + "in" : "query", + "description" : "Billing end date", + "required" : false, + "type" : "string", + "format" : "date-time" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BillingPosition" + } + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/labelled" : { + "post" : { + "tags" : [ "Collections" ], + "summary" : "Create labelled collection", + "operationId" : "createLabelledCollection", + "parameters" : [ { + "in" : "body", + "name" : "createInfo", + "description" : "createInfo", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateLabelledCollectionRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Id4n" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/labelled/{collectionId4n}/elements" : { + "post" : { + "tags" : [ "Collections" ], + "summary" : "Add elements to labelled collection", + "operationId" : "addElementsToLabelledCollection", + "parameters" : [ { + "name" : "collectionId4n", + "in" : "path", + "description" : "collectionId4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "listOfGuids", + "description" : "listOfGuids", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Collections" ], + "summary" : "Remove elements from labelled collection", + "operationId" : "removeElementsFromLabelledCollection", + "parameters" : [ { + "name" : "collectionId4n", + "in" : "path", + "description" : "collectionId4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "listOfGuids", + "description" : "listOfGuids", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/labelled/{id4n}" : { + "get" : { + "tags" : [ "Collections" ], + "summary" : "Find labelled collection", + "operationId" : "findLabelledCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Collections" ], + "summary" : "Set labelled collection values", + "description" : "Update labelled collection replacing all values but the ID", + "operationId" : "setLabelledCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Collections" ], + "summary" : "Delete labelled collection", + "operationId" : "deleteLabelledCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "patch" : { + "tags" : [ "Collections" ], + "summary" : "Update labelled collection", + "description" : "Update labelled collection updating only the given values", + "operationId" : "updateLabelledCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "204" : { + "description" : "No Content" + }, + "401" : { + "description" : "Unauthorized" + }, + "403" : { + "description" : "Forbidden" + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/labelled/{id4n}/elements" : { + "get" : { + "tags" : [ "Collections" ], + "summary" : "List contents of the collection", + "operationId" : "listElementsOfLabelledCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedGuidResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/logistic" : { + "post" : { + "tags" : [ "Collections" ], + "summary" : "Create logistic collection", + "operationId" : "createLogisticCollection", + "parameters" : [ { + "in" : "body", + "name" : "createInfo", + "description" : "createInfo", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateLogisticCollectionRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Id4n" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/logistic/{collectionId4n}/elements" : { + "post" : { + "tags" : [ "Collections" ], + "summary" : "Add elements to logistic collection", + "operationId" : "addElementsToLogisticCollection", + "parameters" : [ { + "name" : "collectionId4n", + "in" : "path", + "description" : "collectionId4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "listOfGuids", + "description" : "listOfGuids", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Collections" ], + "summary" : "Remove elements from logistic collection", + "operationId" : "removeElementsFromLogisticCollection", + "parameters" : [ { + "name" : "collectionId4n", + "in" : "path", + "description" : "collectionId4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "listOfGuids", + "description" : "listOfGuids", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/logistic/{id4n}" : { + "get" : { + "tags" : [ "Collections" ], + "summary" : "Find logistic collection", + "operationId" : "findLogisticCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Collections" ], + "summary" : "Replace logistic collection", + "description" : "Update logistic collection replacing all values but the ID", + "operationId" : "setLogisticCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Collections" ], + "summary" : "Delete logistic collection", + "operationId" : "deleteLogisticCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "patch" : { + "tags" : [ "Collections" ], + "summary" : "Update logistic collection", + "description" : "Update logistic collection updating only the given values", + "operationId" : "updateLogisticCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "204" : { + "description" : "No Content" + }, + "401" : { + "description" : "Unauthorized" + }, + "403" : { + "description" : "Forbidden" + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/logistic/{id4n}/elements" : { + "get" : { + "tags" : [ "Collections" ], + "summary" : "List contents of the collection", + "operationId" : "listElementsOfLogisticCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedGuidResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/routing" : { + "post" : { + "tags" : [ "Collections" ], + "summary" : "Create routing collecton", + "operationId" : "createRoutingCollection", + "parameters" : [ { + "in" : "body", + "name" : "createInfo", + "description" : "createInfo", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateRoutingCollectionRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Id4n" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/routing/{collectionId4n}/elements" : { + "post" : { + "tags" : [ "Collections" ], + "summary" : "Add element to routing collection", + "operationId" : "addElementsToRoutingCollection", + "parameters" : [ { + "name" : "collectionId4n", + "in" : "path", + "description" : "collectionId4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "listOfGuids", + "description" : "listOfGuids", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Collections" ], + "summary" : "Remove elements from routing collection", + "operationId" : "removeElementsFromRoutingCollection", + "parameters" : [ { + "name" : "collectionId4n", + "in" : "path", + "description" : "collectionId4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "listOfGuids", + "description" : "listOfGuids", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/routing/{id4n}" : { + "get" : { + "tags" : [ "Collections" ], + "summary" : "Find routing collection", + "operationId" : "findRoutingCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Collections" ], + "summary" : "Update routing collection", + "operationId" : "setRoutingCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Collections" ], + "summary" : "Delete routing collection", + "operationId" : "deleteRoutingCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "patch" : { + "tags" : [ "Collections" ], + "summary" : "Update routing collection", + "description" : "Update routing collection updating only the given values", + "operationId" : "updateRoutingCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "204" : { + "description" : "No Content" + }, + "401" : { + "description" : "Unauthorized" + }, + "403" : { + "description" : "Forbidden" + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/routing/{id4n}/elements" : { + "get" : { + "tags" : [ "Collections" ], + "summary" : "List contents of the collection", + "operationId" : "listElementsOfRoutingCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedGuidResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/{id4n}" : { + "get" : { + "tags" : [ "Collections" ], + "summary" : "Find collection", + "operationId" : "findCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Collections" ], + "summary" : "Set collection", + "description" : "Update collection replacing all values but the ID", + "operationId" : "setCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Collections" ], + "summary" : "Delete collection", + "operationId" : "deleteCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "patch" : { + "tags" : [ "Collections" ], + "summary" : "Update collection", + "description" : "Update collection changing only the given values", + "operationId" : "updateCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidCollection" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "204" : { + "description" : "No Content" + }, + "401" : { + "description" : "Unauthorized" + }, + "403" : { + "description" : "Forbidden" + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/collections/{id4n}/elements" : { + "get" : { + "tags" : [ "Collections" ], + "summary" : "List contents of the collection", + "operationId" : "listElementsOfCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedGuidResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "Collections" ], + "summary" : "Add elements to collection", + "operationId" : "addElementsToCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "listOfGuids", + "description" : "listOfGuids", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Collections" ], + "summary" : "Remove elements from collection", + "operationId" : "removeElementsFromCollection", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "listOfGuids", + "description" : "listOfGuids", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/countries" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "List countries", + "operationId" : "listCountries", + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedCountryResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/documents/{id4n}" : { + "get" : { + "tags" : [ "Storage" ], + "summary" : "List documents", + "description" : "Listing all documents of an id4n", + "operationId" : "listAllDocuments", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedOwnedDocumentResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/documents/{id4n}/{organizationId}" : { + "get" : { + "tags" : [ "Storage" ], + "summary" : "List organization specific documents", + "description" : "Listing documents of an id4n owned by a specified organization", + "operationId" : "listDocuments", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedDocumentResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Storage" ], + "summary" : "Create an empty document for an id4n", + "description" : "The document is created empty, mime-type defaults to text/plain", + "operationId" : "createDocument", + "consumes" : [ "multipart/form-data" ], + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "content", + "in" : "formData", + "description" : "content", + "required" : true, + "type" : "file" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Document" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/documents/{id4n}/{organizationId}/{fileName}" : { + "get" : { + "tags" : [ "Storage" ], + "summary" : "Read document contents", + "operationId" : "readDocument", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "string", + "format" : "byte" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Storage" ], + "summary" : "Delete a document", + "operationId" : "deleteDocument", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ResponseEntity" + } + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata" : { + "get" : { + "tags" : [ "Storage" ], + "summary" : "Retrieve a document (meta-data only, no content)", + "operationId" : "getDocument", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Document" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "patch" : { + "tags" : [ "Storage" ], + "summary" : "Update a document", + "operationId" : "updateDocumentMetadata", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "document", + "description" : "document", + "required" : true, + "schema" : { + "$ref" : "#/definitions/DocumentUpdate" + } + }, { + "required" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Document" + } + }, + "204" : { + "description" : "No Content" + }, + "401" : { + "description" : "Unauthorized" + }, + "403" : { + "description" : "Forbidden" + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/guids" : { + "post" : { + "tags" : [ "Guids" ], + "summary" : "Create GUID(s)", + "description" : "Creating one or more GUIDs with a specified length.", + "operationId" : "createGuid", + "parameters" : [ { + "in" : "body", + "name" : "createGUIDInfo", + "description" : "createGUIDInfo", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateGuidRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/ListOfId4ns" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/guids/withoutCollection" : { + "get" : { + "tags" : [ "Guids" ], + "summary" : "Retrieve GUIDs not in any collection", + "operationId" : "getGuidsWithoutCollection", + "parameters" : [ { + "name" : "organizationId", + "in" : "query", + "description" : "Organization to search GUIDs for (required).", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedResponse«Guid»" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/guids/{id4n}" : { + "get" : { + "tags" : [ "Guids" ], + "summary" : "Retrieve GUID information", + "operationId" : "getGuid", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID number", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Guid" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Guids" ], + "summary" : "Change GUID information.", + "description" : "Allows ownership transfer.", + "operationId" : "setGuid", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID number", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Guid" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "patch" : { + "tags" : [ "Guids" ], + "summary" : "Change GUID information.", + "description" : "Allows ownership transfer.", + "operationId" : "setGuid_1", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID number", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "request", + "description" : "request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Guid" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "204" : { + "description" : "No Content" + }, + "401" : { + "description" : "Unauthorized" + }, + "403" : { + "description" : "Forbidden" + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/guids/{id4n}/alias" : { + "get" : { + "tags" : [ "Alias", "Guids" ], + "summary" : "Get all aliases for the given GUID", + "description" : "Looks up the alias for each alias type (group and single GUID) and returns all found ones", + "operationId" : "getGuidAliases", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID to operate on", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/guids/{id4n}/alias/{aliasType}" : { + "post" : { + "tags" : [ "Alias", "Guids" ], + "summary" : "Add alias for GUIDs", + "description" : "Adds or replaces aliases for single GUIDs (alias type item and mapp) or groups of GUIDs (alias types gtin, ean and article)", + "operationId" : "addGuidAlias", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID to operate on", + "required" : true, + "type" : "string" + }, { + "name" : "aliasType", + "in" : "path", + "description" : "Alias type, see the corresponding API model", + "required" : true, + "type" : "string", + "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking" ] + }, { + "in" : "body", + "name" : "alias", + "description" : "The alias to add or update", + "required" : true, + "schema" : { + "$ref" : "#/definitions/GuidAlias" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Alias", "Guids" ], + "summary" : "Remove aliases from GUIDs", + "description" : "Remove the alias of the given type", + "operationId" : "removeGuidAlias", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The GUID to operate on", + "required" : true, + "type" : "string" + }, { + "name" : "aliasType", + "in" : "path", + "description" : "Alias type, see the corresponding API model", + "required" : true, + "type" : "string", + "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking" ] + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/id4ns/{id4n}" : { + "get" : { + "tags" : [ "Guids" ], + "summary" : "Retrieve ID4n information", + "description" : "Retrieving basic information about an ID like the type and the creation time.", + "operationId" : "getId4n", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "The ID to resolve to", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Id4nPresentation" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/info" : { + "get" : { + "tags" : [ "Meta Information" ], + "summary" : "Retrieve version information about ID4i", + "description" : "Retrieving version information about ID4i.", + "operationId" : "applicationInfo", + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/AppInfoPresentation" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/microstorage/{id4n}/{organization}" : { + "get" : { + "tags" : [ "Storage" ], + "summary" : "Read data from microstorage", + "operationId" : "readFromMicrostorage", + "parameters" : [ { + "name" : "organization", + "in" : "path", + "description" : "organization", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "string", + "format" : "byte" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Storage" ], + "summary" : "Write data to microstorage", + "operationId" : "writeToMicrostorage", + "consumes" : [ "*/*" ], + "parameters" : [ { + "name" : "organization", + "in" : "path", + "description" : "organization", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "Content-Type", + "in" : "header", + "description" : "Content-Type", + "required" : false, + "type" : "string" + }, { + "name" : "Content-Length", + "in" : "header", + "description" : "Content-Length", + "required" : false, + "type" : "integer", + "format" : "int64" + }, { + "in" : "body", + "name" : "body", + "description" : "body", + "required" : false, + "schema" : { + "type" : "string", + "format" : "byte" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "object" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations" : { + "post" : { + "tags" : [ "Organizations" ], + "summary" : "Create organization", + "description" : "Creating a new organization.", + "operationId" : "createOrganization", + "parameters" : [ { + "in" : "body", + "name" : "organization", + "description" : "Organization to be created", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Organization" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Organization" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "Find organization by id", + "description" : "Returns a single organization.", + "operationId" : "findOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The id of the organization to be retrieved.", + "required" : true, + "type" : "integer", + "format" : "int64" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Organization" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Organizations" ], + "summary" : "Update organization", + "operationId" : "updateOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The id of the organization to be updated.", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "in" : "body", + "name" : "organization", + "description" : "Updated organization object", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Organization" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Organization" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Organizations" ], + "summary" : "Delete organization", + "operationId" : "deleteOrganization", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The id of the organization to be deleted.", + "required" : true, + "type" : "integer", + "format" : "int64" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/addresses/billing" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "Retrieve billing address", + "operationId" : "findOrganizationBillingAddress", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Organizations" ], + "summary" : "Store billing address", + "operationId" : "updateOrganizationBillingAddress", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "in" : "body", + "name" : "addressResource", + "description" : "addressResource", + "required" : true, + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Organizations" ], + "summary" : "Remove billing address", + "operationId" : "deleteOrganizationBillingAddress", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/addresses/default" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "Retrieve address", + "operationId" : "findOrganizationAddress", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Organizations" ], + "summary" : "Store address", + "operationId" : "updateOrganizationAddress", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "in" : "body", + "name" : "addressResource", + "description" : "addressResource", + "required" : true, + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/OrganizationAddress" + } + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/collections" : { + "get" : { + "tags" : [ "Collections", "Organizations" ], + "summary" : "Get collections of organization", + "description" : "Retrieving all collections of an organization in a paginated manner.", + "operationId" : "getAllCollectionsOfOrganization", + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "type", + "in" : "query", + "description" : "Filter by this type", + "required" : false, + "type" : "string", + "enum" : [ "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] + }, { + "name" : "label", + "in" : "query", + "description" : "Filter by this label", + "required" : false, + "type" : "string" + }, { + "name" : "labelPrefix", + "in" : "query", + "description" : "Filter by this label prefix", + "required" : false, + "type" : "string", + "maximum" : 2147483647, + "minimum" : 1 + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedGuidCollection" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/logo" : { + "post" : { + "tags" : [ "Organizations" ], + "summary" : "Update organization logo", + "description" : "Updating an organization logo using a multipart file upload.", + "operationId" : "setOrganizationLogo", + "consumes" : [ "multipart/form-data" ], + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The id of the organization where the logo should be updated.", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "file", + "in" : "formData", + "description" : "An image containing the new logo.", + "required" : true, + "type" : "file" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PublicImagePresentation" + } + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Organizations" ], + "summary" : "Delete organization logo", + "operationId" : "deleteOrganizationLogo", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "The id of the organization where the logo should be deleted.", + "required" : true, + "type" : "integer", + "format" : "int64" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/roles" : { + "get" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "List users and their roles", + "description" : "Listing users and their roles in a paginated manner.", + "operationId" : "getAllOrganizationRoles", + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedUserRolesResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/users" : { + "get" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Find users in organization", + "description" : "Finding users in the specified organization in a paginated manner.", + "operationId" : "getUsersOfOrganization", + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedUserPresentationResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/users/invite" : { + "post" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Invite Users", + "operationId" : "inviteUsers", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "in" : "body", + "name" : "invitationList", + "description" : "invitationList", + "required" : true, + "schema" : { + "$ref" : "#/definitions/OrganizationUserInvitationListRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/organizations/{organizationId}/users/{username}/roles" : { + "get" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Get user roles by username", + "operationId" : "getUserRoles", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "username", + "in" : "path", + "description" : "username", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedStringResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "post" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Add role(s) to user", + "operationId" : "addUserRoles", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "username", + "in" : "path", + "description" : "username", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "changeRoleRequest", + "description" : "changeRoleRequest", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ChangeRoleRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "201" : { + "description" : "Created" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "delete" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Remove role(s) from user", + "operationId" : "removeUserRoles", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "username", + "in" : "path", + "description" : "username", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "changeRoleRequest", + "description" : "changeRoleRequest", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ChangeRoleRequest" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/documents/{id4n}" : { + "get" : { + "tags" : [ "Public Services", "Storage" ], + "summary" : "List organization specific documents", + "description" : "Listing documents of an id4n owned by a specified organization", + "operationId" : "listAllPublicDocuments", + "parameters" : [ { + "name" : "organizationId", + "in" : "query", + "description" : "organizationId", + "required" : false, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedOwnedDocumentResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/documents/{id4n}/{organizationId}" : { + "get" : { + "tags" : [ "Public Services", "Storage" ], + "summary" : "List organization specific documents", + "description" : "Listing documents of an id4n owned by a specified organization", + "operationId" : "listPublicDocuments", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedDocumentResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/documents/{id4n}/{organizationId}/{fileName}" : { + "get" : { + "tags" : [ "Public Services", "Storage" ], + "summary" : "Read document contents", + "operationId" : "readPublicDocument", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "string", + "format" : "byte" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata" : { + "get" : { + "tags" : [ "Public Services", "Storage" ], + "summary" : "Retrieve a document (meta-data only, no content)", + "operationId" : "getPublicDocument", + "parameters" : [ { + "name" : "organizationId", + "in" : "path", + "description" : "organizationId", + "required" : true, + "type" : "integer", + "format" : "int64" + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "fileName", + "in" : "path", + "description" : "fileName", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Document" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/public/image/{imageID}" : { + "get" : { + "tags" : [ "Images", "Public Services" ], + "summary" : "Resolve image", + "operationId" : "resolveImageUsingGET", + "parameters" : [ { + "name" : "imageID", + "in" : "path", + "description" : "The id of the image to be resolved.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "string", + "format" : "byte" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/roles" : { + "get" : { + "tags" : [ "Accounts" ], + "summary" : "List roles", + "description" : "Listing of roles.", + "operationId" : "listAllRoles", + "parameters" : [ { + "name" : "privilege", + "in" : "query", + "description" : "If specified the roles will be filtered containing that privilege.", + "required" : false, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/RoleResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/routingfiles/{id4n}" : { + "get" : { + "tags" : [ "Routing" ], + "summary" : "Retrieve routing file", + "operationId" : "getRoutingFile", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "organizationId", + "description" : "organizationId", + "required" : false, + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/RoutingFile" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + }, + "put" : { + "tags" : [ "Routing" ], + "summary" : "Store routing file", + "operationId" : "updateRoutingFile", + "parameters" : [ { + "in" : "body", + "name" : "rfr", + "description" : "rfr", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RoutingFileRequest" + } + }, { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "202" : { + "description" : "Accepted" + }, + "400" : { + "description" : "Bad Request", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "409" : { + "description" : "Conflict", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/routingfiles/{id4n}/route/{type}" : { + "get" : { + "tags" : [ "Routing" ], + "summary" : "Retrieve current route of a GUID (or ID4N)", + "operationId" : "getRoute", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + }, { + "name" : "type", + "in" : "path", + "description" : "The type of route you want to have", + "required" : true, + "type" : "string" + }, { + "name" : "privateRoutes", + "in" : "query", + "description" : "privateRoutes", + "required" : false, + "type" : "boolean" + }, { + "name" : "publicRoutes", + "in" : "query", + "description" : "publicRoutes", + "required" : false, + "type" : "boolean" + }, { + "name" : "interpolate", + "in" : "query", + "description" : "interpolate", + "required" : false, + "type" : "boolean" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/Route" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/search/guids" : { + "get" : { + "tags" : [ "Alias" ], + "summary" : "Search for GUIDs by alias", + "operationId" : "searchByAlias", + "parameters" : [ { + "name" : "alias", + "in" : "query", + "description" : "The alias to search for", + "required" : true, + "type" : "string" + }, { + "name" : "aliasType", + "in" : "query", + "description" : "Alias type type to search for", + "required" : true, + "type" : "string", + "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking" ] + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedGuidResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/search/guids/aliases/types" : { + "get" : { + "tags" : [ "Alias" ], + "summary" : "List all supported alias types", + "description" : "Retrieve this list to find out all alias types to use with alias search and change operations", + "operationId" : "getGuidAliasTypes", + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking" ] + } + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/user/organizations" : { + "get" : { + "tags" : [ "Accounts", "Organizations" ], + "summary" : "Retrieve organizations of user", + "operationId" : "getOrganizationsOfUser", + "parameters" : [ { + "name" : "role", + "in" : "query", + "description" : "role", + "required" : false, + "type" : "string" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedOrganizationResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/users" : { + "get" : { + "tags" : [ "Accounts" ], + "summary" : "Find users", + "operationId" : "findUsers", + "parameters" : [ { + "name" : "usernamePrefix", + "in" : "query", + "description" : "Find users starting with this prefix.", + "required" : true, + "type" : "string", + "pattern" : "[a-zA-Z0-9_.-]{2,50}" + }, { + "name" : "offset", + "in" : "query", + "description" : "Start with the n-th element", + "required" : false, + "type" : "integer", + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "The maximum count of returned elements", + "required" : false, + "type" : "integer", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/PaginatedUserPresentationResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/api/v1/users/{username}" : { + "get" : { + "tags" : [ "Accounts" ], + "summary" : "Find by username", + "operationId" : "findUserByUsername", + "parameters" : [ { + "name" : "username", + "in" : "path", + "description" : "username", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/UserPresentation" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + }, + "security" : [ { + "Authorization" : [ "id4i" ] + } ] + } + }, + "/go/{guid}" : { + "get" : { + "tags" : [ "Public Services" ], + "summary" : "Forward", + "description" : "Forwarding to the designated route defined in the routing,", + "operationId" : "go", + "parameters" : [ { + "name" : "guid", + "in" : "path", + "description" : "guid", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/login" : { + "post" : { + "tags" : [ "Accounts" ], + "description" : "ID4i API Login", + "operationId" : "login", + "parameters" : [ { + "in" : "body", + "name" : "account-credentials", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccountCredentials" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + }, + "/whois/{id4n}" : { + "get" : { + "tags" : [ "Public Services", "WhoIs" ], + "summary" : "Resolve owner of id4n", + "operationId" : "resolveWhoIsEntry", + "parameters" : [ { + "name" : "id4n", + "in" : "path", + "description" : "id4n", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "OK", + "schema" : { + "$ref" : "#/definitions/WhoIsResponse" + } + }, + "202" : { + "description" : "Accepted" + }, + "401" : { + "description" : "Unauthorized", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "403" : { + "description" : "Forbidden", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "404" : { + "description" : "Not Found", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "405" : { + "description" : "Method not allowed", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "406" : { + "description" : "Not Acceptable", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "415" : { + "description" : "Unsupported Media Type", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + }, + "500" : { + "description" : "Internal Server Error", + "schema" : { + "$ref" : "#/definitions/ApiError" + } + } + } + } + } + }, + "securityDefinitions" : { + "Authorization" : { + "type" : "apiKey", + "name" : "Authorization", + "in" : "header" + } + }, + "definitions" : { + "AccountCredentials" : { + "type" : "object", + "properties" : { + "login" : { + "type" : "string" + }, + "password" : { + "type" : "string" + } + }, + "title" : "AccountCredentials" + }, + "AddApiKeyPrivilegeRequest" : { + "type" : "object", + "required" : [ "privilege" ], + "properties" : { + "privilege" : { + "type" : "string" + } + }, + "title" : "AddApiKeyPrivilegeRequest" + }, + "ApiError" : { + "type" : "object", + "properties" : { + "code" : { + "type" : "string", + "enum" : [ "ERR_REGISTRATION_VERIFICATION_NO_TOKEN", "ERR_REGISTRATION_VERIFICATION_INVALID_TOKEN", "ERR_REGISTRATION_VERIFICATION_EXPIRED_TOKEN", "ERR_AUTHENTICATION_NO_TOKEN", "ERR_AUTHENTICATION_INVALID_TOKEN", "ERR_AUTHENTICATION_EXPIRED_TOKEN", "ERR_AUTHENTICATION_FAILED", "ERR_AUTHORIZATION_MISSING_PRIVILEGES", "ERR_AUTHORIZATION_FORBIDDEN", "ERR_INPUT_VALIDATION_FAILED", "ERR_FIELD_INPUT_VALIDATION_FAILED", "ERR_VALIDATION_CONSTRAINT_FAILED", "ERR_INPUT_NOT_READABLE", "ERR_INVALID_INPUT_PARAMETER", "ERR_GUID_CREATION", "ERR_INVALID_ID4N_OBJECT_TYPE", "ERR_COLLECTION_UPDATE_DENIED", "ERR_ENTITY_NOT_FOUND", "ERR_ENTITY_TOO_BIG", "ERR_DUPLICATE", "ERR_INTERNAL", "ERR_UNKNOWN", "ERR_INVALID_ORGANIZATION_USERROLE", "ERR_ORGANIZATION_ROLE_INCONSISTENCY", "ERR_ORGANIZATION_NOT_DELETABLE", "ERR_USER_ALREADY_IN_ORGANIZATION", "ERR_USER_INVITATION_NEEDS_MINIMUM_ONE_ROLE", "ERR_USER_INVITATION_SPECIFY_EMAIL_OR_USERNAME", "ERR_LANGUAGE_NOT_SUPPORTED", "ERR_EMAIL_MISSING_TEMPLATE_PARAM", "ERR_EMAIL_TEMPLATE_NOT_AVAILABLE", "ERR_EMAIL_PREPARATION_FAILED", "ERR_IMAGE_CONVERSION", "ERR_UPLOAD_TOO_LARGE", "ERR_INVALID_ALIAS_TYPE", "ERR_INVALID_URI_TEMPLATE", "ERR_INVALID_URI_TEMPLATE_VARIABLE", "ERR_MODULE_NOT_ACTIVE", "ERR_INSECURE_PASSWORD" ] + }, + "errorId" : { + "type" : "string" + }, + "errorList" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ApiError" + } + }, + "message" : { + "type" : "string" + } + }, + "title" : "ApiError" + }, + "ApiKeyChangeRequest" : { + "type" : "object", + "required" : [ "newLabel" ], + "properties" : { + "active" : { + "type" : "boolean" + }, + "newLabel" : { + "type" : "string", + "minLength" : 5, + "maxLength" : 50 + } + }, + "title" : "ApiKeyChangeRequest" + }, + "ApiKeyCreationRequest" : { + "type" : "object", + "required" : [ "label", "organizationId", "secret" ], + "properties" : { + "label" : { + "type" : "string", + "minLength" : 5, + "maxLength" : 50 + }, + "organizationId" : { + "type" : "integer", + "format" : "int64" + }, + "secret" : { + "type" : "string", + "minLength" : 10, + "maxLength" : 500 + } + }, + "title" : "ApiKeyCreationRequest" + }, + "ApiKeyPresentation" : { + "type" : "object", + "required" : [ "active", "createdAt", "createdBy", "key", "label", "organizationId" ], + "properties" : { + "active" : { + "type" : "boolean", + "example" : true, + "description" : "Whether this API key is active", + "allowEmptyValue" : false + }, + "createdAt" : { + "type" : "integer", + "format" : "int64", + "example" : 1517232722, + "description" : "The UTC unix timestamp of when this api key has been created", + "allowEmptyValue" : false + }, + "createdBy" : { + "type" : "string", + "example" : "user123", + "allowEmptyValue" : false + }, + "key" : { + "type" : "string", + "example" : "39978f49-6ff1-4147-bf0f-9910185084b7", + "description" : "The api key identifier", + "allowEmptyValue" : false + }, + "label" : { + "type" : "string", + "example" : "My Api Key", + "description" : "The label / name of the api key", + "allowEmptyValue" : false + }, + "organizationId" : { + "type" : "integer", + "format" : "int64", + "example" : 10, + "description" : "The organization id this api key belongs to", + "allowEmptyValue" : false + } + }, + "title" : "ApiKeyPresentation" + }, + "ApiKeyPrivilege" : { + "type" : "object", + "required" : [ "id4nAssociated", "privilege" ], + "properties" : { + "id4nAssociated" : { + "type" : "boolean" + }, + "privilege" : { + "type" : "string" + } + }, + "title" : "ApiKeyPrivilege" + }, + "ApiKeyPrivilegeInfo" : { + "type" : "object", + "required" : [ "id4nAssociated", "name" ], + "properties" : { + "helpText" : { + "type" : "string" + }, + "id4nAssociated" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + } + }, + "title" : "ApiKeyPrivilegeInfo" + }, + "ApiKeyPrivilegeInfoResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPrivilegeInfo" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "ApiKeyPrivilegeInfoResponse" + }, + "ApiKeyPrivilegePaginatedResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPrivilege" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "ApiKeyPrivilegePaginatedResponse" + }, + "AppInfoPresentation" : { + "type" : "object", + "properties" : { + "branch" : { + "type" : "string" + }, + "commitTime" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "revision" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + }, + "title" : "AppInfoPresentation" + }, + "BillingPosition" : { + "type" : "object", + "required" : [ "count", "description", "service", "sum" ], + "properties" : { + "count" : { + "type" : "integer", + "format" : "int64" + }, + "description" : { + "type" : "string" + }, + "service" : { + "type" : "string" + }, + "sum" : { + "type" : "number", + "format" : "float" + } + }, + "title" : "BillingPosition" + }, + "ChangeRoleRequest" : { + "type" : "object", + "required" : [ "roles" ], + "properties" : { + "roles" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "title" : "ChangeRoleRequest" + }, + "CompleteUserRegistrationRequest" : { + "type" : "object", + "required" : [ "password", "username", "verificationToken" ], + "properties" : { + "password" : { + "type" : "string", + "minLength" : 8, + "maxLength" : 99 + }, + "username" : { + "type" : "string", + "pattern" : "[a-zA-Z0-9_.-]{6,50}" + }, + "verificationToken" : { + "type" : "string" + } + }, + "title" : "CompleteUserRegistrationRequest" + }, + "Country" : { + "type" : "object", + "required" : [ "code", "name" ], + "properties" : { + "code" : { + "type" : "string" + }, + "name" : { + "type" : "string" + } + }, + "title" : "Country" + }, + "CreateGuidRequest" : { + "type" : "object", + "required" : [ "count", "length", "organizationId" ], + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "example" : 1, + "description" : "The total number of GUIDs to create", + "allowEmptyValue" : false, + "minimum" : 1.0, + "maximum" : 1000.0, + "exclusiveMinimum" : false, + "exclusiveMaximum" : false + }, + "length" : { + "type" : "integer", + "format" : "int32", + "example" : 40, + "description" : "The charactersequence length of the GUID", + "allowEmptyValue" : false, + "minimum" : 6.0, + "maximum" : 255.0, + "exclusiveMinimum" : false, + "exclusiveMaximum" : false + }, + "organizationId" : { + "type" : "integer", + "format" : "int64", + "example" : 123, + "description" : "The id of the organization where the generated GUIDs should be assigned.", + "allowEmptyValue" : false + } + }, + "title" : "CreateGuidRequest", + "description" : "GUID creation information" + }, + "CreateLabelledCollectionRequest" : { + "type" : "object", + "required" : [ "label", "length", "organizationId" ], + "properties" : { + "label" : { + "type" : "string", + "minLength" : 1, + "maxLength" : 128 + }, + "length" : { + "type" : "integer", + "format" : "int32", + "minimum" : 6.0, + "maximum" : 255.0, + "exclusiveMinimum" : false, + "exclusiveMaximum" : false + }, + "organizationId" : { + "type" : "integer", + "format" : "int64" + } + }, + "title" : "CreateLabelledCollectionRequest" + }, + "CreateLogisticCollectionRequest" : { + "type" : "object", + "required" : [ "length", "organizationId" ], + "properties" : { + "label" : { + "type" : "string", + "minLength" : 1, + "maxLength" : 128 + }, + "length" : { + "type" : "integer", + "format" : "int32", + "minimum" : 6.0, + "maximum" : 255.0, + "exclusiveMinimum" : false, + "exclusiveMaximum" : false + }, + "organizationId" : { + "type" : "integer", + "format" : "int64" + } + }, + "title" : "CreateLogisticCollectionRequest" + }, + "CreateRoutingCollectionRequest" : { + "type" : "object", + "required" : [ "label", "length", "organizationId" ], + "properties" : { + "label" : { + "type" : "string", + "minLength" : 1, + "maxLength" : 128 + }, + "length" : { + "type" : "integer", + "format" : "int32", + "minimum" : 6.0, + "maximum" : 255.0, + "exclusiveMinimum" : false, + "exclusiveMaximum" : false + }, + "organizationId" : { + "type" : "integer", + "format" : "int64" + } + }, + "title" : "CreateRoutingCollectionRequest" + }, + "Document" : { + "type" : "object", + "properties" : { + "filename" : { + "type" : "string", + "example" : "publicInfo.pdf", + "description" : "File Name", + "allowEmptyValue" : false + }, + "mimeType" : { + "type" : "string", + "example" : "text/plain", + "description" : "Mime Type", + "allowEmptyValue" : false + }, + "visibility" : { + "description" : "Visibility configuration", + "allowEmptyValue" : false, + "$ref" : "#/definitions/Visibility" + } + }, + "title" : "Document" + }, + "DocumentUpdate" : { + "type" : "object", + "properties" : { + "filename" : { + "type" : "string", + "example" : "publicInfo.pdf", + "description" : "File Name", + "allowEmptyValue" : false + }, + "mimeType" : { + "type" : "string", + "example" : "text/plain", + "description" : "Mime Type", + "allowEmptyValue" : false + }, + "visibility" : { + "example" : true, + "description" : "Visibility configuration", + "allowEmptyValue" : false, + "$ref" : "#/definitions/VisibilityUpdate" + } + }, + "title" : "DocumentUpdate" + }, + "File" : { + "type" : "object", + "properties" : { + "absolute" : { + "type" : "boolean" + }, + "absoluteFile" : { + "$ref" : "#/definitions/File" + }, + "absolutePath" : { + "type" : "string" + }, + "canonicalFile" : { + "$ref" : "#/definitions/File" + }, + "canonicalPath" : { + "type" : "string" + }, + "directory" : { + "type" : "boolean" + }, + "file" : { + "type" : "boolean" + }, + "freeSpace" : { + "type" : "integer", + "format" : "int64" + }, + "hidden" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "parent" : { + "type" : "string" + }, + "parentFile" : { + "$ref" : "#/definitions/File" + }, + "path" : { + "type" : "string" + }, + "totalSpace" : { + "type" : "integer", + "format" : "int64" + }, + "usableSpace" : { + "type" : "integer", + "format" : "int64" + } + }, + "title" : "File" + }, + "Guid" : { + "type" : "object", + "properties" : { + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "example" : 1517232722, + "description" : "The UTC unix timestamp of when this GUID has been created", + "readOnly" : true, + "allowEmptyValue" : false + }, + "id4n" : { + "type" : "string", + "example" : "3THvgrWxqgTFC4", + "description" : "The ID", + "readOnly" : true, + "allowEmptyValue" : false + }, + "nextScanOwnership" : { + "type" : "boolean" + }, + "ownerOrganizationId" : { + "type" : "integer", + "format" : "int64" + } + }, + "title" : "Guid" + }, + "GuidAlias" : { + "type" : "object", + "properties" : { + "alias" : { + "type" : "string" + } + }, + "title" : "GuidAlias" + }, + "GuidCollection" : { + "type" : "object", + "properties" : { + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The UTC unix timestamp of when this collection has been created", + "readOnly" : true, + "allowEmptyValue" : false + }, + "id4n" : { + "type" : "string", + "description" : "The ID", + "readOnly" : true, + "allowEmptyValue" : false + }, + "label" : { + "type" : "string", + "minLength" : 5, + "maxLength" : 128 + }, + "nextScanOwnership" : { + "type" : "boolean" + }, + "ownerOrganizationId" : { + "type" : "integer", + "format" : "int64" + }, + "type" : { + "type" : "string", + "readOnly" : true, + "allowEmptyValue" : false, + "enum" : [ "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] + } + }, + "title" : "GuidCollection" + }, + "Id4n" : { + "type" : "object", + "properties" : { + "id4n" : { + "type" : "string", + "example" : "3THvgrWxqgTFC4", + "description" : "The ID", + "allowEmptyValue" : false + } + }, + "title" : "Id4n" + }, + "Id4nPresentation" : { + "type" : "object", + "required" : [ "createdTimestamp", "id4n", "type" ], + "properties" : { + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "example" : 1517232722, + "description" : "The UTC unix timestamp of when this ID has been created", + "readOnly" : true, + "allowEmptyValue" : false + }, + "id4n" : { + "type" : "string", + "example" : "3THvgrWxqgTFC4", + "description" : "The ID", + "readOnly" : true, + "allowEmptyValue" : false + }, + "label" : { + "type" : "string", + "readOnly" : true, + "allowEmptyValue" : false + }, + "nextScanOwnership" : { + "type" : "boolean", + "example" : false, + "description" : "Indicates if next scan ownership is active or not. If privileges are missing or the type of object doesn't support NSO this value is null.", + "readOnly" : true, + "allowEmptyValue" : false + }, + "type" : { + "type" : "string", + "description" : "The type of ID", + "readOnly" : true, + "allowEmptyValue" : false, + "enum" : [ "GUID", "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] + } + }, + "title" : "Id4nPresentation" + }, + "Id4nPresentationPaginatedResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Id4nPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "Id4nPresentationPaginatedResponse" + }, + "InputStream" : { + "type" : "object", + "title" : "InputStream" + }, + "InputStreamResource" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "file" : { + "$ref" : "#/definitions/File" + }, + "filename" : { + "type" : "string" + }, + "inputStream" : { + "$ref" : "#/definitions/InputStream" + }, + "open" : { + "type" : "boolean" + }, + "readable" : { + "type" : "boolean" + }, + "uri" : { + "$ref" : "#/definitions/URI" + }, + "url" : { + "$ref" : "#/definitions/URL" + } + }, + "title" : "InputStreamResource" + }, + "ListOfId4ns" : { + "type" : "object", + "properties" : { + "id4ns" : { + "type" : "array", + "description" : "A list of id4ns.", + "allowEmptyValue" : false, + "items" : { + "type" : "string" + } + } + }, + "title" : "ListOfId4ns", + "description" : "A list of id4ns" + }, + "Organization" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64", + "example" : 100, + "description" : "The id of the organization", + "readOnly" : true, + "allowEmptyValue" : false + }, + "logoURL" : { + "type" : "string", + "example" : "/api/v1/public/images/abcdef", + "description" : "URL to a logo of the organization", + "readOnly" : true, + "allowEmptyValue" : false + }, + "name" : { + "type" : "string", + "example" : "ACME Inc.", + "description" : "The name of the organization", + "allowEmptyValue" : false, + "minLength" : 3, + "maxLength" : 254 + } + }, + "title" : "Organization", + "description" : "An organization" + }, + "OrganizationAddress" : { + "type" : "object", + "required" : [ "city", "countryCode", "firstname", "lastname", "postCode", "street" ], + "properties" : { + "companyName" : { + "type" : "string", + "example" : "ACME Inc.", + "allowEmptyValue" : false, + "minLength" : 0, + "maxLength" : 254 + }, + "firstname" : { + "type" : "string", + "example" : "Max", + "allowEmptyValue" : false, + "minLength" : 2, + "maxLength" : 254 + }, + "lastname" : { + "type" : "string", + "example" : "Muster", + "allowEmptyValue" : false, + "minLength" : 2, + "maxLength" : 254 + }, + "street" : { + "type" : "string", + "example" : "Examplestreet 1", + "allowEmptyValue" : false, + "minLength" : 3, + "maxLength" : 254 + }, + "postCode" : { + "type" : "string", + "example" : 12345, + "allowEmptyValue" : false, + "minLength" : 2, + "maxLength" : 40 + }, + "city" : { + "type" : "string", + "example" : "MyCity", + "allowEmptyValue" : false, + "minLength" : 2, + "maxLength" : 99 + }, + "countryCode" : { + "type" : "string", + "example" : "DE", + "description" : "The ISO 3166 two-letter country code", + "allowEmptyValue" : false, + "minLength" : 0, + "maxLength" : 2 + }, + "countryName" : { + "type" : "string", + "example" : "Germany", + "description" : "The country name", + "readOnly" : true, + "allowEmptyValue" : false + }, + "telephone" : { + "type" : "string", + "example" : "+49 8088 12345", + "description" : "The telephone number e.g.", + "allowEmptyValue" : false, + "minLength" : 0, + "maxLength" : 99 + } + }, + "title" : "OrganizationAddress" + }, + "OrganizationUserInvitation" : { + "type" : "object", + "required" : [ "roles" ], + "properties" : { + "email" : { + "type" : "string" + }, + "roles" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "userName" : { + "type" : "string" + } + }, + "title" : "OrganizationUserInvitation" + }, + "OrganizationUserInvitationListRequest" : { + "type" : "object", + "required" : [ "invitations" ], + "properties" : { + "invitations" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/OrganizationUserInvitation" + } + } + }, + "title" : "OrganizationUserInvitationListRequest" + }, + "OwnedDocument" : { + "type" : "object", + "properties" : { + "filename" : { + "type" : "string", + "example" : "publicInfo.pdf", + "description" : "File Name", + "allowEmptyValue" : false + }, + "mimeType" : { + "type" : "string", + "example" : "text/plain", + "description" : "Mime Type", + "allowEmptyValue" : false + }, + "ownerOrganizationId" : { + "type" : "integer", + "format" : "int64", + "example" : 5, + "description" : "The organization's id which owns the document", + "readOnly" : true, + "allowEmptyValue" : false + }, + "visibility" : { + "description" : "Visibility configuration", + "allowEmptyValue" : false, + "$ref" : "#/definitions/Visibility" + } + }, + "title" : "OwnedDocument" + }, + "PaginatedApiKeyResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedApiKeyResponse" + }, + "PaginatedCountryResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Country" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedCountryResponse" + }, + "PaginatedDocumentResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Document" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedDocumentResponse" + }, + "PaginatedGuidCollection" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/GuidCollection" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedGuidCollection" + }, + "PaginatedGuidResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Guid" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedGuidResponse" + }, + "PaginatedOrganizationResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Organization" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedOrganizationResponse" + }, + "PaginatedOwnedDocumentResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/OwnedDocument" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedOwnedDocumentResponse" + }, + "PaginatedResponse«ApiKeyPresentation»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«ApiKeyPresentation»" + }, + "PaginatedResponse«ApiKeyPrivilegeInfo»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPrivilegeInfo" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«ApiKeyPrivilegeInfo»" + }, + "PaginatedResponse«ApiKeyPrivilege»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/ApiKeyPrivilege" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«ApiKeyPrivilege»" + }, + "PaginatedResponse«Country»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Country" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Country»" + }, + "PaginatedResponse«Document»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Document" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Document»" + }, + "PaginatedResponse«GuidCollection»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/GuidCollection" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«GuidCollection»" + }, + "PaginatedResponse«Guid»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Guid" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Guid»" + }, + "PaginatedResponse«Id4nPresentation»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Id4nPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Id4nPresentation»" + }, + "PaginatedResponse«Organization»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Organization" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Organization»" + }, + "PaginatedResponse«OwnedDocument»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/OwnedDocument" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«OwnedDocument»" + }, + "PaginatedResponse«Role»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Role" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«Role»" + }, + "PaginatedResponse«UserPresentation»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/UserPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«UserPresentation»" + }, + "PaginatedResponse«UserRoles»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/UserRoles" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«UserRoles»" + }, + "PaginatedResponse«string»" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "type" : "string" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedResponse«string»" + }, + "PaginatedStringResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "type" : "string" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedStringResponse" + }, + "PaginatedUserPresentationResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/UserPresentation" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedUserPresentationResponse" + }, + "PaginatedUserRolesResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/UserRoles" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "PaginatedUserRolesResponse" + }, + "PasswordResetRequest" : { + "type" : "object", + "required" : [ "username" ], + "properties" : { + "username" : { + "type" : "string" + } + }, + "title" : "PasswordResetRequest" + }, + "PasswordResetVerificationRequest" : { + "type" : "object", + "required" : [ "password", "token" ], + "properties" : { + "password" : { + "type" : "string" + }, + "token" : { + "type" : "string" + } + }, + "title" : "PasswordResetVerificationRequest" + }, + "PublicImagePresentation" : { + "type" : "object", + "required" : [ "uri" ], + "properties" : { + "uri" : { + "type" : "string", + "example" : "/api/v1/public/image/bc671c63-4a9b-46e7-8c59-9bbe1917e6cc", + "description" : "The uri/url of the image", + "readOnly" : true, + "allowEmptyValue" : false + } + }, + "title" : "PublicImagePresentation" + }, + "RegistrationVerificationTokenPresentation" : { + "type" : "object", + "required" : [ "token" ], + "properties" : { + "token" : { + "type" : "string" + } + }, + "title" : "RegistrationVerificationTokenPresentation" + }, + "RemoveApiKeyPrivilegeRequest" : { + "type" : "object", + "required" : [ "privilege" ], + "properties" : { + "privilege" : { + "type" : "string" + } + }, + "title" : "RemoveApiKeyPrivilegeRequest" + }, + "ResponseEntity" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "object" + }, + "statusCode" : { + "type" : "string", + "enum" : [ "100", "101", "102", "103", "200", "201", "202", "203", "204", "205", "206", "207", "208", "226", "300", "301", "302", "303", "304", "305", "307", "308", "400", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "415", "416", "417", "418", "419", "420", "421", "422", "423", "424", "426", "428", "429", "431", "451", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511" ] + }, + "statusCodeValue" : { + "type" : "integer", + "format" : "int32" + } + }, + "title" : "ResponseEntity" + }, + "Role" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "privileges" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "title" : "Role" + }, + "RoleResponse" : { + "type" : "object", + "required" : [ "elements", "limit", "offset" ], + "properties" : { + "elements" : { + "type" : "array", + "allowEmptyValue" : false, + "items" : { + "$ref" : "#/definitions/Role" + } + }, + "limit" : { + "type" : "integer", + "format" : "int32", + "example" : 100, + "description" : "The number of returned elements", + "allowEmptyValue" : false + }, + "offset" : { + "type" : "integer", + "format" : "int32", + "example" : 0, + "description" : "Starting with the n-th element", + "allowEmptyValue" : false + }, + "total" : { + "type" : "integer", + "format" : "int32", + "example" : 200, + "description" : "The total number of elements", + "allowEmptyValue" : false + } + }, + "title" : "RoleResponse" + }, + "Route" : { + "type" : "object", + "required" : [ "params", "public", "type" ], + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "priority" : { + "type" : "integer", + "format" : "int32" + }, + "public" : { + "type" : "boolean" + }, + "type" : { + "type" : "string" + }, + "validUntil" : { + "type" : "integer", + "format" : "int64" + } + }, + "title" : "Route" + }, + "RoutingFile" : { + "type" : "object", + "required" : [ "routes" ], + "properties" : { + "options" : { + "$ref" : "#/definitions/RoutingOptions" + }, + "routes" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Route" + } + } + }, + "title" : "RoutingFile" + }, + "RoutingFileRequest" : { + "type" : "object", + "required" : [ "routing" ], + "properties" : { + "organizationId" : { + "type" : "integer", + "format" : "int64" + }, + "routing" : { + "$ref" : "#/definitions/RoutingFile" + } + }, + "title" : "RoutingFileRequest" + }, + "RoutingOptions" : { + "type" : "object", + "properties" : { + "deleteOutdatedRoutes" : { + "type" : "boolean" + } + }, + "title" : "RoutingOptions" + }, + "ServiceCosts" : { + "type" : "object", + "required" : [ "listing" ], + "properties" : { + "listing" : { + "type" : "object", + "additionalProperties" : { + "type" : "number", + "format" : "float" + } + } + }, + "title" : "ServiceCosts" + }, + "SimpleMessageResponse" : { + "type" : "object", + "properties" : { + "message" : { + "type" : "string" + } + }, + "title" : "SimpleMessageResponse" + }, + "Timestamp" : { + "type" : "object", + "properties" : { + "date" : { + "type" : "integer", + "format" : "int32" + }, + "day" : { + "type" : "integer", + "format" : "int32" + }, + "hours" : { + "type" : "integer", + "format" : "int32" + }, + "minutes" : { + "type" : "integer", + "format" : "int32" + }, + "month" : { + "type" : "integer", + "format" : "int32" + }, + "nanos" : { + "type" : "integer", + "format" : "int32" + }, + "seconds" : { + "type" : "integer", + "format" : "int32" + }, + "time" : { + "type" : "integer", + "format" : "int64" + }, + "timezoneOffset" : { + "type" : "integer", + "format" : "int32" + }, + "year" : { + "type" : "integer", + "format" : "int32" + } + }, + "title" : "Timestamp" + }, + "URI" : { + "type" : "object", + "properties" : { + "absolute" : { + "type" : "boolean" + }, + "authority" : { + "type" : "string" + }, + "fragment" : { + "type" : "string" + }, + "host" : { + "type" : "string" + }, + "opaque" : { + "type" : "boolean" + }, + "path" : { + "type" : "string" + }, + "port" : { + "type" : "integer", + "format" : "int32" + }, + "query" : { + "type" : "string" + }, + "rawAuthority" : { + "type" : "string" + }, + "rawFragment" : { + "type" : "string" + }, + "rawPath" : { + "type" : "string" + }, + "rawQuery" : { + "type" : "string" + }, + "rawSchemeSpecificPart" : { + "type" : "string" + }, + "rawUserInfo" : { + "type" : "string" + }, + "scheme" : { + "type" : "string" + }, + "schemeSpecificPart" : { + "type" : "string" + }, + "userInfo" : { + "type" : "string" + } + }, + "title" : "URI" + }, + "URL" : { + "type" : "object", + "properties" : { + "authority" : { + "type" : "string" + }, + "content" : { + "type" : "object" + }, + "defaultPort" : { + "type" : "integer", + "format" : "int32" + }, + "file" : { + "type" : "string" + }, + "host" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "port" : { + "type" : "integer", + "format" : "int32" + }, + "protocol" : { + "type" : "string" + }, + "query" : { + "type" : "string" + }, + "ref" : { + "type" : "string" + }, + "userInfo" : { + "type" : "string" + } + }, + "title" : "URL" + }, + "UserPresentation" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "xml" : { + "name" : "id", + "attribute" : false, + "wrapped" : false + } + }, + "name" : { + "type" : "string" + } + }, + "title" : "UserPresentation" + }, + "UserRegistrationRequest" : { + "type" : "object", + "required" : [ "email", "password", "username" ], + "properties" : { + "username" : { + "type" : "string", + "pattern" : "[a-zA-Z0-9_.-]{6,50}" + }, + "password" : { + "type" : "string", + "minLength" : 8, + "maxLength" : 99 + }, + "email" : { + "type" : "string" + } + }, + "title" : "UserRegistrationRequest" + }, + "UserRegistrationResponse" : { + "type" : "object", + "properties" : { + "email" : { + "type" : "string" + }, + "id" : { + "type" : "integer", + "format" : "int64" + }, + "message" : { + "type" : "string" + }, + "username" : { + "type" : "string" + } + }, + "title" : "UserRegistrationResponse" + }, + "UserRoles" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "user" : { + "$ref" : "#/definitions/UserPresentation" + } + }, + "title" : "UserRoles" + }, + "Visibility" : { + "type" : "object", + "properties" : { + "public" : { + "type" : "boolean", + "example" : true, + "description" : "Document is publicly readable (if ID4N is owned by the same organization)", + "allowEmptyValue" : false + }, + "sharedOrganizationIds" : { + "type" : "array", + "example" : [ 101, 102, 103 ], + "description" : "Document is readable by these organizations (independend of ID4N ownership)", + "allowEmptyValue" : false, + "items" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "title" : "Visibility" + }, + "VisibilityUpdate" : { + "type" : "object", + "properties" : { + "public" : { + "type" : "boolean", + "example" : true, + "description" : "Document is publicly readable (if ID4N is owned by the same organization)", + "allowEmptyValue" : false + }, + "sharedWithOrganizationIds" : { + "type" : "array", + "example" : [ 101, 102, 103 ], + "description" : "Document is readable by these organizations (independend of ID4N ownership)", + "allowEmptyValue" : false, + "items" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "title" : "VisibilityUpdate" + }, + "WhoIsResponse" : { + "type" : "object", + "properties" : { + "aliases" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "organization" : { + "$ref" : "#/definitions/Organization" + }, + "organizationAddress" : { + "$ref" : "#/definitions/OrganizationAddress" + } + }, + "title" : "WhoIsResponse" + } + } +} \ No newline at end of file diff --git a/src/test/java/com/deepoove/swagger/test/CLITest.java b/src/test/java/com/deepoove/swagger/test/CLITest.java index 7c2ad45a..db37d687 100644 --- a/src/test/java/com/deepoove/swagger/test/CLITest.java +++ b/src/test/java/com/deepoove/swagger/test/CLITest.java @@ -93,7 +93,7 @@ public void testMain() { JCommander jCommander = JCommander.newBuilder().addObject(cli).build(); jCommander.parse(argv); cli.run(jCommander); - Assert.assertTrue(outContent.toString().startsWith("### What's New")); + Assert.assertTrue(outContent.toString().startsWith("## Version")); } } From bfc12046d7da2401f05780f1733da6122568dad7 Mon Sep 17 00:00:00 2001 From: Wolfgang Werner Date: Tue, 22 May 2018 13:36:46 +0200 Subject: [PATCH 2/5] Remove test files --- src/main/resources/new-swagger.json | 10164 ------------------------- src/main/resources/old-swagger.json | 10344 -------------------------- 2 files changed, 20508 deletions(-) delete mode 100644 src/main/resources/new-swagger.json delete mode 100644 src/main/resources/old-swagger.json diff --git a/src/main/resources/new-swagger.json b/src/main/resources/new-swagger.json deleted file mode 100644 index f2bd3dbc..00000000 --- a/src/main/resources/new-swagger.json +++ /dev/null @@ -1,10164 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "ID4i HTTP API", - "version" : "0.7.1", - "title" : "ID4i API", - "termsOfService" : "http://id4i.de", - "contact" : { - "name" : "BlueRain Software GmbH & Co. KG", - "url" : "http://bluerain.de", - "email" : "info@bluerain.de" - }, - "license" : { - "name" : "MIT", - "url" : "https://opensource.org/licenses/MIT" - }, - "x-logo" : { - "backgroundColor" : "#FAFAFA", - "url" : "/static/logo.png" - } - }, - "host" : "backend.id4i.de", - "basePath" : "/", - "tags" : [ { - "name" : "Accounts", - "description" : "User accounts allows people to register for ID4i and login. All permissions and roles for interactive ID4i usage (as opposed to machine-to-machine interactions) are attached to Organizations and User Accounts. The API allows users to register, verify their registration, login and reset their passwords." - }, { - "name" : "Alias", - "description" : "Guid Alias Controller" - }, { - "name" : "Api Keys", - "description" : "Api Key Controller" - }, { - "name" : "Auditing", - "description" : "Auditing services allow to review changes made by users or api keys. Changelog messages can be resolved as plain text or formatted message with parameters." - }, { - "name" : "Billing", - "description" : "Billing Controller" - }, { - "name" : "Collections", - "description" : "Collection Controller" - }, { - "name" : "Guids", - "description" : "Guid Alias Controller" - }, { - "name" : "History", - "description" : "Allows to retrieve a GUID's history and to publish new history items." - }, { - "name" : "Images", - "description" : "Services can use images stored with public visibility. This API allows you to retrieve the stored image by ID." - }, { - "name" : "Meta Information", - "description" : "App Info Controller" - }, { - "name" : "Organizations", - "description" : "Country Controller" - }, { - "name" : "Public Services", - "description" : "Go Controller" - }, { - "name" : "Routing", - "description" : "Routing Controller" - }, { - "name" : "Storage", - "description" : "Document Storage Controller" - }, { - "name" : "Transfer", - "description" : "Id 4n Transfer Controller" - }, { - "name" : "WhoIs", - "description" : "Who Is Controller" - } ], - "consumes" : [ "application/xml", "application/json" ], - "produces" : [ "application/xml", "application/json" ], - "paths" : { - "/account/contractRequired" : { - "get" : { - "tags" : [ "Accounts" ], - "summary" : "Tells you whether your company needs to have a contract with BlueRain to be able to sign up", - "description" : "On production systems, users must confirm that their organization has a valid contract for ID4i usage. It is not required on test and sandbox systems. ", - "operationId" : "isContractRequired", - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "boolean" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/account/password" : { - "post" : { - "tags" : [ "Accounts" ], - "summary" : "Request password reset", - "description" : "Requesting a reset for a new password. ", - "operationId" : "requestPasswordReset", - "parameters" : [ { - "in" : "body", - "name" : "resetRequest", - "description" : "Contains the required information to request a new password.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PasswordResetRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/SimpleMessageResponse" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - }, - "put" : { - "tags" : [ "Accounts" ], - "summary" : "Verify password reset", - "description" : "Setting a new password and verifying the request to set the password.", - "operationId" : "verifyPasswordReset", - "parameters" : [ { - "in" : "body", - "name" : "verificationRequest", - "description" : "Contains the new password and the verification token to set the new password.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PasswordResetVerificationRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/SimpleMessageResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/account/registration" : { - "post" : { - "tags" : [ "Accounts" ], - "summary" : "Register user", - "description" : "Registering a new user.", - "operationId" : "registerUser", - "parameters" : [ { - "in" : "body", - "name" : "userRegistration", - "description" : "The user information about the new created user.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserRegistrationRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/UserRegistrationResponse" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - }, - "put" : { - "tags" : [ "Accounts" ], - "summary" : "Complete registration", - "description" : "Completing a registration e.g. for invited users. Finish registration with a username and a password.", - "operationId" : "completeRegistration", - "parameters" : [ { - "in" : "body", - "name" : "completeRegistration", - "description" : "Contains the verification token, the username and the initial password.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CompleteUserRegistrationRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/account/verification" : { - "post" : { - "tags" : [ "Accounts" ], - "summary" : "Verify registration", - "description" : "Verifies a new user registration.", - "operationId" : "verifyUserRegistration", - "parameters" : [ { - "in" : "body", - "name" : "token", - "description" : "The token for user verification.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistrationVerificationTokenPresentation" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/api/v1/apikeys" : { - "get" : { - "tags" : [ "Api Keys" ], - "summary" : "Find API key by organization", - "description" : "Finding all API key assigned to the specified organization in a paginated manner.", - "operationId" : "listAllApiKeysOfOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "query", - "description" : "The namespace of the organization to search in.", - "required" : false, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedApiKeyResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "Api Keys" ], - "summary" : "Create API key", - "description" : "Creation of a new API key.", - "operationId" : "createNewApiKey", - "parameters" : [ { - "in" : "body", - "name" : "creationRequest", - "description" : "API key to be created.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ApiKeyCreationRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ApiKeyPresentation" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/apikeys/privileges" : { - "get" : { - "tags" : [ "Api Keys" ], - "summary" : "List all privileges", - "description" : "Listing all possible API key privileges.", - "operationId" : "listAllApiKeyPrivileges", - "parameters" : [ { - "name" : "id4nConcerning", - "in" : "query", - "description" : "id4nConcerning", - "required" : false, - "type" : "boolean" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ApiKeyPrivilegeInfoResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/apikeys/{key}" : { - "get" : { - "tags" : [ "Api Keys" ], - "summary" : "Show API key", - "description" : "Showing the details of an API key.", - "operationId" : "getApiKey", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "The API key to show.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ApiKeyPresentation" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Api Keys" ], - "summary" : "Update API keys", - "description" : "API keys can be updated with new labels, and be activated and deactivated. The secret or UUID cannot be changed.", - "operationId" : "updateApiKey", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "The API key to be updated.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "apiKeyChange", - "description" : "The new values to apply.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ApiKeyChangeRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Api Keys" ], - "summary" : "Delete API key", - "description" : "Deletion of an API key.", - "operationId" : "deleteApiKey", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "The API key to delete.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/apikeys/{key}/privileges" : { - "get" : { - "tags" : [ "Api Keys" ], - "summary" : "List privileges", - "operationId" : "listApiKeyPrivileges", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ApiKeyPrivilegePaginatedResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "Api Keys" ], - "summary" : "Add privilege", - "operationId" : "addApiKeyPrivilege", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "addApiKeyPrivilegeRequest", - "description" : "addApiKeyPrivilegeRequest", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AddApiKeyPrivilegeRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Api Keys" ], - "summary" : "Remove privilege", - "operationId" : "removeApiKeyPrivilege", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "removeApiKeyPrivilegeRequest", - "description" : "removeApiKeyPrivilegeRequest", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoveApiKeyPrivilegeRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/apikeys/{key}/privileges/{privilege}/id4ns" : { - "get" : { - "tags" : [ "Api Keys" ], - "summary" : "ID4ns of a privilege", - "description" : "Listing ID4ns of a id4n concerning privilege", - "operationId" : "listId4ns", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "name" : "privilege", - "in" : "path", - "description" : "privilege", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Id4nPresentationPaginatedResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "Api Keys" ], - "summary" : "Add ID4ns of a privilege", - "operationId" : "addApiKeyPrivilegeForId4ns", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "name" : "privilege", - "in" : "path", - "description" : "privilege", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "id4ns", - "description" : "id4ns", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Api Keys" ], - "summary" : "Remove id4ns of a privilege", - "operationId" : "removeApiKeyPrivilegeForId4ns", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "name" : "privilege", - "in" : "path", - "description" : "privilege", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "id4ns", - "description" : "id4ns", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/billing/{organizationId}" : { - "get" : { - "tags" : [ "Billing" ], - "summary" : "Get billing amount of services for a given organization", - "operationId" : "getSumForOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The organization to compute the billing information for", - "required" : true, - "type" : "string" - }, { - "name" : "fromDate", - "in" : "query", - "description" : "Billing start date", - "required" : false, - "type" : "string", - "format" : "date-time" - }, { - "name" : "toDate", - "in" : "query", - "description" : "Billing end date", - "required" : false, - "type" : "string", - "format" : "date-time" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ServiceCosts" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/billing/{organizationId}/positions" : { - "get" : { - "tags" : [ "Billing" ], - "summary" : "Get billing positions for a given organization", - "operationId" : "getPositionsForOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The organization to compute the billing information for", - "required" : true, - "type" : "string" - }, { - "name" : "fromDate", - "in" : "query", - "description" : "Billing start date", - "required" : false, - "type" : "string", - "format" : "date-time" - }, { - "name" : "toDate", - "in" : "query", - "description" : "Billing end date", - "required" : false, - "type" : "string", - "format" : "date-time" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BillingPosition" - } - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/changelog/organization/{organizationId}/" : { - "get" : { - "tags" : [ "Auditing" ], - "summary" : "List change log entries of an organization", - "description" : "Listing change log entries of the specified organization id.", - "operationId" : "listOrganizationChangeLog", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace identifying the organization whose change log entries are to be listed", - "required" : true, - "type" : "string" - }, { - "name" : "messageMimeType", - "in" : "query", - "description" : "The Mime-type for the message format that should be returned. e.g. 'text/plain' or 'text/mustache' ", - "required" : false, - "type" : "string", - "default" : "text/mustache" - }, { - "name" : "fromDate", - "in" : "query", - "description" : "From date time as UTC Date-Time format", - "required" : false, - "type" : "string", - "format" : "date-time" - }, { - "name" : "toDate", - "in" : "query", - "description" : "To date time as UTC Date-Time format", - "required" : false, - "type" : "string", - "format" : "date-time" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedChangeLogEntryResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections" : { - "post" : { - "tags" : [ "Collections" ], - "summary" : "Create collection", - "operationId" : "createCollection", - "parameters" : [ { - "in" : "body", - "name" : "createInfo", - "description" : "createInfo", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateCollectionRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Id4n" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/{id4n}" : { - "get" : { - "tags" : [ "Collections" ], - "summary" : "Find collection", - "operationId" : "findCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Collections" ], - "summary" : "Delete collection", - "operationId" : "deleteCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "patch" : { - "tags" : [ "Collections" ], - "summary" : "Update collection", - "description" : "Update collection changing only the given values", - "operationId" : "updateCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "204" : { - "description" : "No Content" - }, - "401" : { - "description" : "Unauthorized" - }, - "403" : { - "description" : "Forbidden" - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/{id4n}/elements" : { - "get" : { - "tags" : [ "Collections" ], - "summary" : "List contents of the collection", - "operationId" : "listElementsOfCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedGuidResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "Collections" ], - "summary" : "Add elements to collection", - "operationId" : "addElementsToCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "listOfGuids", - "description" : "listOfGuids", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Collections" ], - "summary" : "Remove elements from collection", - "operationId" : "removeElementsFromCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "listOfGuids", - "description" : "listOfGuids", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/countries" : { - "get" : { - "tags" : [ "Organizations" ], - "summary" : "List countries", - "operationId" : "listCountries", - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedCountryResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/documents/{id4n}" : { - "get" : { - "tags" : [ "Storage" ], - "summary" : "List documents", - "description" : "Listing all documents of an id4n", - "operationId" : "listAllDocuments", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedOwnedDocumentResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/documents/{id4n}/{organizationId}" : { - "get" : { - "tags" : [ "Storage" ], - "summary" : "List organization specific documents", - "description" : "Listing documents of an id4n owned by a specified organization", - "operationId" : "listDocuments", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedDocumentResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Storage" ], - "summary" : "Create an empty document for an id4n", - "description" : "The document is created empty, mime-type defaults to text/plain", - "operationId" : "createDocument", - "consumes" : [ "multipart/form-data" ], - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "content", - "in" : "formData", - "description" : "content", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Document" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/documents/{id4n}/{organizationId}/{fileName}" : { - "get" : { - "tags" : [ "Storage" ], - "summary" : "Read document contents", - "operationId" : "readDocument", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "string", - "format" : "byte" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Storage" ], - "summary" : "Delete a document", - "operationId" : "deleteDocument", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ResponseEntity" - } - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata" : { - "get" : { - "tags" : [ "Storage" ], - "summary" : "Retrieve a document (meta-data only, no content)", - "operationId" : "getDocument", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Document" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "patch" : { - "tags" : [ "Storage" ], - "summary" : "Update a document", - "operationId" : "updateDocumentMetadata", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "document", - "description" : "document", - "required" : true, - "schema" : { - "$ref" : "#/definitions/DocumentUpdate" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Document" - } - }, - "204" : { - "description" : "No Content" - }, - "401" : { - "description" : "Unauthorized" - }, - "403" : { - "description" : "Forbidden" - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/guids" : { - "post" : { - "tags" : [ "Guids" ], - "summary" : "Create GUID(s)", - "description" : "Creating one or more GUIDs with a specified length.", - "operationId" : "createGuid", - "parameters" : [ { - "in" : "body", - "name" : "createGUIDInfo", - "description" : "GUID creation model", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateGuidRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/guids/withoutCollection" : { - "get" : { - "tags" : [ "Guids" ], - "summary" : "Retrieve GUIDs not in any collection", - "operationId" : "getGuidsWithoutCollection", - "parameters" : [ { - "name" : "organizationId", - "in" : "query", - "description" : "The namespace of the organization to search GUIDs for", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedResponse«Guid»" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/guids/{id4n}" : { - "get" : { - "tags" : [ "Guids" ], - "summary" : "Retrieve GUID information", - "operationId" : "getGuid", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID number", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Guid" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "patch" : { - "tags" : [ "Guids" ], - "summary" : "Change GUID information.", - "description" : "Allows ownership transfer.", - "operationId" : "updateGuid", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID number", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Guid" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "204" : { - "description" : "No Content" - }, - "401" : { - "description" : "Unauthorized" - }, - "403" : { - "description" : "Forbidden" - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/guids/{id4n}/alias" : { - "get" : { - "tags" : [ "Alias", "Guids" ], - "summary" : "Get all aliases for the given GUID.", - "description" : "Looks up the alias for each alias type (group and single GUID) and returns a map of all aliases found.", - "operationId" : "getGuidAliases", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID to operate on", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/guids/{id4n}/alias/{aliasType}" : { - "post" : { - "tags" : [ "Alias", "Guids" ], - "summary" : "Add alias for GUIDs", - "description" : "Adds or replaces aliases for single GUIDs (alias type item and mapp) or groups of GUIDs (alias types gtin, ean and article)", - "operationId" : "addGuidAlias", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID to operate on", - "required" : true, - "type" : "string" - }, { - "name" : "aliasType", - "in" : "path", - "description" : "Alias type, see the corresponding API model", - "required" : true, - "type" : "string", - "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking", "eclass", "unspsc" ] - }, { - "in" : "body", - "name" : "alias", - "description" : "The alias to add or update", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidAlias" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Alias", "Guids" ], - "summary" : "Remove aliases from GUIDs", - "description" : "Remove the alias of the given type", - "operationId" : "removeGuidAlias", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID to operate on", - "required" : true, - "type" : "string" - }, { - "name" : "aliasType", - "in" : "path", - "description" : "Alias type, see the corresponding API model", - "required" : true, - "type" : "string", - "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking", "eclass", "unspsc" ] - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/history/{id4n}" : { - "get" : { - "tags" : [ "History" ], - "summary" : "List history", - "description" : "Lists the history of a GUID", - "operationId" : "listAll", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "GUID to retrieve the history for", - "required" : true, - "type" : "string" - }, { - "name" : "includePrivate", - "in" : "query", - "description" : "Also return private history entries", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedHistoryItemResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "History" ], - "summary" : "Add history item", - "description" : "Add a new history item", - "operationId" : "addItem", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "GUID to retrieve the history for", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "historyItem", - "description" : "The history item to publish", - "required" : true, - "schema" : { - "$ref" : "#/definitions/HistoryItem" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/history/{id4n}/{organizationId}" : { - "get" : { - "tags" : [ "History" ], - "summary" : "List history", - "description" : "Lists the history of a GUID of the specified organization", - "operationId" : "list", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "GUID to retrieve the history for", - "required" : true, - "type" : "string" - }, { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "includePrivate", - "in" : "query", - "description" : "Also return private history entries", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedHistoryItemResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/history/{id4n}/{organizationId}/{sequenceId}" : { - "get" : { - "tags" : [ "History" ], - "summary" : "Get history item", - "operationId" : "retrieveItem", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "GUID to retrieve the history for", - "required" : true, - "type" : "string" - }, { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "sequenceId", - "in" : "path", - "description" : "sequenceId", - "required" : true, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedHistoryItemResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "patch" : { - "tags" : [ "History" ], - "summary" : "Update history item", - "operationId" : "updateItem", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "GUID to retrieve the history for", - "required" : true, - "type" : "string" - }, { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "sequenceId", - "in" : "path", - "description" : "sequenceId", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "in" : "body", - "name" : "update", - "description" : "update", - "required" : true, - "schema" : { - "$ref" : "#/definitions/HistoryItemUpdate" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/HistoryItem" - } - }, - "204" : { - "description" : "No Content" - }, - "401" : { - "description" : "Unauthorized" - }, - "403" : { - "description" : "Forbidden" - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/history/{id4n}/{organizationId}/{sequenceId}/visibility" : { - "put" : { - "tags" : [ "History" ], - "summary" : "Set history item visibility", - "operationId" : "updateItemVisibility", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "GUID to retrieve the history for", - "required" : true, - "type" : "string" - }, { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "sequenceId", - "in" : "path", - "description" : "sequenceId", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "in" : "body", - "name" : "visibility", - "description" : "History item visibility restrictions", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Visibility" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/HistoryItem" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/id4ns/{id4n}" : { - "get" : { - "tags" : [ "Guids" ], - "summary" : "Retrieve ID4n information", - "description" : "Retrieving basic information about an ID like the type and the creation time.", - "operationId" : "getId4n", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The ID to resolve to", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Id4nPresentation" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/info" : { - "get" : { - "tags" : [ "Meta Information" ], - "summary" : "Retrieve version information about ID4i", - "description" : "Retrieving version information about ID4i.", - "operationId" : "applicationInfo", - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/AppInfoPresentation" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/microstorage/{id4n}/{organization}" : { - "get" : { - "tags" : [ "Storage" ], - "summary" : "Read data from microstorage", - "operationId" : "readFromMicrostorage", - "parameters" : [ { - "name" : "organization", - "in" : "path", - "description" : "organization", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "string", - "format" : "byte" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Storage" ], - "summary" : "Write data to microstorage", - "operationId" : "writeToMicrostorage", - "consumes" : [ "*/*" ], - "parameters" : [ { - "name" : "organization", - "in" : "path", - "description" : "organization", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "Content-Type", - "in" : "header", - "description" : "Content-Type", - "required" : false, - "type" : "string" - }, { - "name" : "Content-Length", - "in" : "header", - "description" : "Content-Length", - "required" : false, - "type" : "integer", - "format" : "int64" - }, { - "in" : "body", - "name" : "body", - "description" : "body", - "required" : false, - "schema" : { - "type" : "string", - "format" : "byte" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations" : { - "post" : { - "tags" : [ "Organizations" ], - "summary" : "Create organization", - "description" : "Creating a new organization.", - "operationId" : "createOrganization", - "parameters" : [ { - "in" : "body", - "name" : "organization", - "description" : "Organization to be created", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Organization" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Organization" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}" : { - "get" : { - "tags" : [ "Organizations" ], - "summary" : "Find organization by id/namespace", - "description" : "Returns a single organization.", - "operationId" : "findOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace of the organization to be retrieved.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Organization" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Organizations" ], - "summary" : "Update organization", - "operationId" : "updateOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace of the organization to be updated.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "organizationUpdate", - "description" : "Updated organization object", - "required" : true, - "schema" : { - "$ref" : "#/definitions/OrganizationUpdate" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Organization" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Organizations" ], - "summary" : "Delete organization", - "operationId" : "deleteOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace of the organization to be deleted.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/addresses/billing" : { - "get" : { - "tags" : [ "Organizations" ], - "summary" : "Retrieve billing address", - "operationId" : "findOrganizationBillingAddress", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Organizations" ], - "summary" : "Store billing address", - "operationId" : "updateOrganizationBillingAddress", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "addressResource", - "description" : "addressResource", - "required" : true, - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Organizations" ], - "summary" : "Remove billing address", - "operationId" : "deleteOrganizationBillingAddress", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/addresses/default" : { - "get" : { - "tags" : [ "Organizations" ], - "summary" : "Retrieve address", - "operationId" : "findOrganizationAddress", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Organizations" ], - "summary" : "Store address", - "operationId" : "updateOrganizationAddress", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "addressResource", - "description" : "addressResource", - "required" : true, - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/collections" : { - "get" : { - "tags" : [ "Collections", "Organizations" ], - "summary" : "Get collections of organization", - "description" : "Retrieving all collections of an organization in a paginated manner.", - "operationId" : "getAllCollectionsOfOrganization", - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace of the organization", - "required" : true, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "Filter by this type", - "required" : false, - "type" : "string", - "enum" : [ "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] - }, { - "name" : "label", - "in" : "query", - "description" : "Filter by this label", - "required" : false, - "type" : "string" - }, { - "name" : "labelPrefix", - "in" : "query", - "description" : "Filter by this label prefix", - "required" : false, - "type" : "string", - "maximum" : 2147483647, - "minimum" : 1 - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedGuidCollection" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/logo" : { - "post" : { - "tags" : [ "Organizations" ], - "summary" : "Update organization logo", - "description" : "Updating an organization logo using a multipart file upload.", - "operationId" : "setOrganizationLogo", - "consumes" : [ "multipart/form-data" ], - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace of the organization where the logo should be updated.", - "required" : true, - "type" : "string" - }, { - "name" : "file", - "in" : "formData", - "description" : "An image containing the new logo.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PublicImagePresentation" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Organizations" ], - "summary" : "Delete organization logo", - "operationId" : "deleteOrganizationLogo", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace of the organization where the logo should be deleted.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/roles" : { - "get" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "List users and their roles", - "description" : "Listing users and their roles in a paginated manner.", - "operationId" : "getAllOrganizationRoles", - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedUserRolesResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/users" : { - "get" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Find users in organization", - "description" : "Finding users in the specified organization in a paginated manner.", - "operationId" : "getUsersOfOrganization", - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedUserPresentationResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/users/invite" : { - "post" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Invite Users", - "operationId" : "inviteUsers", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace of the organization where users should be invited", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "invitationList", - "description" : "invitationList", - "required" : true, - "schema" : { - "$ref" : "#/definitions/OrganizationUserInvitationListRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/users/{username}/roles" : { - "get" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Get user roles by username", - "operationId" : "getUserRoles", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace of the organization", - "required" : true, - "type" : "string" - }, { - "name" : "username", - "in" : "path", - "description" : "username", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedStringResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Add role(s) to user", - "operationId" : "addUserRoles", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace of the organization", - "required" : true, - "type" : "string" - }, { - "name" : "username", - "in" : "path", - "description" : "username", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "changeRoleRequest", - "description" : "changeRoleRequest", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ChangeRoleRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Remove role(s) from user", - "operationId" : "removeUserRoles", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The namespace of the organization", - "required" : true, - "type" : "string" - }, { - "name" : "username", - "in" : "path", - "description" : "username", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "changeRoleRequest", - "description" : "changeRoleRequest", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ChangeRoleRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/documents/{id4n}" : { - "get" : { - "tags" : [ "Public Services", "Storage" ], - "summary" : "List organization specific documents", - "description" : "Listing documents of an id4n owned by a specified organization", - "operationId" : "listAllPublicDocuments", - "parameters" : [ { - "name" : "organizationId", - "in" : "query", - "description" : "organizationId", - "required" : false, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedOwnedDocumentResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/documents/{id4n}/{organizationId}" : { - "get" : { - "tags" : [ "Public Services", "Storage" ], - "summary" : "List organization specific documents", - "description" : "Listing documents of an id4n owned by a specified organization", - "operationId" : "listPublicDocuments", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedDocumentResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/documents/{id4n}/{organizationId}/{fileName}" : { - "get" : { - "tags" : [ "Public Services", "Storage" ], - "summary" : "Read document contents", - "operationId" : "readPublicDocument", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "string", - "format" : "byte" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata" : { - "get" : { - "tags" : [ "Public Services", "Storage" ], - "summary" : "Retrieve a document (meta-data only, no content)", - "operationId" : "getPublicDocument", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "string" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Document" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/history/{id4n}" : { - "get" : { - "tags" : [ "Public Services" ], - "summary" : "Shows the public history of the given GUID", - "description" : "Only contains public history items", - "operationId" : "listPublicHistory", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "GUID to retrieve the history for", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedHistoryItemResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/image/{imageID}" : { - "get" : { - "tags" : [ "Images", "Public Services" ], - "summary" : "Resolve image", - "operationId" : "resolveImageUsingGET", - "parameters" : [ { - "name" : "imageID", - "in" : "path", - "description" : "The id of the image to be resolved.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "string", - "format" : "byte" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/organizations/{organizationId}" : { - "get" : { - "tags" : [ "Public Services" ], - "summary" : "Read public organization information", - "operationId" : "readOrganizationInfo", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "Organization ID", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Organization" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/routes/{id4n}" : { - "get" : { - "tags" : [ "Public Services" ], - "summary" : "Retrieve all public routes for a GUID", - "operationId" : "getWebRoutes", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Route" - } - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/roles" : { - "get" : { - "tags" : [ "Accounts" ], - "summary" : "List roles", - "description" : "Listing of roles.", - "operationId" : "listAllRoles", - "parameters" : [ { - "name" : "privilege", - "in" : "query", - "description" : "If specified the roles will be filtered containing that privilege.", - "required" : false, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/RoleResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/routingfiles/{id4n}" : { - "get" : { - "tags" : [ "Routing" ], - "summary" : "Retrieve routing file", - "operationId" : "getRoutingFile", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "organizationId", - "in" : "query", - "description" : "organizationId", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/RoutingFile" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Routing" ], - "summary" : "Store routing file", - "operationId" : "updateRoutingFile", - "parameters" : [ { - "in" : "body", - "name" : "rfr", - "description" : "rfr", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RoutingFileRequest" - } - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/routingfiles/{id4n}/routes" : { - "get" : { - "tags" : [ "Routing" ], - "summary" : "Retrieve all web routes", - "description" : "Retrieves public and private web routes and interpolates them", - "operationId" : "getAllWebRoutes", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Route" - } - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/routingfiles/{id4n}/routes/{type}" : { - "get" : { - "tags" : [ "Routing" ], - "summary" : "Retrieve current route of a GUID (or ID4N)", - "operationId" : "getRoute", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "type", - "in" : "path", - "description" : "The type of route you want to have", - "required" : true, - "type" : "string" - }, { - "name" : "privateRoutes", - "in" : "query", - "description" : "privateRoutes", - "required" : false, - "type" : "boolean" - }, { - "name" : "publicRoutes", - "in" : "query", - "description" : "publicRoutes", - "required" : false, - "type" : "boolean" - }, { - "name" : "interpolate", - "in" : "query", - "description" : "interpolate", - "required" : false, - "type" : "boolean" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Route" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/search/guids" : { - "get" : { - "tags" : [ "Alias" ], - "summary" : "Search for GUIDs by alias", - "operationId" : "searchByAlias", - "parameters" : [ { - "name" : "alias", - "in" : "query", - "description" : "The alias to search for", - "required" : true, - "type" : "string" - }, { - "name" : "aliasType", - "in" : "query", - "description" : "Alias type type to search for", - "required" : true, - "type" : "string", - "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking", "eclass", "unspsc" ] - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedGuidResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/search/guids/aliases/types" : { - "get" : { - "tags" : [ "Alias" ], - "summary" : "List all supported alias types", - "description" : "Retrieve this list to find out all alias types to use with alias search and change operations", - "operationId" : "getGuidAliasTypes", - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking", "eclass", "unspsc" ] - } - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/transfers/{id4n}/receiveInfo" : { - "get" : { - "tags" : [ "Transfer" ], - "summary" : "Show transfer information", - "operationId" : "getReceiveInfo", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The ID4N to retrieve information about", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/TransferReceiveInfo" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Transfer" ], - "summary" : "Transfer a GUID or collection, obtaining it (i.e. becoming the holder) and if allowed also taking ownership", - "description" : "Taking ownership can be forbidden by a previous owner. See methods prepare and getInfo", - "operationId" : "receive", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "This ID4N identifies the object to take hold of", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "Required information to receive an id4n object", - "required" : true, - "schema" : { - "$ref" : "#/definitions/TransferReceiveInfo" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/transfers/{id4n}/sendInfo" : { - "get" : { - "tags" : [ "Transfer" ], - "summary" : "Show transfer preparation information", - "operationId" : "getSendInfo", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The ID4N to retrieve information about", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/TransferSendInfo" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Transfer" ], - "summary" : "Prepare an object for transfer", - "operationId" : "prepare", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The ID4N to prepare for transfer", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "Transfer preparation status", - "required" : true, - "schema" : { - "$ref" : "#/definitions/TransferSendInfo" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/user/organizations" : { - "get" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Retrieve organizations of user", - "operationId" : "getOrganizationsOfUser", - "parameters" : [ { - "name" : "role", - "in" : "query", - "description" : "role", - "required" : false, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedOrganizationResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/users" : { - "get" : { - "tags" : [ "Accounts" ], - "summary" : "Find users", - "operationId" : "findUsers", - "parameters" : [ { - "name" : "usernamePrefix", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedUserPresentationResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/users/{username}" : { - "get" : { - "tags" : [ "Accounts" ], - "summary" : "Find by username", - "operationId" : "findUserByUsername", - "parameters" : [ { - "name" : "username", - "in" : "path", - "description" : "username", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/UserPresentation" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/go/{guid}" : { - "get" : { - "tags" : [ "Public Services" ], - "summary" : "Forward", - "description" : "Forwarding to the designated route defined in the routing,", - "operationId" : "go", - "parameters" : [ { - "name" : "guid", - "in" : "path", - "description" : "guid", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/login" : { - "post" : { - "tags" : [ "Accounts" ], - "description" : "ID4i API Login", - "operationId" : "login", - "parameters" : [ { - "in" : "body", - "name" : "account-credentials", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccountCredentials" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/whois/{id4n}" : { - "get" : { - "tags" : [ "Public Services", "WhoIs" ], - "summary" : "Resolve owner of id4n", - "operationId" : "resolveWhoIsEntry", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/WhoIsResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - } - }, - "definitions" : { - "AccountCredentials" : { - "type" : "object", - "properties" : { - "login" : { - "type" : "string" - }, - "password" : { - "type" : "string" - } - }, - "title" : "AccountCredentials" - }, - "AddApiKeyPrivilegeRequest" : { - "type" : "object", - "required" : [ "privilege" ], - "properties" : { - "privilege" : { - "type" : "string" - } - }, - "title" : "AddApiKeyPrivilegeRequest" - }, - "ApiError" : { - "type" : "object", - "required" : [ "code", "errorList", "message" ], - "properties" : { - "code" : { - "type" : "string", - "enum" : [ "ERR_REGISTRATION_VERIFICATION_NO_TOKEN", "ERR_REGISTRATION_VERIFICATION_INVALID_TOKEN", "ERR_REGISTRATION_VERIFICATION_EXPIRED_TOKEN", "ERR_AUTHENTICATION_NO_TOKEN", "ERR_AUTHENTICATION_INVALID_TOKEN", "ERR_AUTHENTICATION_EXPIRED_TOKEN", "ERR_AUTHENTICATION_FAILED", "ERR_AUTHORIZATION_MISSING_PRIVILEGES", "ERR_AUTHORIZATION_FORBIDDEN", "ERR_AUTHORIZATION_REQUIRE_USER", "ERR_INPUT_VALIDATION_FAILED", "ERR_FIELD_INPUT_VALIDATION_FAILED", "ERR_VALIDATION_CONSTRAINT_FAILED", "ERR_INPUT_NOT_READABLE", "ERR_INVALID_INPUT_PARAMETER", "ERR_GUID_CREATION", "ERR_INVALID_ID4N_OBJECT_TYPE", "ERR_COLLECTION_UPDATE_DENIED", "ERR_ENTITY_NOT_FOUND", "ERR_ENTITY_TOO_BIG", "ERR_DUPLICATE", "ERR_INTERNAL", "ERR_UNKNOWN", "ERR_INVALID_ORGANIZATION_USERROLE", "ERR_ORGANIZATION_ROLE_INCONSISTENCY", "ERR_ORGANIZATION_NOT_DELETABLE", "ERR_USER_ALREADY_IN_ORGANIZATION", "ERR_USER_INVITATION_NEEDS_MINIMUM_ONE_ROLE", "ERR_USER_INVITATION_SPECIFY_EMAIL_OR_USERNAME", "ERR_USER_DEACTIVATED", "ERR_LANGUAGE_NOT_SUPPORTED", "ERR_EMAIL_MISSING_TEMPLATE_PARAM", "ERR_EMAIL_TEMPLATE_NOT_AVAILABLE", "ERR_EMAIL_PREPARATION_FAILED", "ERR_IMAGE_CONVERSION", "ERR_UPLOAD_TOO_LARGE", "ERR_INVALID_ALIAS_TYPE", "ERR_INVALID_URI_TEMPLATE", "ERR_INVALID_URI_TEMPLATE_VARIABLE", "ERR_INVALID_NAMESPACE", "ERR_NAMESPACE_ALREADY_EXISTS", "ERR_INSECURE_PASSWORD", "ERR_TRANSFER_DENIED", "ERR_INVALID_PHYSICAL_STATE" ] - }, - "errorList" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ApiError" - } - }, - "message" : { - "type" : "string" - } - }, - "title" : "ApiError" - }, - "ApiKeyChangeRequest" : { - "type" : "object", - "required" : [ "newLabel" ], - "properties" : { - "active" : { - "type" : "boolean" - }, - "newLabel" : { - "type" : "string", - "minLength" : 5, - "maxLength" : 50 - } - }, - "title" : "ApiKeyChangeRequest" - }, - "ApiKeyCreationRequest" : { - "type" : "object", - "required" : [ "label", "organizationId", "secret" ], - "properties" : { - "label" : { - "type" : "string", - "minLength" : 5, - "maxLength" : 50 - }, - "organizationId" : { - "type" : "string", - "example" : "de.acme", - "allowEmptyValue" : false - }, - "secret" : { - "type" : "string", - "minLength" : 10, - "maxLength" : 500 - } - }, - "title" : "ApiKeyCreationRequest" - }, - "ApiKeyPresentation" : { - "type" : "object", - "required" : [ "active", "createdAt", "createdBy", "key", "label", "organizationId" ], - "properties" : { - "active" : { - "type" : "boolean", - "example" : true, - "description" : "Whether this API key is active", - "allowEmptyValue" : false - }, - "createdAt" : { - "type" : "integer", - "format" : "int64", - "example" : 1517232722, - "description" : "The UTC unix timestamp of when this api key has been created", - "allowEmptyValue" : false - }, - "createdBy" : { - "type" : "string", - "example" : "user123", - "allowEmptyValue" : false - }, - "key" : { - "type" : "string", - "example" : "39978f49-6ff1-4147-bf0f-9910185084b7", - "description" : "The api key identifier", - "allowEmptyValue" : false - }, - "label" : { - "type" : "string", - "example" : "My Api Key", - "description" : "The label / name of the api key", - "allowEmptyValue" : false - }, - "organizationId" : { - "type" : "string", - "example" : 10, - "description" : "The organization namespace this api key belongs to", - "allowEmptyValue" : false - } - }, - "title" : "ApiKeyPresentation" - }, - "ApiKeyPrivilege" : { - "type" : "object", - "required" : [ "id4nAssociated", "privilege" ], - "properties" : { - "id4nAssociated" : { - "type" : "boolean" - }, - "privilege" : { - "type" : "string" - } - }, - "title" : "ApiKeyPrivilege" - }, - "ApiKeyPrivilegeInfo" : { - "type" : "object", - "required" : [ "id4nAssociated", "name" ], - "properties" : { - "allowsBillableOperations" : { - "type" : "boolean" - }, - "helpText" : { - "type" : "string" - }, - "id4nAssociated" : { - "type" : "boolean" - }, - "name" : { - "type" : "string" - } - }, - "title" : "ApiKeyPrivilegeInfo" - }, - "ApiKeyPrivilegeInfoResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPrivilegeInfo" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "ApiKeyPrivilegeInfoResponse" - }, - "ApiKeyPrivilegePaginatedResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPrivilege" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "ApiKeyPrivilegePaginatedResponse" - }, - "AppInfoPresentation" : { - "type" : "object", - "properties" : { - "branch" : { - "type" : "string" - }, - "commitTime" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "productionMode" : { - "type" : "boolean" - }, - "revision" : { - "type" : "string" - }, - "version" : { - "type" : "string" - } - }, - "title" : "AppInfoPresentation" - }, - "BillingPosition" : { - "type" : "object", - "required" : [ "count", "description", "service", "sum" ], - "properties" : { - "count" : { - "type" : "integer", - "format" : "int64" - }, - "description" : { - "type" : "string" - }, - "service" : { - "type" : "string" - }, - "sum" : { - "type" : "number", - "format" : "float" - } - }, - "title" : "BillingPosition" - }, - "ChangeLogEntry" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "example" : "e100123", - "description" : "The unique id of the changelog entry", - "readOnly" : true, - "allowEmptyValue" : false - }, - "message" : { - "type" : "string", - "example" : "User {{&user}} has changed the title of {{&object}}", - "description" : "The message as template or rendered as plain text", - "readOnly" : true, - "allowEmptyValue" : false - }, - "messageProperties" : { - "type" : "object", - "example" : { - "user" : { - "value" : "a.vratny", - "type" : "user" - }, - "object" : "nearly every object" - }, - "description" : "The values of the properties in the message. May be nested as object with a value field ", - "readOnly" : true, - "allowEmptyValue" : false, - "additionalProperties" : { - "type" : "object" - } - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "example" : 1517232722, - "description" : "The UTC unix timestamp when this change occurred", - "readOnly" : true, - "allowEmptyValue" : false - } - }, - "title" : "ChangeLogEntry", - "description" : "A changelog entry" - }, - "ChangeRoleRequest" : { - "type" : "object", - "properties" : { - "roles" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, - "title" : "ChangeRoleRequest" - }, - "CompleteUserRegistrationRequest" : { - "type" : "object", - "required" : [ "password", "username", "verificationToken" ], - "properties" : { - "verificationToken" : { - "type" : "string" - }, - "username" : { - "type" : "string", - "pattern" : "[a-zA-Z0-9_.-]{6,50}" - }, - "password" : { - "type" : "string", - "minLength" : 8, - "maxLength" : 99 - } - }, - "title" : "CompleteUserRegistrationRequest" - }, - "Country" : { - "type" : "object", - "required" : [ "code", "name" ], - "properties" : { - "code" : { - "type" : "string" - }, - "name" : { - "type" : "string" - } - }, - "title" : "Country" - }, - "CreateCollectionRequest" : { - "type" : "object", - "required" : [ "length", "organizationId", "type" ], - "properties" : { - "label" : { - "type" : "string", - "minLength" : 5, - "maxLength" : 128 - }, - "organizationId" : { - "type" : "string", - "example" : "de.acme", - "allowEmptyValue" : false - }, - "length" : { - "type" : "integer", - "format" : "int32", - "minimum" : 6.0, - "maximum" : 255.0, - "exclusiveMinimum" : false, - "exclusiveMaximum" : false - }, - "type" : { - "type" : "string", - "enum" : [ "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] - } - }, - "title" : "CreateCollectionRequest" - }, - "CreateGuidRequest" : { - "type" : "object", - "required" : [ "count", "length", "organizationId" ], - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "example" : 1, - "description" : "The total number of GUIDs to create", - "allowEmptyValue" : false, - "minimum" : 1.0, - "maximum" : 1000.0, - "exclusiveMinimum" : false, - "exclusiveMaximum" : false - }, - "length" : { - "type" : "integer", - "format" : "int32", - "example" : 40, - "description" : "The charactersequence length of the GUID", - "allowEmptyValue" : false, - "minimum" : 7.0, - "maximum" : 255.0, - "exclusiveMinimum" : false, - "exclusiveMaximum" : false - }, - "organizationId" : { - "type" : "string", - "example" : 123, - "description" : "The namespace of the organization where the generated GUIDs should be assigned.", - "allowEmptyValue" : false - } - }, - "title" : "CreateGuidRequest", - "description" : "GUID creation information" - }, - "Document" : { - "type" : "object", - "properties" : { - "filename" : { - "type" : "string", - "example" : "publicInfo.pdf", - "description" : "File Name", - "allowEmptyValue" : false - }, - "mimeType" : { - "type" : "string", - "example" : "text/plain", - "description" : "Mime Type", - "allowEmptyValue" : false - }, - "visibility" : { - "description" : "Visibility configuration", - "allowEmptyValue" : false, - "$ref" : "#/definitions/Visibility" - } - }, - "title" : "Document" - }, - "DocumentUpdate" : { - "type" : "object", - "properties" : { - "filename" : { - "type" : "string", - "example" : "publicInfo.pdf", - "description" : "File Name", - "allowEmptyValue" : false - }, - "mimeType" : { - "type" : "string", - "example" : "text/plain", - "description" : "Mime Type", - "allowEmptyValue" : false - }, - "visibility" : { - "example" : true, - "description" : "Visibility configuration", - "allowEmptyValue" : false, - "$ref" : "#/definitions/VisibilityUpdate" - } - }, - "title" : "DocumentUpdate" - }, - "File" : { - "type" : "object", - "properties" : { - "absolute" : { - "type" : "boolean" - }, - "absoluteFile" : { - "$ref" : "#/definitions/File" - }, - "absolutePath" : { - "type" : "string" - }, - "canonicalFile" : { - "$ref" : "#/definitions/File" - }, - "canonicalPath" : { - "type" : "string" - }, - "directory" : { - "type" : "boolean" - }, - "file" : { - "type" : "boolean" - }, - "freeSpace" : { - "type" : "integer", - "format" : "int64" - }, - "hidden" : { - "type" : "boolean" - }, - "name" : { - "type" : "string" - }, - "parent" : { - "type" : "string" - }, - "parentFile" : { - "$ref" : "#/definitions/File" - }, - "path" : { - "type" : "string" - }, - "totalSpace" : { - "type" : "integer", - "format" : "int64" - }, - "usableSpace" : { - "type" : "integer", - "format" : "int64" - } - }, - "title" : "File" - }, - "Guid" : { - "type" : "object", - "properties" : { - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "example" : 1517232722, - "description" : "The UTC unix timestamp of when this GUID has been created", - "readOnly" : true, - "allowEmptyValue" : false - }, - "holderOrganizationId" : { - "type" : "string", - "description" : "Organization namespace of the GUID holder", - "readOnly" : true, - "allowEmptyValue" : false - }, - "id4n" : { - "type" : "string", - "example" : "3THvgrWxqgTFC4", - "description" : "The ID", - "readOnly" : true, - "allowEmptyValue" : false - }, - "ownerOrganizationId" : { - "type" : "string", - "description" : "Organization namespace of the GUID owner", - "readOnly" : true, - "allowEmptyValue" : false - }, - "physicalState" : { - "type" : "string", - "description" : "Physical attachment state of the GUID", - "allowEmptyValue" : false, - "enum" : [ "UNATTACHED", "ATTACHED", "DETACHED" ] - } - }, - "title" : "Guid" - }, - "GuidAlias" : { - "type" : "object", - "required" : [ "alias" ], - "properties" : { - "alias" : { - "type" : "string", - "example" : "alias", - "description" : "An alias", - "allowEmptyValue" : false, - "minLength" : 1, - "maxLength" : 255 - } - }, - "title" : "GuidAlias" - }, - "GuidCollection" : { - "type" : "object", - "properties" : { - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The UTC unix timestamp of when this collection has been created", - "readOnly" : true, - "allowEmptyValue" : false - }, - "holderOrganizationId" : { - "type" : "string", - "description" : "Organization namespace of the holder of the collection", - "allowEmptyValue" : false - }, - "id4n" : { - "type" : "string", - "description" : "The ID", - "readOnly" : true, - "allowEmptyValue" : false - }, - "label" : { - "type" : "string", - "minLength" : 5, - "maxLength" : 128 - }, - "ownerOrganizationId" : { - "type" : "string", - "description" : "Organization namespace of the collection owner", - "readOnly" : true, - "allowEmptyValue" : false - }, - "physicalState" : { - "type" : "string", - "description" : "Physical attachment state of the collection", - "allowEmptyValue" : false, - "enum" : [ "UNATTACHED", "ATTACHED", "DETACHED" ] - }, - "type" : { - "type" : "string", - "readOnly" : true, - "allowEmptyValue" : false, - "enum" : [ "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] - } - }, - "title" : "GuidCollection" - }, - "HistoryItem" : { - "type" : "object", - "required" : [ "organizationId", "type" ], - "properties" : { - "organizationId" : { - "type" : "string", - "example" : 93, - "description" : "Originator of the history item", - "allowEmptyValue" : false - }, - "sequenceId" : { - "type" : "integer", - "format" : "int32", - "example" : 9784, - "description" : "Forms the primary key of the history item together with the GUID and the organizationId", - "readOnly" : true, - "allowEmptyValue" : false - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "example" : 1517232722, - "description" : "History item timestamp", - "readOnly" : true, - "allowEmptyValue" : false - }, - "type" : { - "type" : "string", - "example" : "DISPATCHED", - "description" : "Type of the history item", - "allowEmptyValue" : false, - "enum" : [ "CREATED", "DESTROYED", "RECYCLED", "SHIPMENT_PREPARED", "STORED", "RETRIEVED_FROM_STORAGE", "PACKAGED", "DISPATCHED", "RECEIVED", "REPROCESSING_STARTED", "REPROCESSING_CANCELLED", "REPROCESSING_FINISHED", "DISASSEMBLED", "MAINTENANCE_STARTED", "MAINTENANCE_CANCELLED", "MAINTENANCE_FINISHED", "PRODUCTION_STEP_STARTED", "PRODUCTION_STEP_CANCELLED", "PRODUCTION_STEP_FINISHED" ] - }, - "visibility" : { - "description" : "History item visibility restrictions", - "allowEmptyValue" : false, - "$ref" : "#/definitions/Visibility" - } - }, - "title" : "HistoryItem", - "description" : "GUID history item" - }, - "HistoryItemUpdate" : { - "type" : "object", - "properties" : { - "organizationId" : { - "type" : "string", - "example" : "de.acme", - "description" : "New organization id displayed for this item. If given, must match the holder of GUID and the organization the history item is found under.", - "allowEmptyValue" : false - }, - "visibility" : { - "description" : "History item visibility restrictions", - "allowEmptyValue" : false, - "$ref" : "#/definitions/Visibility" - } - }, - "title" : "HistoryItemUpdate", - "description" : "GUID history item update (diff patch)" - }, - "Id4n" : { - "type" : "object", - "properties" : { - "id4n" : { - "type" : "string", - "example" : "3THvgrWxqgTFC4", - "description" : "The ID", - "allowEmptyValue" : false - } - }, - "title" : "Id4n" - }, - "Id4nPresentation" : { - "type" : "object", - "required" : [ "createdTimestamp", "id4n", "type" ], - "properties" : { - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "example" : 1517232722, - "description" : "The UTC unix timestamp of when this ID has been created", - "readOnly" : true, - "allowEmptyValue" : false - }, - "holderOrganizationId" : { - "type" : "string", - "example" : "de.example", - "description" : "${Id4nPresentation.Guid.holderOrganizationId}", - "readOnly" : true, - "allowEmptyValue" : false - }, - "id4n" : { - "type" : "string", - "example" : "3THvgrWxqgTFC4", - "description" : "The ID", - "readOnly" : true, - "allowEmptyValue" : false - }, - "label" : { - "type" : "string", - "readOnly" : true, - "allowEmptyValue" : false - }, - "ownerOrganizationId" : { - "type" : "string", - "example" : "org.acme", - "description" : "${Id4nPresentation.Guid.ownerOrganizationId}", - "readOnly" : true, - "allowEmptyValue" : false - }, - "type" : { - "type" : "string", - "description" : "The type of ID", - "readOnly" : true, - "allowEmptyValue" : false, - "enum" : [ "GUID", "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] - } - }, - "title" : "Id4nPresentation" - }, - "Id4nPresentationPaginatedResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Id4nPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "Id4nPresentationPaginatedResponse" - }, - "InputStream" : { - "type" : "object", - "title" : "InputStream" - }, - "InputStreamResource" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string" - }, - "file" : { - "$ref" : "#/definitions/File" - }, - "filename" : { - "type" : "string" - }, - "inputStream" : { - "$ref" : "#/definitions/InputStream" - }, - "open" : { - "type" : "boolean" - }, - "readable" : { - "type" : "boolean" - }, - "uri" : { - "$ref" : "#/definitions/URI" - }, - "url" : { - "$ref" : "#/definitions/URL" - } - }, - "title" : "InputStreamResource" - }, - "ListOfId4ns" : { - "type" : "object", - "properties" : { - "id4ns" : { - "type" : "array", - "description" : "A list of id4ns.", - "allowEmptyValue" : false, - "items" : { - "type" : "string" - } - } - }, - "title" : "ListOfId4ns", - "description" : "A list of id4ns" - }, - "Organization" : { - "type" : "object", - "required" : [ "name", "namespace" ], - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "example" : 100, - "description" : "The id of the organization ( Deprecated: Use namespace instead. )", - "readOnly" : true, - "allowEmptyValue" : false - }, - "logoURL" : { - "type" : "string", - "example" : "/api/v1/public/images/abcdef", - "description" : "URL to a logo of the organization", - "readOnly" : true, - "allowEmptyValue" : false - }, - "name" : { - "type" : "string", - "example" : "ACME Inc.", - "description" : "The name of the organization", - "allowEmptyValue" : false, - "minLength" : 3, - "maxLength" : 254 - }, - "namespace" : { - "type" : "string", - "example" : "de.acme", - "description" : "The namespace of the organization", - "allowEmptyValue" : false, - "minLength" : 3, - "maxLength" : 255 - } - }, - "title" : "Organization", - "description" : "An organization" - }, - "OrganizationAddress" : { - "type" : "object", - "required" : [ "city", "countryCode", "firstname", "lastname", "postCode", "street" ], - "properties" : { - "companyName" : { - "type" : "string", - "example" : "ACME Inc.", - "allowEmptyValue" : false, - "minLength" : 0, - "maxLength" : 254 - }, - "firstname" : { - "type" : "string", - "example" : "Max", - "allowEmptyValue" : false, - "minLength" : 2, - "maxLength" : 254 - }, - "lastname" : { - "type" : "string", - "example" : "Muster", - "allowEmptyValue" : false, - "minLength" : 2, - "maxLength" : 254 - }, - "street" : { - "type" : "string", - "example" : "Examplestreet 1", - "allowEmptyValue" : false, - "minLength" : 3, - "maxLength" : 254 - }, - "postCode" : { - "type" : "string", - "example" : 12345, - "allowEmptyValue" : false, - "minLength" : 2, - "maxLength" : 40 - }, - "city" : { - "type" : "string", - "example" : "MyCity", - "allowEmptyValue" : false, - "minLength" : 2, - "maxLength" : 99 - }, - "countryCode" : { - "type" : "string", - "example" : "DE", - "description" : "The ISO 3166 two-letter country code", - "allowEmptyValue" : false, - "minLength" : 0, - "maxLength" : 2 - }, - "countryName" : { - "type" : "string", - "example" : "Germany", - "description" : "The country name", - "readOnly" : true, - "allowEmptyValue" : false - }, - "telephone" : { - "type" : "string", - "example" : "+49 8088 12345", - "description" : "The telephone number e.g.", - "allowEmptyValue" : false, - "minLength" : 0, - "maxLength" : 99 - } - }, - "title" : "OrganizationAddress" - }, - "OrganizationUpdate" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "example" : "ACME Inc.", - "description" : "The name of the organization", - "allowEmptyValue" : false, - "minLength" : 3, - "maxLength" : 254 - }, - "namespace" : { - "type" : "string", - "example" : "de.acme", - "description" : "The namespace of the organization", - "allowEmptyValue" : false, - "minLength" : 3, - "maxLength" : 255 - } - }, - "title" : "OrganizationUpdate", - "description" : "An organization" - }, - "OrganizationUserInvitation" : { - "type" : "object", - "required" : [ "roles" ], - "properties" : { - "email" : { - "type" : "string" - }, - "userName" : { - "type" : "string" - }, - "roles" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, - "title" : "OrganizationUserInvitation" - }, - "OrganizationUserInvitationListRequest" : { - "type" : "object", - "required" : [ "invitations" ], - "properties" : { - "invitations" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/OrganizationUserInvitation" - } - } - }, - "title" : "OrganizationUserInvitationListRequest" - }, - "OwnedDocument" : { - "type" : "object", - "properties" : { - "filename" : { - "type" : "string", - "example" : "publicInfo.pdf", - "description" : "File Name", - "allowEmptyValue" : false - }, - "mimeType" : { - "type" : "string", - "example" : "text/plain", - "description" : "Mime Type", - "allowEmptyValue" : false - }, - "ownerOrganizationId" : { - "type" : "string", - "example" : "de.bluerain", - "description" : "The organization's namespace which owns the document", - "readOnly" : true, - "allowEmptyValue" : false - }, - "visibility" : { - "description" : "Visibility configuration", - "allowEmptyValue" : false, - "$ref" : "#/definitions/Visibility" - } - }, - "title" : "OwnedDocument" - }, - "PaginatedApiKeyResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedApiKeyResponse" - }, - "PaginatedChangeLogEntryResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ChangeLogEntry" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedChangeLogEntryResponse" - }, - "PaginatedCountryResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Country" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedCountryResponse" - }, - "PaginatedDocumentResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Document" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedDocumentResponse" - }, - "PaginatedGuidCollection" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/GuidCollection" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedGuidCollection" - }, - "PaginatedGuidResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Guid" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedGuidResponse" - }, - "PaginatedHistoryItemResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/HistoryItem" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedHistoryItemResponse" - }, - "PaginatedOrganizationResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Organization" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedOrganizationResponse" - }, - "PaginatedOwnedDocumentResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/OwnedDocument" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedOwnedDocumentResponse" - }, - "PaginatedResponse«ApiKeyPresentation»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«ApiKeyPresentation»" - }, - "PaginatedResponse«ApiKeyPrivilegeInfo»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPrivilegeInfo" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«ApiKeyPrivilegeInfo»" - }, - "PaginatedResponse«ApiKeyPrivilege»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPrivilege" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«ApiKeyPrivilege»" - }, - "PaginatedResponse«ChangeLogEntry»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ChangeLogEntry" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«ChangeLogEntry»" - }, - "PaginatedResponse«Country»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Country" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Country»" - }, - "PaginatedResponse«Document»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Document" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Document»" - }, - "PaginatedResponse«GuidCollection»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/GuidCollection" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«GuidCollection»" - }, - "PaginatedResponse«Guid»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Guid" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Guid»" - }, - "PaginatedResponse«HistoryItem»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/HistoryItem" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«HistoryItem»" - }, - "PaginatedResponse«Id4nPresentation»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Id4nPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Id4nPresentation»" - }, - "PaginatedResponse«Organization»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Organization" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Organization»" - }, - "PaginatedResponse«OwnedDocument»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/OwnedDocument" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«OwnedDocument»" - }, - "PaginatedResponse«Role»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Role" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Role»" - }, - "PaginatedResponse«UserPresentation»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/UserPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«UserPresentation»" - }, - "PaginatedResponse«UserRoles»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/UserRoles" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«UserRoles»" - }, - "PaginatedResponse«string»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "type" : "string" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«string»" - }, - "PaginatedStringResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "type" : "string" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedStringResponse" - }, - "PaginatedUserPresentationResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/UserPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedUserPresentationResponse" - }, - "PaginatedUserRolesResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/UserRoles" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedUserRolesResponse" - }, - "PasswordResetRequest" : { - "type" : "object", - "required" : [ "username" ], - "properties" : { - "username" : { - "type" : "string" - } - }, - "title" : "PasswordResetRequest" - }, - "PasswordResetVerificationRequest" : { - "type" : "object", - "required" : [ "password", "token" ], - "properties" : { - "password" : { - "type" : "string" - }, - "token" : { - "type" : "string" - } - }, - "title" : "PasswordResetVerificationRequest" - }, - "PublicImagePresentation" : { - "type" : "object", - "required" : [ "uri" ], - "properties" : { - "uri" : { - "type" : "string", - "example" : "/api/v1/public/image/bc671c63-4a9b-46e7-8c59-9bbe1917e6cc", - "description" : "The uri/url of the image", - "readOnly" : true, - "allowEmptyValue" : false - } - }, - "title" : "PublicImagePresentation" - }, - "RegistrationVerificationTokenPresentation" : { - "type" : "object", - "required" : [ "token" ], - "properties" : { - "token" : { - "type" : "string" - } - }, - "title" : "RegistrationVerificationTokenPresentation" - }, - "RemoveApiKeyPrivilegeRequest" : { - "type" : "object", - "required" : [ "privilege" ], - "properties" : { - "privilege" : { - "type" : "string" - } - }, - "title" : "RemoveApiKeyPrivilegeRequest" - }, - "ResponseEntity" : { - "type" : "object", - "properties" : { - "body" : { - "type" : "object" - }, - "statusCode" : { - "type" : "string", - "enum" : [ "100", "101", "102", "103", "200", "201", "202", "203", "204", "205", "206", "207", "208", "226", "300", "301", "302", "303", "304", "305", "307", "308", "400", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "415", "416", "417", "418", "419", "420", "421", "422", "423", "424", "426", "428", "429", "431", "451", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511" ] - }, - "statusCodeValue" : { - "type" : "integer", - "format" : "int32" - } - }, - "title" : "ResponseEntity" - }, - "Role" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "privileges" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, - "title" : "Role" - }, - "RoleResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Role" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "RoleResponse" - }, - "Route" : { - "type" : "object", - "required" : [ "params", "public", "type" ], - "properties" : { - "params" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "priority" : { - "type" : "integer", - "format" : "int32" - }, - "public" : { - "type" : "boolean" - }, - "type" : { - "type" : "string" - }, - "validUntil" : { - "type" : "integer", - "format" : "int64" - } - }, - "title" : "Route" - }, - "RoutingFile" : { - "type" : "object", - "required" : [ "routes" ], - "properties" : { - "options" : { - "$ref" : "#/definitions/RoutingOptions" - }, - "routes" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Route" - } - } - }, - "title" : "RoutingFile" - }, - "RoutingFileRequest" : { - "type" : "object", - "required" : [ "routing" ], - "properties" : { - "routing" : { - "$ref" : "#/definitions/RoutingFile" - }, - "organizationId" : { - "type" : "string" - } - }, - "title" : "RoutingFileRequest" - }, - "RoutingOptions" : { - "type" : "object", - "properties" : { - "deleteOutdatedRoutes" : { - "type" : "boolean" - } - }, - "title" : "RoutingOptions" - }, - "ServiceCosts" : { - "type" : "object", - "required" : [ "listing" ], - "properties" : { - "listing" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "float" - } - } - }, - "title" : "ServiceCosts" - }, - "SimpleMessageResponse" : { - "type" : "object", - "required" : [ "message" ], - "properties" : { - "message" : { - "type" : "string" - } - }, - "title" : "SimpleMessageResponse" - }, - "Timestamp" : { - "type" : "object", - "properties" : { - "date" : { - "type" : "integer", - "format" : "int32" - }, - "day" : { - "type" : "integer", - "format" : "int32" - }, - "hours" : { - "type" : "integer", - "format" : "int32" - }, - "minutes" : { - "type" : "integer", - "format" : "int32" - }, - "month" : { - "type" : "integer", - "format" : "int32" - }, - "nanos" : { - "type" : "integer", - "format" : "int32" - }, - "seconds" : { - "type" : "integer", - "format" : "int32" - }, - "time" : { - "type" : "integer", - "format" : "int64" - }, - "timezoneOffset" : { - "type" : "integer", - "format" : "int32" - }, - "year" : { - "type" : "integer", - "format" : "int32" - } - }, - "title" : "Timestamp" - }, - "TransferReceiveInfo" : { - "type" : "object", - "required" : [ "holderOrganizationId" ], - "properties" : { - "holderOrganizationId" : { - "type" : "string", - "example" : "de.id4i", - "description" : "The current holder of the object", - "allowEmptyValue" : false - }, - "keepOwnership" : { - "type" : "boolean", - "example" : true, - "description" : "Keep the public ownership while transferring the object", - "readOnly" : true, - "allowEmptyValue" : false - }, - "nextScanOwnership" : { - "type" : "boolean", - "example" : false, - "description" : "Allow anyone which scans or knows the ID4N to obtain this object", - "readOnly" : true, - "allowEmptyValue" : false - }, - "ownerOrganizationId" : { - "type" : "string", - "example" : "de.bluerain", - "description" : "The current publicly visible owner of the object", - "readOnly" : true, - "allowEmptyValue" : false - }, - "recipientOrganizationIds" : { - "type" : "array", - "example" : [ "de.acme", "com.porsche", "com.example" ], - "description" : "Allow only these organizations to obtain this object", - "readOnly" : true, - "allowEmptyValue" : false, - "items" : { - "type" : "string" - } - } - }, - "title" : "TransferReceiveInfo" - }, - "TransferSendInfo" : { - "type" : "object", - "required" : [ "keepOwnership", "nextScanOwnership", "recipientOrganizationIds" ], - "properties" : { - "holderOrganizationId" : { - "type" : "string", - "example" : "de.id4i", - "description" : "The current holder of the object", - "readOnly" : true, - "allowEmptyValue" : false - }, - "keepOwnership" : { - "type" : "boolean", - "example" : true, - "description" : "Keep the public ownership while transferring the object", - "allowEmptyValue" : false - }, - "nextScanOwnership" : { - "type" : "boolean", - "example" : false, - "description" : "Allow anyone which scans or knows the ID4N to obtain this object", - "allowEmptyValue" : false - }, - "ownerOrganizationId" : { - "type" : "string", - "example" : "de.bluerain", - "description" : "The current publicly visible owner of the object", - "readOnly" : true, - "allowEmptyValue" : false - }, - "recipientOrganizationIds" : { - "type" : "array", - "example" : [ "de.acme", "com.porsche", "de.bluerain" ], - "description" : "Allow only these organizations to obtain this object", - "allowEmptyValue" : false, - "items" : { - "type" : "string" - } - } - }, - "title" : "TransferSendInfo" - }, - "URI" : { - "type" : "object", - "properties" : { - "absolute" : { - "type" : "boolean" - }, - "authority" : { - "type" : "string" - }, - "fragment" : { - "type" : "string" - }, - "host" : { - "type" : "string" - }, - "opaque" : { - "type" : "boolean" - }, - "path" : { - "type" : "string" - }, - "port" : { - "type" : "integer", - "format" : "int32" - }, - "query" : { - "type" : "string" - }, - "rawAuthority" : { - "type" : "string" - }, - "rawFragment" : { - "type" : "string" - }, - "rawPath" : { - "type" : "string" - }, - "rawQuery" : { - "type" : "string" - }, - "rawSchemeSpecificPart" : { - "type" : "string" - }, - "rawUserInfo" : { - "type" : "string" - }, - "scheme" : { - "type" : "string" - }, - "schemeSpecificPart" : { - "type" : "string" - }, - "userInfo" : { - "type" : "string" - } - }, - "title" : "URI" - }, - "URL" : { - "type" : "object", - "properties" : { - "authority" : { - "type" : "string" - }, - "content" : { - "type" : "object" - }, - "defaultPort" : { - "type" : "integer", - "format" : "int32" - }, - "file" : { - "type" : "string" - }, - "host" : { - "type" : "string" - }, - "path" : { - "type" : "string" - }, - "port" : { - "type" : "integer", - "format" : "int32" - }, - "protocol" : { - "type" : "string" - }, - "query" : { - "type" : "string" - }, - "ref" : { - "type" : "string" - }, - "userInfo" : { - "type" : "string" - } - }, - "title" : "URL" - }, - "UserPresentation" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "xml" : { - "name" : "id", - "attribute" : false, - "wrapped" : false - } - }, - "name" : { - "type" : "string" - } - }, - "title" : "UserPresentation" - }, - "UserRegistrationRequest" : { - "type" : "object", - "required" : [ "email", "password", "username" ], - "properties" : { - "username" : { - "type" : "string", - "pattern" : "[a-zA-Z0-9_.-]{6,50}" - }, - "password" : { - "type" : "string", - "minLength" : 8, - "maxLength" : 99 - }, - "email" : { - "type" : "string" - } - }, - "title" : "UserRegistrationRequest" - }, - "UserRegistrationResponse" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "email" : { - "type" : "string" - }, - "id" : { - "type" : "integer", - "format" : "int64" - }, - "message" : { - "type" : "string" - }, - "username" : { - "type" : "string" - } - }, - "title" : "UserRegistrationResponse" - }, - "UserRoles" : { - "type" : "object", - "properties" : { - "roles" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "user" : { - "$ref" : "#/definitions/UserPresentation" - } - }, - "title" : "UserRoles" - }, - "Visibility" : { - "type" : "object", - "properties" : { - "public" : { - "type" : "boolean", - "example" : true, - "description" : "Document is publicly readable (if ID4N is owned by the same organization)", - "allowEmptyValue" : false - }, - "sharedOrganizationIds" : { - "type" : "array", - "example" : [ "de.acme", "com.porsche", "de.bluerain" ], - "description" : "Document is readable by these organizations (independend of ID4N ownership)", - "allowEmptyValue" : false, - "items" : { - "type" : "string" - } - } - }, - "title" : "Visibility" - }, - "VisibilityUpdate" : { - "type" : "object", - "properties" : { - "public" : { - "type" : "boolean", - "example" : true, - "description" : "Document is publicly readable (if ID4N is owned by the same organization)", - "allowEmptyValue" : false - }, - "sharedWithOrganizationIds" : { - "type" : "array", - "example" : [ 101, 102, 103 ], - "description" : "Document is readable by these organizations (independend of ID4N ownership)", - "allowEmptyValue" : false, - "items" : { - "type" : "string" - } - } - }, - "title" : "VisibilityUpdate" - }, - "WhoIsResponse" : { - "type" : "object", - "properties" : { - "aliases" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "organization" : { - "$ref" : "#/definitions/Organization" - }, - "organizationAddress" : { - "$ref" : "#/definitions/OrganizationAddress" - } - }, - "title" : "WhoIsResponse" - } - } -} \ No newline at end of file diff --git a/src/main/resources/old-swagger.json b/src/main/resources/old-swagger.json deleted file mode 100644 index 2626a416..00000000 --- a/src/main/resources/old-swagger.json +++ /dev/null @@ -1,10344 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "ID4i HTTP API", - "version" : "0.3.3-SNAPSHOT", - "title" : "ID4i API", - "termsOfService" : "http://id4i.de", - "contact" : { - "name" : "BlueRain Software GmbH & Co. KG", - "url" : "http://bluerain.de", - "email" : "info@bluerain.de" - }, - "license" : { - "name" : "MIT", - "url" : "https://opensource.org/licenses/MIT" - }, - "x-logo" : { - "backgroundColor" : "#FAFAFA", - "url" : "/static/logo.png" - } - }, - "host" : "backend.id4i.de", - "basePath" : "/", - "tags" : [ { - "name" : "Accounts", - "description" : "User accounts allows people to register for ID4i and login. All permissions and roles for interactive ID4i usage (as opposed to machine-to-machine interactions) are attached to Organizations and User Accounts. The API allows users to register, verify their registration, login and reset their passwords." - }, { - "name" : "Alias", - "description" : "Guid Alias Controller" - }, { - "name" : "Api Keys", - "description" : "Api Key Controller" - }, { - "name" : "Billing", - "description" : "Billing Controller" - }, { - "name" : "Collections", - "description" : "Collection Controller" - }, { - "name" : "Guids", - "description" : "Guid Alias Controller" - }, { - "name" : "Images", - "description" : "Public Image Controller" - }, { - "name" : "Meta Information", - "description" : "App Info Controller" - }, { - "name" : "Organizations", - "description" : "Country Controller" - }, { - "name" : "Public Services", - "description" : "Go Controller" - }, { - "name" : "Routing", - "description" : "Routing Controller" - }, { - "name" : "Storage", - "description" : "Document Storage Controller" - }, { - "name" : "WhoIs", - "description" : "Who Is Controller" - } ], - "consumes" : [ "application/xml", "application/json" ], - "produces" : [ "application/xml", "application/json" ], - "paths" : { - "/account/password" : { - "post" : { - "tags" : [ "Accounts" ], - "summary" : "Request password reset", - "description" : "Requesting a reset for a new password. ", - "operationId" : "requestPasswordReset", - "parameters" : [ { - "in" : "body", - "name" : "resetRequest", - "description" : "Contains the required information to request a new password.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PasswordResetRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/SimpleMessageResponse" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - }, - "put" : { - "tags" : [ "Accounts" ], - "summary" : "Verify password reset", - "description" : "Setting a new password and verifying the request to set the password.", - "operationId" : "verifyPasswordReset", - "parameters" : [ { - "in" : "body", - "name" : "verificationRequest", - "description" : "Contains the new password and the verification token to set the new password.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PasswordResetVerificationRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/SimpleMessageResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/account/registration" : { - "post" : { - "tags" : [ "Accounts" ], - "summary" : "Register user", - "description" : "Registering a new user.", - "operationId" : "registerUser", - "parameters" : [ { - "in" : "body", - "name" : "userRegistration", - "description" : "The user information about the new created user.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserRegistrationRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/UserRegistrationResponse" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - }, - "put" : { - "tags" : [ "Accounts" ], - "summary" : "Complete registration", - "description" : "Completing a registration e.g. for invited users. Finish registration with a username and a password.", - "operationId" : "completeRegistration", - "parameters" : [ { - "in" : "body", - "name" : "completeRegistration", - "description" : "Contains the verification token, the username and the initial password.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CompleteUserRegistrationRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/account/verification" : { - "post" : { - "tags" : [ "Accounts" ], - "summary" : "Verify registration", - "description" : "Verifies a new user registration.", - "operationId" : "verifyUserRegistration", - "parameters" : [ { - "in" : "body", - "name" : "token", - "description" : "The token for user verification.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistrationVerificationTokenPresentation" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/api/v1/apikeys" : { - "get" : { - "tags" : [ "Api Keys" ], - "summary" : "Find API key by organization", - "description" : "Finding all API key assigned to the specified organization in a paginated manner.", - "operationId" : "listAllApiKeysOfOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "query", - "description" : "The id of the organization to search in.", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedApiKeyResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "Api Keys" ], - "summary" : "Create API key", - "description" : "Creation of a new API key.", - "operationId" : "createNewApiKey", - "parameters" : [ { - "in" : "body", - "name" : "creationRequest", - "description" : "API key to be created.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ApiKeyCreationRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ApiKeyPresentation" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/apikeys/privileges" : { - "get" : { - "tags" : [ "Api Keys" ], - "summary" : "List all privileges", - "description" : "Listing all possible API key privileges.", - "operationId" : "listAllApiKeyPrivileges", - "parameters" : [ { - "name" : "id4nConcerning", - "in" : "query", - "description" : "id4nConcerning", - "required" : false, - "type" : "boolean" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ApiKeyPrivilegeInfoResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/apikeys/{key}" : { - "get" : { - "tags" : [ "Api Keys" ], - "summary" : "Show API key", - "description" : "Showing the details of an API key.", - "operationId" : "getApiKey", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "The API key to show.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ApiKeyPresentation" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Api Keys" ], - "summary" : "Update API keys", - "description" : "API keys can be updated with new labels, and be activated and deactivated. The secret or UUID cannot be changed.", - "operationId" : "updateApiKey", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "The API key to be updated.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "apiKeyChange", - "description" : "The new values to apply.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ApiKeyChangeRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Api Keys" ], - "summary" : "Delete API key", - "description" : "Deletion of an API key.", - "operationId" : "deleteApiKey", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "The API key to delete.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/apikeys/{key}/privileges" : { - "get" : { - "tags" : [ "Api Keys" ], - "summary" : "List privileges", - "operationId" : "listApiKeyPrivileges", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ApiKeyPrivilegePaginatedResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "Api Keys" ], - "summary" : "Add privilege", - "operationId" : "addApiKeyPrivilege", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "addApiKeyPrivilegeRequest", - "description" : "addApiKeyPrivilegeRequest", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AddApiKeyPrivilegeRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Api Keys" ], - "summary" : "Remove privilege", - "operationId" : "removeApiKeyPrivilege", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "removeApiKeyPrivilegeRequest", - "description" : "removeApiKeyPrivilegeRequest", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoveApiKeyPrivilegeRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/apikeys/{key}/privileges/{privilege}/id4ns" : { - "get" : { - "tags" : [ "Api Keys" ], - "summary" : "ID4ns of a privilege", - "description" : "Listing ID4ns of a id4n concerning privilege", - "operationId" : "listId4ns", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "name" : "privilege", - "in" : "path", - "description" : "privilege", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Id4nPresentationPaginatedResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "Api Keys" ], - "summary" : "Add ID4ns of a privilege", - "operationId" : "addApiKeyPrivilegeForId4ns", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "name" : "privilege", - "in" : "path", - "description" : "privilege", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "id4ns", - "description" : "id4ns", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Api Keys" ], - "summary" : "Remove id4ns of a privilege", - "operationId" : "removeApiKeyPrivilegeForId4ns", - "parameters" : [ { - "name" : "key", - "in" : "path", - "description" : "key", - "required" : true, - "type" : "string" - }, { - "name" : "privilege", - "in" : "path", - "description" : "privilege", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "id4ns", - "description" : "id4ns", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/billing/{organizationId}" : { - "get" : { - "tags" : [ "Billing" ], - "summary" : "Get billing amount of services for a given organization", - "operationId" : "getSumForOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The organization to compute the billing information for", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "fromDate", - "in" : "query", - "description" : "Billing start date", - "required" : false, - "type" : "string", - "format" : "date-time" - }, { - "name" : "toDate", - "in" : "query", - "description" : "Billing end date", - "required" : false, - "type" : "string", - "format" : "date-time" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ServiceCosts" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/billing/{organizationId}/positions" : { - "get" : { - "tags" : [ "Billing" ], - "summary" : "Get billing positions for a given organization", - "operationId" : "getPositionsForOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The organization to compute the billing information for", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "fromDate", - "in" : "query", - "description" : "Billing start date", - "required" : false, - "type" : "string", - "format" : "date-time" - }, { - "name" : "toDate", - "in" : "query", - "description" : "Billing end date", - "required" : false, - "type" : "string", - "format" : "date-time" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BillingPosition" - } - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/labelled" : { - "post" : { - "tags" : [ "Collections" ], - "summary" : "Create labelled collection", - "operationId" : "createLabelledCollection", - "parameters" : [ { - "in" : "body", - "name" : "createInfo", - "description" : "createInfo", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateLabelledCollectionRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Id4n" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/labelled/{collectionId4n}/elements" : { - "post" : { - "tags" : [ "Collections" ], - "summary" : "Add elements to labelled collection", - "operationId" : "addElementsToLabelledCollection", - "parameters" : [ { - "name" : "collectionId4n", - "in" : "path", - "description" : "collectionId4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "listOfGuids", - "description" : "listOfGuids", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Collections" ], - "summary" : "Remove elements from labelled collection", - "operationId" : "removeElementsFromLabelledCollection", - "parameters" : [ { - "name" : "collectionId4n", - "in" : "path", - "description" : "collectionId4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "listOfGuids", - "description" : "listOfGuids", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/labelled/{id4n}" : { - "get" : { - "tags" : [ "Collections" ], - "summary" : "Find labelled collection", - "operationId" : "findLabelledCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Collections" ], - "summary" : "Set labelled collection values", - "description" : "Update labelled collection replacing all values but the ID", - "operationId" : "setLabelledCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Collections" ], - "summary" : "Delete labelled collection", - "operationId" : "deleteLabelledCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "patch" : { - "tags" : [ "Collections" ], - "summary" : "Update labelled collection", - "description" : "Update labelled collection updating only the given values", - "operationId" : "updateLabelledCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "204" : { - "description" : "No Content" - }, - "401" : { - "description" : "Unauthorized" - }, - "403" : { - "description" : "Forbidden" - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/labelled/{id4n}/elements" : { - "get" : { - "tags" : [ "Collections" ], - "summary" : "List contents of the collection", - "operationId" : "listElementsOfLabelledCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedGuidResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/logistic" : { - "post" : { - "tags" : [ "Collections" ], - "summary" : "Create logistic collection", - "operationId" : "createLogisticCollection", - "parameters" : [ { - "in" : "body", - "name" : "createInfo", - "description" : "createInfo", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateLogisticCollectionRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Id4n" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/logistic/{collectionId4n}/elements" : { - "post" : { - "tags" : [ "Collections" ], - "summary" : "Add elements to logistic collection", - "operationId" : "addElementsToLogisticCollection", - "parameters" : [ { - "name" : "collectionId4n", - "in" : "path", - "description" : "collectionId4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "listOfGuids", - "description" : "listOfGuids", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Collections" ], - "summary" : "Remove elements from logistic collection", - "operationId" : "removeElementsFromLogisticCollection", - "parameters" : [ { - "name" : "collectionId4n", - "in" : "path", - "description" : "collectionId4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "listOfGuids", - "description" : "listOfGuids", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/logistic/{id4n}" : { - "get" : { - "tags" : [ "Collections" ], - "summary" : "Find logistic collection", - "operationId" : "findLogisticCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Collections" ], - "summary" : "Replace logistic collection", - "description" : "Update logistic collection replacing all values but the ID", - "operationId" : "setLogisticCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Collections" ], - "summary" : "Delete logistic collection", - "operationId" : "deleteLogisticCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "patch" : { - "tags" : [ "Collections" ], - "summary" : "Update logistic collection", - "description" : "Update logistic collection updating only the given values", - "operationId" : "updateLogisticCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "204" : { - "description" : "No Content" - }, - "401" : { - "description" : "Unauthorized" - }, - "403" : { - "description" : "Forbidden" - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/logistic/{id4n}/elements" : { - "get" : { - "tags" : [ "Collections" ], - "summary" : "List contents of the collection", - "operationId" : "listElementsOfLogisticCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedGuidResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/routing" : { - "post" : { - "tags" : [ "Collections" ], - "summary" : "Create routing collecton", - "operationId" : "createRoutingCollection", - "parameters" : [ { - "in" : "body", - "name" : "createInfo", - "description" : "createInfo", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateRoutingCollectionRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Id4n" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/routing/{collectionId4n}/elements" : { - "post" : { - "tags" : [ "Collections" ], - "summary" : "Add element to routing collection", - "operationId" : "addElementsToRoutingCollection", - "parameters" : [ { - "name" : "collectionId4n", - "in" : "path", - "description" : "collectionId4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "listOfGuids", - "description" : "listOfGuids", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Collections" ], - "summary" : "Remove elements from routing collection", - "operationId" : "removeElementsFromRoutingCollection", - "parameters" : [ { - "name" : "collectionId4n", - "in" : "path", - "description" : "collectionId4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "listOfGuids", - "description" : "listOfGuids", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/routing/{id4n}" : { - "get" : { - "tags" : [ "Collections" ], - "summary" : "Find routing collection", - "operationId" : "findRoutingCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Collections" ], - "summary" : "Update routing collection", - "operationId" : "setRoutingCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Collections" ], - "summary" : "Delete routing collection", - "operationId" : "deleteRoutingCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "patch" : { - "tags" : [ "Collections" ], - "summary" : "Update routing collection", - "description" : "Update routing collection updating only the given values", - "operationId" : "updateRoutingCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "204" : { - "description" : "No Content" - }, - "401" : { - "description" : "Unauthorized" - }, - "403" : { - "description" : "Forbidden" - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/routing/{id4n}/elements" : { - "get" : { - "tags" : [ "Collections" ], - "summary" : "List contents of the collection", - "operationId" : "listElementsOfRoutingCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedGuidResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/{id4n}" : { - "get" : { - "tags" : [ "Collections" ], - "summary" : "Find collection", - "operationId" : "findCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Collections" ], - "summary" : "Set collection", - "description" : "Update collection replacing all values but the ID", - "operationId" : "setCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Collections" ], - "summary" : "Delete collection", - "operationId" : "deleteCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "patch" : { - "tags" : [ "Collections" ], - "summary" : "Update collection", - "description" : "Update collection changing only the given values", - "operationId" : "updateCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidCollection" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "204" : { - "description" : "No Content" - }, - "401" : { - "description" : "Unauthorized" - }, - "403" : { - "description" : "Forbidden" - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/collections/{id4n}/elements" : { - "get" : { - "tags" : [ "Collections" ], - "summary" : "List contents of the collection", - "operationId" : "listElementsOfCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedGuidResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "Collections" ], - "summary" : "Add elements to collection", - "operationId" : "addElementsToCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "listOfGuids", - "description" : "listOfGuids", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Collections" ], - "summary" : "Remove elements from collection", - "operationId" : "removeElementsFromCollection", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "listOfGuids", - "description" : "listOfGuids", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/countries" : { - "get" : { - "tags" : [ "Organizations" ], - "summary" : "List countries", - "operationId" : "listCountries", - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedCountryResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/documents/{id4n}" : { - "get" : { - "tags" : [ "Storage" ], - "summary" : "List documents", - "description" : "Listing all documents of an id4n", - "operationId" : "listAllDocuments", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedOwnedDocumentResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/documents/{id4n}/{organizationId}" : { - "get" : { - "tags" : [ "Storage" ], - "summary" : "List organization specific documents", - "description" : "Listing documents of an id4n owned by a specified organization", - "operationId" : "listDocuments", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedDocumentResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Storage" ], - "summary" : "Create an empty document for an id4n", - "description" : "The document is created empty, mime-type defaults to text/plain", - "operationId" : "createDocument", - "consumes" : [ "multipart/form-data" ], - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "content", - "in" : "formData", - "description" : "content", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Document" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/documents/{id4n}/{organizationId}/{fileName}" : { - "get" : { - "tags" : [ "Storage" ], - "summary" : "Read document contents", - "operationId" : "readDocument", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "string", - "format" : "byte" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Storage" ], - "summary" : "Delete a document", - "operationId" : "deleteDocument", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ResponseEntity" - } - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata" : { - "get" : { - "tags" : [ "Storage" ], - "summary" : "Retrieve a document (meta-data only, no content)", - "operationId" : "getDocument", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Document" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "patch" : { - "tags" : [ "Storage" ], - "summary" : "Update a document", - "operationId" : "updateDocumentMetadata", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "document", - "description" : "document", - "required" : true, - "schema" : { - "$ref" : "#/definitions/DocumentUpdate" - } - }, { - "required" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Document" - } - }, - "204" : { - "description" : "No Content" - }, - "401" : { - "description" : "Unauthorized" - }, - "403" : { - "description" : "Forbidden" - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/guids" : { - "post" : { - "tags" : [ "Guids" ], - "summary" : "Create GUID(s)", - "description" : "Creating one or more GUIDs with a specified length.", - "operationId" : "createGuid", - "parameters" : [ { - "in" : "body", - "name" : "createGUIDInfo", - "description" : "createGUIDInfo", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateGuidRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/ListOfId4ns" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/guids/withoutCollection" : { - "get" : { - "tags" : [ "Guids" ], - "summary" : "Retrieve GUIDs not in any collection", - "operationId" : "getGuidsWithoutCollection", - "parameters" : [ { - "name" : "organizationId", - "in" : "query", - "description" : "Organization to search GUIDs for (required).", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedResponse«Guid»" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/guids/{id4n}" : { - "get" : { - "tags" : [ "Guids" ], - "summary" : "Retrieve GUID information", - "operationId" : "getGuid", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID number", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Guid" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Guids" ], - "summary" : "Change GUID information.", - "description" : "Allows ownership transfer.", - "operationId" : "setGuid", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID number", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Guid" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "patch" : { - "tags" : [ "Guids" ], - "summary" : "Change GUID information.", - "description" : "Allows ownership transfer.", - "operationId" : "setGuid_1", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID number", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "request", - "description" : "request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Guid" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "204" : { - "description" : "No Content" - }, - "401" : { - "description" : "Unauthorized" - }, - "403" : { - "description" : "Forbidden" - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/guids/{id4n}/alias" : { - "get" : { - "tags" : [ "Alias", "Guids" ], - "summary" : "Get all aliases for the given GUID", - "description" : "Looks up the alias for each alias type (group and single GUID) and returns all found ones", - "operationId" : "getGuidAliases", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID to operate on", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/guids/{id4n}/alias/{aliasType}" : { - "post" : { - "tags" : [ "Alias", "Guids" ], - "summary" : "Add alias for GUIDs", - "description" : "Adds or replaces aliases for single GUIDs (alias type item and mapp) or groups of GUIDs (alias types gtin, ean and article)", - "operationId" : "addGuidAlias", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID to operate on", - "required" : true, - "type" : "string" - }, { - "name" : "aliasType", - "in" : "path", - "description" : "Alias type, see the corresponding API model", - "required" : true, - "type" : "string", - "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking" ] - }, { - "in" : "body", - "name" : "alias", - "description" : "The alias to add or update", - "required" : true, - "schema" : { - "$ref" : "#/definitions/GuidAlias" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Alias", "Guids" ], - "summary" : "Remove aliases from GUIDs", - "description" : "Remove the alias of the given type", - "operationId" : "removeGuidAlias", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The GUID to operate on", - "required" : true, - "type" : "string" - }, { - "name" : "aliasType", - "in" : "path", - "description" : "Alias type, see the corresponding API model", - "required" : true, - "type" : "string", - "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking" ] - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/id4ns/{id4n}" : { - "get" : { - "tags" : [ "Guids" ], - "summary" : "Retrieve ID4n information", - "description" : "Retrieving basic information about an ID like the type and the creation time.", - "operationId" : "getId4n", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "The ID to resolve to", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Id4nPresentation" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/info" : { - "get" : { - "tags" : [ "Meta Information" ], - "summary" : "Retrieve version information about ID4i", - "description" : "Retrieving version information about ID4i.", - "operationId" : "applicationInfo", - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/AppInfoPresentation" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/microstorage/{id4n}/{organization}" : { - "get" : { - "tags" : [ "Storage" ], - "summary" : "Read data from microstorage", - "operationId" : "readFromMicrostorage", - "parameters" : [ { - "name" : "organization", - "in" : "path", - "description" : "organization", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "string", - "format" : "byte" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Storage" ], - "summary" : "Write data to microstorage", - "operationId" : "writeToMicrostorage", - "consumes" : [ "*/*" ], - "parameters" : [ { - "name" : "organization", - "in" : "path", - "description" : "organization", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "Content-Type", - "in" : "header", - "description" : "Content-Type", - "required" : false, - "type" : "string" - }, { - "name" : "Content-Length", - "in" : "header", - "description" : "Content-Length", - "required" : false, - "type" : "integer", - "format" : "int64" - }, { - "in" : "body", - "name" : "body", - "description" : "body", - "required" : false, - "schema" : { - "type" : "string", - "format" : "byte" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations" : { - "post" : { - "tags" : [ "Organizations" ], - "summary" : "Create organization", - "description" : "Creating a new organization.", - "operationId" : "createOrganization", - "parameters" : [ { - "in" : "body", - "name" : "organization", - "description" : "Organization to be created", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Organization" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Organization" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}" : { - "get" : { - "tags" : [ "Organizations" ], - "summary" : "Find organization by id", - "description" : "Returns a single organization.", - "operationId" : "findOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The id of the organization to be retrieved.", - "required" : true, - "type" : "integer", - "format" : "int64" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Organization" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Organizations" ], - "summary" : "Update organization", - "operationId" : "updateOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The id of the organization to be updated.", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "in" : "body", - "name" : "organization", - "description" : "Updated organization object", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Organization" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Organization" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Organizations" ], - "summary" : "Delete organization", - "operationId" : "deleteOrganization", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The id of the organization to be deleted.", - "required" : true, - "type" : "integer", - "format" : "int64" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/addresses/billing" : { - "get" : { - "tags" : [ "Organizations" ], - "summary" : "Retrieve billing address", - "operationId" : "findOrganizationBillingAddress", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Organizations" ], - "summary" : "Store billing address", - "operationId" : "updateOrganizationBillingAddress", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "in" : "body", - "name" : "addressResource", - "description" : "addressResource", - "required" : true, - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Organizations" ], - "summary" : "Remove billing address", - "operationId" : "deleteOrganizationBillingAddress", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/addresses/default" : { - "get" : { - "tags" : [ "Organizations" ], - "summary" : "Retrieve address", - "operationId" : "findOrganizationAddress", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Organizations" ], - "summary" : "Store address", - "operationId" : "updateOrganizationAddress", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "in" : "body", - "name" : "addressResource", - "description" : "addressResource", - "required" : true, - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/OrganizationAddress" - } - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/collections" : { - "get" : { - "tags" : [ "Collections", "Organizations" ], - "summary" : "Get collections of organization", - "description" : "Retrieving all collections of an organization in a paginated manner.", - "operationId" : "getAllCollectionsOfOrganization", - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "type", - "in" : "query", - "description" : "Filter by this type", - "required" : false, - "type" : "string", - "enum" : [ "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] - }, { - "name" : "label", - "in" : "query", - "description" : "Filter by this label", - "required" : false, - "type" : "string" - }, { - "name" : "labelPrefix", - "in" : "query", - "description" : "Filter by this label prefix", - "required" : false, - "type" : "string", - "maximum" : 2147483647, - "minimum" : 1 - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedGuidCollection" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/logo" : { - "post" : { - "tags" : [ "Organizations" ], - "summary" : "Update organization logo", - "description" : "Updating an organization logo using a multipart file upload.", - "operationId" : "setOrganizationLogo", - "consumes" : [ "multipart/form-data" ], - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The id of the organization where the logo should be updated.", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "file", - "in" : "formData", - "description" : "An image containing the new logo.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PublicImagePresentation" - } - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Organizations" ], - "summary" : "Delete organization logo", - "operationId" : "deleteOrganizationLogo", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "The id of the organization where the logo should be deleted.", - "required" : true, - "type" : "integer", - "format" : "int64" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/roles" : { - "get" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "List users and their roles", - "description" : "Listing users and their roles in a paginated manner.", - "operationId" : "getAllOrganizationRoles", - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedUserRolesResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/users" : { - "get" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Find users in organization", - "description" : "Finding users in the specified organization in a paginated manner.", - "operationId" : "getUsersOfOrganization", - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedUserPresentationResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/users/invite" : { - "post" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Invite Users", - "operationId" : "inviteUsers", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "in" : "body", - "name" : "invitationList", - "description" : "invitationList", - "required" : true, - "schema" : { - "$ref" : "#/definitions/OrganizationUserInvitationListRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/organizations/{organizationId}/users/{username}/roles" : { - "get" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Get user roles by username", - "operationId" : "getUserRoles", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "username", - "in" : "path", - "description" : "username", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedStringResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "post" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Add role(s) to user", - "operationId" : "addUserRoles", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "username", - "in" : "path", - "description" : "username", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "changeRoleRequest", - "description" : "changeRoleRequest", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ChangeRoleRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "201" : { - "description" : "Created" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "delete" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Remove role(s) from user", - "operationId" : "removeUserRoles", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "username", - "in" : "path", - "description" : "username", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "changeRoleRequest", - "description" : "changeRoleRequest", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ChangeRoleRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/documents/{id4n}" : { - "get" : { - "tags" : [ "Public Services", "Storage" ], - "summary" : "List organization specific documents", - "description" : "Listing documents of an id4n owned by a specified organization", - "operationId" : "listAllPublicDocuments", - "parameters" : [ { - "name" : "organizationId", - "in" : "query", - "description" : "organizationId", - "required" : false, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedOwnedDocumentResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/documents/{id4n}/{organizationId}" : { - "get" : { - "tags" : [ "Public Services", "Storage" ], - "summary" : "List organization specific documents", - "description" : "Listing documents of an id4n owned by a specified organization", - "operationId" : "listPublicDocuments", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedDocumentResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/documents/{id4n}/{organizationId}/{fileName}" : { - "get" : { - "tags" : [ "Public Services", "Storage" ], - "summary" : "Read document contents", - "operationId" : "readPublicDocument", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "string", - "format" : "byte" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata" : { - "get" : { - "tags" : [ "Public Services", "Storage" ], - "summary" : "Retrieve a document (meta-data only, no content)", - "operationId" : "getPublicDocument", - "parameters" : [ { - "name" : "organizationId", - "in" : "path", - "description" : "organizationId", - "required" : true, - "type" : "integer", - "format" : "int64" - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "fileName", - "in" : "path", - "description" : "fileName", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Document" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/public/image/{imageID}" : { - "get" : { - "tags" : [ "Images", "Public Services" ], - "summary" : "Resolve image", - "operationId" : "resolveImageUsingGET", - "parameters" : [ { - "name" : "imageID", - "in" : "path", - "description" : "The id of the image to be resolved.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "string", - "format" : "byte" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/roles" : { - "get" : { - "tags" : [ "Accounts" ], - "summary" : "List roles", - "description" : "Listing of roles.", - "operationId" : "listAllRoles", - "parameters" : [ { - "name" : "privilege", - "in" : "query", - "description" : "If specified the roles will be filtered containing that privilege.", - "required" : false, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/RoleResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/routingfiles/{id4n}" : { - "get" : { - "tags" : [ "Routing" ], - "summary" : "Retrieve routing file", - "operationId" : "getRoutingFile", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "organizationId", - "description" : "organizationId", - "required" : false, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/RoutingFile" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - }, - "put" : { - "tags" : [ "Routing" ], - "summary" : "Store routing file", - "operationId" : "updateRoutingFile", - "parameters" : [ { - "in" : "body", - "name" : "rfr", - "description" : "rfr", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RoutingFileRequest" - } - }, { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "202" : { - "description" : "Accepted" - }, - "400" : { - "description" : "Bad Request", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "409" : { - "description" : "Conflict", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/routingfiles/{id4n}/route/{type}" : { - "get" : { - "tags" : [ "Routing" ], - "summary" : "Retrieve current route of a GUID (or ID4N)", - "operationId" : "getRoute", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - }, { - "name" : "type", - "in" : "path", - "description" : "The type of route you want to have", - "required" : true, - "type" : "string" - }, { - "name" : "privateRoutes", - "in" : "query", - "description" : "privateRoutes", - "required" : false, - "type" : "boolean" - }, { - "name" : "publicRoutes", - "in" : "query", - "description" : "publicRoutes", - "required" : false, - "type" : "boolean" - }, { - "name" : "interpolate", - "in" : "query", - "description" : "interpolate", - "required" : false, - "type" : "boolean" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/Route" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/search/guids" : { - "get" : { - "tags" : [ "Alias" ], - "summary" : "Search for GUIDs by alias", - "operationId" : "searchByAlias", - "parameters" : [ { - "name" : "alias", - "in" : "query", - "description" : "The alias to search for", - "required" : true, - "type" : "string" - }, { - "name" : "aliasType", - "in" : "query", - "description" : "Alias type type to search for", - "required" : true, - "type" : "string", - "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking" ] - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedGuidResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/search/guids/aliases/types" : { - "get" : { - "tags" : [ "Alias" ], - "summary" : "List all supported alias types", - "description" : "Retrieve this list to find out all alias types to use with alias search and change operations", - "operationId" : "getGuidAliasTypes", - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "gtin", "article", "mapp", "item", "rfid", "tracking" ] - } - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/user/organizations" : { - "get" : { - "tags" : [ "Accounts", "Organizations" ], - "summary" : "Retrieve organizations of user", - "operationId" : "getOrganizationsOfUser", - "parameters" : [ { - "name" : "role", - "in" : "query", - "description" : "role", - "required" : false, - "type" : "string" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedOrganizationResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/users" : { - "get" : { - "tags" : [ "Accounts" ], - "summary" : "Find users", - "operationId" : "findUsers", - "parameters" : [ { - "name" : "usernamePrefix", - "in" : "query", - "description" : "Find users starting with this prefix.", - "required" : true, - "type" : "string", - "pattern" : "[a-zA-Z0-9_.-]{2,50}" - }, { - "name" : "offset", - "in" : "query", - "description" : "Start with the n-th element", - "required" : false, - "type" : "integer", - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "The maximum count of returned elements", - "required" : false, - "type" : "integer", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/PaginatedUserPresentationResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/api/v1/users/{username}" : { - "get" : { - "tags" : [ "Accounts" ], - "summary" : "Find by username", - "operationId" : "findUserByUsername", - "parameters" : [ { - "name" : "username", - "in" : "path", - "description" : "username", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/UserPresentation" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - }, - "security" : [ { - "Authorization" : [ "id4i" ] - } ] - } - }, - "/go/{guid}" : { - "get" : { - "tags" : [ "Public Services" ], - "summary" : "Forward", - "description" : "Forwarding to the designated route defined in the routing,", - "operationId" : "go", - "parameters" : [ { - "name" : "guid", - "in" : "path", - "description" : "guid", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/login" : { - "post" : { - "tags" : [ "Accounts" ], - "description" : "ID4i API Login", - "operationId" : "login", - "parameters" : [ { - "in" : "body", - "name" : "account-credentials", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccountCredentials" - } - } ], - "responses" : { - "200" : { - "description" : "OK" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - }, - "/whois/{id4n}" : { - "get" : { - "tags" : [ "Public Services", "WhoIs" ], - "summary" : "Resolve owner of id4n", - "operationId" : "resolveWhoIsEntry", - "parameters" : [ { - "name" : "id4n", - "in" : "path", - "description" : "id4n", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/WhoIsResponse" - } - }, - "202" : { - "description" : "Accepted" - }, - "401" : { - "description" : "Unauthorized", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "403" : { - "description" : "Forbidden", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "404" : { - "description" : "Not Found", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "405" : { - "description" : "Method not allowed", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "406" : { - "description" : "Not Acceptable", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "415" : { - "description" : "Unsupported Media Type", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - }, - "500" : { - "description" : "Internal Server Error", - "schema" : { - "$ref" : "#/definitions/ApiError" - } - } - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - } - }, - "definitions" : { - "AccountCredentials" : { - "type" : "object", - "properties" : { - "login" : { - "type" : "string" - }, - "password" : { - "type" : "string" - } - }, - "title" : "AccountCredentials" - }, - "AddApiKeyPrivilegeRequest" : { - "type" : "object", - "required" : [ "privilege" ], - "properties" : { - "privilege" : { - "type" : "string" - } - }, - "title" : "AddApiKeyPrivilegeRequest" - }, - "ApiError" : { - "type" : "object", - "properties" : { - "code" : { - "type" : "string", - "enum" : [ "ERR_REGISTRATION_VERIFICATION_NO_TOKEN", "ERR_REGISTRATION_VERIFICATION_INVALID_TOKEN", "ERR_REGISTRATION_VERIFICATION_EXPIRED_TOKEN", "ERR_AUTHENTICATION_NO_TOKEN", "ERR_AUTHENTICATION_INVALID_TOKEN", "ERR_AUTHENTICATION_EXPIRED_TOKEN", "ERR_AUTHENTICATION_FAILED", "ERR_AUTHORIZATION_MISSING_PRIVILEGES", "ERR_AUTHORIZATION_FORBIDDEN", "ERR_INPUT_VALIDATION_FAILED", "ERR_FIELD_INPUT_VALIDATION_FAILED", "ERR_VALIDATION_CONSTRAINT_FAILED", "ERR_INPUT_NOT_READABLE", "ERR_INVALID_INPUT_PARAMETER", "ERR_GUID_CREATION", "ERR_INVALID_ID4N_OBJECT_TYPE", "ERR_COLLECTION_UPDATE_DENIED", "ERR_ENTITY_NOT_FOUND", "ERR_ENTITY_TOO_BIG", "ERR_DUPLICATE", "ERR_INTERNAL", "ERR_UNKNOWN", "ERR_INVALID_ORGANIZATION_USERROLE", "ERR_ORGANIZATION_ROLE_INCONSISTENCY", "ERR_ORGANIZATION_NOT_DELETABLE", "ERR_USER_ALREADY_IN_ORGANIZATION", "ERR_USER_INVITATION_NEEDS_MINIMUM_ONE_ROLE", "ERR_USER_INVITATION_SPECIFY_EMAIL_OR_USERNAME", "ERR_LANGUAGE_NOT_SUPPORTED", "ERR_EMAIL_MISSING_TEMPLATE_PARAM", "ERR_EMAIL_TEMPLATE_NOT_AVAILABLE", "ERR_EMAIL_PREPARATION_FAILED", "ERR_IMAGE_CONVERSION", "ERR_UPLOAD_TOO_LARGE", "ERR_INVALID_ALIAS_TYPE", "ERR_INVALID_URI_TEMPLATE", "ERR_INVALID_URI_TEMPLATE_VARIABLE", "ERR_MODULE_NOT_ACTIVE", "ERR_INSECURE_PASSWORD" ] - }, - "errorId" : { - "type" : "string" - }, - "errorList" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ApiError" - } - }, - "message" : { - "type" : "string" - } - }, - "title" : "ApiError" - }, - "ApiKeyChangeRequest" : { - "type" : "object", - "required" : [ "newLabel" ], - "properties" : { - "active" : { - "type" : "boolean" - }, - "newLabel" : { - "type" : "string", - "minLength" : 5, - "maxLength" : 50 - } - }, - "title" : "ApiKeyChangeRequest" - }, - "ApiKeyCreationRequest" : { - "type" : "object", - "required" : [ "label", "organizationId", "secret" ], - "properties" : { - "label" : { - "type" : "string", - "minLength" : 5, - "maxLength" : 50 - }, - "organizationId" : { - "type" : "integer", - "format" : "int64" - }, - "secret" : { - "type" : "string", - "minLength" : 10, - "maxLength" : 500 - } - }, - "title" : "ApiKeyCreationRequest" - }, - "ApiKeyPresentation" : { - "type" : "object", - "required" : [ "active", "createdAt", "createdBy", "key", "label", "organizationId" ], - "properties" : { - "active" : { - "type" : "boolean", - "example" : true, - "description" : "Whether this API key is active", - "allowEmptyValue" : false - }, - "createdAt" : { - "type" : "integer", - "format" : "int64", - "example" : 1517232722, - "description" : "The UTC unix timestamp of when this api key has been created", - "allowEmptyValue" : false - }, - "createdBy" : { - "type" : "string", - "example" : "user123", - "allowEmptyValue" : false - }, - "key" : { - "type" : "string", - "example" : "39978f49-6ff1-4147-bf0f-9910185084b7", - "description" : "The api key identifier", - "allowEmptyValue" : false - }, - "label" : { - "type" : "string", - "example" : "My Api Key", - "description" : "The label / name of the api key", - "allowEmptyValue" : false - }, - "organizationId" : { - "type" : "integer", - "format" : "int64", - "example" : 10, - "description" : "The organization id this api key belongs to", - "allowEmptyValue" : false - } - }, - "title" : "ApiKeyPresentation" - }, - "ApiKeyPrivilege" : { - "type" : "object", - "required" : [ "id4nAssociated", "privilege" ], - "properties" : { - "id4nAssociated" : { - "type" : "boolean" - }, - "privilege" : { - "type" : "string" - } - }, - "title" : "ApiKeyPrivilege" - }, - "ApiKeyPrivilegeInfo" : { - "type" : "object", - "required" : [ "id4nAssociated", "name" ], - "properties" : { - "helpText" : { - "type" : "string" - }, - "id4nAssociated" : { - "type" : "boolean" - }, - "name" : { - "type" : "string" - } - }, - "title" : "ApiKeyPrivilegeInfo" - }, - "ApiKeyPrivilegeInfoResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPrivilegeInfo" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "ApiKeyPrivilegeInfoResponse" - }, - "ApiKeyPrivilegePaginatedResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPrivilege" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "ApiKeyPrivilegePaginatedResponse" - }, - "AppInfoPresentation" : { - "type" : "object", - "properties" : { - "branch" : { - "type" : "string" - }, - "commitTime" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "revision" : { - "type" : "string" - }, - "version" : { - "type" : "string" - } - }, - "title" : "AppInfoPresentation" - }, - "BillingPosition" : { - "type" : "object", - "required" : [ "count", "description", "service", "sum" ], - "properties" : { - "count" : { - "type" : "integer", - "format" : "int64" - }, - "description" : { - "type" : "string" - }, - "service" : { - "type" : "string" - }, - "sum" : { - "type" : "number", - "format" : "float" - } - }, - "title" : "BillingPosition" - }, - "ChangeRoleRequest" : { - "type" : "object", - "required" : [ "roles" ], - "properties" : { - "roles" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, - "title" : "ChangeRoleRequest" - }, - "CompleteUserRegistrationRequest" : { - "type" : "object", - "required" : [ "password", "username", "verificationToken" ], - "properties" : { - "password" : { - "type" : "string", - "minLength" : 8, - "maxLength" : 99 - }, - "username" : { - "type" : "string", - "pattern" : "[a-zA-Z0-9_.-]{6,50}" - }, - "verificationToken" : { - "type" : "string" - } - }, - "title" : "CompleteUserRegistrationRequest" - }, - "Country" : { - "type" : "object", - "required" : [ "code", "name" ], - "properties" : { - "code" : { - "type" : "string" - }, - "name" : { - "type" : "string" - } - }, - "title" : "Country" - }, - "CreateGuidRequest" : { - "type" : "object", - "required" : [ "count", "length", "organizationId" ], - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "example" : 1, - "description" : "The total number of GUIDs to create", - "allowEmptyValue" : false, - "minimum" : 1.0, - "maximum" : 1000.0, - "exclusiveMinimum" : false, - "exclusiveMaximum" : false - }, - "length" : { - "type" : "integer", - "format" : "int32", - "example" : 40, - "description" : "The charactersequence length of the GUID", - "allowEmptyValue" : false, - "minimum" : 6.0, - "maximum" : 255.0, - "exclusiveMinimum" : false, - "exclusiveMaximum" : false - }, - "organizationId" : { - "type" : "integer", - "format" : "int64", - "example" : 123, - "description" : "The id of the organization where the generated GUIDs should be assigned.", - "allowEmptyValue" : false - } - }, - "title" : "CreateGuidRequest", - "description" : "GUID creation information" - }, - "CreateLabelledCollectionRequest" : { - "type" : "object", - "required" : [ "label", "length", "organizationId" ], - "properties" : { - "label" : { - "type" : "string", - "minLength" : 1, - "maxLength" : 128 - }, - "length" : { - "type" : "integer", - "format" : "int32", - "minimum" : 6.0, - "maximum" : 255.0, - "exclusiveMinimum" : false, - "exclusiveMaximum" : false - }, - "organizationId" : { - "type" : "integer", - "format" : "int64" - } - }, - "title" : "CreateLabelledCollectionRequest" - }, - "CreateLogisticCollectionRequest" : { - "type" : "object", - "required" : [ "length", "organizationId" ], - "properties" : { - "label" : { - "type" : "string", - "minLength" : 1, - "maxLength" : 128 - }, - "length" : { - "type" : "integer", - "format" : "int32", - "minimum" : 6.0, - "maximum" : 255.0, - "exclusiveMinimum" : false, - "exclusiveMaximum" : false - }, - "organizationId" : { - "type" : "integer", - "format" : "int64" - } - }, - "title" : "CreateLogisticCollectionRequest" - }, - "CreateRoutingCollectionRequest" : { - "type" : "object", - "required" : [ "label", "length", "organizationId" ], - "properties" : { - "label" : { - "type" : "string", - "minLength" : 1, - "maxLength" : 128 - }, - "length" : { - "type" : "integer", - "format" : "int32", - "minimum" : 6.0, - "maximum" : 255.0, - "exclusiveMinimum" : false, - "exclusiveMaximum" : false - }, - "organizationId" : { - "type" : "integer", - "format" : "int64" - } - }, - "title" : "CreateRoutingCollectionRequest" - }, - "Document" : { - "type" : "object", - "properties" : { - "filename" : { - "type" : "string", - "example" : "publicInfo.pdf", - "description" : "File Name", - "allowEmptyValue" : false - }, - "mimeType" : { - "type" : "string", - "example" : "text/plain", - "description" : "Mime Type", - "allowEmptyValue" : false - }, - "visibility" : { - "description" : "Visibility configuration", - "allowEmptyValue" : false, - "$ref" : "#/definitions/Visibility" - } - }, - "title" : "Document" - }, - "DocumentUpdate" : { - "type" : "object", - "properties" : { - "filename" : { - "type" : "string", - "example" : "publicInfo.pdf", - "description" : "File Name", - "allowEmptyValue" : false - }, - "mimeType" : { - "type" : "string", - "example" : "text/plain", - "description" : "Mime Type", - "allowEmptyValue" : false - }, - "visibility" : { - "example" : true, - "description" : "Visibility configuration", - "allowEmptyValue" : false, - "$ref" : "#/definitions/VisibilityUpdate" - } - }, - "title" : "DocumentUpdate" - }, - "File" : { - "type" : "object", - "properties" : { - "absolute" : { - "type" : "boolean" - }, - "absoluteFile" : { - "$ref" : "#/definitions/File" - }, - "absolutePath" : { - "type" : "string" - }, - "canonicalFile" : { - "$ref" : "#/definitions/File" - }, - "canonicalPath" : { - "type" : "string" - }, - "directory" : { - "type" : "boolean" - }, - "file" : { - "type" : "boolean" - }, - "freeSpace" : { - "type" : "integer", - "format" : "int64" - }, - "hidden" : { - "type" : "boolean" - }, - "name" : { - "type" : "string" - }, - "parent" : { - "type" : "string" - }, - "parentFile" : { - "$ref" : "#/definitions/File" - }, - "path" : { - "type" : "string" - }, - "totalSpace" : { - "type" : "integer", - "format" : "int64" - }, - "usableSpace" : { - "type" : "integer", - "format" : "int64" - } - }, - "title" : "File" - }, - "Guid" : { - "type" : "object", - "properties" : { - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "example" : 1517232722, - "description" : "The UTC unix timestamp of when this GUID has been created", - "readOnly" : true, - "allowEmptyValue" : false - }, - "id4n" : { - "type" : "string", - "example" : "3THvgrWxqgTFC4", - "description" : "The ID", - "readOnly" : true, - "allowEmptyValue" : false - }, - "nextScanOwnership" : { - "type" : "boolean" - }, - "ownerOrganizationId" : { - "type" : "integer", - "format" : "int64" - } - }, - "title" : "Guid" - }, - "GuidAlias" : { - "type" : "object", - "properties" : { - "alias" : { - "type" : "string" - } - }, - "title" : "GuidAlias" - }, - "GuidCollection" : { - "type" : "object", - "properties" : { - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The UTC unix timestamp of when this collection has been created", - "readOnly" : true, - "allowEmptyValue" : false - }, - "id4n" : { - "type" : "string", - "description" : "The ID", - "readOnly" : true, - "allowEmptyValue" : false - }, - "label" : { - "type" : "string", - "minLength" : 5, - "maxLength" : 128 - }, - "nextScanOwnership" : { - "type" : "boolean" - }, - "ownerOrganizationId" : { - "type" : "integer", - "format" : "int64" - }, - "type" : { - "type" : "string", - "readOnly" : true, - "allowEmptyValue" : false, - "enum" : [ "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] - } - }, - "title" : "GuidCollection" - }, - "Id4n" : { - "type" : "object", - "properties" : { - "id4n" : { - "type" : "string", - "example" : "3THvgrWxqgTFC4", - "description" : "The ID", - "allowEmptyValue" : false - } - }, - "title" : "Id4n" - }, - "Id4nPresentation" : { - "type" : "object", - "required" : [ "createdTimestamp", "id4n", "type" ], - "properties" : { - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "example" : 1517232722, - "description" : "The UTC unix timestamp of when this ID has been created", - "readOnly" : true, - "allowEmptyValue" : false - }, - "id4n" : { - "type" : "string", - "example" : "3THvgrWxqgTFC4", - "description" : "The ID", - "readOnly" : true, - "allowEmptyValue" : false - }, - "label" : { - "type" : "string", - "readOnly" : true, - "allowEmptyValue" : false - }, - "nextScanOwnership" : { - "type" : "boolean", - "example" : false, - "description" : "Indicates if next scan ownership is active or not. If privileges are missing or the type of object doesn't support NSO this value is null.", - "readOnly" : true, - "allowEmptyValue" : false - }, - "type" : { - "type" : "string", - "description" : "The type of ID", - "readOnly" : true, - "allowEmptyValue" : false, - "enum" : [ "GUID", "ROUTING_COLLECTION", "LOGISTIC_COLLECTION", "LABELLED_COLLECTION" ] - } - }, - "title" : "Id4nPresentation" - }, - "Id4nPresentationPaginatedResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Id4nPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "Id4nPresentationPaginatedResponse" - }, - "InputStream" : { - "type" : "object", - "title" : "InputStream" - }, - "InputStreamResource" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string" - }, - "file" : { - "$ref" : "#/definitions/File" - }, - "filename" : { - "type" : "string" - }, - "inputStream" : { - "$ref" : "#/definitions/InputStream" - }, - "open" : { - "type" : "boolean" - }, - "readable" : { - "type" : "boolean" - }, - "uri" : { - "$ref" : "#/definitions/URI" - }, - "url" : { - "$ref" : "#/definitions/URL" - } - }, - "title" : "InputStreamResource" - }, - "ListOfId4ns" : { - "type" : "object", - "properties" : { - "id4ns" : { - "type" : "array", - "description" : "A list of id4ns.", - "allowEmptyValue" : false, - "items" : { - "type" : "string" - } - } - }, - "title" : "ListOfId4ns", - "description" : "A list of id4ns" - }, - "Organization" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "example" : 100, - "description" : "The id of the organization", - "readOnly" : true, - "allowEmptyValue" : false - }, - "logoURL" : { - "type" : "string", - "example" : "/api/v1/public/images/abcdef", - "description" : "URL to a logo of the organization", - "readOnly" : true, - "allowEmptyValue" : false - }, - "name" : { - "type" : "string", - "example" : "ACME Inc.", - "description" : "The name of the organization", - "allowEmptyValue" : false, - "minLength" : 3, - "maxLength" : 254 - } - }, - "title" : "Organization", - "description" : "An organization" - }, - "OrganizationAddress" : { - "type" : "object", - "required" : [ "city", "countryCode", "firstname", "lastname", "postCode", "street" ], - "properties" : { - "companyName" : { - "type" : "string", - "example" : "ACME Inc.", - "allowEmptyValue" : false, - "minLength" : 0, - "maxLength" : 254 - }, - "firstname" : { - "type" : "string", - "example" : "Max", - "allowEmptyValue" : false, - "minLength" : 2, - "maxLength" : 254 - }, - "lastname" : { - "type" : "string", - "example" : "Muster", - "allowEmptyValue" : false, - "minLength" : 2, - "maxLength" : 254 - }, - "street" : { - "type" : "string", - "example" : "Examplestreet 1", - "allowEmptyValue" : false, - "minLength" : 3, - "maxLength" : 254 - }, - "postCode" : { - "type" : "string", - "example" : 12345, - "allowEmptyValue" : false, - "minLength" : 2, - "maxLength" : 40 - }, - "city" : { - "type" : "string", - "example" : "MyCity", - "allowEmptyValue" : false, - "minLength" : 2, - "maxLength" : 99 - }, - "countryCode" : { - "type" : "string", - "example" : "DE", - "description" : "The ISO 3166 two-letter country code", - "allowEmptyValue" : false, - "minLength" : 0, - "maxLength" : 2 - }, - "countryName" : { - "type" : "string", - "example" : "Germany", - "description" : "The country name", - "readOnly" : true, - "allowEmptyValue" : false - }, - "telephone" : { - "type" : "string", - "example" : "+49 8088 12345", - "description" : "The telephone number e.g.", - "allowEmptyValue" : false, - "minLength" : 0, - "maxLength" : 99 - } - }, - "title" : "OrganizationAddress" - }, - "OrganizationUserInvitation" : { - "type" : "object", - "required" : [ "roles" ], - "properties" : { - "email" : { - "type" : "string" - }, - "roles" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "userName" : { - "type" : "string" - } - }, - "title" : "OrganizationUserInvitation" - }, - "OrganizationUserInvitationListRequest" : { - "type" : "object", - "required" : [ "invitations" ], - "properties" : { - "invitations" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/OrganizationUserInvitation" - } - } - }, - "title" : "OrganizationUserInvitationListRequest" - }, - "OwnedDocument" : { - "type" : "object", - "properties" : { - "filename" : { - "type" : "string", - "example" : "publicInfo.pdf", - "description" : "File Name", - "allowEmptyValue" : false - }, - "mimeType" : { - "type" : "string", - "example" : "text/plain", - "description" : "Mime Type", - "allowEmptyValue" : false - }, - "ownerOrganizationId" : { - "type" : "integer", - "format" : "int64", - "example" : 5, - "description" : "The organization's id which owns the document", - "readOnly" : true, - "allowEmptyValue" : false - }, - "visibility" : { - "description" : "Visibility configuration", - "allowEmptyValue" : false, - "$ref" : "#/definitions/Visibility" - } - }, - "title" : "OwnedDocument" - }, - "PaginatedApiKeyResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedApiKeyResponse" - }, - "PaginatedCountryResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Country" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedCountryResponse" - }, - "PaginatedDocumentResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Document" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedDocumentResponse" - }, - "PaginatedGuidCollection" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/GuidCollection" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedGuidCollection" - }, - "PaginatedGuidResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Guid" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedGuidResponse" - }, - "PaginatedOrganizationResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Organization" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedOrganizationResponse" - }, - "PaginatedOwnedDocumentResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/OwnedDocument" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedOwnedDocumentResponse" - }, - "PaginatedResponse«ApiKeyPresentation»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«ApiKeyPresentation»" - }, - "PaginatedResponse«ApiKeyPrivilegeInfo»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPrivilegeInfo" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«ApiKeyPrivilegeInfo»" - }, - "PaginatedResponse«ApiKeyPrivilege»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/ApiKeyPrivilege" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«ApiKeyPrivilege»" - }, - "PaginatedResponse«Country»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Country" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Country»" - }, - "PaginatedResponse«Document»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Document" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Document»" - }, - "PaginatedResponse«GuidCollection»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/GuidCollection" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«GuidCollection»" - }, - "PaginatedResponse«Guid»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Guid" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Guid»" - }, - "PaginatedResponse«Id4nPresentation»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Id4nPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Id4nPresentation»" - }, - "PaginatedResponse«Organization»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Organization" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Organization»" - }, - "PaginatedResponse«OwnedDocument»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/OwnedDocument" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«OwnedDocument»" - }, - "PaginatedResponse«Role»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Role" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«Role»" - }, - "PaginatedResponse«UserPresentation»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/UserPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«UserPresentation»" - }, - "PaginatedResponse«UserRoles»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/UserRoles" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«UserRoles»" - }, - "PaginatedResponse«string»" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "type" : "string" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedResponse«string»" - }, - "PaginatedStringResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "type" : "string" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedStringResponse" - }, - "PaginatedUserPresentationResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/UserPresentation" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedUserPresentationResponse" - }, - "PaginatedUserRolesResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/UserRoles" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "PaginatedUserRolesResponse" - }, - "PasswordResetRequest" : { - "type" : "object", - "required" : [ "username" ], - "properties" : { - "username" : { - "type" : "string" - } - }, - "title" : "PasswordResetRequest" - }, - "PasswordResetVerificationRequest" : { - "type" : "object", - "required" : [ "password", "token" ], - "properties" : { - "password" : { - "type" : "string" - }, - "token" : { - "type" : "string" - } - }, - "title" : "PasswordResetVerificationRequest" - }, - "PublicImagePresentation" : { - "type" : "object", - "required" : [ "uri" ], - "properties" : { - "uri" : { - "type" : "string", - "example" : "/api/v1/public/image/bc671c63-4a9b-46e7-8c59-9bbe1917e6cc", - "description" : "The uri/url of the image", - "readOnly" : true, - "allowEmptyValue" : false - } - }, - "title" : "PublicImagePresentation" - }, - "RegistrationVerificationTokenPresentation" : { - "type" : "object", - "required" : [ "token" ], - "properties" : { - "token" : { - "type" : "string" - } - }, - "title" : "RegistrationVerificationTokenPresentation" - }, - "RemoveApiKeyPrivilegeRequest" : { - "type" : "object", - "required" : [ "privilege" ], - "properties" : { - "privilege" : { - "type" : "string" - } - }, - "title" : "RemoveApiKeyPrivilegeRequest" - }, - "ResponseEntity" : { - "type" : "object", - "properties" : { - "body" : { - "type" : "object" - }, - "statusCode" : { - "type" : "string", - "enum" : [ "100", "101", "102", "103", "200", "201", "202", "203", "204", "205", "206", "207", "208", "226", "300", "301", "302", "303", "304", "305", "307", "308", "400", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "415", "416", "417", "418", "419", "420", "421", "422", "423", "424", "426", "428", "429", "431", "451", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511" ] - }, - "statusCodeValue" : { - "type" : "integer", - "format" : "int32" - } - }, - "title" : "ResponseEntity" - }, - "Role" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "privileges" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, - "title" : "Role" - }, - "RoleResponse" : { - "type" : "object", - "required" : [ "elements", "limit", "offset" ], - "properties" : { - "elements" : { - "type" : "array", - "allowEmptyValue" : false, - "items" : { - "$ref" : "#/definitions/Role" - } - }, - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 100, - "description" : "The number of returned elements", - "allowEmptyValue" : false - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Starting with the n-th element", - "allowEmptyValue" : false - }, - "total" : { - "type" : "integer", - "format" : "int32", - "example" : 200, - "description" : "The total number of elements", - "allowEmptyValue" : false - } - }, - "title" : "RoleResponse" - }, - "Route" : { - "type" : "object", - "required" : [ "params", "public", "type" ], - "properties" : { - "params" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "priority" : { - "type" : "integer", - "format" : "int32" - }, - "public" : { - "type" : "boolean" - }, - "type" : { - "type" : "string" - }, - "validUntil" : { - "type" : "integer", - "format" : "int64" - } - }, - "title" : "Route" - }, - "RoutingFile" : { - "type" : "object", - "required" : [ "routes" ], - "properties" : { - "options" : { - "$ref" : "#/definitions/RoutingOptions" - }, - "routes" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Route" - } - } - }, - "title" : "RoutingFile" - }, - "RoutingFileRequest" : { - "type" : "object", - "required" : [ "routing" ], - "properties" : { - "organizationId" : { - "type" : "integer", - "format" : "int64" - }, - "routing" : { - "$ref" : "#/definitions/RoutingFile" - } - }, - "title" : "RoutingFileRequest" - }, - "RoutingOptions" : { - "type" : "object", - "properties" : { - "deleteOutdatedRoutes" : { - "type" : "boolean" - } - }, - "title" : "RoutingOptions" - }, - "ServiceCosts" : { - "type" : "object", - "required" : [ "listing" ], - "properties" : { - "listing" : { - "type" : "object", - "additionalProperties" : { - "type" : "number", - "format" : "float" - } - } - }, - "title" : "ServiceCosts" - }, - "SimpleMessageResponse" : { - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - } - }, - "title" : "SimpleMessageResponse" - }, - "Timestamp" : { - "type" : "object", - "properties" : { - "date" : { - "type" : "integer", - "format" : "int32" - }, - "day" : { - "type" : "integer", - "format" : "int32" - }, - "hours" : { - "type" : "integer", - "format" : "int32" - }, - "minutes" : { - "type" : "integer", - "format" : "int32" - }, - "month" : { - "type" : "integer", - "format" : "int32" - }, - "nanos" : { - "type" : "integer", - "format" : "int32" - }, - "seconds" : { - "type" : "integer", - "format" : "int32" - }, - "time" : { - "type" : "integer", - "format" : "int64" - }, - "timezoneOffset" : { - "type" : "integer", - "format" : "int32" - }, - "year" : { - "type" : "integer", - "format" : "int32" - } - }, - "title" : "Timestamp" - }, - "URI" : { - "type" : "object", - "properties" : { - "absolute" : { - "type" : "boolean" - }, - "authority" : { - "type" : "string" - }, - "fragment" : { - "type" : "string" - }, - "host" : { - "type" : "string" - }, - "opaque" : { - "type" : "boolean" - }, - "path" : { - "type" : "string" - }, - "port" : { - "type" : "integer", - "format" : "int32" - }, - "query" : { - "type" : "string" - }, - "rawAuthority" : { - "type" : "string" - }, - "rawFragment" : { - "type" : "string" - }, - "rawPath" : { - "type" : "string" - }, - "rawQuery" : { - "type" : "string" - }, - "rawSchemeSpecificPart" : { - "type" : "string" - }, - "rawUserInfo" : { - "type" : "string" - }, - "scheme" : { - "type" : "string" - }, - "schemeSpecificPart" : { - "type" : "string" - }, - "userInfo" : { - "type" : "string" - } - }, - "title" : "URI" - }, - "URL" : { - "type" : "object", - "properties" : { - "authority" : { - "type" : "string" - }, - "content" : { - "type" : "object" - }, - "defaultPort" : { - "type" : "integer", - "format" : "int32" - }, - "file" : { - "type" : "string" - }, - "host" : { - "type" : "string" - }, - "path" : { - "type" : "string" - }, - "port" : { - "type" : "integer", - "format" : "int32" - }, - "protocol" : { - "type" : "string" - }, - "query" : { - "type" : "string" - }, - "ref" : { - "type" : "string" - }, - "userInfo" : { - "type" : "string" - } - }, - "title" : "URL" - }, - "UserPresentation" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "xml" : { - "name" : "id", - "attribute" : false, - "wrapped" : false - } - }, - "name" : { - "type" : "string" - } - }, - "title" : "UserPresentation" - }, - "UserRegistrationRequest" : { - "type" : "object", - "required" : [ "email", "password", "username" ], - "properties" : { - "username" : { - "type" : "string", - "pattern" : "[a-zA-Z0-9_.-]{6,50}" - }, - "password" : { - "type" : "string", - "minLength" : 8, - "maxLength" : 99 - }, - "email" : { - "type" : "string" - } - }, - "title" : "UserRegistrationRequest" - }, - "UserRegistrationResponse" : { - "type" : "object", - "properties" : { - "email" : { - "type" : "string" - }, - "id" : { - "type" : "integer", - "format" : "int64" - }, - "message" : { - "type" : "string" - }, - "username" : { - "type" : "string" - } - }, - "title" : "UserRegistrationResponse" - }, - "UserRoles" : { - "type" : "object", - "properties" : { - "roles" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "user" : { - "$ref" : "#/definitions/UserPresentation" - } - }, - "title" : "UserRoles" - }, - "Visibility" : { - "type" : "object", - "properties" : { - "public" : { - "type" : "boolean", - "example" : true, - "description" : "Document is publicly readable (if ID4N is owned by the same organization)", - "allowEmptyValue" : false - }, - "sharedOrganizationIds" : { - "type" : "array", - "example" : [ 101, 102, 103 ], - "description" : "Document is readable by these organizations (independend of ID4N ownership)", - "allowEmptyValue" : false, - "items" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "title" : "Visibility" - }, - "VisibilityUpdate" : { - "type" : "object", - "properties" : { - "public" : { - "type" : "boolean", - "example" : true, - "description" : "Document is publicly readable (if ID4N is owned by the same organization)", - "allowEmptyValue" : false - }, - "sharedWithOrganizationIds" : { - "type" : "array", - "example" : [ 101, 102, 103 ], - "description" : "Document is readable by these organizations (independend of ID4N ownership)", - "allowEmptyValue" : false, - "items" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "title" : "VisibilityUpdate" - }, - "WhoIsResponse" : { - "type" : "object", - "properties" : { - "aliases" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "organization" : { - "$ref" : "#/definitions/Organization" - }, - "organizationAddress" : { - "$ref" : "#/definitions/OrganizationAddress" - } - }, - "title" : "WhoIsResponse" - } - } -} \ No newline at end of file From 4aab84e495ef677964be4135755df2644d7cc748 Mon Sep 17 00:00:00 2001 From: Wolfgang Werner Date: Tue, 22 May 2018 13:48:29 +0200 Subject: [PATCH 3/5] Add workaround for missing response messages --- src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java b/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java index 8d9ec0e0..a144266c 100644 --- a/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java +++ b/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java @@ -192,6 +192,8 @@ private SwaggerDiff compare() { private Property getResponseProperty(Operation operation) { Map responses = operation.getResponses(); + // temporary workaround for missing response messages + if(responses == null) return null; Response response = responses.get("200"); return null == response ? null : response.getSchema(); } From e7071babb71515c44f0fe0760bd925cbff841a9b Mon Sep 17 00:00:00 2001 From: Wolfgang Werner Date: Tue, 22 May 2018 15:26:03 +0200 Subject: [PATCH 4/5] Remove Slf4j nop binding --- pom.xml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/pom.xml b/pom.xml index c84fd2ce..ffba8814 100644 --- a/pom.xml +++ b/pom.xml @@ -80,11 +80,6 @@ jcommander 1.72 - - org.slf4j - slf4j-nop - 1.6.3 - junit junit From 74913b484e8f0fcc76c6a5022b814e34b60f6277 Mon Sep 17 00:00:00 2001 From: Sayi Date: Wed, 23 May 2018 01:04:10 +0800 Subject: [PATCH 5/5] refactor facade: SwaggerDiff --- pom.xml | 2 +- .../deepoove/swagger/diff/SwaggerDiff.java | 137 +------------- .../diff/compare/SpecificationDiff.java | 174 ++++++++++++++++++ .../com/deepoove/swagger/test/CLITest.java | 2 +- .../swagger/test/SwaggerDiffTest.java | 1 - src/test/resources/petstore_v2_2.json | 2 +- src/test/resources/petstore_v2_empty.json | 2 +- 7 files changed, 183 insertions(+), 137 deletions(-) create mode 100644 src/main/java/com/deepoove/swagger/diff/compare/SpecificationDiff.java diff --git a/pom.xml b/pom.xml index ffba8814..0a26b31b 100644 --- a/pom.xml +++ b/pom.xml @@ -10,7 +10,7 @@ com.deepoove swagger-diff - 1.2.0 + 1.3.0-SNAPSHOT jar swagger-diff diff --git a/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java b/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java index a144266c..a777b64b 100644 --- a/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java +++ b/src/main/java/com/deepoove/swagger/diff/SwaggerDiff.java @@ -1,32 +1,18 @@ package com.deepoove.swagger.diff; import java.io.IOException; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashMap; import java.util.List; -import java.util.Map; -import java.util.Map.Entry; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import com.deepoove.swagger.diff.compare.MapKeyDiff; -import com.deepoove.swagger.diff.compare.ParameterDiff; -import com.deepoove.swagger.diff.compare.PropertyDiff; +import com.deepoove.swagger.diff.compare.SpecificationDiff; import com.deepoove.swagger.diff.model.ChangedEndpoint; -import com.deepoove.swagger.diff.model.ChangedOperation; import com.deepoove.swagger.diff.model.Endpoint; import com.fasterxml.jackson.databind.JsonNode; -import io.swagger.models.HttpMethod; -import io.swagger.models.Operation; -import io.swagger.models.Path; -import io.swagger.models.Response; import io.swagger.models.Swagger; import io.swagger.models.auth.AuthorizationValue; -import io.swagger.models.parameters.Parameter; -import io.swagger.models.properties.Property; import io.swagger.parser.SwaggerCompatConverter; import io.swagger.parser.SwaggerParser; @@ -119,126 +105,13 @@ private SwaggerDiff(JsonNode oldSpec, JsonNode newSpec) { } private SwaggerDiff compare() { - Map oldPaths = oldSpecSwagger.getPaths(); - Map newPaths = newSpecSwagger.getPaths(); - MapKeyDiff pathDiff = MapKeyDiff.diff(oldPaths, newPaths); - this.newEndpoints = convert2EndpointList(pathDiff.getIncreased()); - this.missingEndpoints = convert2EndpointList(pathDiff.getMissing()); - - this.changedEndpoints = new ArrayList(); - - List sharedKey = pathDiff.getSharedKey(); - ChangedEndpoint changedEndpoint = null; - for (String pathUrl : sharedKey) { - changedEndpoint = new ChangedEndpoint(); - changedEndpoint.setPathUrl(pathUrl); - Path oldPath = oldPaths.get(pathUrl); - Path newPath = newPaths.get(pathUrl); - - Map oldOperationMap = oldPath.getOperationMap(); - Map newOperationMap = newPath.getOperationMap(); - MapKeyDiff operationDiff = MapKeyDiff.diff(oldOperationMap, - newOperationMap); - Map increasedOperation = operationDiff.getIncreased(); - Map missingOperation = operationDiff.getMissing(); - changedEndpoint.setNewOperations(increasedOperation); - changedEndpoint.setMissingOperations(missingOperation); - - List sharedMethods = operationDiff.getSharedKey(); - Map operas = new HashMap(); - ChangedOperation changedOperation = null; - for (HttpMethod method : sharedMethods) { - changedOperation = new ChangedOperation(); - Operation oldOperation = oldOperationMap.get(method); - Operation newOperation = newOperationMap.get(method); - changedOperation.setSummary(newOperation.getSummary()); - - List oldParameters = oldOperation.getParameters(); - List newParameters = newOperation.getParameters(); - ParameterDiff parameterDiff = ParameterDiff - .buildWithDefinition(oldSpecSwagger.getDefinitions(), - newSpecSwagger.getDefinitions()) - .diff(oldParameters, newParameters); - changedOperation.setAddParameters(parameterDiff.getIncreased()); - changedOperation.setMissingParameters(parameterDiff.getMissing()); - changedOperation.setChangedParameter(parameterDiff.getChanged()); - - Property oldResponseProperty = getResponseProperty(oldOperation); - Property newResponseProperty = getResponseProperty(newOperation); - PropertyDiff propertyDiff = PropertyDiff.buildWithDefinition( - oldSpecSwagger.getDefinitions(), newSpecSwagger.getDefinitions()); - propertyDiff.diff(oldResponseProperty, newResponseProperty); - changedOperation.setAddProps(propertyDiff.getIncreased()); - changedOperation.setMissingProps(propertyDiff.getMissing()); - - if (changedOperation.isDiff()) { - operas.put(method, changedOperation); - } - } - changedEndpoint.setChangedOperations(operas); - - this.newEndpoints.addAll(convert2EndpointList(changedEndpoint.getPathUrl(), - changedEndpoint.getNewOperations())); - this.missingEndpoints.addAll(convert2EndpointList(changedEndpoint.getPathUrl(), - changedEndpoint.getMissingOperations())); - - if (changedEndpoint.isDiff()) { - changedEndpoints.add(changedEndpoint); - } - } - + SpecificationDiff diff = SpecificationDiff.diff(oldSpecSwagger, newSpecSwagger); + this.newEndpoints = diff.getNewEndpoints(); + this.missingEndpoints = diff.getMissingEndpoints(); + this.changedEndpoints = diff.getChangedEndpoints(); return this; } - private Property getResponseProperty(Operation operation) { - Map responses = operation.getResponses(); - // temporary workaround for missing response messages - if(responses == null) return null; - Response response = responses.get("200"); - return null == response ? null : response.getSchema(); - } - - private List convert2EndpointList(Map map) { - List endpoints = new ArrayList(); - if (null == map) return endpoints; - for (Entry entry : map.entrySet()) { - String url = entry.getKey(); - Path path = entry.getValue(); - - Map operationMap = path.getOperationMap(); - for (Entry entryOper : operationMap.entrySet()) { - HttpMethod httpMethod = entryOper.getKey(); - Operation operation = entryOper.getValue(); - - Endpoint endpoint = new Endpoint(); - endpoint.setPathUrl(url); - endpoint.setMethod(httpMethod); - endpoint.setSummary(operation.getSummary()); - endpoint.setPath(path); - endpoint.setOperation(operation); - endpoints.add(endpoint); - } - } - return endpoints; - } - - private Collection convert2EndpointList(String pathUrl, - Map map) { - List endpoints = new ArrayList(); - if (null == map) return endpoints; - for (Entry entry : map.entrySet()) { - HttpMethod httpMethod = entry.getKey(); - Operation operation = entry.getValue(); - Endpoint endpoint = new Endpoint(); - endpoint.setPathUrl(pathUrl); - endpoint.setMethod(httpMethod); - endpoint.setSummary(operation.getSummary()); - endpoint.setOperation(operation); - endpoints.add(endpoint); - } - return endpoints; - } - public List getNewEndpoints() { return newEndpoints; } diff --git a/src/main/java/com/deepoove/swagger/diff/compare/SpecificationDiff.java b/src/main/java/com/deepoove/swagger/diff/compare/SpecificationDiff.java new file mode 100644 index 00000000..b432d1f5 --- /dev/null +++ b/src/main/java/com/deepoove/swagger/diff/compare/SpecificationDiff.java @@ -0,0 +1,174 @@ +package com.deepoove.swagger.diff.compare; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; + +import com.deepoove.swagger.diff.model.ChangedEndpoint; +import com.deepoove.swagger.diff.model.ChangedOperation; +import com.deepoove.swagger.diff.model.Endpoint; + +import io.swagger.models.HttpMethod; +import io.swagger.models.Operation; +import io.swagger.models.Path; +import io.swagger.models.Response; +import io.swagger.models.Swagger; +import io.swagger.models.parameters.Parameter; +import io.swagger.models.properties.Property; + +/** + * compare two Swagger + * + * @author Sayi + * + */ +public class SpecificationDiff { + + private List newEndpoints; + private List missingEndpoints; + private List changedEndpoints; + + private SpecificationDiff() { + } + + public static SpecificationDiff diff(Swagger oldSpec, Swagger newSpec) { + SpecificationDiff instance = new SpecificationDiff(); + if (null == oldSpec || null == newSpec) { + throw new IllegalArgumentException("cannot diff null spec."); + } + Map oldPaths = oldSpec.getPaths(); + Map newPaths = newSpec.getPaths(); + MapKeyDiff pathDiff = MapKeyDiff.diff(oldPaths, newPaths); + instance.newEndpoints = convert2EndpointList(pathDiff.getIncreased()); + instance.missingEndpoints = convert2EndpointList(pathDiff.getMissing()); + instance.changedEndpoints = new ArrayList(); + + List sharedKey = pathDiff.getSharedKey(); + ChangedEndpoint changedEndpoint = null; + for (String pathUrl : sharedKey) { + changedEndpoint = new ChangedEndpoint(); + changedEndpoint.setPathUrl(pathUrl); + Path oldPath = oldPaths.get(pathUrl); + Path newPath = newPaths.get(pathUrl); + + Map oldOperationMap = oldPath.getOperationMap(); + Map newOperationMap = newPath.getOperationMap(); + MapKeyDiff operationDiff = MapKeyDiff.diff(oldOperationMap, newOperationMap); + Map increasedOperation = operationDiff.getIncreased(); + Map missingOperation = operationDiff.getMissing(); + changedEndpoint.setNewOperations(increasedOperation); + changedEndpoint.setMissingOperations(missingOperation); + + List sharedMethods = operationDiff.getSharedKey(); + Map operas = new HashMap(); + ChangedOperation changedOperation = null; + for (HttpMethod method : sharedMethods) { + changedOperation = new ChangedOperation(); + Operation oldOperation = oldOperationMap.get(method); + Operation newOperation = newOperationMap.get(method); + changedOperation.setSummary(newOperation.getSummary()); + + List oldParameters = oldOperation.getParameters(); + List newParameters = newOperation.getParameters(); + ParameterDiff parameterDiff = ParameterDiff + .buildWithDefinition(oldSpec.getDefinitions(), newSpec.getDefinitions()) + .diff(oldParameters, newParameters); + changedOperation.setAddParameters(parameterDiff.getIncreased()); + changedOperation.setMissingParameters(parameterDiff.getMissing()); + changedOperation.setChangedParameter(parameterDiff.getChanged()); + + Property oldResponseProperty = getResponseProperty(oldOperation); + Property newResponseProperty = getResponseProperty(newOperation); + PropertyDiff propertyDiff = PropertyDiff.buildWithDefinition(oldSpec.getDefinitions(), + newSpec.getDefinitions()); + propertyDiff.diff(oldResponseProperty, newResponseProperty); + changedOperation.setAddProps(propertyDiff.getIncreased()); + changedOperation.setMissingProps(propertyDiff.getMissing()); + + if (changedOperation.isDiff()) { + operas.put(method, changedOperation); + } + } + changedEndpoint.setChangedOperations(operas); + + instance.newEndpoints + .addAll(convert2EndpointList(changedEndpoint.getPathUrl(), changedEndpoint.getNewOperations())); + instance.missingEndpoints + .addAll(convert2EndpointList(changedEndpoint.getPathUrl(), changedEndpoint.getMissingOperations())); + + if (changedEndpoint.isDiff()) { + instance.changedEndpoints.add(changedEndpoint); + } + } + + return instance; + + } + + private static Property getResponseProperty(Operation operation) { + Map responses = operation.getResponses(); + // temporary workaround for missing response messages + if (responses == null) + return null; + Response response = responses.get("200"); + return null == response ? null : response.getSchema(); + } + + private static List convert2EndpointList(Map map) { + List endpoints = new ArrayList(); + if (null == map) + return endpoints; + for (Entry entry : map.entrySet()) { + String url = entry.getKey(); + Path path = entry.getValue(); + + Map operationMap = path.getOperationMap(); + for (Entry entryOper : operationMap.entrySet()) { + HttpMethod httpMethod = entryOper.getKey(); + Operation operation = entryOper.getValue(); + + Endpoint endpoint = new Endpoint(); + endpoint.setPathUrl(url); + endpoint.setMethod(httpMethod); + endpoint.setSummary(operation.getSummary()); + endpoint.setPath(path); + endpoint.setOperation(operation); + endpoints.add(endpoint); + } + } + return endpoints; + } + + private static Collection convert2EndpointList(String pathUrl, Map map) { + List endpoints = new ArrayList(); + if (null == map) + return endpoints; + for (Entry entry : map.entrySet()) { + HttpMethod httpMethod = entry.getKey(); + Operation operation = entry.getValue(); + Endpoint endpoint = new Endpoint(); + endpoint.setPathUrl(pathUrl); + endpoint.setMethod(httpMethod); + endpoint.setSummary(operation.getSummary()); + endpoint.setOperation(operation); + endpoints.add(endpoint); + } + return endpoints; + } + + public List getNewEndpoints() { + return newEndpoints; + } + + public List getMissingEndpoints() { + return missingEndpoints; + } + + public List getChangedEndpoints() { + return changedEndpoints; + } + +} diff --git a/src/test/java/com/deepoove/swagger/test/CLITest.java b/src/test/java/com/deepoove/swagger/test/CLITest.java index db37d687..41ba53f0 100644 --- a/src/test/java/com/deepoove/swagger/test/CLITest.java +++ b/src/test/java/com/deepoove/swagger/test/CLITest.java @@ -93,7 +93,7 @@ public void testMain() { JCommander jCommander = JCommander.newBuilder().addObject(cli).build(); jCommander.parse(argv); cli.run(jCommander); - Assert.assertTrue(outContent.toString().startsWith("## Version")); + Assert.assertTrue(outContent.toString().startsWith("## Version 1.0.0 to 1.0.2")); } } diff --git a/src/test/java/com/deepoove/swagger/test/SwaggerDiffTest.java b/src/test/java/com/deepoove/swagger/test/SwaggerDiffTest.java index 24c9792c..7dcd7999 100644 --- a/src/test/java/com/deepoove/swagger/test/SwaggerDiffTest.java +++ b/src/test/java/com/deepoove/swagger/test/SwaggerDiffTest.java @@ -27,7 +27,6 @@ public class SwaggerDiffTest { public void testEqual() { SwaggerDiff diff = SwaggerDiff.compareV2(SWAGGER_V2_DOC2, SWAGGER_V2_DOC2); assertEqual(diff); - } @Test diff --git a/src/test/resources/petstore_v2_2.json b/src/test/resources/petstore_v2_2.json index 584cec22..f631deb0 100644 --- a/src/test/resources/petstore_v2_2.json +++ b/src/test/resources/petstore_v2_2.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "version": "1.0.0", + "version": "1.0.2", "title": "Swagger Petstore", "termsOfService": "http://swagger.io/terms/", "contact": { diff --git a/src/test/resources/petstore_v2_empty.json b/src/test/resources/petstore_v2_empty.json index 5f957ad8..edfcea5f 100644 --- a/src/test/resources/petstore_v2_empty.json +++ b/src/test/resources/petstore_v2_empty.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "version": "1.0.0", + "version": "1.0.1", "title": "Swagger Petstore", "termsOfService": "http://swagger.io/terms/", "contact": {