mfdoc/build/src/response.js

Auto generate JS SDK and HTTP API documentation

import { mfdocConstruct } from './mfdoc.js';
const errorObject = mfdocConstruct.constructObject({
    name: 'ExternalError',
    fields: {
        message: mfdocConstruct.constructObjectField({
            required: true,
            data: mfdocConstruct.constructString({
                description: 'Error message',
                example: 'Workspace name is invalid',
            }),
        }),
    },
});
const errorResponseBody = mfdocConstruct.constructObject({
    name: 'EndpointErrorResult',
    description: 'Endpoint error result',
    fields: {
        errors: mfdocConstruct.constructObjectField({
            required: false,
            data: mfdocConstruct.constructArray({
                type: errorObject,
                description: 'Endpoint call response errors',
            }),
        }),
    },
});
const emptySuccessResponseBody = mfdocConstruct.constructObject({
    name: 'EmptyEndpointResult',
    description: 'Empty endpoint success result',
    fields: {},
});
export const kMfdocHttpResponseItems = {
    errorResponseBody,
    emptySuccessResponseBody,
};
//# sourceMappingURL=response.js.map