diff --git a/.eslintrc.json b/.eslintrc.json index aa1a3284..2a9d3ca7 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -12,6 +12,7 @@ }, "rules": { "@typescript-eslint/no-explicit-any": 0, + "@typescript-eslint/no-inferrable-types": 0, "@typescript-eslint/no-non-null-assertion": 0, "@typescript-eslint/explicit-function-return-type": 0, "prettier/prettier": [ diff --git a/src/client/interfaces/Schema.d.ts b/src/client/interfaces/Schema.d.ts index 5e73fa7c..edd7cf80 100644 --- a/src/client/interfaces/Schema.d.ts +++ b/src/client/interfaces/Schema.d.ts @@ -1,7 +1,15 @@ +import { Dictionary } from '../../utils/types'; + export interface Schema { type: string; base: string; template: string | null; + description?: string; default?: any; + required: boolean; + nullable: boolean; + readOnly: boolean; + extends: string[]; imports: string[]; + properties: Dictionary; } diff --git a/src/index.ts b/src/index.ts index 178e95c7..f7a32ecd 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,12 +1,11 @@ import * as path from 'path'; import { parse as parseV2 } from './openApi/v2'; import { parse as parseV3 } from './openApi/v3'; -import { readHandlebarsTemplates } from './utils/readHandlebarsTemplates'; +import { readHandlebarsTemplates, Templates } from './utils/readHandlebarsTemplates'; import { getOpenApiSpec } from './utils/getOpenApiSpec'; import { writeClient } from './utils/writeClient'; -import * as os from 'os'; -import chalk from 'chalk'; import { getOpenApiVersion, OpenApiVersion } from './utils/getOpenApiVersion'; +import { Client } from './client/interfaces/Client'; export enum Language { TYPESCRIPT = 'typescript', @@ -28,8 +27,8 @@ export enum HttpClient { * @param httpClient: The selected httpClient (fetch or XHR) */ export function generate(input: string, output: string, language: Language = Language.TYPESCRIPT, httpClient: HttpClient = HttpClient.FETCH): void { - const inputPath = path.resolve(process.cwd(), input); - const outputPath = path.resolve(process.cwd(), output); + const inputPath: string = path.resolve(process.cwd(), input); + const outputPath: string = path.resolve(process.cwd(), output); // console.log(chalk.bold.green('Generate:')); // console.log(chalk.grey(' Input:'), input); @@ -41,22 +40,22 @@ export function generate(input: string, output: string, language: Language = Lan try { // Load the specification, read the OpenAPI version and load the // handlebar templates for the given language - const openApi = getOpenApiSpec(inputPath); - const openApiVersion = getOpenApiVersion(openApi); - const templates = readHandlebarsTemplates(language); + const openApi: any = getOpenApiSpec(inputPath); + const openApiVersion: OpenApiVersion = getOpenApiVersion(openApi); + const templates: Templates = readHandlebarsTemplates(language); switch (language) { case Language.JAVASCRIPT: case Language.TYPESCRIPT: // Generate and write version 2 client if (openApiVersion === OpenApiVersion.V2) { - const clientV2 = parseV2(openApi); + const clientV2: Client = parseV2(openApi); writeClient(clientV2, language, templates, outputPath); } // Generate and write version 3 client if (openApiVersion === OpenApiVersion.V3) { - const clientV3 = parseV3(openApi); + const clientV3: Client = parseV3(openApi); writeClient(clientV3, language, templates, outputPath); } } diff --git a/src/openApi/v2/parser/getArrayType.ts b/src/openApi/v2/parser/getArrayType.ts index 337195b1..e3bcab8d 100644 --- a/src/openApi/v2/parser/getArrayType.ts +++ b/src/openApi/v2/parser/getArrayType.ts @@ -5,18 +5,21 @@ import { getEnumType } from './getEnumType'; import { ArrayType } from '../../../client/interfaces/ArrayType'; export function getArrayType(items: OpenApiItems): ArrayType { - let itemsType = 'any'; - let itemsBase = 'any'; - let itemsTemplate: string | null = null; - let itemsImports: string[] = []; + const result: ArrayType = { + type: 'any', + base: 'any', + template: null, + default: items.default, + imports: [], + }; // If the parameter has a type than it can be a basic or generic type. if (items.type) { const itemsData: Type = getType(items.type); - itemsType = itemsData.type; - itemsBase = itemsData.base; - itemsTemplate = itemsData.template; - itemsImports = [...itemsData.imports]; + result.type = itemsData.type; + result.base = itemsData.base; + result.template = itemsData.template; + result.imports.push(...itemsData.imports); // If the parameter is an Array type, we check for the child type, // so we can create a typed array, otherwise this will be a "any[]". @@ -32,14 +35,10 @@ export function getArrayType(items: OpenApiItems): ArrayType { } if (items.enum) { - itemsType = getEnumType(items.enum, true); + result.type = getEnumType(items.enum, true); + result.base = 'string'; + result.imports = []; } - return { - type: itemsType, - base: itemsBase, - template: itemsTemplate, - default: items.default, - imports: itemsImports, - }; + return result; } diff --git a/src/openApi/v2/parser/getEnumTypeFromDescription.ts b/src/openApi/v2/parser/getEnumTypeFromDescription.ts index 9b73191f..d1054b82 100644 --- a/src/openApi/v2/parser/getEnumTypeFromDescription.ts +++ b/src/openApi/v2/parser/getEnumTypeFromDescription.ts @@ -1,31 +1,33 @@ -export function getEnumTypeFromDescription(description: string, addParentheses = false): string | null { +export function getEnumTypeFromDescription(description: string, addParentheses: boolean = false): string | null { // Check if we can find this special format string: // None=0,Something=1,AnotherThing=2 - const matches: RegExpMatchArray | null = description.match(/((\w+)=([0-9]+)(?:,|$))/g); - if (matches) { - // Grab the values from the description - const values: number[] = []; - for (let i = 0, n = matches.length; i < n; i++) { - const value = parseInt(matches[i].split('=')[1].replace(/[^0-9]/g, '')); - if (Number.isInteger(value)) { - values.push(value); + if (/^(\w+=[0-9]+,?)+$/g.test(description)) { + const matches: RegExpMatchArray | null = description.match(/(\w+=[0-9]+,?)/g); + if (matches) { + // Grab the values from the description + const values: number[] = []; + matches.forEach(match => { + const value = parseInt(match.split('=')[1].replace(/[^0-9]/g, '')); + if (Number.isInteger(value)) { + values.push(value); + } + }); + + // Filter and sort the values + const entries: string[] = values + .sort() + .filter((name, index, arr) => arr.indexOf(name) === index) + .map(value => String(value)); + + // Add grouping parentheses if needed. This can be handy if enum values + // are used in Arrays, so that you will get the following definition: + // const myArray: ('EnumValue1' | 'EnumValue2' | 'EnumValue3')[]; + if (entries.length > 1 && addParentheses) { + return `(${entries.join(' | ')})`; } + + return entries.join(' | '); } - - // Filter and sort the values - const entries: string[] = values - .sort() - .filter((name, index, arr) => arr.indexOf(name) === index) - .map(value => String(value)); - - // Add grouping parentheses if needed. This can be handy if enum values - // are used in Arrays, so that you will get the following definition: - // const myArray: ('EnumValue1' | 'EnumValue2' | 'EnumValue3')[]; - if (entries.length > 1 && addParentheses) { - return `(${entries.join(' | ')})`; - } - - return entries.join(' | '); } return null; diff --git a/src/openApi/v2/parser/getModelProperty.ts b/src/openApi/v2/parser/getModelProperty.ts index 811e9b22..18166dfc 100644 --- a/src/openApi/v2/parser/getModelProperty.ts +++ b/src/openApi/v2/parser/getModelProperty.ts @@ -66,15 +66,15 @@ export function getModelProperty(name: string, schema: OpenApiSchema & OpenApiRe // type is enum! } - console.log('propertyName:', schema); - console.log('format:', schema.format); - console.log('type:', schema.type); + // console.log('propertyName:', schema); + // console.log('format:', schema.format); + // console.log('type:', schema.type); const properties = schema.properties; for (const propertyName in properties) { if (properties.hasOwnProperty(propertyName)) { const property = properties[propertyName]; - console.log('propertyName', propertyName); + /// console.log('propertyName', propertyName); // getModelProperty(propertyName, property); } } @@ -87,7 +87,7 @@ export function getModelProperty(name: string, schema: OpenApiSchema & OpenApiRe prop.imports.push(extend.base); } if (parent.properties) { - console.log(parent.properties); + // console.log(parent.properties); // const properties: ParsedModelProperties = parseModelProperties(modelClass, definition.allOf[1].properties as SwaggerDefinitions, required); // model.imports.push(...properties.imports); // model.properties.push(...properties.properties); diff --git a/src/openApi/v2/parser/getOperation.ts b/src/openApi/v2/parser/getOperation.ts index 62a7c25a..32ac0995 100644 --- a/src/openApi/v2/parser/getOperation.ts +++ b/src/openApi/v2/parser/getOperation.ts @@ -15,14 +15,14 @@ import { getOperationErrors } from './getOperationErrors'; import { OperationError } from '../../../client/interfaces/OperationError'; export function getOperation(openApi: OpenApi, url: string, method: string, op: OpenApiOperation): Operation { - const serviceName = (op.tags && op.tags[0]) || 'Service'; - const serviceClassName = getServiceClassName(serviceName); - const operationNameFallback = `${method}${serviceClassName}`; - const operationName = getOperationName(op.operationId || operationNameFallback); - const operationPath = getOperationPath(url); + const serviceName: string = (op.tags && op.tags[0]) || 'Service'; + const serviceClassName: string = getServiceClassName(serviceName); + const operationNameFallback: string = `${method}${serviceClassName}`; + const operationName: string = getOperationName(op.operationId || operationNameFallback); + const operationPath: string = getOperationPath(url); // Create a new operation object for this method. - const operation: Operation = { + const result: Operation = { service: serviceClassName, name: operationName, summary: getComment(op.summary), @@ -44,13 +44,13 @@ export function getOperation(openApi: OpenApi, url: string, method: string, op: // Parse the operation parameters (path, query, body, etc). if (op.parameters) { const parameters: OperationParameters = getOperationParameters(openApi, op.parameters); - operation.imports.push(...parameters.imports); - operation.parameters.push(...parameters.parameters); - operation.parametersPath.push(...parameters.parametersPath); - operation.parametersQuery.push(...parameters.parametersQuery); - operation.parametersForm.push(...parameters.parametersForm); - operation.parametersHeader.push(...parameters.parametersHeader); - operation.parametersBody = parameters.parametersBody; + result.imports.push(...parameters.imports); + result.parameters.push(...parameters.parameters); + result.parametersPath.push(...parameters.parametersPath); + result.parametersQuery.push(...parameters.parametersQuery); + result.parametersForm.push(...parameters.parametersForm); + result.parametersHeader.push(...parameters.parametersHeader); + result.parametersBody = parameters.parametersBody; } // Parse the operation responses. @@ -58,12 +58,10 @@ export function getOperation(openApi: OpenApi, url: string, method: string, op: const responses: OperationResponse[] = getOperationResponses(openApi, op.responses); const response: OperationResponse = getOperationResponse(responses); const errors: OperationError[] = getOperationErrors(responses); - operation.imports.push(...response.imports); - operation.errors = errors; - operation.result = response.type; - - console.log(operation.result); + result.imports.push(...response.imports); + result.errors = errors; + result.result = response.type; } - return operation; + return result; } diff --git a/src/openApi/v2/parser/getOperationName.ts b/src/openApi/v2/parser/getOperationName.ts index 83a9abcb..ed46b315 100644 --- a/src/openApi/v2/parser/getOperationName.ts +++ b/src/openApi/v2/parser/getOperationName.ts @@ -6,6 +6,6 @@ import camelCase from 'camelcase'; * the most popular Javascript and Typescript writing style. */ export function getOperationName(value: string): string { - const clean = value.replace(/[^\w\s\-]+/g, '_').trim(); + const clean: string = value.replace(/[^\w\s\-]+/g, '_').trim(); return camelCase(clean); } diff --git a/src/openApi/v2/parser/getOperationParameters.ts b/src/openApi/v2/parser/getOperationParameters.ts index 240c0fe3..ed6bb97b 100644 --- a/src/openApi/v2/parser/getOperationParameters.ts +++ b/src/openApi/v2/parser/getOperationParameters.ts @@ -11,17 +11,18 @@ function sortByRequired(a: Parameter, b: Parameter): number { } export function getOperationParameters(openApi: OpenApi, parametersOrReferences: (OpenApiParameter & OpenApiReference)[]): OperationParameters { - const imports: string[] = []; - const parameters: Parameter[] = []; - const parametersPath: Parameter[] = []; - const parametersQuery: Parameter[] = []; - const parametersForm: Parameter[] = []; - const parametersHeader: Parameter[] = []; - let parametersBody: Parameter | null = null; + const result: OperationParameters = { + imports: [], + parameters: [], + parametersPath: [], + parametersQuery: [], + parametersForm: [], + parametersHeader: [], + parametersBody: null, + }; // Iterate over the parameters - for (let i = 0, n = parametersOrReferences.length; i < n; i++) { - const parameterOrReference: OpenApiParameter & OpenApiReference = parametersOrReferences[i]; + parametersOrReferences.forEach(parameterOrReference => { const parameter: OpenApiParameter = getRef(openApi, parameterOrReference); const param: Parameter = getParameter(openApi, parameter); @@ -30,45 +31,42 @@ export function getOperationParameters(openApi: OpenApi, parametersOrReferences: if (param.prop !== 'api-version') { switch (parameter.in) { case 'path': - parametersPath.push(param); - parameters.push(param); - imports.push(...param.imports); + result.parametersPath.push(param); + result.parameters.push(param); + result.imports.push(...param.imports); break; case 'query': - parametersQuery.push(param); - parameters.push(param); - imports.push(...param.imports); + result.parametersQuery.push(param); + result.parameters.push(param); + result.imports.push(...param.imports); break; case 'header': - parametersHeader.push(param); - parameters.push(param); - imports.push(...param.imports); + result.parametersHeader.push(param); + result.parameters.push(param); + result.imports.push(...param.imports); break; case 'formData': - parametersForm.push(param); - parameters.push(param); - imports.push(...param.imports); + result.parametersForm.push(param); + result.parameters.push(param); + result.imports.push(...param.imports); break; case 'body': - parametersBody = param; - parameters.push(param); - imports.push(...param.imports); + result.parametersBody = param; + result.parameters.push(param); + result.imports.push(...param.imports); break; } } - } + }); - return { - imports, - parameters: parameters.sort(sortByRequired), - parametersPath: parametersPath.sort(sortByRequired), - parametersQuery: parametersQuery.sort(sortByRequired), - parametersForm: parametersForm.sort(sortByRequired), - parametersHeader: parametersHeader.sort(sortByRequired), - parametersBody: parametersBody, - }; + result.parameters = result.parameters.sort(sortByRequired); + result.parametersPath = result.parametersPath.sort(sortByRequired); + result.parametersQuery = result.parametersQuery.sort(sortByRequired); + result.parametersForm = result.parametersForm.sort(sortByRequired); + result.parametersHeader = result.parametersHeader.sort(sortByRequired); + return result; } diff --git a/src/openApi/v2/parser/getOperationResponse.ts b/src/openApi/v2/parser/getOperationResponse.ts index 466a5933..89a3f34f 100644 --- a/src/openApi/v2/parser/getOperationResponse.ts +++ b/src/openApi/v2/parser/getOperationResponse.ts @@ -1,31 +1,26 @@ import { OperationResponse } from '../../../client/interfaces/OperationResponse'; export function getOperationResponse(responses: OperationResponse[]): OperationResponse { - let responseCode = 200; - let responseText = ''; - let responseType = 'any'; - let responseBase = 'any'; - let responseTemplate: string | null = null; - let responseImports: string[] = []; + const response: OperationResponse = { + code: 200, + text: '', + type: 'any', + base: 'any', + template: null, + imports: [], + }; // Fetch the first valid (2XX range) response code and return that type. const result: OperationResponse | undefined = responses.find(response => response.code && response.code >= 200 && response.code < 300); if (result) { - responseCode = result.code; - responseText = result.text; - responseType = result.type; - responseBase = result.base; - responseTemplate = result.template; - responseImports = [...result.imports]; + response.code = result.code; + response.text = result.text; + response.type = result.type; + response.base = result.base; + response.template = result.template; + response.imports.push(...result.imports); } - return { - code: responseCode, - text: responseText, - type: responseType, - base: responseBase, - template: responseTemplate, - imports: responseImports, - }; + return response; } diff --git a/src/openApi/v2/parser/getOperationResponses.ts b/src/openApi/v2/parser/getOperationResponses.ts index 7d3fae85..5c7b9c7e 100644 --- a/src/openApi/v2/parser/getOperationResponses.ts +++ b/src/openApi/v2/parser/getOperationResponses.ts @@ -12,7 +12,7 @@ import { getSchema } from './getSchema'; import { OpenApiSchema } from '../interfaces/OpenApiSchema'; export function getOperationResponses(openApi: OpenApi, responses: OpenApiResponses): OperationResponse[] { - const result: OperationResponse[] = []; + const results: OperationResponse[] = []; // Iterate over each response code and get the // status code and response message (if any). @@ -21,43 +21,39 @@ export function getOperationResponses(openApi: OpenApi, responses: OpenApiRespon const responseOrReference: OpenApiResponse & OpenApiReference = responses[code]; const response: OpenApiResponse = getRef(openApi, responseOrReference); const responseCode: number | null = getOperationResponseCode(code); - const responseText: string = response.description || ''; - let responseType = 'any'; - let responseBase = 'any'; - let responseTemplate: string | null = null; - let responseImports: string[] = []; - - if (response.schema) { - if (response.schema.$ref) { - const schemaReference: Type = getType(response.schema.$ref); - responseType = schemaReference.type; - responseBase = schemaReference.base; - responseTemplate = schemaReference.template; - responseImports = [...schemaReference.imports]; - } else { - const schema: Schema = getSchema(openApi, response.schema as OpenApiSchema); - responseType = schema.type; - responseBase = schema.base; - responseTemplate = schema.template; - responseImports = [...schema.imports]; - } - } - if (responseCode) { - result.push({ + const result: OperationResponse = { code: responseCode, - text: responseText, - type: responseType, - base: responseBase, - template: responseTemplate, - imports: responseImports, - }); + text: response.description || '', + type: 'any', + base: 'any', + template: null, + imports: [], + }; + + if (response.schema) { + if (response.schema.$ref) { + const schemaReference: Type = getType(response.schema.$ref); + result.type = schemaReference.type; + result.base = schemaReference.base; + result.template = schemaReference.template; + result.imports.push(...schemaReference.imports); + } else { + const schema: Schema = getSchema(openApi, response.schema as OpenApiSchema); + result.type = schema.type; + result.base = schema.base; + result.template = schema.template; + result.imports.push(...schema.imports); + } + } + + results.push(result); } } } // Sort the responses to 2XX success codes come before 4XX and 5XX error codes. - return result.sort((a, b): number => { + return results.sort((a, b): number => { return a.code < b.code ? -1 : a.code > b.code ? 1 : 0; }); } diff --git a/src/openApi/v2/parser/getParameter.ts b/src/openApi/v2/parser/getParameter.ts index 5fb1d484..faa4714f 100644 --- a/src/openApi/v2/parser/getParameter.ts +++ b/src/openApi/v2/parser/getParameter.ts @@ -14,27 +14,36 @@ import { Schema } from '../../../client/interfaces/Schema'; import { OpenApiSchema } from '../interfaces/OpenApiSchema'; export function getParameter(openApi: OpenApi, parameter: OpenApiParameter): Parameter { - let parameterType = 'any'; - let parameterBase = 'any'; - let parameterTemplate: string | null = null; - let parameterImports: string[] = []; + const result: Parameter = { + in: parameter.in, + prop: parameter.name, + name: getParameterName(parameter.name), + type: 'any', + base: 'any', + template: null, + description: getComment(parameter.description), + default: parameter.default, + required: parameter.required || false, + nullable: false, + imports: [], + }; // If the parameter has a type than it can be a basic or generic type. if (parameter.type) { const parameterData: Type = getType(parameter.type); - parameterType = parameterData.type; - parameterBase = parameterData.base; - parameterTemplate = parameterData.template; - parameterImports.push(...parameterData.imports); + result.type = parameterData.type; + result.base = parameterData.base; + result.template = parameterData.template; + result.imports.push(...parameterData.imports); // If the parameter is an Array type, we check for the child type, // so we can create a typed array, otherwise this will be a "any[]". if (parameter.type === 'array' && parameter.items) { const arrayType: ArrayType = getArrayType(parameter.items); - parameterType = `${arrayType.type}[]`; - parameterBase = arrayType.base; - parameterTemplate = arrayType.template; - parameterImports.push(...arrayType.imports); + result.type = `${arrayType.type}[]`; + result.base = arrayType.base; + result.template = arrayType.template; + result.imports.push(...arrayType.imports); } } @@ -45,47 +54,35 @@ export function getParameter(openApi: OpenApi, parameter: OpenApiParameter): Par if (parameter.schema) { if (parameter.schema.$ref) { const schemaReference: Type = getType(parameter.schema.$ref); - parameterType = schemaReference.type; - parameterBase = schemaReference.base; - parameterTemplate = schemaReference.template; - parameterImports.push(...schemaReference.imports); + result.type = schemaReference.type; + result.base = schemaReference.base; + result.template = schemaReference.template; + result.imports.push(...schemaReference.imports); } else { const schema: Schema = getSchema(openApi, parameter.schema as OpenApiSchema); - parameterType = schema.type; - parameterBase = schema.base; - parameterTemplate = schema.template; - parameterImports.push(...schema.imports); + result.type = schema.type; + result.base = schema.base; + result.template = schema.template; + result.imports.push(...schema.imports); } } // If the param is a enum then return the values as an inline type. if (parameter.enum) { - parameterType = getEnumType(parameter.enum); - parameterBase = 'string'; - parameterImports = []; + result.type = getEnumType(parameter.enum); + result.base = 'string'; + result.imports = []; } // Check if this could be a special enum where values are documented in the description. if (parameter.description && parameter.type === 'int') { const enumType: string | null = getEnumTypeFromDescription(parameter.description); if (enumType) { - parameterType = enumType; - parameterBase = 'number'; - parameterImports = []; + result.type = enumType; + result.base = 'number'; + result.imports = []; } } - return { - in: parameter.in, - prop: parameter.name, - name: getParameterName(parameter.name), - type: parameterType, - base: parameterBase, - template: parameterTemplate, - description: getComment(parameter.description), - default: parameter.default, - required: parameter.required || false, - nullable: false, - imports: parameterImports, - }; + return result; } diff --git a/src/openApi/v2/parser/getParameterName.ts b/src/openApi/v2/parser/getParameterName.ts index bab13644..b911c644 100644 --- a/src/openApi/v2/parser/getParameterName.ts +++ b/src/openApi/v2/parser/getParameterName.ts @@ -5,6 +5,6 @@ import camelCase from 'camelcase'; * For example: 'filter.someProperty' becomes 'filterSomeProperty'. */ export function getParameterName(value: string): string { - const clean = value.replace(/[^\w\s\-]+/g, '_').trim(); + const clean: string = value.replace(/[^\w\s\-]+/g, '_').trim(); return camelCase(clean); } diff --git a/src/openApi/v2/parser/getRef.ts b/src/openApi/v2/parser/getRef.ts index 18b25b1a..acb67124 100644 --- a/src/openApi/v2/parser/getRef.ts +++ b/src/openApi/v2/parser/getRef.ts @@ -5,7 +5,7 @@ export function getRef(openApi: OpenApi, item: T & OpenApiReference): T { if (item.$ref) { // Fetch the paths to the definitions, this converts: // "#/definitions/Form" to ["definitions", "Form"] - const paths = item.$ref + const paths: string[] = item.$ref .replace(/^#/g, '') .split('/') .filter(item => item); @@ -13,14 +13,13 @@ export function getRef(openApi: OpenApi, item: T & OpenApiReference): T { // Try to find the reference by walking down the path, // if we cannot find it, then we throw an error. let result: any = openApi; - for (let i = 0, n = paths.length; i < n; i++) { - const path: string = paths[i]; + paths.forEach(path => { if (result.hasOwnProperty(path)) { result = result[path]; } else { throw new Error(`Could not find reference: "${item.$ref}"`); } - } + }); return result as T; } return item as T; diff --git a/src/openApi/v2/parser/getSchema.ts b/src/openApi/v2/parser/getSchema.ts index 4fdd47a2..8b68f389 100644 --- a/src/openApi/v2/parser/getSchema.ts +++ b/src/openApi/v2/parser/getSchema.ts @@ -1,12 +1,130 @@ import { OpenApi } from '../interfaces/OpenApi'; import { Schema } from '../../../client/interfaces/Schema'; import { OpenApiSchema } from '../interfaces/OpenApiSchema'; +import { getType } from './getType'; +import { getComment } from './getComment'; +import { Type } from '../../../client/interfaces/Type'; +import { getEnumType } from './getEnumType'; +import { getEnumTypeFromDescription } from './getEnumTypeFromDescription'; +import { Dictionary } from '../../../utils/types'; +import { OpenApiReference } from '../interfaces/OpenApiReference'; +import { getRef } from './getRef'; -export function getSchema(openApi: OpenApi, schema: OpenApiSchema): Schema { - return { - type: 'todo', - base: 'todo', +export function getSchema(openApi: OpenApi, schema: OpenApiSchema, required: boolean = false): Schema { + /** + format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password'; + title?: string; + description?: string; + default?: any; + multipleOf?: number; + maximum?: number; + exclusiveMaximum?: boolean; + minimum?: number; + exclusiveMinimum?: boolean; + maxLength?: number; + minLength?: number; + pattern?: string; + maxItems?: number; + minItems?: number; + uniqueItems?: number; + maxProperties?: number; + minProperties?: number; + required?: string[]; + enum?: string[]; + type?: string; + items?: OpenApiSchema & OpenApiReference; + allOf?: (OpenApiSchema & OpenApiReference)[]; + properties?: Dictionary; + additionalProperties?: boolean | (OpenApiSchema & OpenApiReference); + discriminator?: string; + readOnly?: boolean; + xml?: OpenApiXml; + externalDocs?: OpenApiExternalDocs; + example?: any; + */ + + // TODO: Does this need a name? + const result: Schema = { + type: 'any', + base: 'any', template: null, + description: getComment(schema.description), + default: schema.default, + required: required, + nullable: false, + readOnly: schema.readOnly || false, + extends: [], imports: [], + properties: {}, }; + + // If the schema has a type than it can be a basic or generic type. + if (schema.type) { + const schemaData: Type = getType(schema.type); + result.type = schemaData.type; + result.base = schemaData.base; + result.template = schemaData.template; + result.imports.push(...schemaData.imports); + + // If the schema is an Array type, we check for the child type, + // so we can create a typed array, otherwise this will be a "any[]". + if (schema.type === 'array' && schema.items) { + const itemsOrReference: OpenApiSchema & OpenApiReference = schema.items; + const items: OpenApiSchema = getRef(openApi, itemsOrReference); + const itemsSchema: Schema = getSchema(openApi, items); + result.type = `${itemsSchema.type}[]`; + result.base = itemsSchema.base; + result.template = itemsSchema.template; + result.imports.push(...itemsSchema.imports); + } + } + + // If the param is a enum then return the values as an inline type. + if (schema.enum) { + result.type = getEnumType(schema.enum); + result.base = 'string'; + result.imports = []; + } + + // Check if this could be a special enum where values are documented in the description. + if (schema.description && schema.type === 'int') { + const enumType: string | null = getEnumTypeFromDescription(schema.description); + if (enumType) { + result.type = enumType; + result.base = 'number'; + result.imports = []; + } + } + + // Check if this model extends other models + if (schema.allOf) { + schema.allOf.forEach(parent => { + if (parent.$ref) { + const extend: Type = getType(parent.$ref); + result.extends.push(extend.type); + result.imports.push(extend.base); + } + + // Merge properties of other models + if (parent.properties) { + console.log(parent.properties); + // const properties: ParsedModelProperties = parseModelProperties(modelClass, definition.allOf[1].properties as SwaggerDefinitions, required); + // model.imports.push(...properties.imports); + // model.properties.push(...properties.properties); + // model.enums.push(...properties.enums); + } + }); + } + + const properties: Dictionary | undefined = schema.properties; + for (const propertyName in properties) { + if (properties.hasOwnProperty(propertyName)) { + const property = properties[propertyName]; + // console.log('property??', property); + // console.log('propertyName', propertyName); + // getModelProperty(propertyName, property); + } + } + + return result; } diff --git a/src/openApi/v2/parser/getServer.ts b/src/openApi/v2/parser/getServer.ts index 6037e0c5..ab229940 100644 --- a/src/openApi/v2/parser/getServer.ts +++ b/src/openApi/v2/parser/getServer.ts @@ -5,8 +5,8 @@ import { OpenApi } from '../interfaces/OpenApi'; * @param openApi */ export function getServer(openApi: OpenApi): string { - const scheme = (openApi.schemes && openApi.schemes[0]) || 'http'; - const host = openApi.host; - const basePath = openApi.basePath || ''; + const scheme: string = (openApi.schemes && openApi.schemes[0]) || 'http'; + const host: string | undefined = openApi.host; + const basePath: string = openApi.basePath || ''; return host ? `${scheme}://${host}${basePath}` : basePath; } diff --git a/src/openApi/v2/parser/getServiceClassName.ts b/src/openApi/v2/parser/getServiceClassName.ts index ffaeb49c..57dcae30 100644 --- a/src/openApi/v2/parser/getServiceClassName.ts +++ b/src/openApi/v2/parser/getServiceClassName.ts @@ -5,7 +5,7 @@ import camelCase from 'camelcase'; * the input string to PascalCase and appends the "Service" prefix if needed. */ export function getServiceClassName(value: string): string { - const clean = value.replace(/[^\w\s\-]+/g, '_').trim(); + const clean: string = value.replace(/[^\w\s\-]+/g, '_').trim(); const name: string = camelCase(clean, { pascalCase: true }); if (name && !name.endsWith('Service')) { return `${name}Service`; diff --git a/src/openApi/v2/parser/getType.ts b/src/openApi/v2/parser/getType.ts index 7034aea9..62a663fb 100644 --- a/src/openApi/v2/parser/getType.ts +++ b/src/openApi/v2/parser/getType.ts @@ -8,10 +8,12 @@ import { getMappedType, hasMappedType } from './getMappedType'; * @param template Optional template class from parent (needed to process generics) */ export function getType(value: string | undefined, template: string | null = null): Type { - let propertyType = 'any'; - let propertyBase = 'any'; - let propertyTemplate: string | null = null; - let propertyImports: string[] = []; + const result: Type = { + type: 'any', + base: 'any', + template: null, + imports: [], + }; // Remove definitions prefix and cleanup string. const valueClean: string = stripNamespace(value || ''); @@ -27,47 +29,42 @@ export function getType(value: string | undefined, template: string | null = nul // If the first match is a generic array then construct a correct array type, // for example the type "Array[Model]" becomes "Model[]". if (match1.type === 'any[]') { - propertyType = `${match2.type}[]`; - propertyBase = `${match2.type}`; + result.type = `${match2.type}[]`; + result.base = `${match2.type}`; match1.imports = []; } else if (match2.type === '') { // Primary types like number[] or string[] - propertyType = match1.type; - propertyBase = match1.type; - propertyTemplate = match1.type; + result.type = match1.type; + result.base = match1.type; + result.template = match1.type; match2.imports = []; } else { - propertyType = `${match1.type}<${match2.type}>`; - propertyBase = match1.type; - propertyTemplate = match2.type; + result.type = `${match1.type}<${match2.type}>`; + result.base = match1.type; + result.template = match2.type; } // Either way we need to add the found imports - propertyImports.push(...match1.imports); - propertyImports.push(...match2.imports); + result.imports.push(...match1.imports); + result.imports.push(...match2.imports); } } else if (hasMappedType(valueClean)) { const mapped: string = getMappedType(valueClean); - propertyType = mapped; - propertyBase = mapped; + result.type = mapped; + result.base = mapped; } else { - propertyType = valueClean; - propertyBase = valueClean; - propertyImports.push(valueClean); + result.type = valueClean; + result.base = valueClean; + result.imports.push(valueClean); } // If the property that we found matched the parent template class // Then ignore this whole property and return it as a "T" template property. - if (propertyType === template) { - propertyType = 'T'; // Template; - propertyBase = 'T'; // Template; - propertyImports = []; + if (result.type === template) { + result.type = 'T'; // Template; + result.base = 'T'; // Template; + result.imports = []; } - return { - type: propertyType, - base: propertyBase, - template: propertyTemplate, - imports: propertyImports, - }; + return result; } diff --git a/src/templates/javascript/core/ApiError.js b/src/templates/javascript/core/ApiError.js index 7bfdbcc6..25388488 100644 --- a/src/templates/javascript/core/ApiError.js +++ b/src/templates/javascript/core/ApiError.js @@ -1,5 +1,6 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ import { isSuccess } from "./isSuccess"; diff --git a/src/templates/javascript/core/OpenAPI.js b/src/templates/javascript/core/OpenAPI.js index 71f8eca8..f20fbce1 100644 --- a/src/templates/javascript/core/OpenAPI.js +++ b/src/templates/javascript/core/OpenAPI.js @@ -1,5 +1,6 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ export let OpenAPI; (function (OpenAPI) { diff --git a/src/templates/javascript/core/getFormData.js b/src/templates/javascript/core/getFormData.js index 03256b33..50ef9885 100644 --- a/src/templates/javascript/core/getFormData.js +++ b/src/templates/javascript/core/getFormData.js @@ -1,5 +1,6 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ /** * Get FormData from object. This method is needed to upload diff --git a/src/templates/javascript/core/getQueryString.js b/src/templates/javascript/core/getQueryString.js index d31789a1..190ba2c0 100644 --- a/src/templates/javascript/core/getQueryString.js +++ b/src/templates/javascript/core/getQueryString.js @@ -1,5 +1,6 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ /** * Get query string from query parameters object. This method also @@ -13,9 +14,9 @@ export function getQueryString(params) { const value = params[key]; if (value !== undefined && value !== null) { if (Array.isArray(value)) { - for (let i = 0, n = value.length; i < n; i++) { - qs.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(value[i]))}`); - } + value.forEach(value => { + qs.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`); + }); } else { qs.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`); } diff --git a/src/templates/javascript/core/isSuccess.js b/src/templates/javascript/core/isSuccess.js index d42ee321..3813a45a 100644 --- a/src/templates/javascript/core/isSuccess.js +++ b/src/templates/javascript/core/isSuccess.js @@ -1,5 +1,6 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ /** * Check success response code. diff --git a/src/templates/javascript/core/isValidRequiredParam.js b/src/templates/javascript/core/isValidRequiredParam.js index 19cf9189..6bd81d56 100644 --- a/src/templates/javascript/core/isValidRequiredParam.js +++ b/src/templates/javascript/core/isValidRequiredParam.js @@ -1,5 +1,6 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ /** * Check if a parameter is valid. diff --git a/src/templates/javascript/core/request.js b/src/templates/javascript/core/request.js index 11e71d7d..6a246144 100644 --- a/src/templates/javascript/core/request.js +++ b/src/templates/javascript/core/request.js @@ -1,10 +1,11 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ -import {getFormData} from './getFormData'; -import {getQueryString} from './getQueryString'; -import {OpenAPI} from './OpenAPI'; -import {requestUsingFetch} from './requestUsingFetch'; +import { getFormData } from './getFormData'; +import { getQueryString } from './getQueryString'; +import { OpenAPI } from './OpenAPI'; +import { requestUsingFetch } from './requestUsingFetch'; /** * Create the request. diff --git a/src/templates/javascript/core/requestUsingFetch.js b/src/templates/javascript/core/requestUsingFetch.js index e508691c..6d692c96 100644 --- a/src/templates/javascript/core/requestUsingFetch.js +++ b/src/templates/javascript/core/requestUsingFetch.js @@ -1,5 +1,6 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ /** * Request content using the new Fetch API. This is the default API that is used and diff --git a/src/templates/javascript/core/requestUsingXHR.js b/src/templates/javascript/core/requestUsingXHR.js index dfbd92c5..58dc21ef 100644 --- a/src/templates/javascript/core/requestUsingXHR.js +++ b/src/templates/javascript/core/requestUsingXHR.js @@ -1,8 +1,8 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ -import { Result } from './Result'; -import {isSuccess} from "./isSuccess"; +import { isSuccess } from "./isSuccess"; /** * Request content using the new legacy XMLHttpRequest API. This method is usefull diff --git a/src/templates/javascript/index.hbs b/src/templates/javascript/index.hbs index 860ed55f..6454d8a8 100644 --- a/src/templates/javascript/index.hbs +++ b/src/templates/javascript/index.hbs @@ -1,5 +1,6 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ export { ApiError } from './core/ApiError'; export { OpenAPI } from './core/OpenAPI'; diff --git a/src/templates/javascript/model.hbs b/src/templates/javascript/model.hbs index 2677cdd3..f5fcc623 100644 --- a/src/templates/javascript/model.hbs +++ b/src/templates/javascript/model.hbs @@ -1,5 +1,6 @@ /* istanbul ignore file */ /* eslint-disable */ +/* prettier-ignore */ {{#if imports}} {{#each imports}} diff --git a/src/templates/javascript/service.hbs b/src/templates/javascript/service.hbs index 607ac5e3..f702af53 100644 --- a/src/templates/javascript/service.hbs +++ b/src/templates/javascript/service.hbs @@ -1,6 +1,6 @@ /* istanbul ignore file */ /* eslint-disable */ -import * as yup from 'yup'; +/* prettier-ignore */ import { ApiError, catchGenericError } from '../core/ApiError'; import { request } from '../core/request'; diff --git a/src/templates/typescript/core/ApiError.ts b/src/templates/typescript/core/ApiError.ts index 041adcdd..a5d86214 100644 --- a/src/templates/typescript/core/ApiError.ts +++ b/src/templates/typescript/core/ApiError.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ import { isSuccess } from './isSuccess'; import { Result } from './Result'; diff --git a/src/templates/typescript/core/Dictionary.ts b/src/templates/typescript/core/Dictionary.ts index 8008973b..d780f127 100644 --- a/src/templates/typescript/core/Dictionary.ts +++ b/src/templates/typescript/core/Dictionary.ts @@ -1,3 +1,8 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +/* prettier-ignore */ + export interface Dictionary { [key: string]: T; } diff --git a/src/templates/typescript/core/OpenAPI.ts b/src/templates/typescript/core/OpenAPI.ts index 1cb106bb..e66257c3 100644 --- a/src/templates/typescript/core/OpenAPI.ts +++ b/src/templates/typescript/core/OpenAPI.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ export namespace OpenAPI { export let BASE: string = ''; diff --git a/src/templates/typescript/core/RequestOptions.ts b/src/templates/typescript/core/RequestOptions.ts index a1b2cfed..7816bf98 100644 --- a/src/templates/typescript/core/RequestOptions.ts +++ b/src/templates/typescript/core/RequestOptions.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ export interface RequestOptions { method: string; diff --git a/src/templates/typescript/core/Result.ts b/src/templates/typescript/core/Result.ts index 42c51286..9a2892d2 100644 --- a/src/templates/typescript/core/Result.ts +++ b/src/templates/typescript/core/Result.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ export interface Result { url: string; diff --git a/src/templates/typescript/core/getFormData.ts b/src/templates/typescript/core/getFormData.ts index 695d7119..df4fffd0 100644 --- a/src/templates/typescript/core/getFormData.ts +++ b/src/templates/typescript/core/getFormData.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ /** * Get FormData from object. This method is needed to upload diff --git a/src/templates/typescript/core/getQueryString.ts b/src/templates/typescript/core/getQueryString.ts index 4ecb874b..8866db77 100644 --- a/src/templates/typescript/core/getQueryString.ts +++ b/src/templates/typescript/core/getQueryString.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ /** * Get query string from query parameters object. This method also @@ -14,9 +15,9 @@ export function getQueryString(params: { [key: string]: any }): string { const value: any = params[key]; if (value !== undefined && value !== null) { if (Array.isArray(value)) { - for (let i = 0, n = value.length; i < n; i++) { - qs.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(value[i]))}`); - } + value.forEach(value => { + qs.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`); + }); } else { qs.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`); } diff --git a/src/templates/typescript/core/isSuccess.ts b/src/templates/typescript/core/isSuccess.ts index 272e7122..8d3d2115 100644 --- a/src/templates/typescript/core/isSuccess.ts +++ b/src/templates/typescript/core/isSuccess.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ /** * Check success response code. diff --git a/src/templates/typescript/core/isValidRequiredParam.ts b/src/templates/typescript/core/isValidRequiredParam.ts index d65dd37b..73ebc900 100644 --- a/src/templates/typescript/core/isValidRequiredParam.ts +++ b/src/templates/typescript/core/isValidRequiredParam.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ /** * Check if a parameter is valid. diff --git a/src/templates/typescript/core/request.ts b/src/templates/typescript/core/request.ts index a505edc9..83fc5101 100644 --- a/src/templates/typescript/core/request.ts +++ b/src/templates/typescript/core/request.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ import { getFormData } from './getFormData'; import { getQueryString } from './getQueryString'; diff --git a/src/templates/typescript/core/requestUsingFetch.ts b/src/templates/typescript/core/requestUsingFetch.ts index 8d3134f5..4ec4050b 100644 --- a/src/templates/typescript/core/requestUsingFetch.ts +++ b/src/templates/typescript/core/requestUsingFetch.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ import { Result } from './Result'; diff --git a/src/templates/typescript/core/requestUsingXHR.ts b/src/templates/typescript/core/requestUsingXHR.ts index 515b05e0..a3774493 100644 --- a/src/templates/typescript/core/requestUsingXHR.ts +++ b/src/templates/typescript/core/requestUsingXHR.ts @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ import { Result } from './Result'; import { isSuccess } from './isSuccess'; diff --git a/src/templates/typescript/index.hbs b/src/templates/typescript/index.hbs index 4cba2408..94e48bba 100644 --- a/src/templates/typescript/index.hbs +++ b/src/templates/typescript/index.hbs @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ export { ApiError } from './core/ApiError'; export { isSuccess } from './core/isSuccess'; diff --git a/src/templates/typescript/model.hbs b/src/templates/typescript/model.hbs index 6d258690..58d7aa79 100644 --- a/src/templates/typescript/model.hbs +++ b/src/templates/typescript/model.hbs @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ {{#if imports}} {{#each imports}} diff --git a/src/templates/typescript/service.hbs b/src/templates/typescript/service.hbs index 99eb386b..4a232f92 100644 --- a/src/templates/typescript/service.hbs +++ b/src/templates/typescript/service.hbs @@ -1,6 +1,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +/* prettier-ignore */ {{#if imports}} {{#each imports}} diff --git a/src/utils/getOpenApiSpec.ts b/src/utils/getOpenApiSpec.ts index bde0416e..c06cfccb 100644 --- a/src/utils/getOpenApiSpec.ts +++ b/src/utils/getOpenApiSpec.ts @@ -25,7 +25,6 @@ function read(filePath: string): string { */ export function getOpenApiSpec(filePath: string): any { const content: string = read(filePath); - const extname: string = path.extname(filePath).toLowerCase(); switch (extname) { case '.yml': diff --git a/src/utils/getOpenApiVersion.ts b/src/utils/getOpenApiVersion.ts index c9b0e394..7cde3691 100644 --- a/src/utils/getOpenApiVersion.ts +++ b/src/utils/getOpenApiVersion.ts @@ -9,7 +9,7 @@ export enum OpenApiVersion { * an incompatible type. Or if the type is missing... * @param openApi The loaded spec (can be any object) */ -export function getOpenApiVersion(openApi: any): OpenApiVersion | undefined { +export function getOpenApiVersion(openApi: any): OpenApiVersion { const info: any = openApi.swagger || openApi.openapi; if (info && typeof info === 'string') { const c: string = info.charAt(0); diff --git a/test/mock/v2/test-docs.json b/test/mock/v2/test-docs.json index 6cc75c60..98d37d54 100644 --- a/test/mock/v2/test-docs.json +++ b/test/mock/v2/test-docs.json @@ -1,29 +1,17 @@ { "swagger": "2.0", - "info": { - "version": "v1", - "title": "Trisoft.InfoShare.Web" - }, + "info": { "version": "v1", "title": "Trisoft.InfoShare.Web" }, "host": "localhost:40470", "basePath": "/infoshareauthor", - "schemes": [ - "https" - ], + "schemes": ["https"], "paths": { "/Api/Annotations/Form/": { "get": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Gets a new annotation creation form for a content object specified in parameters.", "operationId": "GetCreateForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "formId", @@ -39,159 +27,66 @@ "required": false, "type": "string" }, - { - "name": "param.publicationId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "param.publicationVersion", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "param.revisionId", - "in": "query", - "required": false, - "type": "string" - } + { "name": "param.publicationId", "in": "query", "required": false, "type": "string" }, + { "name": "param.publicationVersion", "in": "query", "required": false, "type": "string" }, + { "name": "param.revisionId", "in": "query", "required": false, "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/Annotations/": { "put": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Updates multiple annotations", "operationId": "Update", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { - "name": "updateRequestParameters", + "name": "parameter", "in": "body", - "description": "List of request objects (annotationId and metadata) that needs to be updated", + "description": "List of request objects (annotationId and metadata) that needs to be updated and the requested fields", "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AnnotationUpdateRequest" - } - } + "schema": { "$ref": "#/definitions/AnnotationMultipleUpdateRequestParameter" } } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AnnotationUpdateResponse" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/AnnotationUpdateResponse" } } } } }, "post": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Creates an annotation specified by {param} with the specified metadata.", "operationId": "Create", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { - "name": "metadata", + "name": "request", "in": "body", "description": "Contains information related with annotation to be created.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/AnnotationRequest" } }, - { - "name": "param.publicationId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "param.publicationVersion", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "param.revisionId", - "in": "query", - "required": false, - "type": "string" - } + { "name": "param.publicationId", "in": "query", "required": false, "type": "string" }, + { "name": "param.publicationVersion", "in": "query", "required": false, "type": "string" }, + { "name": "param.revisionId", "in": "query", "required": false, "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/Annotations/{annotationId}/Form/": { "get": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Gets a form to update an annotation by the given id.", "operationId": "GetUpdateForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ - { - "name": "annotationId", - "in": "path", - "description": "Annotation Id", - "required": true, - "type": "string" - }, + { "name": "annotationId", "in": "path", "description": "Annotation Id", "required": true, "type": "string" }, { "name": "formId", "in": "query", @@ -207,37 +102,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/Annotations/{annotationId}/": { "put": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Updates the annotation specified by {annotationId} with the specified metadata.", "description": "The parameter {metadata} can only contain fields of annotation level.", "operationId": "Update", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "annotationId", @@ -247,153 +122,83 @@ "type": "string" }, { - "name": "metadata", + "name": "request", "in": "body", "description": "Optional. Metadata containing a collection of {Trisoft.InfoShare.XAPI.Models.FieldValue} instances that will be set on the annotation.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/AnnotationRequest" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AnnotationDescriptor" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AnnotationMetadata" } } } }, "delete": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Deletes an annotation by the given annotation id.", "description": "Requirements are: \r\nThe user must have write access for the folder in which the object that has annotation with ID.", "operationId": "Delete", "consumes": [], "produces": [], "parameters": [ - { - "name": "annotationId", - "in": "path", - "description": "annotation ID", - "required": true, - "type": "string" - } + { "name": "annotationId", "in": "path", "description": "annotation ID", "required": true, "type": "string" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/Annotations/Details/": { "post": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Gets the values of requested fields for given annotations ids.", "operationId": "GetDetails", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "parameter", "in": "body", "description": "Contains information about the desired annotation ids and requested fields.", "required": true, - "schema": { - "$ref": "#/definitions/AnnotationDetailParameters" - } + "schema": { "$ref": "#/definitions/AnnotationDetailParameters" } } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AnnotationMetadata" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/AnnotationMetadata" } } } } } }, "/Api/Annotations/List/": { "post": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Gets the values of requested fields for given filters.", "operationId": "List", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "parameter", "in": "body", "description": "Contains information about the desired publication, metadata filtters and requested fields.", "required": true, - "schema": { - "$ref": "#/definitions/AnnotationListParameters" - } + "schema": { "$ref": "#/definitions/AnnotationListParameters" } } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AnnotationMetadata" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/AnnotationMetadata" } } } } } }, "/Api/Annotations/{annotationId}/Replies/{annotationReplyId}/": { "put": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Updates the reply.", "operationId": "UpdateReply", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "annotationId", @@ -402,41 +207,23 @@ "required": true, "type": "string" }, + { "name": "annotationReplyId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { - "name": "annotationReplyId", - "in": "path", - "description": "The annotation reply identifier.", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "metadata", + "name": "annotationReplyRequest", "in": "body", - "description": "The metadata that holds the detail of the annotation reply.", + "description": "The metadata that holds the detail of the annotation reply and requested metadata fields", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/AnnotationRequest" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AnnotationReplyDescriptor" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AnnotationMetadata" } } } }, "delete": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Deletes the reply.", "operationId": "DeleteReply", - "consumes": [], - "produces": [], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "annotationId", @@ -452,35 +239,25 @@ "required": true, "type": "integer", "format": "int64" + }, + { + "name": "requestedMetadata", + "in": "body", + "description": "The metadata that holds requested metadata fields", + "required": true, + "schema": { "$ref": "#/definitions/RequestedMetadata" } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AnnotationMetadata" } } } } }, "/Api/Annotations/{annotationId}/Replies/": { "post": { - "tags": [ - "Annotations" - ], + "tags": ["Annotations"], "summary": "Creates the reply.", "operationId": "CreateReply", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "annotationId", @@ -490,205 +267,99 @@ "type": "string" }, { - "name": "metadata", + "name": "annotationReplyRequest", "in": "body", - "description": "The metadata that holds the detail of the annotation reply.", + "description": "The metadata that holds the detail of the annotation reply and requested metadata fields", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/AnnotationRequest" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AnnotationReplyDescriptor" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AnnotationMetadata" } } } } }, "/Api/Comments/DeleteMultipleById/": { "post": { - "tags": [ - "Comments" - ], + "tags": ["Comments"], "summary": "Deletes the multiple comments by identifier.", "operationId": "DeleteMultipleById", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "ids", "in": "body", "description": "The ids.", "required": true, - "schema": { - "type": "array", - "items": { - "format": "int64", - "type": "integer" - } - } + "schema": { "type": "array", "items": { "format": "int64", "type": "integer" } } } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "format": "int64", - "type": "integer" - } - } + "schema": { "type": "array", "items": { "format": "int64", "type": "integer" } } } } } }, "/Api/Comments/Users/": { "get": { - "tags": [ - "Comments" - ], + "tags": ["Comments"], "summary": "Get users for the given parameters", "operationId": "GetUsers", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/User" - } - } - } + "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/User" } } } } } }, "/Api/Comments/Languages/": { "get": { - "tags": [ - "Comments" - ], + "tags": ["Comments"], "summary": "Gets comment languages", "operationId": "GetLanguages", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/Api/Comments/Publications/{language}/": { "get": { - "tags": [ - "Comments" - ], + "tags": ["Comments"], "summary": "Gets the publications.", "operationId": "GetPublications", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ - { - "name": "language", - "in": "path", - "description": "The language.", - "required": true, - "type": "string" - } + { "name": "language", "in": "path", "description": "The language.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Publication" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/Publication" } } } } } }, "/Api/Comments/Statuses/": { "get": { - "tags": [ - "Comments" - ], + "tags": ["Comments"], "summary": "Gets comment statuses", "operationId": "GetStatuses", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Status" - } - } - } + "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Status" } } } } } }, "/api/Comments/": { "get": { - "tags": [ - "Comments" - ], + "tags": ["Comments"], "summary": "Get comments for the given parameters", "operationId": "Get", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "language", @@ -729,13 +400,7 @@ "type": "integer", "format": "int32" }, - { - "name": "status", - "in": "query", - "description": "The status.", - "required": false, - "type": "string" - }, + { "name": "status", "in": "query", "description": "The status.", "required": false, "type": "string" }, { "name": "userId", "in": "query", @@ -760,69 +425,33 @@ "format": "int32" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CommentingResult" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommentingResult" } } } }, "post": { - "tags": [ - "Comments" - ], + "tags": ["Comments"], "summary": "Posts the specified value.", "operationId": "Post", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "value", "in": "body", "description": "The value.", "required": true, - "schema": { - "$ref": "#/definitions/Comment" - } + "schema": { "$ref": "#/definitions/Comment" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Comment" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Comment" } } } } }, "/api/Comments/{id}/": { "get": { - "tags": [ - "Comments" - ], + "tags": ["Comments"], "summary": "Gets the specified identifier.", "operationId": "Get", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "id", @@ -833,34 +462,14 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Comment" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Comment" } } } }, "put": { - "tags": [ - "Comments" - ], + "tags": ["Comments"], "summary": "Puts the specified identifier.", "operationId": "Put", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "id", @@ -875,24 +484,13 @@ "in": "body", "description": "The value.", "required": true, - "schema": { - "$ref": "#/definitions/Comment" - } + "schema": { "$ref": "#/definitions/Comment" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Comment" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Comment" } } } }, "delete": { - "tags": [ - "Comments" - ], + "tags": ["Comments"], "summary": "Deletes the comment.", "operationId": "Delete", "consumes": [], @@ -907,28 +505,17 @@ "format": "int64" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/ContentObjects/": { "post": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Creates a new content object in the specified folder.", "description": "The metadata that will be set on the content object, can be passed in the request body in JSON format.\r\nThe metadata can contain fields of all levels (logical, version, language).\r\nThe logical identifier can explicitly be added to the metadata.\r\nThe version cannot be added to the metadata. By default, it is set to 1.\r\nThe language and resolution can explicitly be added to the metadata. If the language is not provided by the metadata the default language will be used (language on user card). If the resolution is not provided by the metadata the default resolution will be used (resolution on settings card).\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", "operationId": "CreateObject", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["multipart/form-data"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "folderCardId", @@ -938,43 +525,19 @@ "type": "integer", "format": "int64" }, - { - "name": "data", - "in": "formData", - "required": false, - "type": "File" - }, - { - "name": "metadata", - "in": "formData", - "required": false, - "type": "string" - } + { "name": "data", "in": "formData", "required": false, "type": "File" }, + { "name": "metadata", "in": "formData", "required": false, "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/ContentObjects/{folderCardId}/": { "get": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets a new content object in the specified folder.", "operationId": "GetCreateObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "folderCardId", @@ -984,13 +547,7 @@ "type": "integer", "format": "int64" }, - { - "name": "referenceLanguageCardId", - "in": "query", - "required": true, - "type": "integer", - "format": "int64" - }, + { "name": "referenceLanguageCardId", "in": "query", "required": true, "type": "integer", "format": "int64" }, { "name": "formId", "in": "query", @@ -1006,29 +563,15 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } }, "post": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Creates a new content object in the specified folder.", "description": "The metadata that will be set on the content object, can be passed in the request body in JSON format.\r\nThe metadata can contain fields of all levels (logical, version, language).\r\nThe logical identifier can explicitly be added to the metadata.\r\nThe version cannot be added to the metadata. By default, it is set to 1.\r\nThe fields are inherited from the editor template or reference object specified by {referenceLanguageCardId}. If the language or resolution is provided by the metadata, they have to be equal to the language or resolution of the editor template or reference object.\r\nContent cannot be uploaded. A multipart body is not supported.", "operationId": "Create", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["multipart/form-data"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "folderCardId", @@ -1046,56 +589,22 @@ "type": "integer", "format": "int64" }, - { - "name": "formId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "clientNames", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "data", - "in": "formData", - "required": false, - "type": "File" - }, - { - "name": "metadata", - "in": "formData", - "required": false, - "type": "string" - } + { "name": "formId", "in": "query", "required": false, "type": "string" }, + { "name": "clientNames", "in": "query", "required": false, "type": "string" }, + { "name": "data", "in": "formData", "required": false, "type": "File" }, + { "name": "metadata", "in": "formData", "required": false, "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/ContentObjects/LanguageCard/{languageCardId}/": { "get": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets a form containing definition and values needed to generate a form to update an existing object.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateObject\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetUpdateObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -1120,25 +629,14 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } }, "put": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Updates the content object specified by {languageCardId}.", "description": "The metadata that will be set on the content object, can be passed in the request body in JSON format.\r\nThe metadata can contain fields of all levels (logical, version, language).\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", "operationId": "Update", - "consumes": [ - "multipart/form-data" - ], + "consumes": ["multipart/form-data"], "produces": [], "parameters": [ { @@ -1149,79 +647,31 @@ "type": "integer", "format": "int64" }, - { - "name": "data", - "in": "formData", - "required": false, - "type": "File" - }, - { - "name": "metadata", - "in": "formData", - "required": false, - "type": "string" - } + { "name": "data", "in": "formData", "required": false, "type": "File" }, + { "name": "metadata", "in": "formData", "required": false, "type": "string" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/ContentObjects/LanguageCard/{languageCardId}/CheckIn/": { "get": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "operationId": "GetCheckinObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ - { - "name": "languageCardId", - "in": "path", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "formId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "clientName", - "in": "query", - "required": false, - "type": "string" - } + { "name": "languageCardId", "in": "path", "required": true, "type": "integer", "format": "int64" }, + { "name": "formId", "in": "query", "required": false, "type": "string" }, + { "name": "clientName", "in": "query", "required": false, "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } }, "put": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Checks in the content object specified by {languageCardId}.", "description": "The metadata that will be set on the content object, can be passed in the request body in JSON format.\r\nThe metadata can contain fields of all levels (logical, version, language).\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", "operationId": "Checkin", - "consumes": [ - "multipart/form-data" - ], + "consumes": ["multipart/form-data"], "produces": [], "parameters": [ { @@ -1232,47 +682,21 @@ "type": "integer", "format": "int64" }, - { - "name": "keepCheckedOut", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "data", - "in": "formData", - "required": false, - "type": "File" - }, - { - "name": "metadata", - "in": "formData", - "required": false, - "type": "string" - } + { "name": "keepCheckedOut", "in": "query", "required": false, "type": "boolean" }, + { "name": "data", "in": "formData", "required": false, "type": "File" }, + { "name": "metadata", "in": "formData", "required": false, "type": "string" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/ContentObjects/{logicalId}/": { "get": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets a form containing definition and values needed to generate a form to update an existing logical object.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLogicalObject\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetUpdateObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -1303,33 +727,15 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } }, "post": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Creates a new version object in the specified logical object.", "description": "The parameter {metadata} can only contain version level fields.\r\nThe version can explicitly be added to the metadata. If the version is not provided by the metadatas the version will be generated by calculating the next free version number on the main branch for the specified logical object (e.g. 3.1.2 -> 4).\r\nThis method is only to be used in the old web client.", "operationId": "CreateVersionObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -1343,36 +749,20 @@ "in": "body", "description": "The metadata that will be set on the version object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/ContentObjects/{logicalId}/Version/": { "get": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets a form containing definition and values needed to generate a form to create a new version object.", "description": "The {fromVersion} is optional. By default, a new version number will be generated.\r\nThe {doBranch} is optional. By default, a new version number will be generated.\r\nThe {formId} is optional. By default, \"Properties_NewVersion_'ObjectType'\" is used.", "operationId": "GetCreateVersionObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -1418,30 +808,16 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/ContentObjects/{logicalId}/DefaultMetadata/": { "post": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Creates a new version object (fills the required metadata fields with latest version's default language object field values).", "operationId": "CreateVersionObjectWithDefaultMetadata", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -1465,30 +841,16 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DocumentObjDescriptor" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentObjDescriptor" } } } } }, "/Api/ContentObjects/DefaultLanguageCardId/": { "get": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets the language card id of the default language for related logicalId.", "operationId": "GetDefaultLanguageCardId", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -1519,32 +881,17 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "format": "int64", - "type": "integer" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "format": "int64", "type": "integer" } } } } }, "/Api/ContentObjects/{logicalId}/Version/{version}/": { "get": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets a form containing definition and values needed to generate a form to create a new version object.", "description": "The {formId} is optional. By default, \"Properties_Create_'ObjectType'\" is used.", "operationId": "GetCreateLanguageObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -1583,33 +930,15 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } }, "post": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Creates a new version object in the specified logical object.", "description": "The parameter {metadata} can only contain version level fields.\r\nThe version can explicitly be added to the metadata. If the version is not provided by the metadatas the version will be generated by calculating the next free version number on the main branch for the specified logical object (e.g. 3.1.2 -> 4).\r\nThis method is only to be used in the old web client.", "operationId": "CreateLanguageObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -1630,33 +959,19 @@ "in": "body", "description": "The metadata that will be set on the version object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/ContentObjects/RevisionObject/{revisionId}/Content/": { "get": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Get XML content for a document", "operationId": "GetContent", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "revisionId", @@ -1673,155 +988,83 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/ContentObjects/InContext/Metadata/": { "post": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets the metadata for the given logical id matching the versions specified in the baseline for the given publication version", "operationId": "GetInContextMetadata", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "parameters", "in": "body", "description": "InContextMetadataParameters with the parameters for the call including:\r\n Logical Id of the publication, Version of the publication, Logical Ids of the documents or images, Requested metadata, Language and KeepOrder\r\n When null, the working language of the publication is used.", "required": true, - "schema": { - "$ref": "#/definitions/InContextMetadataParameters" - } + "schema": { "$ref": "#/definitions/InContextMetadataParameters" } } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ContentObjectMetadata" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/ContentObjectMetadata" } } } } } }, "/Api/ContentObjects/InContext/Content/": { "post": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets the content for the given logical id matching the versions specified in the baseline for the given publication version", "operationId": "GetInContextContent", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "parameters", "in": "body", "description": "InContextContentParameters with the parameters for the call including:\r\n Logical Id of the publication, Version of the publication, revision id of root map of publication, Language, Resolution and IgnoreNavigationTitles flag\r\n When null, the working language of the publication is used.", "required": true, - "schema": { - "$ref": "#/definitions/InContextContentParameters" - } + "schema": { "$ref": "#/definitions/InContextContentParameters" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/ContentObjects/InContext/VariableAssignments/": { "post": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets the metadata and variable assignments for the given publication which has version and language as given", "operationId": "GetInContextVariableAssignments", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "parameters", "in": "body", "description": "InContextVariableAssignmentsParameters with the parameters for the call including:\r\n // Logical Id of the publication, Version of the publication, Language of the publication", "required": true, - "schema": { - "$ref": "#/definitions/InContextVariableAssignmentsParameters" - } + "schema": { "$ref": "#/definitions/InContextVariableAssignmentsParameters" } } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VariableResources" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/VariableResources" } } } } } }, "/Api/ContentObjects/{folderCardId}/ShowModeBehavior/": { "get": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets the show mode behavior of the form when creating an object", "operationId": "GetShowModeBehaviorForNewObject", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "folderCardId", @@ -1854,34 +1097,16 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "enum": [ - "show", - "hide" - ], - "type": "string" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "enum": ["show", "hide"], "type": "string" } } } } }, "/Api/ContentObjects/{logicalId}/ShowModeBehavior/": { "get": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Gets the show mode behavior of the form when creating a version object", "operationId": "GetShowModeBehaviorForNewVersion", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -1905,25 +1130,12 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "enum": [ - "show", - "hide" - ], - "type": "string" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "enum": ["show", "hide"], "type": "string" } } } } }, "/Api/ContentObjects/InContext/Baseline/BaselineEntry/": { "put": { - "tags": [ - "ContentObjects" - ], + "tags": ["ContentObjects"], "summary": "Updates the baseline with the given version of a document", "operationId": "SetVersionInBaseline", "consumes": [], @@ -1963,36 +1175,20 @@ "description": "Auto complete mode of baseline for children of the objects", "required": false, "type": "string", - "enum": [ - "iSHNone", - "iSHFirstVersion", - "iSHLatestReleased", - "iSHLatestAvailable" - ] + "enum": ["iSHNone", "iSHFirstVersion", "iSHLatestReleased", "iSHLatestAvailable"] } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/DocumentObj/{languageCardId}/CanReview/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Get the can review state for an object.", "description": "Both objects are dealt seperately, there is no validation if the document is actually part of the publication output.", "operationId": "CanReview", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -2011,30 +1207,16 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "boolean" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/Api/DocumentObj/{languageCardId}/CanCheckOut/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Checks whether the object can be checked out.", "operationId": "CanCheckOut", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -2045,103 +1227,50 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "boolean" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/Api/DocumentObj/MetadataForPublish/": { "post": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Gets the metadata fields that would also be created by the PublishService", "operationId": "MetadataForPublish", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "languageCardIds", "in": "body", "description": "Language Card Ids of the objects.", "required": true, - "schema": { - "type": "array", - "items": { - "format": "int64", - "type": "integer" - } - } + "schema": { "type": "array", "items": { "format": "int64", "type": "integer" } } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/Metadata/": { "post": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Gets the metadata for multiple language objects using the provided filter.", "operationId": "Metadata", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "filter", "in": "body", "description": "Object filter.", "required": true, - "schema": { - "$ref": "#/definitions/DocumentObjectFilter" - } + "schema": { "$ref": "#/definitions/DocumentObjectFilter" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/{languageCardId}/UndoCheckOut/": { "put": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Undo check out", "operationId": "UndoCheckOut", "consumes": [], @@ -2156,27 +1285,16 @@ "format": "int64" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/DocumentObj/{languageCardId}/CheckOut/": { "put": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Check out document", "operationId": "CheckOut", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -2187,27 +1305,16 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/Api/DocumentObj/{languageCardId}/CheckIn/": { "put": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Check in document\r\nNote: The actual content (blob) needs to be passed in the request body.", "description": "The actual content (blob) needs to be passed in the request body.", "operationId": "CheckIn", - "consumes": [ - "application/octet-stream" - ], + "consumes": ["application/octet-stream"], "produces": [], "parameters": [ { @@ -2218,32 +1325,18 @@ "type": "integer", "format": "int64" }, - { - "name": "payload", - "in": "body", - "required": true, - "type": "string", - "format": "binary" - } + { "name": "payload", "in": "body", "required": true, "type": "string", "format": "binary" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/DocumentObj/{languageCardId}/Update/": { "put": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Update the document\r\nNote: The actual content (blob) needs to be passed in the request body.", "description": "The actual content (blob) needs to be passed in the request body.", "operationId": "Update", - "consumes": [ - "application/octet-stream" - ], + "consumes": ["application/octet-stream"], "produces": [], "parameters": [ { @@ -2254,35 +1347,18 @@ "type": "integer", "format": "int64" }, - { - "name": "payload", - "in": "body", - "required": true, - "type": "string", - "format": "binary" - } + { "name": "payload", "in": "body", "required": true, "type": "string", "format": "binary" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/DocumentObj/LanguageCard/{languageCardId}/ContentInfo/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Get content information for document", "operationId": "ContentInfo", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -2293,30 +1369,16 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Item" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Item" } } } } }, "/Api/DocumentObj/LogicalObject/{logicalId}/ContentInfo/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Get content information for document", "operationId": "ContentInfo", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -2347,28 +1409,16 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Item" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Item" } } } } }, "/Api/DocumentObj/LanguageCard/{languageCardId}/Content/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Get XML content for a document", "operationId": "Content", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "languageCardId", @@ -2386,28 +1436,16 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/LogicalObject/{logicalId}/Content/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Get XML content for a document", "operationId": "Content", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -2445,30 +1483,16 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/{languageCardId}/MetadataAndContent/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Get metadata and xml content for a language card", "operationId": "MetadataAndContent", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -2484,35 +1508,20 @@ "description": "Mode. If mode is Create (Xopus) the pipeline configuration is included.", "required": false, "type": "string", - "enum": [ - "none", - "create" - ] + "enum": ["none", "create"] } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MetadataAndContent" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MetadataAndContent" } } } } }, "/Api/DocumentObj/LanguageCard/{languageCardId}/Thumbnail/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Returns a thumbnail.\r\nSupported formats are jpg, jpeg, gif, bmp and png.", "description": "When the thumbnail cannot be rendered a dummy image is returned saying that the graphic could not be found.", "operationId": "Thumbnail", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "languageCardId", @@ -2539,29 +1548,17 @@ "format": "int32" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/RevisionObject/{revisionId}/Thumbnail/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Returns a thumbnail.\r\nSupported formats are jpg, jpeg, gif, bmp and png.", "description": "When the thumbnail cannot be rendered a dummy image is returned saying that the graphic could not be found.", "operationId": "Thumbnail", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "revisionId", @@ -2587,29 +1584,17 @@ "format": "int32" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/LogicalObject/{logicalId}/Thumbnail/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Returns a thumbnail.\r\nSupported formats are jpg, jpeg, gif, bmp and png.", "description": "When the thumbnail cannot be rendered a dummy image is returned saying that the graphic could not be found.", "operationId": "Thumbnail", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -2656,28 +1641,16 @@ "format": "int32" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/LanguageCard/{languageCardId}/SelectionPreview/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Preview an object with option to select target(s).", "operationId": "SelectionPreview", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "languageCardId", @@ -2693,15 +1666,7 @@ "description": "Select mode.", "required": false, "type": "string", - "enum": [ - "none", - "link", - "conref", - "variable", - "keyref", - "reusableObject", - "all" - ] + "enum": ["none", "link", "conref", "variable", "keyref", "reusableObject", "all"] }, { "name": "selectableElements", @@ -2732,28 +1697,16 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/LogicalObject/{logicalId}/SelectionPreview/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Preview an object with option to select target(s).", "operationId": "SelectionPreview", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -2782,15 +1735,7 @@ "description": "Select mode.", "required": false, "type": "string", - "enum": [ - "none", - "link", - "conref", - "variable", - "keyref", - "reusableObject", - "all" - ] + "enum": ["none", "link", "conref", "variable", "keyref", "reusableObject", "all"] }, { "name": "selectableElements", @@ -2821,28 +1766,16 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/LanguageCard/{languageCardId}/Preview/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Preview an object by languagecard id", "operationId": "Preview", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "languageCardId", @@ -2881,28 +1814,16 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/RevisionObject/{revisionId}/Preview/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Preview an object by revision id", "operationId": "Preview", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "revisionId", @@ -2940,28 +1861,16 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/LogicalObject/{logicalId}/Preview/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Preview an object by logical id", "operationId": "Preview", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -3020,30 +1929,16 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/LanguageCard/{languageCardId}/ComparePreview/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Retrieves preview with changetracking", "operationId": "ComparePreview", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -3090,38 +1985,18 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ComparePreview" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ComparePreview" } } } } }, "/Api/DocumentObj/RevisionObject/{revisionId}/ComparePreview/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Retrieves preview with changetracking", "operationId": "ComparePreview", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ - { - "name": "revisionId", - "in": "path", - "description": "Revision id", - "required": true, - "type": "string" - }, + { "name": "revisionId", "in": "path", "description": "Revision id", "required": true, "type": "string" }, { "name": "revisionIdToCompare", "in": "query", @@ -3158,45 +2033,19 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ComparePreview" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ComparePreview" } } } } }, "/Api/DocumentObj/LogicalObject/{logicalId}/ComparePreview/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Retrieves preview with changetracking", "operationId": "ComparePreview", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical Object id", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Object version", - "required": false, - "type": "string" - }, + { "name": "logicalId", "in": "path", "description": "Logical Object id", "required": true, "type": "string" }, + { "name": "version", "in": "query", "description": "Object version", "required": false, "type": "string" }, { "name": "versionToCompare", "in": "query", @@ -3204,13 +2053,7 @@ "required": false, "type": "string" }, - { - "name": "language", - "in": "query", - "description": "Objet language", - "required": false, - "type": "string" - }, + { "name": "language", "in": "query", "description": "Objet language", "required": false, "type": "string" }, { "name": "resolution", "in": "query", @@ -3247,31 +2090,17 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ComparePreview" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ComparePreview" } } } } }, "/Api/DocumentObj/LogicalObject/MetadataForm/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Gets a form containing definition and values needed to generate a form to create a new logical object.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateLogicalObject\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetCreateLogicalObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "folderCardId", @@ -3289,31 +2118,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/DocumentObj/LogicalObject/{logicalId}/MetadataForm/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Gets a form containing definition and values needed to generate a form to update an existing logical object.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLogicalObject\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetUpdateLogicalObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -3330,31 +2145,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/DocumentObj/VersionObject/MetadataForm/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Gets a form containing definition and values needed to generate a form to create a new version object.", "description": "The {fromVersion} is optional. By default, a new version number will be generated.\r\nThe {doBranch} is optional. By default, a new version number will be generated.\r\nThe {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateVersionObject\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetCreateVersionObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -3385,31 +2186,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/DocumentObj/VersionObject/{logicalId}/{version}/MetadataForm/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Gets a form containing definition and values needed to generate a form to update a version object.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateVersionObject\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetUpdateVersionObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -3433,31 +2220,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/DocumentObj/LanguageObject/MetadataForm/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Gets a form containing definition and values needed to generate a form to create a new language object.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateLanguageObject\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetCreateLanguageObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -3481,31 +2254,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/DocumentObj/LanguageObject/{languageCardId}/MetadataForm/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Gets a form containing definition and values needed to generate a form to update a language object.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLanguageObject\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetUpdateLanguageObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -3523,31 +2282,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/DocumentObj/LanguageObject/{languageCardId}/Checkin/MetadataForm/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Gets a form containing definition and values needed to generate a form to check-in a language object.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLanguageObject\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetCheckinLanguageObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -3565,35 +2310,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/DocumentObj/LogicalObject/": { "post": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Creates a new logical object in the specified folder.", "description": "The parameter {metadata} can only contain logical level fields.\r\nThe logical identifier can explicitly be added to the metadata.\r\nThis method is only to be used in the old web client.", "operationId": "CreateLogicalObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "folderCardId", @@ -3608,105 +2335,53 @@ "in": "body", "description": "The metadata that will be set on the logical object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/LogicalObject/{logicalId}/": { "put": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Updates a logical object with the specified metadata.", "description": "The parameter {metadata} can only contain logical level fields.\r\nThis method is only to be used in the old web client.", "operationId": "UpdateLogicalObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], "produces": [], "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical object id", - "required": true, - "type": "string" - }, + { "name": "logicalId", "in": "path", "description": "Logical object id", "required": true, "type": "string" }, { "name": "metadata", "in": "body", "description": "The metadata that will be set on the logical object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } }, "delete": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Deletes a logical object.", "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", "operationId": "DeleteLogicalObject", "consumes": [], "produces": [], "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical object ID", - "required": true, - "type": "string" - } + { "name": "logicalId", "in": "path", "description": "Logical object ID", "required": true, "type": "string" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/DocumentObj/VersionObject/": { "post": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Creates a new version object in the specified logical object.", "description": "The parameter {metadata} can only contain version level fields.\r\nThe version can explicitly be added to the metadata. If the version is not provided by the metadatas the version will be generated by calculating the next free version number on the main branch for the specified logical object (e.g. 3.1.2 -> 4).\r\nThis method is only to be used in the old web client.", "operationId": "CreateVersionObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -3720,36 +2395,19 @@ "in": "body", "description": "The metadata that will be set on the version object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/VersionObject/{logicalId}/{version}/": { "put": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Updates the version object specified by {logicalId} and {version} with the specified metadata.", "description": "The parameter {metadata} can only contain version level fields.\r\nThis method is only to be used in the old web client.", "operationId": "UpdateVersionObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], "produces": [], "parameters": [ { @@ -3771,34 +2429,20 @@ "in": "body", "description": "The metadata that will be set on the version object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } }, "delete": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Deletes a version object.", "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", "operationId": "DeleteVersionObject", "consumes": [], "produces": [], "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Lobical object ID", - "required": true, - "type": "string" - }, + { "name": "logicalId", "in": "path", "description": "Lobical object ID", "required": true, "type": "string" }, { "name": "version", "in": "path", @@ -3807,26 +2451,17 @@ "type": "string" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/DocumentObj/LanguageObject/": { "post": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Creates a new language object in the version object specified by {logicalId} and {version}.", "description": "The metadata can only contain language level fields.\r\nThe language and resolution can explicitly be added to the metadata. If the language is not provided by the metadata the default language will be used (language on user card). If the resolution is not provided by the metadata the default resolution will be used (resolution on settings card).\r\nThis method is only to be used in the old web client.\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", "operationId": "CreateLanguageObject", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -3843,21 +2478,12 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/DocumentObj/LanguageObject/{languageCardId}/": { "put": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Updates a language object with the specified metadata.", "description": "The metadata that will be set on the language object, can be passed in the request body in JSON format.\r\nThe metadata can only contain language level fields.\r\nThis method is only to be used in the old web client.\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", "operationId": "UpdateLanguageObject", @@ -3873,16 +2499,10 @@ "format": "int64" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } }, "delete": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Deletes a language object.", "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", "operationId": "DeleteLanguageObject", @@ -3898,18 +2518,12 @@ "format": "int64" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/DocumentObj/LanguageObject/{languageCardId}/Checkin/": { "put": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Checks-in a language object with the specified metadata.", "description": "The metadata that will be set on the language object, can be passed in the request body in JSON format.\r\nThe metadata can only contain language level fields.\r\nThis method is only to be used in the old web client.\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", "operationId": "CheckinLanguageObject", @@ -3925,35 +2539,18 @@ "format": "int64" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/DocumentObj/LogicalObject/{logicalId}/Versions/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Get ordered list of versions by logicalId", "operationId": "GetVersions", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical object id", - "required": true, - "type": "string" - }, + { "name": "logicalId", "in": "path", "description": "Logical object id", "required": true, "type": "string" }, { "name": "sortDescending", "in": "query", @@ -3962,33 +2559,16 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/Api/DocumentObj/{languageCardId}/Revisions/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Get revisions log for the object with given language card id.", "operationId": "GetRevisions", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -4009,30 +2589,18 @@ "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/RevisionInfo" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/RevisionInfo" } } } } } }, "/Api/DocumentObj/PossibleTargetStatuses/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Get the initial target statuses for the given object type.", "operationId": "GetPossibleTargetStatuses", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "objectType", @@ -4047,40 +2615,24 @@ "description": "Specifies the sort order of the statuses.. Default: None.", "required": false, "type": "string", - "enum": [ - "none", - "ascending", - "descending" - ] + "enum": ["none", "ascending", "descending"] } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ValueListItem" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/ValueListItem" } } } } } }, "/Api/DocumentObj/{languageCardId}/PossibleTargetStatuses/": { "get": { - "tags": [ - "DocumentObj" - ], + "tags": ["DocumentObj"], "summary": "Get the possible target statuses for the given language card ID.", "operationId": "GetPossibleTargetStatuses", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -4103,94 +2655,50 @@ "description": "Specifies the sort order of the statuses. Default: None.", "required": false, "type": "string", - "enum": [ - "none", - "ascending", - "descending" - ] + "enum": ["none", "ascending", "descending"] } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ValueListItem" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/ValueListItem" } } } } } }, "/Api/ExternalPreview/": { "get": { - "tags": [ - "ExternalPreview" - ], + "tags": ["ExternalPreview"], "summary": "Returns the HTML form to test the External Preview (read from ExternalPreviewForm.html in the InfoshareAuthor website root).", "operationId": "Get", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "produces": ["application/json", "text/json"], + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "post": { - "tags": [ - "ExternalPreview" - ], + "tags": ["ExternalPreview"], "summary": "Get the html preview for the posted object.\r\nThe parameters:\r\nbase64Blob: Base64 encoded blob (XML); \r\npreTranslationType: Source (SRC) or Target (TGT, TARGET) language; \r\nhost: Identifier of the external system. This parameter is passed to the preview xsl. Defaults to 'ExternalPreview'.\r\n", "operationId": "Post", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "externalPreview", "in": "body", "required": true, - "schema": { - "$ref": "#/definitions/ExternalPreview" - } + "schema": { "$ref": "#/definitions/ExternalPreview" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/ExternalPreview/Resource/": { "get": { - "tags": [ - "ExternalPreview" - ], + "tags": ["ExternalPreview"], "summary": "Get an image resource from the repository.", "operationId": "Resource", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -4207,110 +2715,52 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/ExternalPreview/UserInfo/": { "get": { - "tags": [ - "ExternalPreview" - ], + "tags": ["ExternalPreview"], "summary": "Test for the ExternalPreviewModule.", "operationId": "GetUserInfo", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/UserInfo" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserInfo" } } } } }, "/Api/ExternalPreview/Validate/": { "get": { - "tags": [ - "ExternalPreview" - ], + "tags": ["ExternalPreview"], "summary": "Returns the HTML form to test the External Validate (read from ExternalValidateForm.html in the InfoshareAuthor website root).", "operationId": "Validate", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "produces": ["application/json", "text/json"], + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "post": { - "tags": [ - "ExternalPreview" - ], + "tags": ["ExternalPreview"], "summary": "Get the result of validate for the posted object.\r\nThe parameters:\r\nbase64Blob: Base64 encoded blob (XML); \r\npreTranslationType: Source (SRC) or Target (TGT, TARGET) language; \r\n", "operationId": "Validate", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "externalValidate", "in": "body", "required": true, - "schema": { - "$ref": "#/definitions/ExternalPreview" - } + "schema": { "$ref": "#/definitions/ExternalPreview" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/Folder/EditorTemplates/": { "get": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Get the editor templates.", "operationId": "EditorTemplates", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "typesFilter", @@ -4318,12 +2768,7 @@ "description": "Filter editor templates for a type. \r\nPossible values: None (No filtering), Module, Library or Master.\r\nDefault value is None.", "required": false, "type": "string", - "enum": [ - "none", - "module", - "master", - "library" - ] + "enum": ["none", "module", "master", "library"] }, { "name": "languages", @@ -4331,36 +2776,20 @@ "description": "The languages for which you wish to retrieve the editor templates.\r\nWhen providing multiple values you should do \"&languages=VLANGUAGEEN&languages=VLANGUAGEFR\".\r\nDefault value is the working language of the current user.", "required": false, "type": "array", - "items": { - "type": "string" - }, + "items": { "type": "string" }, "collectionFormat": "multi" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/EditorTemplateSpecification" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EditorTemplateSpecification" } } } } }, "/Api/Folder/EditorTemplates2/": { "get": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Gets the released editor templates speciefied by {objectTypes} and {languages}.", "operationId": "EditorTemplates", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "objectTypes", @@ -4368,9 +2797,7 @@ "description": "The object types for which to return the editor templates.\r\nIf null or an empty list is provided, editor templates for all object types are returned.\r\n(e.g. \"&objectTypes=ISHModule&objectTypes=ISHPublicationOutput\")", "required": false, "type": "array", - "items": { - "type": "string" - }, + "items": { "type": "string" }, "collectionFormat": "multi" }, { @@ -4379,60 +2806,30 @@ "description": "The languages for which you wish to retrieve the editor templates.\r\nDefault value is the working language of the current user.\r\n(e.g. \"&languages=VLANGUAGEEN&languages=VLANGUAGEFR\")", "required": false, "type": "array", - "items": { - "type": "string" - }, + "items": { "type": "string" }, "collectionFormat": "multi" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/EditorTemplateSpecification" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EditorTemplateSpecification" } } } } }, "/Api/Folder/Favorites/": { "get": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Get the first level items from the user's favorites folder.", "operationId": "GetFavorites", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Favorites" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Favorites" } } } } }, "/Api/Folder/{folderCardId}/": { "get": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Get the specified folder", "operationId": "Get", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "folderCardId", @@ -4443,28 +2840,13 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/FolderModel" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderModel" } } } }, "put": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Update the specified folder", "operationId": "Put", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], "produces": [], "parameters": [ { @@ -4480,21 +2862,13 @@ "in": "body", "description": "The folder model from http body", "required": true, - "schema": { - "$ref": "#/definitions/FolderModel" - } + "schema": { "$ref": "#/definitions/FolderModel" } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } }, "delete": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Delete the specified folder", "operationId": "Delete", "consumes": [], @@ -4509,66 +2883,34 @@ "format": "int64" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/Folder/": { "post": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Create the new query folder in the specified parent folder", "operationId": "Post", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "folder", "in": "body", "description": "The folder model from http body", "required": true, - "schema": { - "$ref": "#/definitions/FolderModel" - } + "schema": { "$ref": "#/definitions/FolderModel" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/Folder/{folderCardId}/Move/": { "put": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Moves folder under new parent folder", "operationId": "Move", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], "produces": [], "parameters": [ { @@ -4584,33 +2926,19 @@ "in": "body", "description": "New folder parent id", "required": true, - "schema": { - "format": "int64", - "type": "integer" - } + "schema": { "format": "int64", "type": "integer" } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/Folder/{folderCardId}/Folders/": { "get": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Gets the sub folders for a specified folderid.", "operationId": "Folders", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "folderCardId", @@ -4621,54 +2949,26 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Folders" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Folders" } } } } }, "/Api/Folder/Folders/": { "get": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Gets the sub folders for the base (or root) folder.", "operationId": "Folders", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Folders" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Folders" } } } } }, "/Api/Folder/{folderCardId}/List/": { "get": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Get the content for a folder", "operationId": "List", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "folderCardId", @@ -4684,9 +2984,7 @@ "description": "The object languages which should be returned.\r\nWhen providing multiple values you should do \"&languages=en&languages=fr\".\r\nDefault value is the working language of the current user.", "required": true, "type": "array", - "items": { - "type": "string" - }, + "items": { "type": "string" }, "collectionFormat": "multi" }, { @@ -4695,65 +2993,29 @@ "description": "Object types to return.", "required": false, "type": "string", - "enum": [ - "none", - "module", - "master", - "library", - "illustration", - "template", - "publication" - ] + "enum": ["none", "module", "master", "library", "illustration", "template", "publication"] } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/FolderContent" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderContent" } } } } }, "/Api/Folder/List/": { "get": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Get the content for the base (or root) folder.", "operationId": "List", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/FolderContent" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderContent" } } } } }, "/Api/Folder/RootFolders/": { "get": { - "tags": [ - "Folder" - ], + "tags": ["Folder"], "summary": "Gets the sub folders of specified BaseFolder type for the base (or root) folder.", "operationId": "RootFolders", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "baseFolderTypes", @@ -4761,45 +3023,25 @@ "description": "Types of folders", "required": true, "type": "array", - "items": { - "type": "string", - "enum": [ - "data", - "system", - "favorites", - "editorTemplate" - ] - }, + "items": { "type": "string", "enum": ["data", "system", "favorites", "editorTemplate"] }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/FolderModel" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/FolderModel" } } } } } }, "/Api/Lists/ListOfValues/{name}/": { "get": { - "tags": [ - "Lists" - ], + "tags": ["Lists"], "summary": "Get the list of values by Name and Activity Filter.", "operationId": "GetListOfValues", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "name", @@ -4814,55 +3056,31 @@ "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", "required": false, "type": "string", - "enum": [ - "none", - "active", - "inactive" - ] + "enum": ["none", "active", "inactive"] } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ValueListItem" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/ValueListItem" } } } } } }, "/Api/Lists/Users/": { "post": { - "tags": [ - "Lists" - ], + "tags": ["Lists"], "summary": "Get the list of users.", "operationId": "GetUserList", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "metadataFilter", "in": "body", "description": "MetadataFilter, which is retrieved from the Request Body as a JSON object.", "required": true, - "schema": { - "$ref": "#/definitions/MetadataFilter" - } + "schema": { "$ref": "#/definitions/MetadataFilter" } }, { "name": "activityFilter", @@ -4870,55 +3088,31 @@ "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", "required": false, "type": "string", - "enum": [ - "none", - "active", - "inactive" - ] + "enum": ["none", "active", "inactive"] } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ValueListItem" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/ValueListItem" } } } } } }, "/Api/Lists/UserGroups/": { "post": { - "tags": [ - "Lists" - ], + "tags": ["Lists"], "summary": "Get the list of user groups.", "operationId": "GetUserGroupList", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "metadataFilter", "in": "body", "description": "MetadataFilter, which is retrieved from the Request Body as a JSON object.", "required": true, - "schema": { - "$ref": "#/definitions/MetadataFilter" - } + "schema": { "$ref": "#/definitions/MetadataFilter" } }, { "name": "activityFilter", @@ -4926,55 +3120,31 @@ "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", "required": false, "type": "string", - "enum": [ - "none", - "active", - "inactive" - ] + "enum": ["none", "active", "inactive"] } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ValueListItem" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/ValueListItem" } } } } } }, "/Api/Lists/UserRoles/": { "post": { - "tags": [ - "Lists" - ], + "tags": ["Lists"], "summary": "Get the list of user roles.", "operationId": "GetUserRoleList", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "metadataFilter", "in": "body", "description": "MetadataFilter, which is retrieved from the Request Body as a JSON object.", "required": true, - "schema": { - "$ref": "#/definitions/MetadataFilter" - } + "schema": { "$ref": "#/definitions/MetadataFilter" } }, { "name": "activityFilter", @@ -4982,55 +3152,31 @@ "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", "required": false, "type": "string", - "enum": [ - "none", - "active", - "inactive" - ] + "enum": ["none", "active", "inactive"] } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ValueListItem" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/ValueListItem" } } } } } }, "/Api/Lists/Baselines/": { "post": { - "tags": [ - "Lists" - ], + "tags": ["Lists"], "summary": "Get the list of baselines.", "operationId": "GetBaselines", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "metadataFilter", "in": "body", "description": "MetadataFilter, which is retrieved from the Request Body as a JSON object.", "required": true, - "schema": { - "$ref": "#/definitions/MetadataFilter" - } + "schema": { "$ref": "#/definitions/MetadataFilter" } }, { "name": "activityFilter", @@ -5038,55 +3184,31 @@ "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", "required": false, "type": "string", - "enum": [ - "none", - "active", - "inactive" - ] + "enum": ["none", "active", "inactive"] } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ValueListItem" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/ValueListItem" } } } } } }, "/Api/Lists/Edts/": { "post": { - "tags": [ - "Lists" - ], + "tags": ["Lists"], "summary": "Get the list of electronic document types..", "operationId": "GetEdts", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "metadataFilter", "in": "body", "description": "MetadataFilter, which is retrieved from the Request Body as a JSON object.", "required": true, - "schema": { - "$ref": "#/definitions/MetadataFilter" - } + "schema": { "$ref": "#/definitions/MetadataFilter" } }, { "name": "activityFilter", @@ -5094,40 +3216,24 @@ "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", "required": false, "type": "string", - "enum": [ - "none", - "active", - "inactive" - ] + "enum": ["none", "active", "inactive"] } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ValueListItem" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/ValueListItem" } } } } } }, "/Api/Localization/MetadataForm/": { "get": { - "tags": [ - "Localization" - ], + "tags": ["Localization"], "summary": "Get resource file in RESJSON format", "operationId": "Get", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "language", @@ -5140,39 +3246,18 @@ "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string" - } - } - } + "schema": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } }, "/Api/MetadataBinding/RetrieveTags/": { "post": { - "tags": [ - "MetadataBinding" - ], + "tags": ["MetadataBinding"], "summary": "Retrieve tags", "operationId": "RetrieveTags", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "fieldName", @@ -5187,22 +3272,14 @@ "description": "The IshLevel of the field for which to retrieve information", "required": true, "type": "string", - "enum": [ - "none", - "logical", - "version", - "language", - "annotation" - ] + "enum": ["none", "logical", "version", "language", "annotation"] }, { "name": "fieldsFilter", "in": "body", "description": "The values of other fields which can be used as an additional filter", "required": true, - "schema": { - "$ref": "#/definitions/FieldsFilter" - } + "schema": { "$ref": "#/definitions/FieldsFilter" } }, { "name": "inputFilter", @@ -5227,34 +3304,16 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RetrieveTagsResult" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrieveTagsResult" } } } } }, "/Api/MetadataBinding/RetrieveTags2/": { "post": { - "tags": [ - "MetadataBinding" - ], + "tags": ["MetadataBinding"], "summary": "Retrieve tags", "operationId": "RetrieveTags", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "fieldName", @@ -5275,12 +3334,7 @@ "in": "body", "description": "The values of other fields which can be used as an additional filter", "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/FieldValue" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/FieldValue" } } }, { "name": "inputFilter", @@ -5305,45 +3359,23 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RetrieveTagsResult" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrieveTagsResult" } } } } }, "/Api/MetadataBinding/ResolveIds/": { "post": { - "tags": [ - "MetadataBinding" - ], + "tags": ["MetadataBinding"], "summary": "Resolve ids", "operationId": "ResolveIds", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "fieldTags", "in": "body", "description": "The fields with the ids to resolve", "required": true, - "schema": { - "$ref": "#/definitions/FieldTags" - } + "schema": { "$ref": "#/definitions/FieldTags" } }, { "name": "language", @@ -5353,36 +3385,16 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResolveIdsResult" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResolveIdsResult" } } } } }, "/Api/MetadataBinding/RetrieveTagStructure/": { "post": { - "tags": [ - "MetadataBinding" - ], + "tags": ["MetadataBinding"], "summary": "Retrieve Tag Structure", "operationId": "RetrieveTagStructure", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "fieldName", @@ -5397,22 +3409,14 @@ "description": "The IshLevel of the field for which to retrieve information", "required": true, "type": "string", - "enum": [ - "none", - "logical", - "version", - "language", - "annotation" - ] + "enum": ["none", "logical", "version", "language", "annotation"] }, { "name": "fieldsFilter", "in": "body", "description": "The values of other fields which can be used as an additional filter", "required": true, - "schema": { - "$ref": "#/definitions/FieldsFilter" - } + "schema": { "$ref": "#/definitions/FieldsFilter" } }, { "name": "language", @@ -5422,36 +3426,16 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RetrieveTagsStructureResult" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrieveTagsStructureResult" } } } } }, "/Api/MetadataBinding/RetrieveTagStructure2/": { "post": { - "tags": [ - "MetadataBinding" - ], + "tags": ["MetadataBinding"], "summary": "Retrieve Tag Structure", "operationId": "RetrieveTagStructure", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "fieldName", @@ -5472,12 +3456,7 @@ "in": "body", "description": "The values of other fields which can be used as an additional filter", "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/FieldValue" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/FieldValue" } } }, { "name": "language", @@ -5487,31 +3466,37 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RetrieveTagsStructureResult" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrieveTagsStructureResult" } } } + } + }, + "/Api/Proxy/FontoReview/{relativeUri}/": { + "post": { + "tags": ["Proxy"], + "summary": "Gets responce from the Review App through proxy.", + "operationId": "FontoReview", + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json"], + "produces": ["application/json", "text/json"], + "parameters": [ + { + "name": "relativeUri", + "in": "path", + "description": "The relative uri for subsequent requests to the Review App.", + "required": true, + "type": "string" + }, + { "name": "data", "in": "body", "required": true, "schema": { "type": "object" } } + ], + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/Publication/MetadataForm/": { "get": { - "tags": [ - "Publication" - ], + "tags": ["Publication"], "summary": "Gets a form containing definition and values needed to generate a form to create a new publication.", "description": "The {formId} is optional. By default, \"Properties_Create_\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetCreateObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "folderCardId", @@ -5535,12 +3520,7 @@ "required": true, "type": "string" }, - { - "name": "clientName", - "in": "query", - "required": false, - "type": "string" - }, + { "name": "clientName", "in": "query", "required": false, "type": "string" }, { "name": "formId", "in": "query", @@ -5549,35 +3529,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/Publication/{folderCardId}/": { "post": { - "tags": [ - "Publication" - ], + "tags": ["Publication"], "summary": "Creates a new object in the specified folder.", "description": "The parameter {metadata} can only contain logical and version level fields.\r\nThe logical identifier can explicitly be added to the metadata.", "operationId": "CreateObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "folderCardId", @@ -5592,79 +3554,34 @@ "in": "body", "description": "The metadata that will be set on the object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/Publication/": { "put": { - "tags": [ - "Publication" - ], + "tags": ["Publication"], "operationId": "UpdateObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], "produces": [], "parameters": [ - { - "name": "logicalId", - "in": "query", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "query", - "required": true, - "type": "string" - }, - { - "name": "metadata", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } - } + { "name": "logicalId", "in": "query", "required": true, "type": "string" }, + { "name": "version", "in": "query", "required": true, "type": "string" }, + { "name": "metadata", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/Publication/VersionObject/MetadataForm/": { "get": { - "tags": [ - "Publication" - ], + "tags": ["Publication"], "summary": "Gets a form containing definition and values needed to generate a form to create a new publication version.", "description": "The {fromVersion} is optional. By default, a new version number will be generated.\r\nThe {doBranch} is optional. By default, a new version number will be generated.\r\nThe {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateVersionPublication\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetCreateVersionForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -5701,12 +3618,7 @@ "required": false, "type": "boolean" }, - { - "name": "clientName", - "in": "query", - "required": false, - "type": "string" - }, + { "name": "clientName", "in": "query", "required": false, "type": "string" }, { "name": "formId", "in": "query", @@ -5715,35 +3627,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/Publication/VersionObject/": { "post": { - "tags": [ - "Publication" - ], + "tags": ["Publication"], "summary": "Creates a new version object in the specified logical object.", "description": "The parameter {metadata} can only contain version level fields.\r\nThe version can explicitly be added to the metadata. If the version is not provided by the metadatas the version will be generated by calculating the next free version number on the main branch for the specified logical object (e.g. 3.1.2 -> 4).\r\nThis method is only to be used in the old web client.", "operationId": "CreateVersionObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -5757,35 +3651,19 @@ "in": "body", "description": "The metadata that will be set on the version object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/Publication/MetadataForm/LatestVersion/": { "get": { - "tags": [ - "Publication" - ], + "tags": ["Publication"], "summary": "Gets the latest version of related logicalId.", "operationId": "GetLatestVersion", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -5809,28 +3687,16 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/Api/Publication/VersionObject/{publicationLogicalId}/{publicationVersion}/Preview/": { "get": { - "tags": [ - "Publication" - ], + "tags": ["Publication"], "summary": "Preview an object by logical id", "operationId": "Preview", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "publicationLogicalId", @@ -5882,44 +3748,20 @@ "type": "boolean" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/Publication/VersionObject/{publicationLogicalId}/{publicationVersion}/SearchAnywhere/": { "get": { - "tags": [ - "Publication" - ], + "tags": ["Publication"], "summary": "Simple search to search for a specific value in the repository.", "description": "This endpoint does not support searching for the publication object type.", "operationId": "SearchAnywhere", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ - { - "name": "publicationLogicalId", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "publicationVersion", - "in": "path", - "required": true, - "type": "string" - }, + { "name": "publicationLogicalId", "in": "path", "required": true, "type": "string" }, + { "name": "publicationVersion", "in": "path", "required": true, "type": "string" }, { "name": "value", "in": "query", @@ -5933,9 +3775,7 @@ "description": "Languages to return.\r\nWhen providing multiple values you should do \"&languages=en&languages=fr\".\r\nDefault value is the working language of the current user.", "required": false, "type": "array", - "items": { - "type": "string" - }, + "items": { "type": "string" }, "collectionFormat": "multi" }, { @@ -5943,9 +3783,7 @@ "in": "query", "required": false, "type": "array", - "items": { - "type": "string" - }, + "items": { "type": "string" }, "collectionFormat": "multi" }, { @@ -5954,22 +3792,9 @@ "description": "Object types to return.\r\nBy default all object types are returned.", "required": false, "type": "string", - "enum": [ - "none", - "module", - "master", - "library", - "illustration", - "template", - "publication" - ] - }, - { - "name": "baselineAutoCompleteMode", - "in": "query", - "required": false, - "type": "string" + "enum": ["none", "module", "master", "library", "illustration", "template", "publication"] }, + { "name": "baselineAutoCompleteMode", "in": "query", "required": false, "type": "string" }, { "name": "maximumHits", "in": "query", @@ -5979,69 +3804,35 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SearchResults" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SearchResults" } } } } }, "/Api/Publication/Metadata/": { "post": { - "tags": [ - "Publication" - ], + "tags": ["Publication"], "summary": "Gets the metadata for publication using the requested metadata filter.", "operationId": "GetMetadata", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "parameters", "in": "body", "description": "The parameters.", "required": true, - "schema": { - "$ref": "#/definitions/PublicationMetadataParameters" - } + "schema": { "$ref": "#/definitions/PublicationMetadataParameters" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PublicationMetadata" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PublicationMetadata" } } } } }, "/Api/PublicationOutput/{publicationOutputCardId}/CanReview/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Gets the can review state for a publication output.", "operationId": "CanReview", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "publicationOutputCardId", @@ -6052,28 +3843,16 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "boolean" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/Api/PublicationOutput/{publicationOutputCardId}/Download/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Downloads a publication output.", "operationId": "Download", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "publicationOutputCardId", @@ -6084,31 +3863,17 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/PublicationOutput/LogicalObject/MetadataForm/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Gets a form containing definition and values needed to generate a form to create a new publication.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateLogicalPublication\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetCreateLogicalObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "folderCardId", @@ -6126,31 +3891,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/PublicationOutput/LogicalObject/{logicalId}/MetadataForm/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Gets a form containing definition and values needed to generate a form to update an existing publication.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLogicalPublication\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetUpdateLogicalObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -6167,31 +3918,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/PublicationOutput/VersionObject/MetadataForm/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Gets a form containing definition and values needed to generate a form to create a new publication version.", "description": "The {fromVersion} is optional. By default, a new version number will be generated.\r\nThe {doBranch} is optional. By default, a new version number will be generated.\r\nThe {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateVersionPublication\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetCreateVersionObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -6222,31 +3959,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/PublicationOutput/VersionObject/{logicalId}/{version}/MetadataForm/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Gets a form containing definition and values needed to generate a form to update a publication version.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateVersionPublication\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetUpdateVersionObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -6270,31 +3993,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/PublicationOutput/LanguageObject/MetadataForm/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Gets a form containing definition and values needed to generate a form to create a new publication output.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateLanguagePublication\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetCreateLanguageObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -6325,31 +4034,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/PublicationOutput/LanguageObject/{languageCardId}/MetadataForm/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Gets a form containing definition and values needed to generate a form to update a publication output.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLanguagePublication\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetUpdateLanguageObjectForm", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -6367,35 +4062,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/PublicationOutput/LogicalObject/": { "post": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Creates a new logical object in the specified folder.", "description": "The parameter {metadata} can only contain logical level fields.\r\nThe logical identifier can explicitly be added to the metadata.\r\nThis method is only to be used in the old web client.", "operationId": "CreateLogicalObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "folderCardId", @@ -6410,105 +4087,53 @@ "in": "body", "description": "The metadata that will be set on the logical object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/PublicationOutput/LogicalObject/{logicalId}/": { "put": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Updates a logical object with the specified metadata.", "description": "The parameter {metadata} can only contain logical level fields.\r\nThis method is only to be used in the old web client.", "operationId": "UpdateLogicalObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], "produces": [], "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical object id", - "required": true, - "type": "string" - }, + { "name": "logicalId", "in": "path", "description": "Logical object id", "required": true, "type": "string" }, { "name": "metadata", "in": "body", "description": "The metadata that will be set on the logical object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } }, "delete": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Deletes a logical object.", "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", "operationId": "DeleteLogicalObject", "consumes": [], "produces": [], "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical object id", - "required": true, - "type": "string" - } + { "name": "logicalId", "in": "path", "description": "Logical object id", "required": true, "type": "string" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/PublicationOutput/VersionObject/": { "post": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Creates a new version object in the specified logical object.", "description": "The parameter {metadata} can only contain version level fields.\r\nThe version can explicitly be added to the metadata. If the version is not provided by the metadatas the version will be generated by calculating the next free version number on the main branch for the specified logical object (e.g. 3.1.2 -> 4).\r\nThis method is only to be used in the old web client.", "operationId": "CreateVersionObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -6522,36 +4147,19 @@ "in": "body", "description": "The metadata that will be set on the version object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/PublicationOutput/VersionObject/{logicalId}/{version}/": { "put": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Updates the version object specified by {logicalId} and {version} with the specified metadata.", "description": "The parameter {metadata} can only contain version level fields.\r\nThis method is only to be used in the old web client.", "operationId": "UpdateVersionObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], "produces": [], "parameters": [ { @@ -6573,34 +4181,20 @@ "in": "body", "description": "The metadata that will be set on the version object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } }, "delete": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Deletes a version object.", "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", "operationId": "DeleteVersionObject", "consumes": [], "produces": [], "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Lobical object ID", - "required": true, - "type": "string" - }, + { "name": "logicalId", "in": "path", "description": "Lobical object ID", "required": true, "type": "string" }, { "name": "version", "in": "path", @@ -6609,32 +4203,17 @@ "type": "string" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/PublicationOutput/LanguageObject/": { "post": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Creates a new language object in the version object specified by {logicalId} and {version}.", "description": "The metadata can only contain language level fields.\r\nThe language and resolution can explicitly be added to the metadata. If the language is not provided by the metadata the default language will be used (language on user card). If the resolution is not provided by the metadata the default resolution will be used (resolution on settings card).\r\nThis method is only to be used in the old web client.", "operationId": "CreateLanguageObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -6655,36 +4234,19 @@ "in": "body", "description": "The metadata that will be set on the version object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/PublicationOutput/LanguageObject/{languageCardId}/": { "put": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Updates a language object with the specified metadata.", "description": "The metadata that will be set on the language object, can be passed in the request body in JSON format.\r\nThe metadata can only contain language level fields.\r\nThis method is only to be used in the old web client.\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", "operationId": "UpdateLanguageObject", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], "produces": [], "parameters": [ { @@ -6695,25 +4257,12 @@ "type": "integer", "format": "int64" }, - { - "name": "metadata", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } - } + { "name": "metadata", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } }, "delete": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Deletes a language object.", "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", "operationId": "DeleteLanguageObject", @@ -6729,27 +4278,16 @@ "format": "int64" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/PublicationOutput/LogicalObject/{logicalId}/Versions/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Gets the list of versions for the publication specified by logical ID.", "operationId": "GetVersions", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -6764,41 +4302,20 @@ "description": "Specifies the sort order of the versions. Default: Descending.", "required": false, "type": "string", - "enum": [ - "none", - "ascending", - "descending" - ] + "enum": ["none", "ascending", "descending"] } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/Api/PublicationOutput/Output/MetadataForm/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Gets a form containing definition and values needed to generate a form to create a new publication output.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateLanguagePublication\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetCreateOutput", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "logicalId", @@ -6836,35 +4353,17 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/PublicationOutput/Output/": { "post": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Creates a new output in the version object specified by {logicalId} and {version}.", "description": "The metadata can only contain language level fields.\r\nThe language and resolution can explicitly be added to the metadata. If the language is not provided by the metadata the default language will be used (language on user card). If the resolution is not provided by the metadata the default resolution will be used (resolution on settings card).\r\nThis method is only to be used in the old web client.", "operationId": "CreateOutput", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "logicalId", @@ -6885,36 +4384,20 @@ "in": "body", "description": "The metadata that will be set on the version object.", "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } + "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/Api/PublicationOutput/Output/{languageCardId}/MetadataForm/": { "get": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Gets a form containing definition and values needed to generate a form to update a publication output.", "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLanguagePublication\" is used.\r\nThis method is only to be used in the old web client.", "operationId": "GetUpdateOutput", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "languageCardId", @@ -6939,31 +4422,16 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Form" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Form" } } } } }, "/Api/PublicationOutput/Output/{languageCardId}/": { "put": { - "tags": [ - "PublicationOutput" - ], + "tags": ["PublicationOutput"], "summary": "Updates a language object with the specified metadata.", "description": "The metadata that will be set on the language object, can be passed in the request body in JSON format.\r\nThe metadata can only contain language level fields.\r\nThis method is only to be used in the old web client.\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", "operationId": "UpdateOutput", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], "produces": [], "parameters": [ { @@ -6974,37 +4442,19 @@ "type": "integer", "format": "int64" }, - { - "name": "metadata", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Metadata" - } - } + { "name": "metadata", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Metadata" } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/Search/Anywhere/": { "get": { - "tags": [ - "Search" - ], + "tags": ["Search"], "summary": "Simple search to search for a specific value in the repository.", "description": "This endpoint does not support searching for the publication object type.", "operationId": "Anywhere", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "value", @@ -7019,9 +4469,7 @@ "description": "Languages to return.\r\nWhen providing multiple values you should do \"&languages=en&languages=fr\".\r\nDefault value is the working language of the current user.", "required": false, "type": "array", - "items": { - "type": "string" - }, + "items": { "type": "string" }, "collectionFormat": "multi" }, { @@ -7030,15 +4478,7 @@ "description": "Object types to return.\r\nBy default all object types are returned.", "required": false, "type": "string", - "enum": [ - "none", - "module", - "master", - "library", - "illustration", - "template", - "publication" - ] + "enum": ["none", "module", "master", "library", "illustration", "template", "publication"] }, { "name": "maximumHits", @@ -7049,209 +4489,95 @@ "format": "int64" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SearchResults" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SearchResults" } } } } }, "/Api/Settings/ApplicationHost/": { "get": { - "tags": [ - "Settings" - ], + "tags": ["Settings"], "summary": "Get integration settings for the ApplicationHost.", "operationId": "ApplicationHost", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplicationHostSettings" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ApplicationHostSettings" } } } } }, "/Api/Settings/Enrich/": { "get": { - "tags": [ - "Settings" - ], + "tags": ["Settings"], "summary": "Get integration settings for Enrich.", "operationId": "Enrich", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/EnrichSettings" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichSettings" } } } } }, "/Api/Settings/Integration/Reach/": { "get": { - "tags": [ - "Settings" - ], + "tags": ["Settings"], "summary": "Get integration settings for SDL LiveContent Reach.", "operationId": "GetReachConfig", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ReachConfig" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ReachConfig" } } } } }, "/Api/Settings/Integration/": { "get": { - "tags": [ - "Settings" - ], + "tags": ["Settings"], "summary": "Get integration settings for SDL LiveContent Create.", "operationId": "GetCreateConfig", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/XopusConfig" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/XopusConfig" } } } } }, "/Api/Settings/Integration/Create/": { "get": { - "tags": [ - "Settings" - ], + "tags": ["Settings"], "summary": "Get integration settings for SDL LiveContent Create.", "operationId": "GetCreateConfig", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/XopusConfig" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/XopusConfig" } } } } }, "/Api/Settings/Metadata/": { "post": { - "tags": [ - "Settings" - ], + "tags": ["Settings"], "summary": "Gets the Settings metadata", "operationId": "GetMetadata", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "produces": [ - "application/json", - "text/json" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "settingsMetadataParameters", "in": "body", "description": "SettingsMetadataParameters with the parameters for the call including:\r\n Requested metadata", "required": true, - "schema": { - "$ref": "#/definitions/SettingsMetadataParameters" - } + "schema": { "$ref": "#/definitions/SettingsMetadataParameters" } } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SettingsMetadata" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SettingsMetadata" } } } } }, "/Api/Settings/CollectiveSpaces/": { "get": { - "tags": [ - "Settings" - ], + "tags": ["Settings"], "summary": "Gets the collective space configuration from settings and metadataconfig file.", "operationId": "GetCollectiveSpaceConfig", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CollectiveSpacesConfig" - } - } - } + "produces": ["application/json", "text/json"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CollectiveSpacesConfig" } } } } }, "/Api/Synchronization/SyncInfo/": { "get": { - "tags": [ - "Synchronization" - ], + "tags": ["Synchronization"], "summary": "Gets the synchronization information required for the client application specified by {clientExe}, {clientExeVersion} and {clientEdition}, and/or for the Authoring Bridge specified by {authoringBridgeVersion}.", "operationId": "GetSyncInfo", "consumes": [], - "produces": [ - "application/json", - "text/json" - ], + "produces": ["application/json", "text/json"], "parameters": [ { "name": "clientExe", @@ -7282,45 +4608,75 @@ "type": "string" } ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object" - } - } - } + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } + } + }, + "/Api/TrustedSubsystem/Fonto/document/revision/": { + "get": { + "tags": ["TrustedSubsystem"], + "summary": "Gets the XML content of a specific document revision.", + "operationId": "GetFontoDocumentRevision", + "consumes": [], + "produces": ["application/json", "text/json"], + "parameters": [ + { + "name": "documentId", + "in": "query", + "description": "The identifier of the document for which to retrieve the revision.", + "required": true, + "type": "string" + }, + { + "name": "revisionId", + "in": "query", + "description": "The identifier of the revision to retrieve.", + "required": true, + "type": "string" + }, + { "name": "request.data.publicationId", "in": "query", "required": false, "type": "string" }, + { "name": "request.data.language", "in": "query", "required": false, "type": "string" }, + { "name": "request.data.version", "in": "query", "required": false, "type": "string" }, + { "name": "request.data.resolution", "in": "query", "required": false, "type": "string" } + ], + "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } + } + }, + "/Api/TrustedSubsystem/Fonto/document/history/": { + "get": { + "tags": ["TrustedSubsystem"], + "summary": "Gets the complete revision history for the given document id in a chronological descending (new to old) order.", + "operationId": "GetFontoDocumentHistory", + "consumes": [], + "produces": ["application/json", "text/json"], + "parameters": [ + { + "name": "documentId", + "in": "query", + "description": "The identifier of the document for which to retrieve the revisions.", + "required": true, + "type": "string" + }, + { "name": "request.data.publicationId", "in": "query", "required": false, "type": "string" }, + { "name": "request.data.language", "in": "query", "required": false, "type": "string" }, + { "name": "request.data.version", "in": "query", "required": false, "type": "string" }, + { "name": "request.data.resolution", "in": "query", "required": false, "type": "string" } + ], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentHistoryInfo" } } } } }, "/Api/User/UserInfo/": { "get": { - "tags": [ - "User" - ], + "tags": ["User"], "summary": "Get info for the current logged on user", "operationId": "GetUserInfo", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/UserInfo" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserInfo" } } } } }, "/Api/User/ChangePassword/": { "put": { - "tags": [ - "User" - ], + "tags": ["User"], "summary": "Change password", "operationId": "ChangePassword", "consumes": [], @@ -7333,20 +4689,8 @@ "required": true, "type": "string" }, - { - "name": "oldPassword", - "in": "query", - "description": "Old password.", - "required": true, - "type": "string" - }, - { - "name": "newPassword", - "in": "query", - "description": "New password.", - "required": true, - "type": "string" - }, + { "name": "oldPassword", "in": "query", "description": "Old password.", "required": true, "type": "string" }, + { "name": "newPassword", "in": "query", "description": "New password.", "required": true, "type": "string" }, { "name": "confirmationPassword", "in": "query", @@ -7355,27 +4699,16 @@ "type": "string" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/User/Preferences/": { "get": { - "tags": [ - "User" - ], + "tags": ["User"], "summary": "Gets user preference sets", "operationId": "GetPreferenceSets", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "produces": ["application/json", "text/json", "application/xml", "text/xml"], "parameters": [ { "name": "preferenceSetNames", @@ -7383,103 +4716,53 @@ "description": "The set name filter used for filtering preference sets.", "required": true, "type": "array", - "items": { - "type": "string" - }, + "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/UserPreferenceSet" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/UserPreferenceSet" } } } } }, "put": { - "tags": [ - "User" - ], + "tags": ["User"], "summary": "Sets user preference sets", "operationId": "SetPreferenceSets", - "consumes": [ - "application/x-www-form-urlencoded", - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "consumes": ["application/x-www-form-urlencoded", "application/json", "text/json", "application/xml", "text/xml"], "produces": [], "parameters": [ { "name": "preferenceSets", "in": "body", "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/UserPreferenceSet" - } - } + "schema": { "type": "array", "items": { "$ref": "#/definitions/UserPreferenceSet" } } } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } }, "/Api/User/Preferences/UILanguage/": { "get": { - "tags": [ - "User" - ], + "tags": ["User"], "summary": "Gets user UILanguage preference for WebClient", "operationId": "GetUiLanguagePreference", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - } - } + "produces": ["application/json", "text/json", "application/xml", "text/xml"], + "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } }, "put": { - "tags": [ - "User" - ], + "tags": ["User"], "summary": "Sets user UILanguage preference for WebClient", "operationId": "SetUiLanguagePreference", "consumes": [], "produces": [], "parameters": [ - { - "name": "languageCode", - "in": "query", - "description": "Language code", - "required": true, - "type": "string" - } + { "name": "languageCode", "in": "query", "description": "Language code", "required": true, "type": "string" } ], - "responses": { - "204": { - "description": "No Content" - } - } + "responses": { "204": { "description": "No Content" } } } } }, @@ -7487,1105 +4770,446 @@ "AnnotationParameters": { "type": "object", "properties": { - "publicationId": { - "type": "string" - }, - "publicationVersion": { - "type": "string" - }, - "revisionId": { - "type": "string" - } + "publicationId": { "type": "string" }, + "publicationVersion": { "type": "string" }, + "revisionId": { "type": "string" } } }, "Form": { "type": "object", "properties": { - "definition": { - "$ref": "#/definitions/FormDefinition" - }, - "metadata": { - "$ref": "#/definitions/Metadata" - }, - "objectDescriptor": { - "$ref": "#/definitions/ObjectDescriptor" - } + "definition": { "$ref": "#/definitions/FormDefinition" }, + "metadata": { "$ref": "#/definitions/Metadata" }, + "objectDescriptor": { "$ref": "#/definitions/ObjectDescriptor" } } }, "FormDefinition": { "type": "object", "properties": { - "label": { - "$ref": "#/definitions/TranslatableValue" - }, - "description": { - "$ref": "#/definitions/TranslatableValue" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/FormChild" - } - }, - "id": { - "type": "string" - }, - "width": { - "type": "string" - }, - "height": { - "type": "string" - } + "label": { "$ref": "#/definitions/TranslatableValue" }, + "description": { "$ref": "#/definitions/TranslatableValue" }, + "items": { "type": "array", "items": { "$ref": "#/definitions/FormChild" } }, + "id": { "type": "string" }, + "width": { "type": "string" }, + "height": { "type": "string" } } }, "Metadata": { "type": "object", - "properties": { - "fieldValues": { - "type": "array", - "items": { - "$ref": "#/definitions/FieldValue" - } - } - } - }, - "ObjectDescriptor": { - "type": "object", - "properties": { - "objectType": { - "type": "string" - } - } + "properties": { "fieldValues": { "type": "array", "items": { "$ref": "#/definitions/FieldValue" } } } }, + "ObjectDescriptor": { "type": "object", "properties": { "objectType": { "type": "string" } } }, "TranslatableValue": { "type": "object", - "properties": { - "default": { - "type": "string" - }, - "resourceId": { - "type": "string" - } - } + "properties": { "default": { "type": "string" }, "resourceId": { "type": "string" } } }, "FormChild": { - "required": [ - "discriminator" - ], + "required": ["discriminator"], "type": "object", "properties": { - "typeName": { - "type": "string", - "readOnly": true - }, - "label": { - "$ref": "#/definitions/TranslatableValue" - }, - "description": { - "$ref": "#/definitions/TranslatableValue" - }, - "discriminator": { - "type": "string" - } + "typeName": { "type": "string", "readOnly": true }, + "label": { "$ref": "#/definitions/TranslatableValue" }, + "description": { "$ref": "#/definitions/TranslatableValue" }, + "discriminator": { "type": "string" } }, "discriminator": "discriminator" }, "FieldValue": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "level": { - "type": "string" - }, - "value": { - "type": "object" - }, - "originalValue": { - "type": "object" - }, - "valueType": { - "enum": [ - "undefined", - "string", - "number", - "dateTime", - "reference" - ], - "type": "string" - }, - "multiValue": { - "type": "boolean" - }, - "originalValueProvided": { - "type": "boolean" - } + "name": { "type": "string" }, + "level": { "type": "string" }, + "value": { "type": "object" }, + "originalValue": { "type": "object" }, + "valueType": { "enum": ["undefined", "string", "number", "dateTime", "reference"], "type": "string" }, + "multiValue": { "type": "boolean" }, + "originalValueProvided": { "type": "boolean" } } }, - "AnnotationUpdateRequest": { + "AnnotationRequest": { "type": "object", "properties": { - "annotationId": { - "type": "string" - }, - "metadata": { - "$ref": "#/definitions/Metadata" - } - } - }, - "AnnotationUpdateResponse": { - "type": "object", - "properties": { - "errorNumber": { - "format": "int32", - "type": "integer" - }, - "errorMessage": { - "type": "string" - }, - "annotationId": { - "type": "string" - }, - "modifiedOn": { - "format": "date-time", - "type": "string" - }, - "createdOn": { - "format": "date-time", - "type": "string" - }, - "objectType": { - "type": "string" - } - } - }, - "AnnotationDescriptor": { - "type": "object", - "properties": { - "annotationId": { - "type": "string" - }, - "modifiedOn": { - "format": "date-time", - "type": "string" - }, - "createdOn": { - "format": "date-time", - "type": "string" - }, - "objectType": { - "type": "string" - } - } - }, - "AnnotationDetailParameters": { - "type": "object", - "properties": { - "annotationIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "requestedMetadata": { - "$ref": "#/definitions/RequestedMetadata" - } + "metadata": { "$ref": "#/definitions/Metadata" }, + "requestedMetadata": { "$ref": "#/definitions/RequestedMetadata" } } }, "RequestedMetadata": { "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataField" - } - } - } + "properties": { "fields": { "type": "array", "items": { "$ref": "#/definitions/MetadataField" } } } }, "MetadataField": { "type": "object", - "properties": { - "name": { - "type": "string" - }, - "level": { - "type": "string" - }, - "valueType": { - "type": "string" - } - } + "properties": { "name": { "type": "string" }, "level": { "type": "string" }, "valueType": { "type": "string" } } }, - "AnnotationMetadata": { + "AnnotationMultipleUpdateRequestParameter": { "type": "object", "properties": { - "metadata": { - "$ref": "#/definitions/ResolvedMetadata" - }, - "annotationReplyMetadata": { - "type": "array", - "items": { - "$ref": "#/definitions/AnnotationReplyMetadata" - } - }, - "annotationId": { - "type": "string" - }, - "modifiedOn": { - "format": "date-time", - "type": "string" - }, - "createdOn": { - "format": "date-time", - "type": "string" - }, - "objectType": { - "type": "string" - } + "updateRequests": { "type": "array", "items": { "$ref": "#/definitions/AnnotationUpdateRequest" } }, + "requestedMetadata": { "$ref": "#/definitions/RequestedMetadata" } + } + }, + "AnnotationUpdateRequest": { + "type": "object", + "properties": { "annotationId": { "type": "string" }, "metadata": { "$ref": "#/definitions/Metadata" } } + }, + "AnnotationUpdateResponse": { + "type": "object", + "properties": { + "errorNumber": { "format": "int32", "type": "integer" }, + "errorMessage": { "type": "string" }, + "metadata": { "$ref": "#/definitions/ResolvedMetadata" }, + "annotationReplyMetadata": { "type": "array", "items": { "$ref": "#/definitions/AnnotationReplyMetadata" } }, + "annotationId": { "type": "string" }, + "objectType": { "type": "string" } } }, "ResolvedMetadata": { "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "$ref": "#/definitions/ResolvedFieldValue" - } - } - } + "properties": { "fields": { "type": "array", "items": { "$ref": "#/definitions/ResolvedFieldValue" } } } }, "AnnotationReplyMetadata": { "type": "object", "properties": { - "metadata": { - "$ref": "#/definitions/ResolvedMetadata" - }, - "annotationReplyId": { - "format": "int64", - "type": "integer" - }, - "annotationId": { - "type": "string" - }, - "modifiedOn": { - "format": "date-time", - "type": "string" - }, - "createdOn": { - "format": "date-time", - "type": "string" - }, - "objectType": { - "type": "string" - } + "metadata": { "$ref": "#/definitions/ResolvedMetadata" }, + "annotationId": { "type": "string" }, + "annotationReplyId": { "format": "int64", "type": "integer" } } }, "ResolvedFieldValue": { "type": "object", "properties": { - "name": { - "type": "string", - "readOnly": true - }, + "name": { "type": "string", "readOnly": true }, "level": { - "enum": [ - "none", - "logical", - "version", - "lng", - "annotation" - ], + "enum": ["none", "logical", "version", "lng", "annotation", "reply"], "type": "string", "readOnly": true }, - "value": { - "type": "object", - "readOnly": true - }, - "valueType": { - "enum": [ - "none", - "id", - "value", - "element" - ], - "type": "string", - "readOnly": true - }, - "multiValue": { - "type": "boolean", - "readOnly": true - }, - "dataType": { - "type": "string", - "readOnly": true - } + "value": { "type": "object", "readOnly": true }, + "valueType": { "enum": ["none", "id", "value", "element"], "type": "string", "readOnly": true }, + "multiValue": { "type": "boolean", "readOnly": true }, + "dataType": { "type": "string", "readOnly": true } + } + }, + "AnnotationMetadata": { + "type": "object", + "properties": { + "metadata": { "$ref": "#/definitions/ResolvedMetadata" }, + "annotationReplyMetadata": { "type": "array", "items": { "$ref": "#/definitions/AnnotationReplyMetadata" } }, + "annotationId": { "type": "string" }, + "objectType": { "type": "string" } + } + }, + "AnnotationDetailParameters": { + "type": "object", + "properties": { + "annotationIds": { "type": "array", "items": { "type": "string" } }, + "requestedMetadata": { "$ref": "#/definitions/RequestedMetadata" } } }, "AnnotationListParameters": { "type": "object", "properties": { - "requestedMetadata": { - "$ref": "#/definitions/RequestedMetadata" - }, - "metadataFilter": { - "$ref": "#/definitions/MetadataFilter" - } + "requestedMetadata": { "$ref": "#/definitions/RequestedMetadata" }, + "metadataFilter": { "$ref": "#/definitions/MetadataFilter" } } }, "MetadataFilter": { "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataFilterField" - } - } - } + "properties": { "fields": { "type": "array", "items": { "$ref": "#/definitions/MetadataFilterField" } } } }, "MetadataFilterField": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "level": { - "type": "string" - }, - "operator": { - "type": "string" - }, - "valueType": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "AnnotationReplyDescriptor": { - "type": "object", - "properties": { - "annotationReplyId": { - "format": "int64", - "type": "integer" - }, - "annotationId": { - "type": "string" - }, - "modifiedOn": { - "format": "date-time", - "type": "string" - }, - "createdOn": { - "format": "date-time", - "type": "string" - }, - "objectType": { - "type": "string" - } + "name": { "type": "string" }, + "level": { "type": "string" }, + "operator": { "type": "string" }, + "valueType": { "type": "string" }, + "value": { "type": "string" } } }, "User": { "type": "object", - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - }, - "email": { - "type": "string" - } - } + "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" } } }, "Publication": { "type": "object", "properties": { - "id": { - "format": "int32", - "type": "integer" - }, - "title": { - "type": "string" - }, - "url": { - "type": "string" - } + "id": { "format": "int32", "type": "integer" }, + "title": { "type": "string" }, + "url": { "type": "string" } } }, "Status": { "type": "object", - "properties": { - "id": { - "format": "int32", - "type": "integer" - }, - "title": { - "type": "string" - } - } + "properties": { "id": { "format": "int32", "type": "integer" }, "title": { "type": "string" } } }, "CommentingResult": { "type": "object", "properties": { - "comments": { - "type": "array", - "items": { - "$ref": "#/definitions/Comment" - } - }, - "total": { - "format": "int32", - "type": "integer" - } + "comments": { "type": "array", "items": { "$ref": "#/definitions/Comment" } }, + "total": { "format": "int32", "type": "integer" } } }, "Comment": { "type": "object", "properties": { - "id": { - "format": "int64", - "type": "integer" - }, - "content": { - "type": "string" - }, - "itemUri": { - "type": "string" - }, - "pageId": { - "format": "int32", - "type": "integer" - }, - "pageTitle": { - "type": "string" - }, - "pageUrl": { - "type": "string" - }, - "publicationId": { - "format": "int32", - "type": "integer" - }, - "publicationTitle": { - "type": "string" - }, - "publicationUrl": { - "type": "string" - }, - "creationDate": { - "format": "date-time", - "type": "string" - }, - "modifiedDate": { - "format": "date-time", - "type": "string" - }, - "parentId": { - "format": "int64", - "type": "integer" - }, - "status": { - "enum": [ - "new", - "approved", - "declined", - "completed" - ], - "type": "string" - }, - "user": { - "$ref": "#/definitions/User" - }, - "replyCount": { - "format": "int32", - "type": "integer" - }, - "language": { - "type": "string" - }, - "replies": { - "type": "array", - "items": { - "$ref": "#/definitions/Comment" - } - } + "id": { "format": "int64", "type": "integer" }, + "content": { "type": "string" }, + "itemUri": { "type": "string" }, + "pageId": { "format": "int32", "type": "integer" }, + "pageTitle": { "type": "string" }, + "pageUrl": { "type": "string" }, + "publicationId": { "format": "int32", "type": "integer" }, + "publicationTitle": { "type": "string" }, + "publicationUrl": { "type": "string" }, + "creationDate": { "format": "date-time", "type": "string" }, + "modifiedDate": { "format": "date-time", "type": "string" }, + "parentId": { "format": "int64", "type": "integer" }, + "status": { "enum": ["new", "approved", "declined", "completed"], "type": "string" }, + "user": { "$ref": "#/definitions/User" }, + "replyCount": { "format": "int32", "type": "integer" }, + "language": { "type": "string" }, + "replies": { "type": "array", "items": { "$ref": "#/definitions/Comment" } } } }, "DocumentObjDescriptor": { "type": "object", "properties": { - "logicalId": { - "type": "string" - }, - "version": { - "type": "string" - }, - "language": { - "type": "string" - }, - "resolution": { - "type": "string" - }, - "logicalCardId": { - "format": "int64", - "type": "integer" - }, - "versionCardId": { - "format": "int64", - "type": "integer" - }, - "languageCardId": { - "format": "int64", - "type": "integer" - }, - "objectType": { - "type": "string" - } + "logicalId": { "type": "string" }, + "version": { "type": "string" }, + "language": { "type": "string" }, + "resolution": { "type": "string" }, + "logicalCardId": { "format": "int64", "type": "integer" }, + "versionCardId": { "format": "int64", "type": "integer" }, + "languageCardId": { "format": "int64", "type": "integer" }, + "objectType": { "type": "string" } } }, "InContextMetadataParameters": { "type": "object", "properties": { - "language": { - "type": "string" - }, - "resolution": { - "type": "string" - }, - "publicationId": { - "type": "string" - }, - "publicationVersion": { - "type": "string" - }, - "logicalIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "requestedMetadata": { - "$ref": "#/definitions/RequestedMetadata" - }, - "keepOrder": { - "type": "boolean" - } + "language": { "type": "string" }, + "resolution": { "type": "string" }, + "publicationId": { "type": "string" }, + "publicationVersion": { "type": "string" }, + "logicalIds": { "type": "array", "items": { "type": "string" } }, + "requestedMetadata": { "$ref": "#/definitions/RequestedMetadata" }, + "keepOrder": { "type": "boolean" } } }, "ContentObjectMetadata": { "type": "object", "properties": { "resultType": { - "enum": [ - "notInitialized", - "objectInvalidId", - "objectNotFound", - "objectFound" - ], + "enum": ["notInitialized", "objectInvalidId", "objectNotFound", "objectFound"], "type": "string" }, - "metadata": { - "$ref": "#/definitions/ResolvedMetadata" - }, - "logicalId": { - "type": "string" - }, - "version": { - "type": "string" - }, - "language": { - "type": "string" - }, - "resolution": { - "type": "string" - }, - "logicalCardId": { - "format": "int64", - "type": "integer" - }, - "versionCardId": { - "format": "int64", - "type": "integer" - }, - "languageCardId": { - "format": "int64", - "type": "integer" - }, - "objectType": { - "type": "string" - } + "metadata": { "$ref": "#/definitions/ResolvedMetadata" }, + "logicalId": { "type": "string" }, + "version": { "type": "string" }, + "language": { "type": "string" }, + "resolution": { "type": "string" }, + "logicalCardId": { "format": "int64", "type": "integer" }, + "versionCardId": { "format": "int64", "type": "integer" }, + "languageCardId": { "format": "int64", "type": "integer" }, + "objectType": { "type": "string" } } }, "InContextContentParameters": { "type": "object", "properties": { - "language": { - "type": "string" - }, - "resolution": { - "type": "string" - }, - "publicationId": { - "type": "string" - }, - "publicationVersion": { - "type": "string" - }, - "revisionId": { - "type": "string" - }, - "ignoreNavigationTitles": { - "type": "boolean" - }, - "includeByteOrderMark": { - "type": "boolean" - } + "language": { "type": "string" }, + "resolution": { "type": "string" }, + "publicationId": { "type": "string" }, + "publicationVersion": { "type": "string" }, + "revisionId": { "type": "string" }, + "ignoreNavigationTitles": { "type": "boolean" }, + "includeByteOrderMark": { "type": "boolean" } } }, "InContextVariableAssignmentsParameters": { "type": "object", "properties": { - "publicationId": { - "type": "string" - }, - "publicationVersion": { - "type": "string" - }, - "language": { - "type": "string" - } + "publicationId": { "type": "string" }, + "publicationVersion": { "type": "string" }, + "language": { "type": "string" } } }, "VariableResources": { "type": "object", "properties": { - "revisionId": { - "type": "string" - }, - "variableAssignments": { - "$ref": "#/definitions/VariableAssignments" - }, - "logicalId": { - "type": "string" - }, - "version": { - "type": "string" - }, - "language": { - "type": "string" - }, - "resolution": { - "type": "string" - }, - "logicalCardId": { - "format": "int64", - "type": "integer" - }, - "versionCardId": { - "format": "int64", - "type": "integer" - }, - "languageCardId": { - "format": "int64", - "type": "integer" - }, - "objectType": { - "type": "string" - } + "revisionId": { "type": "string" }, + "variableAssignments": { "$ref": "#/definitions/VariableAssignments" }, + "logicalId": { "type": "string" }, + "version": { "type": "string" }, + "language": { "type": "string" }, + "resolution": { "type": "string" }, + "logicalCardId": { "format": "int64", "type": "integer" }, + "versionCardId": { "format": "int64", "type": "integer" }, + "languageCardId": { "format": "int64", "type": "integer" }, + "objectType": { "type": "string" } } }, "VariableAssignments": { "type": "object", - "properties": { - "variables": { - "type": "array", - "items": { - "$ref": "#/definitions/VariableAssignment" - } - } - } - }, - "VariableAssignment": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "content": { - "type": "string" - } - } + "properties": { "variables": { "type": "array", "items": { "$ref": "#/definitions/VariableAssignment" } } } }, + "VariableAssignment": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" } } }, "DocumentObjectFilter": { "type": "object", "properties": { - "languageCardIds": { - "type": "array", - "items": { - "format": "int64", - "type": "integer" - } - }, + "languageCardIds": { "type": "array", "items": { "format": "int64", "type": "integer" } }, "statusFilter": { - "enum": [ - "latestReleasedVersions", - "draftOrLatestReleasedVersions", - "allReleasedVersions", - "noStatusFilter" - ], + "enum": ["latestReleasedVersions", "draftOrLatestReleasedVersions", "allReleasedVersions", "noStatusFilter"], "type": "string" }, - "metadataFilter": { - "$ref": "#/definitions/MetadataFilter" - }, - "requestedMetadata": { - "$ref": "#/definitions/RequestedMetadata" - } + "metadataFilter": { "$ref": "#/definitions/MetadataFilter" }, + "requestedMetadata": { "$ref": "#/definitions/RequestedMetadata" } } }, "Item": { "type": "object", "properties": { - "checkedOutBy": { - "type": "string" - }, - "language": { - "type": "string" - }, - "languageCardId": { - "format": "int64", - "type": "integer" - }, - "logicalId": { - "type": "string" - }, - "resolution": { - "type": "string" - }, - "status": { - "type": "string" - }, - "version": { - "type": "string" - }, - "title": { - "type": "string" - }, - "revision": { - "format": "int64", - "type": "integer" - }, - "revisionId": { - "type": "string" - }, - "electronicDocumentType": { - "$ref": "#/definitions/ElectronicDocumentType" - } + "checkedOutBy": { "type": "string" }, + "language": { "type": "string" }, + "languageCardId": { "format": "int64", "type": "integer" }, + "logicalId": { "type": "string" }, + "resolution": { "type": "string" }, + "status": { "type": "string" }, + "version": { "type": "string" }, + "title": { "type": "string" }, + "revision": { "format": "int64", "type": "integer" }, + "revisionId": { "type": "string" }, + "electronicDocumentType": { "$ref": "#/definitions/ElectronicDocumentType" } } }, "ElectronicDocumentType": { "type": "object", "properties": { - "defaultExtension": { - "type": "string" - }, - "mimeType": { - "type": "string" - }, - "name": { - "type": "string" - } + "defaultExtension": { "type": "string" }, + "mimeType": { "type": "string" }, + "name": { "type": "string" } } }, "MetadataAndContent": { "type": "object", - "properties": { - "item": { - "$ref": "#/definitions/MetadataAndContentItem" - }, - "content": { - "type": "string" - } - } + "properties": { "item": { "$ref": "#/definitions/MetadataAndContentItem" }, "content": { "type": "string" } } }, "MetadataAndContentItem": { "type": "object", "properties": { - "canCheckIn": { - "type": "boolean" - }, - "canCheckOut": { - "type": "boolean" - }, - "canUndoCheckOut": { - "type": "boolean" - }, - "css": { - "type": "string" - }, - "docType": { - "type": "string" - }, - "publicId": { - "type": "string" - }, - "xsd": { - "type": "string" - }, - "title": { - "type": "string" - }, - "revision": { - "format": "int64", - "type": "integer" - }, - "pipeline": { - "$ref": "#/definitions/Pipeline" - }, - "checkedOutBy": { - "type": "string" - }, - "language": { - "type": "string" - }, - "languageCardId": { - "format": "int64", - "type": "integer" - }, - "logicalId": { - "type": "string" - }, - "resolution": { - "type": "string" - }, - "status": { - "type": "string" - }, - "version": { - "type": "string" - }, - "revisionId": { - "type": "string" - }, - "electronicDocumentType": { - "$ref": "#/definitions/ElectronicDocumentType" - } + "canCheckIn": { "type": "boolean" }, + "canCheckOut": { "type": "boolean" }, + "canUndoCheckOut": { "type": "boolean" }, + "css": { "type": "string" }, + "docType": { "type": "string" }, + "publicId": { "type": "string" }, + "xsd": { "type": "string" }, + "title": { "type": "string" }, + "revision": { "format": "int64", "type": "integer" }, + "pipeline": { "$ref": "#/definitions/Pipeline" }, + "checkedOutBy": { "type": "string" }, + "language": { "type": "string" }, + "languageCardId": { "format": "int64", "type": "integer" }, + "logicalId": { "type": "string" }, + "resolution": { "type": "string" }, + "status": { "type": "string" }, + "version": { "type": "string" }, + "revisionId": { "type": "string" }, + "electronicDocumentType": { "$ref": "#/definitions/ElectronicDocumentType" } } }, "Pipeline": { "type": "object", "properties": { - "version": { - "type": "string" - }, - "xml": { - "type": "string" - }, - "xsd": { - "type": "string" - }, - "views": { - "type": "array", - "items": { - "$ref": "#/definitions/XopusConfigView" - } - } + "version": { "type": "string" }, + "xml": { "type": "string" }, + "xsd": { "type": "string" }, + "views": { "type": "array", "items": { "$ref": "#/definitions/XopusConfigView" } } } }, "XopusConfigView": { "type": "object", "properties": { - "actions": { - "type": "array", - "items": { - "$ref": "#/definitions/XopusConfigAction" - } - }, - "name": { - "type": "string" - } - } - }, - "XopusConfigAction": { - "type": "object", - "properties": { - "type": { - "type": "string", - "readOnly": true - } + "actions": { "type": "array", "items": { "$ref": "#/definitions/XopusConfigAction" } }, + "name": { "type": "string" } } }, + "XopusConfigAction": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true } } }, "ComparePreview": { "type": "object", - "properties": { - "hasDifferences": { - "type": "boolean" - }, - "content": { - "type": "string" - } - } + "properties": { "hasDifferences": { "type": "boolean" }, "content": { "type": "string" } } }, "RevisionInfo": { "type": "object", - "properties": { - "revisionId": { - "type": "string" - }, - "revision": { - "format": "int64", - "type": "integer" - } - } + "properties": { "revisionId": { "type": "string" }, "revision": { "format": "int64", "type": "integer" } } }, "ValueListItem": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "text": { - "$ref": "#/definitions/TranslatableValue" - }, - "description": { - "$ref": "#/definitions/TranslatableValue" - } + "name": { "type": "string" }, + "text": { "$ref": "#/definitions/TranslatableValue" }, + "description": { "$ref": "#/definitions/TranslatableValue" } } }, "ExternalPreview": { "type": "object", "properties": { - "base64Blob": { - "type": "string" - }, - "preTranslationType": { - "type": "string" - }, - "host": { - "type": "string" - }, - "ignoreObjectFragments": { - "type": "boolean" - }, - "ignoreLinkTexts": { - "type": "boolean" - }, - "ignoreNavigationTitles": { - "type": "boolean" - } + "base64Blob": { "type": "string" }, + "preTranslationType": { "type": "string" }, + "host": { "type": "string" }, + "ignoreObjectFragments": { "type": "boolean" }, + "ignoreLinkTexts": { "type": "boolean" }, + "ignoreNavigationTitles": { "type": "boolean" } } }, "UserInfo": { "type": "object", "properties": { - "userName": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "canChangePassword": { - "type": "boolean" - }, - "isAdmin": { - "type": "boolean" - } + "userName": { "type": "string" }, + "displayName": { "type": "string" }, + "canChangePassword": { "type": "boolean" }, + "isAdmin": { "type": "boolean" } } }, "EditorTemplateSpecification": { "type": "object", "properties": { - "editorTemplateGroups": { - "type": "array", - "items": { - "$ref": "#/definitions/EditorTemplateGroup" - } - }, - "editorTemplates": { - "type": "array", - "items": { - "$ref": "#/definitions/EditorTemplate" - } - } + "editorTemplateGroups": { "type": "array", "items": { "$ref": "#/definitions/EditorTemplateGroup" } }, + "editorTemplates": { "type": "array", "items": { "$ref": "#/definitions/EditorTemplate" } } } }, "EditorTemplateGroup": { "type": "object", "properties": { - "id": { - "format": "int64", - "type": "integer" - }, - "name": { - "type": "string" - }, - "objectType": { - "type": "string" - } + "id": { "format": "int64", "type": "integer" }, + "name": { "type": "string" }, + "objectType": { "type": "string" } } }, "EditorTemplate": { "type": "object", "properties": { - "logicalId": { - "type": "string" - }, - "languageCardId": { - "format": "int64", - "type": "integer" - }, - "editorTemplateGroupId": { - "format": "int64", - "type": "integer" - }, - "language": { - "type": "string" - }, - "title": { - "type": "string" - }, - "icon": { - "type": "string" - }, - "description": { - "type": "string" - }, - "version": { - "type": "string" - } + "logicalId": { "type": "string" }, + "languageCardId": { "format": "int64", "type": "integer" }, + "editorTemplateGroupId": { "format": "int64", "type": "integer" }, + "language": { "type": "string" }, + "title": { "type": "string" }, + "icon": { "type": "string" }, + "description": { "type": "string" }, + "version": { "type": "string" } } }, "Favorites": { "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/Favorite" - } - } - } + "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Favorite" } } } }, "Favorite": { "type": "object", "properties": { - "logicalId": { - "type": "string" - }, - "logicalCardId": { - "format": "int64", - "type": "integer" - }, - "title": { - "type": "string" - }, + "logicalId": { "type": "string" }, + "logicalCardId": { "format": "int64", "type": "integer" }, + "title": { "type": "string" }, "type": { "enum": [ "none", @@ -8601,67 +5225,31 @@ ], "type": "string" }, - "folderPath": { - "$ref": "#/definitions/FolderPath" - } + "folderPath": { "$ref": "#/definitions/FolderPath" } } }, "FolderPath": { "type": "object", - "properties": { - "folderPathSegments": { - "type": "array", - "items": { - "$ref": "#/definitions/FolderPathSegment" - } - } - } + "properties": { "folderPathSegments": { "type": "array", "items": { "$ref": "#/definitions/FolderPathSegment" } } } }, "FolderPathSegment": { "type": "object", "properties": { - "folderCardId": { - "format": "int64", - "type": "integer" - }, - "depth": { - "format": "int64", - "type": "integer" - }, - "label": { - "type": "string" - } + "folderCardId": { "format": "int64", "type": "integer" }, + "depth": { "format": "int64", "type": "integer" }, + "label": { "type": "string" } } }, "FolderModel": { "type": "object", "properties": { - "folderCardId": { - "format": "int64", - "type": "integer" - }, - "parentFolderCardId": { - "format": "int64", - "type": "integer" - }, - "isBaseFolder": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "ownedBy": { - "type": "string" - }, - "readAccess": { - "type": "array", - "items": { - "type": "string" - } - }, - "xmlQuery": { - "type": "string" - }, + "folderCardId": { "format": "int64", "type": "integer" }, + "parentFolderCardId": { "format": "int64", "type": "integer" }, + "isBaseFolder": { "type": "boolean" }, + "name": { "type": "string" }, + "ownedBy": { "type": "string" }, + "readAccess": { "type": "array", "items": { "type": "string" } }, + "xmlQuery": { "type": "string" }, "folderType": { "enum": [ "none", @@ -8680,14 +5268,7 @@ }, "Folders": { "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/NavigationFolder" - } - } - } + "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/NavigationFolder" } } } }, "NavigationFolder": { "type": "object", @@ -8706,54 +5287,25 @@ ], "type": "string" }, - "cardId": { - "format": "int64", - "type": "integer" - }, - "isBaseFolder": { - "type": "boolean" - }, - "parentId": { - "format": "int64", - "type": "integer" - }, - "title": { - "type": "string" - } + "cardId": { "format": "int64", "type": "integer" }, + "isBaseFolder": { "type": "boolean" }, + "parentId": { "format": "int64", "type": "integer" }, + "title": { "type": "string" } } }, "FolderContent": { "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/FolderContentItem" - } - } - } + "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/FolderContentItem" } } } }, "FolderContentItem": { "type": "object", "properties": { - "type": { - "type": "string" - }, - "logicalId": { - "type": "string" - }, - "canCheckIn": { - "type": "boolean" - }, - "canCheckOut": { - "type": "boolean" - }, - "canUndoCheckOut": { - "type": "boolean" - }, - "exception": { - "type": "string" - }, + "type": { "type": "string" }, + "logicalId": { "type": "string" }, + "canCheckIn": { "type": "boolean" }, + "canCheckOut": { "type": "boolean" }, + "canUndoCheckOut": { "type": "boolean" }, + "exception": { "type": "string" }, "itemType": { "enum": [ "none", @@ -8769,715 +5321,270 @@ ], "type": "string" }, - "version": { - "type": "string" - }, - "language": { - "type": "string" - }, - "resolution": { - "type": "string" - }, - "cardId": { - "format": "int64", - "type": "integer" - }, - "isBaseFolder": { - "type": "boolean" - }, - "parentId": { - "format": "int64", - "type": "integer" - }, - "title": { - "type": "string" - } + "version": { "type": "string" }, + "language": { "type": "string" }, + "resolution": { "type": "string" }, + "cardId": { "format": "int64", "type": "integer" }, + "isBaseFolder": { "type": "boolean" }, + "parentId": { "format": "int64", "type": "integer" }, + "title": { "type": "string" } } }, "FieldsFilter": { "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "$ref": "#/definitions/Field" - } - } - } + "properties": { "fields": { "type": "array", "items": { "$ref": "#/definitions/Field" } } } }, "Field": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "level": { - "enum": [ - "none", - "logical", - "version", - "language", - "annotation" - ], - "type": "string" - }, - "valueType": { - "enum": [ - "none", - "id", - "value", - "element" - ], - "type": "string" - }, - "value": { - "type": "string" - } + "name": { "type": "string" }, + "level": { "enum": ["none", "logical", "version", "language", "annotation"], "type": "string" }, + "valueType": { "enum": ["none", "id", "value", "element"], "type": "string" }, + "value": { "type": "string" } } }, "RetrieveTagsResult": { "type": "object", "properties": { - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/Tag" - } - }, - "messages": { - "type": "array", - "items": { - "$ref": "#/definitions/Message" - } - } + "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, + "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } } } }, "Tag": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "label": { - "type": "string" - }, - "annotatedLabel": { - "type": "string" - }, - "description": { - "type": "string" - } + "id": { "type": "string" }, + "label": { "type": "string" }, + "annotatedLabel": { "type": "string" }, + "description": { "type": "string" } } }, "Message": { "type": "object", "properties": { - "baseDescription": { - "type": "string" - }, - "description": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/definitions/Parameter" - } - }, - "type": { - "enum": [ - "error", - "warning", - "info" - ], - "type": "string" - } - } - }, - "Parameter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } + "baseDescription": { "type": "string" }, + "description": { "type": "string" }, + "resourceId": { "type": "string" }, + "parameters": { "type": "array", "items": { "$ref": "#/definitions/Parameter" } }, + "type": { "enum": ["error", "warning", "info"], "type": "string" } } }, + "Parameter": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "FieldTags": { "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "$ref": "#/definitions/FieldTag" - } - } - } + "properties": { "fields": { "type": "array", "items": { "$ref": "#/definitions/FieldTag" } } } }, "FieldTag": { "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ids": { - "type": "array", - "items": { - "type": "string" - } - } - } + "properties": { "name": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string" } } } }, "ResolveIdsResult": { "type": "object", - "properties": { - "resolveIdResults": { - "type": "array", - "items": { - "$ref": "#/definitions/ResolveIdResult" - } - } - } + "properties": { "resolveIdResults": { "type": "array", "items": { "$ref": "#/definitions/ResolveIdResult" } } } }, "ResolveIdResult": { "type": "object", "properties": { - "messages": { - "type": "array", - "items": { - "$ref": "#/definitions/Message" - } - }, - "fieldName": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/Tag" - } - } + "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, + "fieldName": { "type": "string" }, + "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } } } }, "RetrieveTagsStructureResult": { "type": "object", "properties": { - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/StructureTag" - } - }, - "relations": { - "type": "array", - "items": { - "$ref": "#/definitions/TagRelation" - } - }, - "messages": { - "type": "array", - "items": { - "$ref": "#/definitions/Message" - } - } + "tags": { "type": "array", "items": { "$ref": "#/definitions/StructureTag" } }, + "relations": { "type": "array", "items": { "$ref": "#/definitions/TagRelation" } }, + "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } } } }, "StructureTag": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "label": { - "type": "string" - }, - "isSelectable": { - "type": "boolean" - }, - "description": { - "type": "string" - } - } - }, - "TagRelation": { - "type": "object", - "properties": { - "fromId": { - "type": "string" - }, - "toId": { - "type": "string" - } + "id": { "type": "string" }, + "label": { "type": "string" }, + "isSelectable": { "type": "boolean" }, + "description": { "type": "string" } } }, + "TagRelation": { "type": "object", "properties": { "fromId": { "type": "string" }, "toId": { "type": "string" } } }, "SearchResults": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchResult" - } - }, - "totalHits": { - "format": "int64", - "type": "integer" - } + "items": { "type": "array", "items": { "$ref": "#/definitions/SearchResult" } }, + "totalHits": { "format": "int64", "type": "integer" } } }, "SearchResult": { "type": "object", "properties": { - "languageCardId": { - "format": "int64", - "type": "integer" - }, - "logicalId": { - "type": "string" - }, + "languageCardId": { "format": "int64", "type": "integer" }, + "logicalId": { "type": "string" }, "type": { - "enum": [ - "none", - "module", - "master", - "library", - "illustration", - "template", - "publication" - ], + "enum": ["none", "module", "master", "library", "illustration", "template", "publication"], "type": "string" }, - "language": { - "type": "string" - }, - "version": { - "type": "string" - }, - "resolution": { - "type": "string" - }, - "title": { - "type": "string" - }, - "folderPath": { - "$ref": "#/definitions/FolderPath" - }, - "score": { - "format": "double", - "type": "number" - } + "language": { "type": "string" }, + "version": { "type": "string" }, + "resolution": { "type": "string" }, + "title": { "type": "string" }, + "folderPath": { "$ref": "#/definitions/FolderPath" }, + "score": { "format": "double", "type": "number" } } }, "PublicationMetadataParameters": { "type": "object", "properties": { - "publicationId": { - "type": "string" - }, - "publicationVersion": { - "type": "string" - }, - "requestedMetadata": { - "$ref": "#/definitions/RequestedMetadata" - } + "publicationId": { "type": "string" }, + "publicationVersion": { "type": "string" }, + "requestedMetadata": { "$ref": "#/definitions/RequestedMetadata" } } }, "PublicationMetadata": { "type": "object", "properties": { - "metadata": { - "$ref": "#/definitions/ResolvedMetadata" - }, - "logicalId": { - "type": "string" - }, - "version": { - "type": "string" - }, - "logicalCardId": { - "format": "int64", - "type": "integer" - }, - "versionCardId": { - "format": "int64", - "type": "integer" - }, - "languageCardId": { - "format": "int64", - "type": "integer" - }, - "objectType": { - "type": "string" - } + "metadata": { "$ref": "#/definitions/ResolvedMetadata" }, + "logicalId": { "type": "string" }, + "version": { "type": "string" }, + "logicalCardId": { "format": "int64", "type": "integer" }, + "versionCardId": { "format": "int64", "type": "integer" }, + "languageCardId": { "format": "int64", "type": "integer" }, + "objectType": { "type": "string" } } }, "ApplicationHostSettings": { "type": "object", - "properties": { - "enrichUri": { - "type": "string" - }, - "reachUri": { - "type": "string" - }, - "ugcUri": { - "type": "string" - } - } - }, - "EnrichSettings": { - "type": "object", - "properties": { - "uri": { - "type": "string" - } - } + "properties": { "enrichUri": { "type": "string" }, "reachUri": { "type": "string" }, "ugcUri": { "type": "string" } } }, + "EnrichSettings": { "type": "object", "properties": { "uri": { "type": "string" } } }, "ReachConfig": { "type": "object", "properties": { - "url": { - "type": "string" - }, - "reachRelativeUrl": { - "type": "string" - }, - "architectRelativeUrl": { - "type": "string" - } + "url": { "type": "string" }, + "reachRelativeUrl": { "type": "string" }, + "architectRelativeUrl": { "type": "string" } } }, "XopusConfig": { "type": "object", "properties": { - "version": { - "type": "string" - }, - "import": { - "$ref": "#/definitions/Import" - }, - "catalog": { - "$ref": "#/definitions/Catalog" - }, - "changeTracking": { - "$ref": "#/definitions/ChangeTracking" - }, - "nodeConfig": { - "$ref": "#/definitions/NodeConfig" - }, - "javascript": { - "$ref": "#/definitions/Javascript" - }, - "lookupConfig": { - "$ref": "#/definitions/LookupConfig" - }, - "miscellaneous": { - "$ref": "#/definitions/Miscellaneous" - }, - "spellChecker": { - "$ref": "#/definitions/SpellChecker" - }, - "overlay": { - "$ref": "#/definitions/Overlay" - }, - "pipeline": { - "$ref": "#/definitions/Pipeline" - }, - "validation": { - "$ref": "#/definitions/Validation" - } - } - }, - "Import": { - "type": "object", - "properties": { - "source": { - "type": "string" - } - } - }, - "Catalog": { - "type": "object", - "properties": { - "source": { - "type": "string" - } + "version": { "type": "string" }, + "import": { "$ref": "#/definitions/Import" }, + "catalog": { "$ref": "#/definitions/Catalog" }, + "changeTracking": { "$ref": "#/definitions/ChangeTracking" }, + "nodeConfig": { "$ref": "#/definitions/NodeConfig" }, + "javascript": { "$ref": "#/definitions/Javascript" }, + "lookupConfig": { "$ref": "#/definitions/LookupConfig" }, + "miscellaneous": { "$ref": "#/definitions/Miscellaneous" }, + "spellChecker": { "$ref": "#/definitions/SpellChecker" }, + "overlay": { "$ref": "#/definitions/Overlay" }, + "pipeline": { "$ref": "#/definitions/Pipeline" }, + "validation": { "$ref": "#/definitions/Validation" } } }, + "Import": { "type": "object", "properties": { "source": { "type": "string" } } }, + "Catalog": { "type": "object", "properties": { "source": { "type": "string" } } }, "ChangeTracking": { "type": "object", "properties": { - "visible": { - "type": "boolean" - }, - "enabled": { - "type": "boolean" - }, - "allowAccept": { - "type": "boolean" - }, - "allowReject": { - "type": "boolean" - } + "visible": { "type": "boolean" }, + "enabled": { "type": "boolean" }, + "allowAccept": { "type": "boolean" }, + "allowReject": { "type": "boolean" } } }, "NodeConfig": { "type": "object", - "properties": { - "node": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeConfigNode" - } - } - } - }, - "Javascript": { - "type": "object", - "properties": { - "source": { - "type": "string" - }, - "content": { - "type": "string" - } - } + "properties": { "node": { "type": "array", "items": { "$ref": "#/definitions/NodeConfigNode" } } } }, + "Javascript": { "type": "object", "properties": { "source": { "type": "string" }, "content": { "type": "string" } } }, "LookupConfig": { "type": "object", - "properties": { - "lookup": { - "type": "array", - "items": { - "$ref": "#/definitions/LookupConfigLookup" - } - } - } + "properties": { "lookup": { "type": "array", "items": { "$ref": "#/definitions/LookupConfigLookup" } } } }, "Miscellaneous": { "type": "object", "properties": { - "attentionBorders": { - "type": "boolean" - }, - "debugMode": { - "type": "boolean" - }, - "disableContextMenu": { - "type": "boolean" - }, - "disableQuickInsertMenu": { - "type": "boolean" - }, - "extensiveInsertMenu": { - "type": "boolean" - }, - "hideStatusbar": { - "type": "boolean" - }, - "ignoreUnsavedChanges": { - "type": "boolean" - }, - "reproducerSupportEmailAddress": { - "type": "string" - }, - "saveWithIndentation": { - "type": "string" - }, - "hideMaximizeViewportButton": { - "type": "boolean" - }, - "skipPrecalculationForNS": { - "type": "string" - }, - "useSchemaOrderInUI": { - "type": "string" - } - } - }, - "SpellChecker": { - "type": "object", - "properties": { - "defaultLanguage": { - "type": "string" - } + "attentionBorders": { "type": "boolean" }, + "debugMode": { "type": "boolean" }, + "disableContextMenu": { "type": "boolean" }, + "disableQuickInsertMenu": { "type": "boolean" }, + "extensiveInsertMenu": { "type": "boolean" }, + "hideStatusbar": { "type": "boolean" }, + "ignoreUnsavedChanges": { "type": "boolean" }, + "reproducerSupportEmailAddress": { "type": "string" }, + "saveWithIndentation": { "type": "string" }, + "hideMaximizeViewportButton": { "type": "boolean" }, + "skipPrecalculationForNS": { "type": "string" }, + "useSchemaOrderInUI": { "type": "string" } } }, + "SpellChecker": { "type": "object", "properties": { "defaultLanguage": { "type": "string" } } }, "Overlay": { "type": "object", - "properties": { - "ribbonElements": { - "type": "array", - "items": { - "$ref": "#/definitions/OverlayRibbonElement" - } - } - } + "properties": { "ribbonElements": { "type": "array", "items": { "$ref": "#/definitions/OverlayRibbonElement" } } } }, "Validation": { "type": "object", - "properties": { - "autoMakeValid": { - "type": "boolean" - }, - "validateSimpleTypes": { - "type": "boolean" - } - } + "properties": { "autoMakeValid": { "type": "boolean" }, "validateSimpleTypes": { "type": "boolean" } } }, "NodeConfigNode": { "type": "object", "properties": { - "match": { - "type": "string" - }, - "description": { - "type": "string" - }, - "enumeration": { - "$ref": "#/definitions/NodeConfigNodeEnumeration" - }, - "invalidValueMessage": { - "type": "boolean" - }, - "inputType": { - "type": "string" - }, - "lookup": { - "type": "array", - "items": { - "$ref": "#/definitions/LookupConfigLookup" - } - }, - "name": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeConfigElementWithLang" - } - }, - "placeholder": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeConfigElementWithLang" - } - }, - "role": { - "type": "string" - }, - "templates": { - "$ref": "#/definitions/NodeConfigNodeTemplates" - }, - "uiGroup": { - "type": "string" - } + "match": { "type": "string" }, + "description": { "type": "string" }, + "enumeration": { "$ref": "#/definitions/NodeConfigNodeEnumeration" }, + "invalidValueMessage": { "type": "boolean" }, + "inputType": { "type": "string" }, + "lookup": { "type": "array", "items": { "$ref": "#/definitions/LookupConfigLookup" } }, + "name": { "type": "array", "items": { "$ref": "#/definitions/NodeConfigElementWithLang" } }, + "placeholder": { "type": "array", "items": { "$ref": "#/definitions/NodeConfigElementWithLang" } }, + "role": { "type": "string" }, + "templates": { "$ref": "#/definitions/NodeConfigNodeTemplates" }, + "uiGroup": { "type": "string" } } }, "LookupConfigLookup": { "type": "object", "properties": { - "parentPattern": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string" - }, - "forceLooup": { - "type": "boolean" - }, - "autoOpen": { - "type": "boolean" - } + "parentPattern": { "type": "string" }, + "name": { "type": "string" }, + "url": { "type": "string" }, + "forceLooup": { "type": "boolean" }, + "autoOpen": { "type": "boolean" } } }, "OverlayRibbonElement": { "type": "object", "properties": { - "type": { - "type": "string", - "readOnly": true - }, - "after": { - "type": "string" - }, - "before": { - "type": "string" - }, - "id": { - "type": "string" - }, - "label": { - "type": "string" - } + "type": { "type": "string", "readOnly": true }, + "after": { "type": "string" }, + "before": { "type": "string" }, + "id": { "type": "string" }, + "label": { "type": "string" } } }, "NodeConfigNodeEnumeration": { "type": "object", - "properties": { - "value": { - "type": "string" - }, - "name": { - "$ref": "#/definitions/NodeConfigElementWithLang" - } - } + "properties": { "value": { "type": "string" }, "name": { "$ref": "#/definitions/NodeConfigElementWithLang" } } }, "NodeConfigElementWithLang": { "type": "object", - "properties": { - "lang": { - "type": "string" - }, - "value": { - "type": "string" - } - } + "properties": { "lang": { "type": "string" }, "value": { "type": "string" } } }, "NodeConfigNodeTemplates": { "type": "object", - "properties": { - "template": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeConfigNodeTemplate" - } - } - } + "properties": { "template": { "type": "array", "items": { "$ref": "#/definitions/NodeConfigNodeTemplate" } } } }, "NodeConfigNodeTemplate": { "type": "object", - "properties": { - "color": { - "type": "string" - }, - "value": { - "type": "string" - } - } + "properties": { "color": { "type": "string" }, "value": { "type": "string" } } }, "SettingsMetadataParameters": { "type": "object", - "properties": { - "requestedMetadata": { - "$ref": "#/definitions/RequestedMetadata" - } - } - }, - "SettingsMetadata": { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/definitions/ResolvedMetadata" - } - } + "properties": { "requestedMetadata": { "$ref": "#/definitions/RequestedMetadata" } } }, + "SettingsMetadata": { "type": "object", "properties": { "metadata": { "$ref": "#/definitions/ResolvedMetadata" } } }, "CollectiveSpacesConfig": { "required": [ "fileAssociations", @@ -9488,281 +5595,140 @@ ], "type": "object", "properties": { - "fileAssociations": { - "type": "array", - "items": { - "$ref": "#/definitions/FileExtensionAssociation" - } - }, - "previewResolution": { - "type": "string" - }, - "collectiveSpacesConfiguration": { - "$ref": "#/definitions/CollectiveSpacesXmlConfiguration" - }, - "supportedUiLanguages": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "experienceConfiguration": { - "$ref": "#/definitions/CollectiveSpacesExperienceConfig" - } + "fileAssociations": { "type": "array", "items": { "$ref": "#/definitions/FileExtensionAssociation" } }, + "previewResolution": { "type": "string" }, + "collectiveSpacesConfiguration": { "$ref": "#/definitions/CollectiveSpacesXmlConfiguration" }, + "supportedUiLanguages": { "type": "object", "additionalProperties": { "type": "string" } }, + "experienceConfiguration": { "$ref": "#/definitions/CollectiveSpacesExperienceConfig" } } }, "FileExtensionAssociation": { - "required": [ - "fileExtension", - "editorTemplateId" - ], + "required": ["fileExtension", "editorTemplateId"], "type": "object", - "properties": { - "fileExtension": { - "type": "string" - }, - "editorTemplateId": { - "type": "string" - } - } + "properties": { "fileExtension": { "type": "string" }, "editorTemplateId": { "type": "string" } } }, "CollectiveSpacesXmlConfiguration": { - "required": [ - "draftSpaceSettings" - ], + "required": ["draftSpaceSettings"], "type": "object", "properties": { - "commonSettings": { - "$ref": "#/definitions/CommonCollectiveSpacesSettings" - }, - "draftSpaceSettings": { - "$ref": "#/definitions/DraftSpaceSettings" - }, - "reviewSpaceSettings": { - "$ref": "#/definitions/ReviewSpaceSettings" - } + "commonSettings": { "$ref": "#/definitions/CommonCollectiveSpacesSettings" }, + "draftSpaceSettings": { "$ref": "#/definitions/DraftSpaceSettings" }, + "reviewSpaceSettings": { "$ref": "#/definitions/ReviewSpaceSettings" } } }, "CollectiveSpacesExperienceConfig": { - "required": [ - "behaviorConfigXml", - "schemaLocationConfigXml" - ], + "required": ["behaviorConfigXml", "schemaLocationConfigXml"], "type": "object", - "properties": { - "behaviorConfigXml": { - "type": "string" - }, - "schemaLocationConfigXml": { - "type": "string" - } - } - }, - "CommonCollectiveSpacesSettings": { - "type": "object", - "properties": {} + "properties": { "behaviorConfigXml": { "type": "string" }, "schemaLocationConfigXml": { "type": "string" } } }, + "CommonCollectiveSpacesSettings": { "type": "object", "properties": {} }, "DraftSpaceSettings": { - "required": [ - "imageUpload" - ], + "required": ["imageUpload"], "type": "object", - "properties": { - "imageUpload": { - "$ref": "#/definitions/ImageUploadSettings" - } - } - }, - "ReviewSpaceSettings": { - "type": "object", - "properties": {} + "properties": { "imageUpload": { "$ref": "#/definitions/ImageUploadSettings" } } }, + "ReviewSpaceSettings": { "type": "object", "properties": {} }, "ImageUploadSettings": { - "required": [ - "isEnabled", - "preferredResolution" - ], + "required": ["isEnabled", "preferredResolution"], "type": "object", "properties": { - "isEnabled": { - "type": "boolean" - }, - "preferredResolution": { - "$ref": "#/definitions/PreferredResolution" - } + "isEnabled": { "type": "boolean" }, + "preferredResolution": { "$ref": "#/definitions/PreferredResolution" } } }, "PreferredResolution": { - "required": [ - "ishValueType", - "value" - ], + "required": ["ishValueType", "value"], + "type": "object", + "properties": { "ishValueType": { "type": "string" }, "value": { "type": "string" } } + }, + "DocumentHistoryRequest": { + "type": "object", + "properties": { "data": { "$ref": "#/definitions/DocumentHistoryRequestParameters" } } + }, + "DocumentHistoryRequestParameters": { "type": "object", "properties": { - "ishValueType": { - "type": "string" - }, - "value": { - "type": "string" - } + "publicationId": { "type": "string" }, + "language": { "type": "string" }, + "version": { "type": "string" }, + "resolution": { "type": "string" } } }, - "UserPreferenceSet": { - "required": [ - "name", - "items" - ], + "DocumentHistoryInfo": { + "type": "object", + "properties": { "revisions": { "type": "array", "items": { "$ref": "#/definitions/DocumentRevisionInfo" } } } + }, + "DocumentRevisionInfo": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/UserPreferenceItem" - } - } + "id": { "type": "string", "readOnly": true }, + "lastModifiedTimestamp": { "format": "date-time", "type": "string", "readOnly": true }, + "author": { "$ref": "#/definitions/DocumentRevisionAuthor", "readOnly": true } + } + }, + "DocumentRevisionAuthor": { + "type": "object", + "properties": { "id": { "type": "string", "readOnly": true }, "displayName": { "type": "string", "readOnly": true } } + }, + "UserPreferenceSet": { + "required": ["name", "items"], + "type": "object", + "properties": { + "name": { "type": "string" }, + "items": { "type": "array", "items": { "$ref": "#/definitions/UserPreferenceItem" } } } }, "UserPreferenceItem": { - "required": [ - "name", - "value" - ], + "required": ["name", "value"], "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - } + "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "FormField": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/FormChild" - }, + { "$ref": "#/definitions/FormChild" }, { "type": "object", "properties": { - "displayType": { - "$ref": "#/definitions/DisplayType" - }, - "allowDuplicates": { - "type": "boolean" - }, - "hidden": { - "type": "boolean" - }, - "mandatory": { - "type": "boolean" - }, - "pattern": { - "$ref": "#/definitions/Pattern" - }, - "readOnly": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "requestedField": { - "$ref": "#/definitions/RequestedField" - }, - "typeName": { - "type": "string", - "readOnly": true - }, - "label": { - "$ref": "#/definitions/TranslatableValue" - }, - "description": { - "$ref": "#/definitions/TranslatableValue" - } + "displayType": { "$ref": "#/definitions/DisplayType" }, + "allowDuplicates": { "type": "boolean" }, + "hidden": { "type": "boolean" }, + "mandatory": { "type": "boolean" }, + "pattern": { "$ref": "#/definitions/Pattern" }, + "readOnly": { "type": "boolean" }, + "name": { "type": "string" }, + "requestedField": { "$ref": "#/definitions/RequestedField" }, + "typeName": { "type": "string", "readOnly": true }, + "label": { "$ref": "#/definitions/TranslatableValue" }, + "description": { "$ref": "#/definitions/TranslatableValue" } } } ], "properties": {} }, "DisplayType": { - "required": [ - "discriminator" - ], + "required": ["discriminator"], "type": "object", - "properties": { - "typeName": { - "type": "string", - "readOnly": true - }, - "discriminator": { - "type": "string" - } - }, + "properties": { "typeName": { "type": "string", "readOnly": true }, "discriminator": { "type": "string" } }, "discriminator": "discriminator" }, "Pattern": { "type": "object", - "properties": { - "type": { - "enum": [ - "formatString", - "regex" - ], - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "RequestedField": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "level": { - "type": "string" - } - } + "properties": { "type": { "enum": ["formatString", "regex"], "type": "string" }, "value": { "type": "string" } } }, + "RequestedField": { "type": "object", "properties": { "name": { "type": "string" }, "level": { "type": "string" } } }, "FormGroup": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/FormChild" - }, + { "$ref": "#/definitions/FormChild" }, { "type": "object", "properties": { - "expandState": { - "enum": [ - "none", - "expanded", - "collapsed" - ], - "type": "string" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/FormChild" - } - }, - "typeName": { - "type": "string", - "readOnly": true - }, - "label": { - "$ref": "#/definitions/TranslatableValue" - }, - "description": { - "$ref": "#/definitions/TranslatableValue" - } + "expandState": { "enum": ["none", "expanded", "collapsed"], "type": "string" }, + "items": { "type": "array", "items": { "$ref": "#/definitions/FormChild" } }, + "typeName": { "type": "string", "readOnly": true }, + "label": { "$ref": "#/definitions/TranslatableValue" }, + "description": { "$ref": "#/definitions/TranslatableValue" } } } ], @@ -9771,28 +5737,15 @@ "FormLeaf": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/FormChild" - }, + { "$ref": "#/definitions/FormChild" }, { "type": "object", "properties": { - "name": { - "type": "string" - }, - "requestedField": { - "$ref": "#/definitions/RequestedField" - }, - "typeName": { - "type": "string", - "readOnly": true - }, - "label": { - "$ref": "#/definitions/TranslatableValue" - }, - "description": { - "$ref": "#/definitions/TranslatableValue" - } + "name": { "type": "string" }, + "requestedField": { "$ref": "#/definitions/RequestedField" }, + "typeName": { "type": "string", "readOnly": true }, + "label": { "$ref": "#/definitions/TranslatableValue" }, + "description": { "$ref": "#/definitions/TranslatableValue" } } } ], @@ -9801,28 +5754,14 @@ "FormTab": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/FormChild" - }, + { "$ref": "#/definitions/FormChild" }, { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/FormChild" - } - }, - "typeName": { - "type": "string", - "readOnly": true - }, - "label": { - "$ref": "#/definitions/TranslatableValue" - }, - "description": { - "$ref": "#/definitions/TranslatableValue" - } + "items": { "type": "array", "items": { "$ref": "#/definitions/FormChild" } }, + "typeName": { "type": "string", "readOnly": true }, + "label": { "$ref": "#/definitions/TranslatableValue" }, + "description": { "$ref": "#/definitions/TranslatableValue" } } } ], @@ -9831,73 +5770,35 @@ "FormContainer": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/FormChild" - }, + { "$ref": "#/definitions/FormChild" }, { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/FormChild" - } - }, - "typeName": { - "type": "string", - "readOnly": true - }, - "label": { - "$ref": "#/definitions/TranslatableValue" - }, - "description": { - "$ref": "#/definitions/TranslatableValue" - } + "items": { "type": "array", "items": { "$ref": "#/definitions/FormChild" } }, + "typeName": { "type": "string", "readOnly": true }, + "label": { "$ref": "#/definitions/TranslatableValue" }, + "description": { "$ref": "#/definitions/TranslatableValue" } } } ], "properties": {} }, "BaseList": { - "required": [ - "discriminator" - ], + "required": ["discriminator"], "type": "object", - "properties": { - "typeName": { - "type": "string", - "readOnly": true - }, - "discriminator": { - "type": "string" - } - }, + "properties": { "typeName": { "type": "string", "readOnly": true }, "discriminator": { "type": "string" } }, "discriminator": "discriminator" }, "BaselineList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, + { "$ref": "#/definitions/BaseList" }, { "type": "object", "properties": { - "activityFilter": { - "enum": [ - "none", - "active", - "inactive" - ], - "type": "string" - }, - "metadataFilter": { - "$ref": "#/definitions/MetadataFilter" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "activityFilter": { "enum": ["none", "active", "inactive"], "type": "string" }, + "metadataFilter": { "$ref": "#/definitions/MetadataFilter" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -9906,27 +5807,13 @@ "ElectronicDocumentTypeList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, + { "$ref": "#/definitions/BaseList" }, { "type": "object", "properties": { - "activityFilter": { - "enum": [ - "none", - "active", - "inactive" - ], - "type": "string" - }, - "metadataFilter": { - "$ref": "#/definitions/MetadataFilter" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "activityFilter": { "enum": ["none", "active", "inactive"], "type": "string" }, + "metadataFilter": { "$ref": "#/definitions/MetadataFilter" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -9935,22 +5822,12 @@ "EnumList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, + { "$ref": "#/definitions/BaseList" }, { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/ValueListItem" - } - }, - "typeName": { - "type": "string", - "readOnly": true - } + "items": { "type": "array", "items": { "$ref": "#/definitions/ValueListItem" } }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -9959,27 +5836,13 @@ "LovList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, + { "$ref": "#/definitions/BaseList" }, { "type": "object", "properties": { - "activityFilter": { - "enum": [ - "none", - "active", - "inactive" - ], - "type": "string" - }, - "lovReference": { - "type": "string" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "activityFilter": { "enum": ["none", "active", "inactive"], "type": "string" }, + "lovReference": { "type": "string" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -9988,22 +5851,13 @@ "TagList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, + { "$ref": "#/definitions/BaseList" }, { "type": "object", "properties": { - "name": { - "type": "string" - }, - "level": { - "type": "string" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "name": { "type": "string" }, + "level": { "type": "string" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10012,63 +5866,29 @@ "TransitionStateList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, - { - "type": "object", - "properties": { - "typeName": { - "type": "string", - "readOnly": true - } - } - } + { "$ref": "#/definitions/BaseList" }, + { "type": "object", "properties": { "typeName": { "type": "string", "readOnly": true } } } ], "properties": {} }, "TranslationTemplatesList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, - { - "type": "object", - "properties": { - "typeName": { - "type": "string", - "readOnly": true - } - } - } + { "$ref": "#/definitions/BaseList" }, + { "type": "object", "properties": { "typeName": { "type": "string", "readOnly": true } } } ], "properties": {} }, "UserGroupList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, + { "$ref": "#/definitions/BaseList" }, { "type": "object", "properties": { - "activityFilter": { - "enum": [ - "none", - "active", - "inactive" - ], - "type": "string" - }, - "metadataFilter": { - "$ref": "#/definitions/MetadataFilter" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "activityFilter": { "enum": ["none", "active", "inactive"], "type": "string" }, + "metadataFilter": { "$ref": "#/definitions/MetadataFilter" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10077,30 +5897,14 @@ "UserList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, + { "$ref": "#/definitions/BaseList" }, { "type": "object", "properties": { - "activityFilter": { - "enum": [ - "none", - "active", - "inactive" - ], - "type": "string" - }, - "metadataFilter": { - "$ref": "#/definitions/MetadataFilter" - }, - "restrictUserGroup": { - "type": "boolean" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "activityFilter": { "enum": ["none", "active", "inactive"], "type": "string" }, + "metadataFilter": { "$ref": "#/definitions/MetadataFilter" }, + "restrictUserGroup": { "type": "boolean" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10109,27 +5913,13 @@ "UserRoleList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, + { "$ref": "#/definitions/BaseList" }, { "type": "object", "properties": { - "activityFilter": { - "enum": [ - "none", - "active", - "inactive" - ], - "type": "string" - }, - "metadataFilter": { - "$ref": "#/definitions/MetadataFilter" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "activityFilter": { "enum": ["none", "active", "inactive"], "type": "string" }, + "metadataFilter": { "$ref": "#/definitions/MetadataFilter" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10138,40 +5928,21 @@ "VersionList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/BaseList" - }, - { - "type": "object", - "properties": { - "typeName": { - "type": "string", - "readOnly": true - } - } - } + { "$ref": "#/definitions/BaseList" }, + { "type": "object", "properties": { "typeName": { "type": "string", "readOnly": true } } } ], "properties": {} }, "TypeCheckBox": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, + { "$ref": "#/definitions/DisplayType" }, { "type": "object", "properties": { - "checkedValue": { - "type": "string" - }, - "uncheckedValue": { - "type": "string" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "checkedValue": { "type": "string" }, + "uncheckedValue": { "type": "string" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10180,20 +5951,10 @@ "TypeCondition": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, + { "$ref": "#/definitions/DisplayType" }, { "type": "object", - "properties": { - "assist": { - "type": "boolean" - }, - "typeName": { - "type": "string", - "readOnly": true - } - } + "properties": { "assist": { "type": "boolean" }, "typeName": { "type": "string", "readOnly": true } } } ], "properties": {} @@ -10201,58 +5962,29 @@ "TypeCustom": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, - { - "type": "object", - "properties": { - "typeName": { - "type": "string", - "readOnly": true - } - } - } + { "$ref": "#/definitions/DisplayType" }, + { "type": "object", "properties": { "typeName": { "type": "string", "readOnly": true } } } ], "properties": {} }, "TypeDate": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, - { - "type": "object", - "properties": { - "typeName": { - "type": "string", - "readOnly": true - } - } - } + { "$ref": "#/definitions/DisplayType" }, + { "type": "object", "properties": { "typeName": { "type": "string", "readOnly": true } } } ], "properties": {} }, "TypeFile": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, + { "$ref": "#/definitions/DisplayType" }, { "type": "object", "properties": { - "valueList": { - "$ref": "#/definitions/ValueList" - }, - "assist": { - "type": "boolean" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "valueList": { "$ref": "#/definitions/ValueList" }, + "assist": { "type": "boolean" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10261,57 +5993,28 @@ "ValueList": { "type": "object", "properties": { - "list": { - "$ref": "#/definitions/BaseList" - }, - "isStatic": { - "type": "boolean" - }, - "sortOrder": { - "enum": [ - "none", - "ascending", - "descending" - ], - "type": "string" - } + "list": { "$ref": "#/definitions/BaseList" }, + "isStatic": { "type": "boolean" }, + "sortOrder": { "enum": ["none", "ascending", "descending"], "type": "string" } } }, "TypeLabel": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, - { - "type": "object", - "properties": { - "typeName": { - "type": "string", - "readOnly": true - } - } - } + { "$ref": "#/definitions/DisplayType" }, + { "type": "object", "properties": { "typeName": { "type": "string", "readOnly": true } } } ], "properties": {} }, "TypeMultilineText": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, + { "$ref": "#/definitions/DisplayType" }, { "type": "object", "properties": { - "lines": { - "format": "int32", - "type": "integer" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "lines": { "format": "int32", "type": "integer" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10320,32 +6023,15 @@ "TypeNumeric": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, + { "$ref": "#/definitions/DisplayType" }, { "type": "object", "properties": { - "decimalPlaces": { - "format": "int32", - "type": "integer" - }, - "increment": { - "format": "double", - "type": "number" - }, - "minimum": { - "format": "double", - "type": "number" - }, - "maximum": { - "format": "double", - "type": "number" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "decimalPlaces": { "format": "int32", "type": "integer" }, + "increment": { "format": "double", "type": "number" }, + "minimum": { "format": "double", "type": "number" }, + "maximum": { "format": "double", "type": "number" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10354,26 +6040,13 @@ "TypeOptions": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, + { "$ref": "#/definitions/DisplayType" }, { "type": "object", "properties": { - "valueList": { - "$ref": "#/definitions/ValueList" - }, - "flowDirection": { - "enum": [ - "vertical", - "horizontal" - ], - "type": "string" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "valueList": { "$ref": "#/definitions/ValueList" }, + "flowDirection": { "enum": ["vertical", "horizontal"], "type": "string" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10382,19 +6055,12 @@ "TypePullDown": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, + { "$ref": "#/definitions/DisplayType" }, { "type": "object", "properties": { - "valueList": { - "$ref": "#/definitions/ValueList" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "valueList": { "$ref": "#/definitions/ValueList" }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10403,22 +6069,12 @@ "TypeReference": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, + { "$ref": "#/definitions/DisplayType" }, { "type": "object", "properties": { - "selectableTypes": { - "type": "array", - "items": { - "type": "string" - } - }, - "typeName": { - "type": "string", - "readOnly": true - } + "selectableTypes": { "type": "array", "items": { "type": "string" } }, + "typeName": { "type": "string", "readOnly": true } } } ], @@ -10427,74 +6083,30 @@ "TypeTagList": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, + { "$ref": "#/definitions/DisplayType" }, { "type": "object", "properties": { - "autosuggest": { - "$ref": "#/definitions/Autosuggest" - }, - "recentCache": { - "type": "boolean" - }, - "structureView": { - "$ref": "#/definitions/StructureView" - }, - "valuePanel": { - "$ref": "#/definitions/ValuePanel" - }, - "typeName": { - "type": "string", - "readOnly": true - } + "autosuggest": { "$ref": "#/definitions/Autosuggest" }, + "recentCache": { "type": "boolean" }, + "structureView": { "$ref": "#/definitions/StructureView" }, + "valuePanel": { "$ref": "#/definitions/ValuePanel" }, + "typeName": { "type": "string", "readOnly": true } } } ], "properties": {} }, - "Autosuggest": { - "type": "object", - "properties": { - "valueList": { - "$ref": "#/definitions/ValueList" - } - } - }, - "StructureView": { - "type": "object", - "properties": { - "valueList": { - "$ref": "#/definitions/ValueList" - } - } - }, - "ValuePanel": { - "type": "object", - "properties": { - "valueList": { - "$ref": "#/definitions/ValueList" - } - } - }, + "Autosuggest": { "type": "object", "properties": { "valueList": { "$ref": "#/definitions/ValueList" } } }, + "StructureView": { "type": "object", "properties": { "valueList": { "$ref": "#/definitions/ValueList" } } }, + "ValuePanel": { "type": "object", "properties": { "valueList": { "$ref": "#/definitions/ValueList" } } }, "TypeText": { "type": "object", "allOf": [ - { - "$ref": "#/definitions/DisplayType" - }, + { "$ref": "#/definitions/DisplayType" }, { "type": "object", - "properties": { - "password": { - "type": "boolean" - }, - "typeName": { - "type": "string", - "readOnly": true - } - } + "properties": { "password": { "type": "boolean" }, "typeName": { "type": "string", "readOnly": true } } } ], "properties": {} diff --git a/test/mock/v2/test-sites.json b/test/mock/v2/test-sites.json index 4e88e794..bb5a0801 100644 --- a/test/mock/v2/test-sites.json +++ b/test/mock/v2/test-sites.json @@ -1,10 +1,11 @@ { "swagger": "2.0", "info": { - "version": "V1.0", - "title": "CMS" + "version": "V9.5", + "title": "Sdl.Tridion.ContentManager.OpenApi", + "x-swagger-net-version": "8.3.23.103" }, - "host": "global.cms.corp:8080", + "host": "dxui-dev.global.sdl.corp:7086", "basePath": "/OpenApi", "schemes": [ "http" @@ -2390,7 +2391,7 @@ "Blueprinting" ], "summary": "Localizes an Item in the Blueprint.", - "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • CmsProcessDefinition
  • VirtualFolder
", + "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • TridionProcessDefinition
  • VirtualFolder
", "operationId": "LocalizeRepositoryLocalObject", "consumes": [ "*/*", @@ -2455,7 +2456,7 @@ "Blueprinting" ], "summary": "UnLocalizes an Item in the Blueprint.", - "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • CmsProcessDefinition
  • VirtualFolder
", + "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • TridionProcessDefinition
  • VirtualFolder
", "operationId": "UnLocalizeRepositoryLocalObject", "consumes": [ "*/*", @@ -2676,7 +2677,7 @@ "Item" ], "summary": "Fetches an item.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "FetchIdentifableObject", "consumes": [ "*/*", @@ -2755,7 +2756,7 @@ "Item" ], "summary": "Updates an existing item.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "UpdateIdentifableObject", "consumes": [ "*/*", @@ -3127,7 +3128,7 @@ "Item" ], "summary": "Returns a default data type for the given Item Type and Container Id.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "GetDefaultData", "consumes": [ "*/*", @@ -3181,7 +3182,7 @@ "Item" ], "summary": "Copies a RepositoryLocalObject.", - "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • CmsProcessDefinition
  • VirtualFolder
", + "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • TridionProcessDefinition
  • VirtualFolder
", "operationId": "CopyRepositoryLocalObject", "consumes": [ "*/*", @@ -3251,7 +3252,7 @@ "Item" ], "summary": "Moves a RepositoryLocalObject.", - "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • CmsProcessDefinition
  • VirtualFolder
", + "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • TridionProcessDefinition
  • VirtualFolder
", "operationId": "MoveRepositoryLocalObject", "consumes": [ "*/*", @@ -3581,7 +3582,7 @@ "Lists" ], "summary": "Gets a list of related items.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "GetList", "consumes": [ "*/*", @@ -3661,7 +3662,7 @@ "OrganizationalItems" ], "summary": "Gets a list of classified items.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "ClassifiedItems", "consumes": [ "*/*", @@ -3795,7 +3796,7 @@ "OrganizationalItems" ], "summary": "Gets a list of child items.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "Items", "consumes": [ "*/*", @@ -3922,7 +3923,7 @@ "Blueprinting" ], "summary": "Gets a list of items that are used by a specific item.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "Uses", "consumes": [ "*/*", @@ -4119,7 +4120,7 @@ "Blueprinting" ], "summary": "Gets a list of items that use a specific item.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "UsedBy", "consumes": [ "*/*", @@ -4333,7 +4334,7 @@ "OrganizationalItems" ], "summary": "Gets a list of bundles a specific item is in.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "InBundles", "consumes": [ "*/*", @@ -4461,7 +4462,7 @@ "Workflow" ], "summary": "Gets a list of Process Definitions for a specific item.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "ProcessDefinitions", "consumes": [ "*/*", @@ -4529,7 +4530,7 @@ "Lists" ], "summary": "Gets a list of Publications.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "Publications", "consumes": [ "*/*", @@ -4659,7 +4660,7 @@ "Lists" ], "summary": "Gets the items that are checked out by a given user.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "GetCheckedOutItemsForUser", "consumes": [ "*/*", @@ -6244,7 +6245,7 @@ "Search" ], "summary": "", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "BasicFullTextSearch", "consumes": [ "*/*", @@ -6319,7 +6320,7 @@ "Search" ], "summary": "Full search.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "Search", "consumes": [ "*/*", @@ -6388,7 +6389,7 @@ "tags": [ "Search" ], - "summary": "Reindexes a Cms repository.", + "summary": "Reindexes a Tridion repository.", "description": "When no repositoryId is provided, all repositories will be reindexed.", "operationId": "Reindex", "consumes": [ @@ -6485,7 +6486,7 @@ "System" ], "summary": "Gets a system wide list.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "GetSystemWideList", "consumes": [ "*/*", @@ -6629,14 +6630,14 @@ } } }, - "/api/v{api-version}/cm/system/Cmslanguages": { + "/api/v{api-version}/cm/system/tridionlanguages": { "get": { "tags": [ "System" ], "summary": "Gets available languages.", "description": "", - "operationId": "GetCmsLanguages", + "operationId": "GetTridionLanguages", "consumes": [ "*/*", "application/json" @@ -6659,10 +6660,10 @@ "description": "The request was succesful.", "schema": { "items": { - "$ref": "#/definitions/CmsLanguageInfo" + "$ref": "#/definitions/TridionLanguageInfo" }, "xml": { - "name": "CmsLanguageInfo", + "name": "TridionLanguageInfo", "wrapped": true }, "type": "array" @@ -6759,7 +6760,7 @@ "description": "The filter to apply to the output.", "required": true, "schema": { - "$ref": "#/definitions/CmsDirectoryUsersFilter" + "$ref": "#/definitions/TridionDirectoryUsersFilter" } }, { @@ -7558,7 +7559,7 @@ "Versioning" ], "summary": "Gets the history of a VersionedItem.", - "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • TridionActivityDefinition
  • TridionProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", "operationId": "History", "consumes": [ "*/*", @@ -9173,7 +9174,7 @@ "type": "array" }, "SynchronizeOptions": { - "$ref": "#/definitions/CmsSynchronizeOptions" + "$ref": "#/definitions/TridionSynchronizeOptions" } }, "xml": { @@ -9181,7 +9182,7 @@ }, "type": "object" }, - "CmsSynchronizeOptions": { + "TridionSynchronizeOptions": { "properties": { "LoadFlags": { "type": "string", @@ -9222,7 +9223,7 @@ } }, "xml": { - "name": "CmsSynchronizeOptions" + "name": "TridionSynchronizeOptions" }, "type": "object" }, @@ -11668,7 +11669,7 @@ }, "type": "object" }, - "IsCmsWebSchema": { + "IsTridionWebSchema": { "type": "boolean" }, "MetadataFields": { @@ -12008,10 +12009,10 @@ }, "type": "object" }, - "CmsLanguageInfo": { + "TridionLanguageInfo": { "properties": { "$type": { - "example": "CmsLanguageInfo", + "example": "TridionLanguageInfo", "type": "string" }, "LanguageId": { @@ -12026,7 +12027,7 @@ } }, "xml": { - "name": "CmsLanguageInfo" + "name": "TridionLanguageInfo" }, "type": "object" }, @@ -12060,7 +12061,7 @@ }, "type": "object" }, - "CmsDirectoryUsersFilter": { + "TridionDirectoryUsersFilter": { "properties": { "SubtreeDN": { "type": "string" @@ -12077,7 +12078,7 @@ } }, "xml": { - "name": "CmsDirectoryUsersFilter" + "name": "TridionDirectoryUsersFilter" }, "type": "object" }, @@ -15864,7 +15865,7 @@ }, "type": "object" }, - "CmsActivityDefinition": { + "TridionActivityDefinition": { "allOf": [ { "$ref": "#/definitions/ActivityDefinition" @@ -15919,11 +15920,11 @@ } ], "xml": { - "name": "CmsActivityDefinition" + "name": "TridionActivityDefinition" }, "type": "object" }, - "CmsProcessDefinition": { + "TridionProcessDefinition": { "allOf": [ { "$ref": "#/definitions/ProcessDefinition" @@ -15942,7 +15943,7 @@ } ], "xml": { - "name": "CmsProcessDefinition" + "name": "TridionProcessDefinition" }, "type": "object" }, @@ -16400,7 +16401,7 @@ "IsBasedOnMandatorySchema": { "type": "boolean" }, - "IsBasedOnCmsWebSchema": { + "IsBasedOnTridionWebSchema": { "type": "boolean" }, "Schema": { diff --git a/test/mock/v3/test-access.json b/test/mock/v3/test-access.json index 20ee2ee4..d1b1038a 100644 --- a/test/mock/v3/test-access.json +++ b/test/mock/v3/test-access.json @@ -216,12 +216,12 @@ } } }, - "/api/v{api-version}/Applications/getByDisplayName/{name}": { + "/api/v{api-version}/Applications/getByName/{name}": { "get": { "tags": [ "Applications" ], - "operationId": "GetByDisplayName", + "operationId": "GetByName", "parameters": [ { "name": "name", @@ -343,7 +343,7 @@ "schema": { "title": "Application", "required": [ - "displayName", + "name", "redirectUrls" ], "type": "object", @@ -358,7 +358,7 @@ "format": "int32", "readOnly": true }, - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true @@ -377,7 +377,7 @@ "schema": { "title": "Application", "required": [ - "displayName", + "name", "redirectUrls" ], "type": "object", @@ -392,7 +392,7 @@ "format": "int32", "readOnly": true }, - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true @@ -411,7 +411,7 @@ "schema": { "title": "Application", "required": [ - "displayName", + "name", "redirectUrls" ], "type": "object", @@ -426,7 +426,7 @@ "format": "int32", "readOnly": true }, - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true @@ -445,7 +445,7 @@ "schema": { "title": "Application", "required": [ - "displayName", + "name", "redirectUrls" ], "type": "object", @@ -460,7 +460,7 @@ "format": "int32", "readOnly": true }, - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true @@ -3246,7 +3246,7 @@ "schemas": { "ApiResourceRole": { "required": [ - "displayName", + "key", "name" ], "type": "object", @@ -3255,12 +3255,12 @@ "type": "integer", "format": "int32" }, - "name": { + "key": { "maxLength": 256, "type": "string", "nullable": true }, - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true @@ -3273,7 +3273,7 @@ }, "ApiResource": { "required": [ - "displayName", + "key", "name" ], "type": "object", @@ -3282,13 +3282,13 @@ "type": "integer", "format": "int32" }, - "name": { + "key": { "maxLength": 256, "pattern": "^[a-zA-Z0-9-_.]*$", "type": "string", "nullable": true }, - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true @@ -3366,7 +3366,7 @@ }, "Application": { "required": [ - "displayName", + "name", "redirectUrls" ], "type": "object", @@ -3380,7 +3380,7 @@ "type": "integer", "format": "int32" }, - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true @@ -3411,22 +3411,20 @@ }, "IdentityProvider": { "required": [ - "displayName", - "fullNameClaim", + "key", "name", "parameters", - "type", - "usernameClaim" + "type" ], "type": "object", "properties": { - "name": { + "key": { "maxLength": 64, "pattern": "^[a-zA-Z0-9_]*$", "type": "string", "nullable": true }, - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true @@ -3442,21 +3440,6 @@ "type": { "$ref": "#/components/schemas/IdentityProviderType" }, - "separator": { - "maxLength": 1, - "type": "string", - "nullable": true - }, - "usernameClaim": { - "maxLength": 256, - "type": "string", - "nullable": true - }, - "fullNameClaim": { - "maxLength": 256, - "type": "string", - "nullable": true - }, "iconUrl": { "type": "string", "nullable": true @@ -3523,23 +3506,21 @@ "identityProvider": { "title": "IdentityProvider", "required": [ - "displayName", - "fullNameClaim", + "key", "name", "parameters", - "type", - "usernameClaim" + "type" ], "type": "object", "properties": { - "name": { + "key": { "maxLength": 64, "pattern": "^[a-zA-Z0-9_]*$", "type": "string", "nullable": true, "readOnly": true }, - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true, @@ -3567,24 +3548,6 @@ "type": "string", "readOnly": true }, - "separator": { - "maxLength": 1, - "type": "string", - "nullable": true, - "readOnly": true - }, - "usernameClaim": { - "maxLength": 256, - "type": "string", - "nullable": true, - "readOnly": true - }, - "fullNameClaim": { - "maxLength": 256, - "type": "string", - "nullable": true, - "readOnly": true - }, "iconUrl": { "type": "string", "nullable": true, @@ -3696,7 +3659,7 @@ "type": "integer", "format": "int32" }, - "displayName": { + "name": { "type": "string", "nullable": true, "readOnly": true @@ -3711,7 +3674,7 @@ "type": "integer", "format": "int32" }, - "displayName": { + "name": { "type": "string", "nullable": true, "readOnly": true @@ -3726,7 +3689,7 @@ "type": "integer", "format": "int32" }, - "displayName": { + "name": { "type": "string", "nullable": true, "readOnly": true @@ -3747,23 +3710,21 @@ "identityProvider": { "title": "IdentityProvider", "required": [ - "displayName", - "fullNameClaim", + "key", "name", "parameters", - "type", - "usernameClaim" + "type" ], "type": "object", "properties": { - "name": { + "key": { "maxLength": 64, "pattern": "^[a-zA-Z0-9_]*$", "type": "string", "nullable": true, "readOnly": true }, - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true, @@ -3791,24 +3752,6 @@ "type": "string", "readOnly": true }, - "separator": { - "maxLength": 1, - "type": "string", - "nullable": true, - "readOnly": true - }, - "usernameClaim": { - "maxLength": 256, - "type": "string", - "nullable": true, - "readOnly": true - }, - "fullNameClaim": { - "maxLength": 256, - "type": "string", - "nullable": true, - "readOnly": true - }, "iconUrl": { "type": "string", "nullable": true, @@ -3927,11 +3870,11 @@ }, "LoginOption": { "required": [ - "displayName" + "name" ], "type": "object", "properties": { - "displayName": { + "name": { "maxLength": 256, "type": "string", "nullable": true