@appsemble/utils 0.20.9 → 0.20.12

package/api/paths/resourceHistory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceHistory.js","sourceRoot":"","sources":["resourceHistory.ts"],"names":[],"mappings":";;;AAEa,QAAA,KAAK,GAA0B;IAC1C,iEAAiE,EAAE;QACjE,UAAU,EAAE;YACV,EAAE,IAAI,EAAE,+BAA+B,EAAE;YACzC,EAAE,IAAI,EAAE,sCAAsC,EAAE;YAChD,EAAE,IAAI,EAAE,oCAAoC,EAAE;SAC/C;QACD,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,qCAAqC;YAClD,WAAW,EAAE,oBAAoB;YACjC,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,yCAAyC;oBACtD,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACL,IAAI,EAAE,iCAAiC;iCACxC;6BACF;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SAC3B;KACF;CACF,CAAC"}

package/api/paths/resourceHistory.ts

@@ -0,0 +1,32 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const paths: OpenAPIV3.PathsObject = {
+  '/api/apps/{appId}/resources/{resourceType}/{resourceId}/history': {
+    parameters: [
+      { $ref: '#/components/parameters/appId' },
+      { $ref: '#/components/parameters/resourceType' },
+      { $ref: '#/components/parameters/resourceId' },
+    ],
+    get: {
+      tags: ['resource'],
+      description: 'Get the known history of a resource',
+      operationId: 'getResourceHistory',
+      responses: {
+        200: {
+          description: 'The resource that matches the given id.',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: {
+                  $ref: '#/components/responses/resource',
+                },
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }],
+    },
+  },
+};

package/api/paths/resources.js

@@ -0,0 +1,307 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paths = void 0;
+exports.paths = {
+    '/api/apps/{appId}/resources/{resourceType}': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { $ref: '#/components/parameters/resourceType' },
+        ],
+        get: {
+            tags: ['resource'],
+            description: 'Get all resources of this app.',
+            operationId: 'queryResources',
+            parameters: [
+                { $ref: '#/components/parameters/view' },
+                { $ref: '#/components/parameters/$filter' },
+                { $ref: '#/components/parameters/$orderby' },
+                { $ref: '#/components/parameters/$select' },
+                { $ref: '#/components/parameters/$top' },
+                { $ref: '#/components/parameters/$team' },
+            ],
+            responses: {
+                200: {
+                    description: 'The list of all this app’s resources of this type.',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'array',
+                                items: {
+                                    $ref: '#/components/schemas/Resource',
+                                },
+                            },
+                        },
+                        'text/csv': {
+                            schema: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+        },
+        post: {
+            tags: ['resource'],
+            description: 'Create a new resource for this app.',
+            operationId: 'createResource',
+            requestBody: {
+                required: true,
+                description: 'The resource to create',
+                content: {
+                    'application/json': {
+                        schema: {
+                            anyOf: [
+                                { $ref: '#/components/schemas/Resource' },
+                                { type: 'array', items: { $ref: '#/components/schemas/Resource' } },
+                            ],
+                        },
+                    },
+                    'multipart/form-data': {
+                        schema: {
+                            type: 'object',
+                            required: ['resource'],
+                            description: 'A `multipart/form-data` representation of a resource.',
+                            additionalProperties: false,
+                            properties: {
+                                resource: {
+                                    type: 'array',
+                                    items: { $ref: '#/components/schemas/Resource' },
+                                },
+                                assets: {
+                                    type: 'array',
+                                    description: 'A list of assets that should be linked to the resource.',
+                                    items: {
+                                        type: 'string',
+                                        format: 'binary',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                    'text/csv': {
+                        schema: {
+                            type: 'array',
+                            items: { type: 'object', additionalProperties: { type: 'string' } },
+                        },
+                    },
+                },
+            },
+            responses: {
+                201: {
+                    description: 'The resource that was created.',
+                    $ref: '#/components/responses/resource',
+                },
+            },
+            security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+        },
+        put: {
+            tags: ['resource'],
+            description: 'Update existing app resources.',
+            operationId: 'updateResources',
+            requestBody: {
+                required: true,
+                description: 'The resources to update',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: { $ref: '#/components/schemas/Resource' },
+                        },
+                    },
+                    'multipart/form-data': {
+                        schema: {
+                            type: 'object',
+                            required: ['resource'],
+                            description: 'A `multipart/form-data` representation of a resource.',
+                            additionalProperties: false,
+                            properties: {
+                                resource: {
+                                    type: 'array',
+                                    items: { $ref: '#/components/schemas/Resource' },
+                                },
+                                assets: {
+                                    type: 'array',
+                                    description: 'A list of assets that should be linked to the resources.',
+                                    items: {
+                                        type: 'string',
+                                        format: 'binary',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                    'text/csv': {
+                        schema: {
+                            type: 'array',
+                            items: { type: 'object', additionalProperties: { type: 'string' } },
+                        },
+                    },
+                },
+            },
+            responses: {
+                200: {
+                    description: 'The updated resources.',
+                    $ref: '#/components/responses/resource',
+                },
+            },
+            security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+        },
+        delete: {
+            tags: ['resource'],
+            description: 'Delete multiple app resources.',
+            operationId: 'deleteResources',
+            requestBody: {
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            description: 'An array of resource IDs to remove.',
+                            items: { $ref: '#/components/schemas/Resource/properties/id' },
+                        },
+                    },
+                },
+            },
+            responses: {
+                204: {
+                    description: 'The app resources have been deleted successfully.',
+                },
+            },
+            security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+        },
+    },
+    // XXX: Temporary workaround until this is fixed in Koas
+    // See https://gitlab.com/remcohaszing/koas/-/issues/2
+    '/api/apps/{appId}/resources/{resourceType}/\\$count': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { $ref: '#/components/parameters/resourceType' },
+        ],
+        get: {
+            tags: ['resource'],
+            description: 'Get a count of all resources of this app.',
+            operationId: 'countResources',
+            parameters: [
+                { $ref: '#/components/parameters/$filter' },
+                { $ref: '#/components/parameters/$team' },
+            ],
+            responses: {
+                200: {
+                    description: 'The count of all this app’s resources of this type.',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'number',
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+        },
+    },
+    '/api/apps/{appId}/resources/{resourceType}/subscriptions': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { $ref: '#/components/parameters/resourceType' },
+            { $ref: '#/components/parameters/endpoint' },
+        ],
+        get: {
+            tags: ['resource'],
+            description: 'Get the current subscription status of this resource.',
+            operationId: 'getResourceTypeSubscription',
+            responses: {
+                200: {
+                    description: 'The subscription status for this resource.',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: '#/components/schemas/ResourceSubscription',
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }, { app: ['openid'] }, {}],
+        },
+    },
+    '/api/apps/{appId}/resources/{resourceType}/{resourceId}': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { $ref: '#/components/parameters/resourceType' },
+            { $ref: '#/components/parameters/resourceId' },
+            { $ref: '#/components/parameters/view' },
+        ],
+        get: {
+            tags: ['resource'],
+            description: 'Get a single app resource.',
+            operationId: 'getResourceById',
+            responses: {
+                200: {
+                    description: 'The resource that matches the given id.',
+                    $ref: '#/components/responses/resource',
+                },
+            },
+            security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+        },
+        put: {
+            tags: ['resource'],
+            description: 'Update an existing app resource.',
+            operationId: 'updateResource',
+            requestBody: {
+                required: true,
+                $ref: '#/components/requestBodies/resource',
+            },
+            responses: {
+                200: {
+                    description: 'The updated resource.',
+                    $ref: '#/components/responses/resource',
+                },
+            },
+            security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+        },
+        delete: {
+            tags: ['resource'],
+            description: 'Delete an existing app resource.',
+            operationId: 'deleteResource',
+            responses: {
+                204: {
+                    description: 'The app resource has been deleted successfully.',
+                    $ref: '#/components/responses/resource',
+                },
+            },
+            security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+        },
+    },
+    '/api/apps/{appId}/resources/{resourceType}/{resourceId}/subscriptions': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { $ref: '#/components/parameters/resourceType' },
+            { $ref: '#/components/parameters/resourceId' },
+            { $ref: '#/components/parameters/endpoint' },
+        ],
+        get: {
+            tags: ['resource'],
+            description: 'Get the subscription status of a resource.',
+            operationId: 'getResourceSubscription',
+            responses: {
+                200: {
+                    description: 'The subscription status of the resource that matches the given id.',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'object',
+                                properties: {
+                                    id: { type: 'number' },
+                                    update: { type: 'boolean' },
+                                    delete: { type: 'boolean' },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=resources.js.map

package/api/paths/resources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["resources.ts"],"names":[],"mappings":";;;AAEa,QAAA,KAAK,GAA0B;IAC1C,4CAA4C,EAAE;QAC5C,UAAU,EAAE;YACV,EAAE,IAAI,EAAE,+BAA+B,EAAE;YACzC,EAAE,IAAI,EAAE,sCAAsC,EAAE;SACjD;QACD,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,gCAAgC;YAC7C,WAAW,EAAE,gBAAgB;YAC7B,UAAU,EAAE;gBACV,EAAE,IAAI,EAAE,8BAA8B,EAAE;gBACxC,EAAE,IAAI,EAAE,iCAAiC,EAAE;gBAC3C,EAAE,IAAI,EAAE,kCAAkC,EAAE;gBAC5C,EAAE,IAAI,EAAE,iCAAiC,EAAE;gBAC3C,EAAE,IAAI,EAAE,8BAA8B,EAAE;gBACxC,EAAE,IAAI,EAAE,+BAA+B,EAAE;aAC1C;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,oDAAoD;oBACjE,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACL,IAAI,EAAE,+BAA+B;iCACtC;6BACF;yBACF;wBACD,UAAU,EAAE;4BACV,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;6BACf;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,EAAE,EAAE,EAAE,CAAC;SAC3F;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,qCAAqC;YAClD,WAAW,EAAE,gBAAgB;YAC7B,WAAW,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,wBAAwB;gBACrC,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,KAAK,EAAE;gCACL,EAAE,IAAI,EAAE,+BAA+B,EAAE;gCACzC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,+BAA+B,EAAE,EAAE;6BACpE;yBACF;qBACF;oBACD,qBAAqB,EAAE;wBACrB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,QAAQ,EAAE,CAAC,UAAU,CAAC;4BACtB,WAAW,EAAE,uDAAuD;4BACpE,oBAAoB,EAAE,KAAK;4BAC3B,UAAU,EAAE;gCACV,QAAQ,EAAE;oCACR,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE,EAAE,IAAI,EAAE,+BAA+B,EAAE;iCACjD;gCACD,MAAM,EAAE;oCACN,IAAI,EAAE,OAAO;oCACb,WAAW,EAAE,yDAAyD;oCACtE,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,MAAM,EAAE,QAAQ;qCACjB;iCACF;6BACF;yBACF;qBACF;oBACD,UAAU,EAAE;wBACV,MAAM,EAAE;4BACN,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;yBACpE;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,gCAAgC;oBAC7C,IAAI,EAAE,iCAAiC;iBACxC;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC;SAC5F;QACD,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,gCAAgC;YAC7C,WAAW,EAAE,iBAAiB;YAC9B,WAAW,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,yBAAyB;gBACtC,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE,EAAE,IAAI,EAAE,+BAA+B,EAAE;yBACjD;qBACF;oBACD,qBAAqB,EAAE;wBACrB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,QAAQ,EAAE,CAAC,UAAU,CAAC;4BACtB,WAAW,EAAE,uDAAuD;4BACpE,oBAAoB,EAAE,KAAK;4BAC3B,UAAU,EAAE;gCACV,QAAQ,EAAE;oCACR,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE,EAAE,IAAI,EAAE,+BAA+B,EAAE;iCACjD;gCACD,MAAM,EAAE;oCACN,IAAI,EAAE,OAAO;oCACb,WAAW,EAAE,0DAA0D;oCACvE,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,MAAM,EAAE,QAAQ;qCACjB;iCACF;6BACF;yBACF;qBACF;oBACD,UAAU,EAAE;wBACV,MAAM,EAAE;4BACN,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;yBACpE;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,wBAAwB;oBACrC,IAAI,EAAE,iCAAiC;iBACxC;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC;SAC5F;QACD,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,gCAAgC;YAC7C,WAAW,EAAE,iBAAiB;YAC9B,WAAW,EAAE;gBACX,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,OAAO;4BACb,WAAW,EAAE,qCAAqC;4BAClD,KAAK,EAAE,EAAE,IAAI,EAAE,6CAA6C,EAAE;yBAC/D;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,mDAAmD;iBACjE;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC;SAC5F;KACF;IACD,wDAAwD;IACxD,sDAAsD;IACtD,qDAAqD,EAAE;QACrD,UAAU,EAAE;YACV,EAAE,IAAI,EAAE,+BAA+B,EAAE;YACzC,EAAE,IAAI,EAAE,sCAAsC,EAAE;SACjD;QACD,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,2CAA2C;YACxD,WAAW,EAAE,gBAAgB;YAC7B,UAAU,EAAE;gBACV,EAAE,IAAI,EAAE,iCAAiC,EAAE;gBAC3C,EAAE,IAAI,EAAE,+BAA+B,EAAE;aAC1C;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,qDAAqD;oBAClE,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;6BACf;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,EAAE,EAAE,EAAE,CAAC;SAC3F;KACF;IACD,0DAA0D,EAAE;QAC1D,UAAU,EAAE;YACV,EAAE,IAAI,EAAE,+BAA+B,EAAE;YACzC,EAAE,IAAI,EAAE,sCAAsC,EAAE;YAChD,EAAE,IAAI,EAAE,kCAAkC,EAAE;SAC7C;QACD,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,uDAAuD;YACpE,WAAW,EAAE,6BAA6B;YAC1C,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,4CAA4C;oBACzD,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,2CAA2C;6BAClD;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC;SACpD;KACF;IACD,yDAAyD,EAAE;QACzD,UAAU,EAAE;YACV,EAAE,IAAI,EAAE,+BAA+B,EAAE;YACzC,EAAE,IAAI,EAAE,sCAAsC,EAAE;YAChD,EAAE,IAAI,EAAE,oCAAoC,EAAE;YAC9C,EAAE,IAAI,EAAE,8BAA8B,EAAE;SACzC;QACD,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,4BAA4B;YACzC,WAAW,EAAE,iBAAiB;YAC9B,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,yCAAyC;oBACtD,IAAI,EAAE,iCAAiC;iBACxC;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,EAAE,EAAE,EAAE,CAAC;SAC3F;QACD,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,kCAAkC;YAC/C,WAAW,EAAE,gBAAgB;YAC7B,WAAW,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,qCAAqC;aAC5C;YACD,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,uBAAuB;oBACpC,IAAI,EAAE,iCAAiC;iBACxC;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC;SAC5F;QACD,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,kCAAkC;YAC/C,WAAW,EAAE,gBAAgB;YAC7B,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,iDAAiD;oBAC9D,IAAI,EAAE,iCAAiC;iBACxC;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC;SAC5F;KACF;IACD,uEAAuE,EAAE;QACvE,UAAU,EAAE;YACV,EAAE,IAAI,EAAE,+BAA+B,EAAE;YACzC,EAAE,IAAI,EAAE,sCAAsC,EAAE;YAChD,EAAE,IAAI,EAAE,oCAAoC,EAAE;YAC9C,EAAE,IAAI,EAAE,kCAAkC,EAAE;SAC7C;QACD,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,4CAA4C;YACzD,WAAW,EAAE,yBAAyB;YACtC,SAAS,EAAE;gBACT,GAAG,EAAE;oBACH,WAAW,EAAE,oEAAoE;oBACjF,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oCACtB,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oCAC3B,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;iCAC5B;6BACF;yBACF;qBACF;iBACF;aACF;SACF;KACF;CACF,CAAC"}

package/api/paths/resources.ts

@@ -0,0 +1,305 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const paths: OpenAPIV3.PathsObject = {
+  '/api/apps/{appId}/resources/{resourceType}': {
+    parameters: [
+      { $ref: '#/components/parameters/appId' },
+      { $ref: '#/components/parameters/resourceType' },
+    ],
+    get: {
+      tags: ['resource'],
+      description: 'Get all resources of this app.',
+      operationId: 'queryResources',
+      parameters: [
+        { $ref: '#/components/parameters/view' },
+        { $ref: '#/components/parameters/$filter' },
+        { $ref: '#/components/parameters/$orderby' },
+        { $ref: '#/components/parameters/$select' },
+        { $ref: '#/components/parameters/$top' },
+        { $ref: '#/components/parameters/$team' },
+      ],
+      responses: {
+        200: {
+          description: 'The list of all this app’s resources of this type.',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: {
+                  $ref: '#/components/schemas/Resource',
+                },
+              },
+            },
+            'text/csv': {
+              schema: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+    },
+    post: {
+      tags: ['resource'],
+      description: 'Create a new resource for this app.',
+      operationId: 'createResource',
+      requestBody: {
+        required: true,
+        description: 'The resource to create',
+        content: {
+          'application/json': {
+            schema: {
+              anyOf: [
+                { $ref: '#/components/schemas/Resource' },
+                { type: 'array', items: { $ref: '#/components/schemas/Resource' } },
+              ],
+            },
+          },
+          'multipart/form-data': {
+            schema: {
+              type: 'object',
+              required: ['resource'],
+              description: 'A `multipart/form-data` representation of a resource.',
+              additionalProperties: false,
+              properties: {
+                resource: {
+                  type: 'array',
+                  items: { $ref: '#/components/schemas/Resource' },
+                },
+                assets: {
+                  type: 'array',
+                  description: 'A list of assets that should be linked to the resource.',
+                  items: {
+                    type: 'string',
+                    format: 'binary',
+                  },
+                },
+              },
+            },
+          },
+          'text/csv': {
+            schema: {
+              type: 'array',
+              items: { type: 'object', additionalProperties: { type: 'string' } },
+            },
+          },
+        },
+      },
+      responses: {
+        201: {
+          description: 'The resource that was created.',
+          $ref: '#/components/responses/resource',
+        },
+      },
+      security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    put: {
+      tags: ['resource'],
+      description: 'Update existing app resources.',
+      operationId: 'updateResources',
+      requestBody: {
+        required: true,
+        description: 'The resources to update',
+        content: {
+          'application/json': {
+            schema: {
+              type: 'array',
+              items: { $ref: '#/components/schemas/Resource' },
+            },
+          },
+          'multipart/form-data': {
+            schema: {
+              type: 'object',
+              required: ['resource'],
+              description: 'A `multipart/form-data` representation of a resource.',
+              additionalProperties: false,
+              properties: {
+                resource: {
+                  type: 'array',
+                  items: { $ref: '#/components/schemas/Resource' },
+                },
+                assets: {
+                  type: 'array',
+                  description: 'A list of assets that should be linked to the resources.',
+                  items: {
+                    type: 'string',
+                    format: 'binary',
+                  },
+                },
+              },
+            },
+          },
+          'text/csv': {
+            schema: {
+              type: 'array',
+              items: { type: 'object', additionalProperties: { type: 'string' } },
+            },
+          },
+        },
+      },
+      responses: {
+        200: {
+          description: 'The updated resources.',
+          $ref: '#/components/responses/resource',
+        },
+      },
+      security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    delete: {
+      tags: ['resource'],
+      description: 'Delete multiple app resources.',
+      operationId: 'deleteResources',
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: {
+              type: 'array',
+              description: 'An array of resource IDs to remove.',
+              items: { $ref: '#/components/schemas/Resource/properties/id' },
+            },
+          },
+        },
+      },
+      responses: {
+        204: {
+          description: 'The app resources have been deleted successfully.',
+        },
+      },
+      security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+  },
+  // XXX: Temporary workaround until this is fixed in Koas
+  // See https://gitlab.com/remcohaszing/koas/-/issues/2
+  '/api/apps/{appId}/resources/{resourceType}/\\$count': {
+    parameters: [
+      { $ref: '#/components/parameters/appId' },
+      { $ref: '#/components/parameters/resourceType' },
+    ],
+    get: {
+      tags: ['resource'],
+      description: 'Get a count of all resources of this app.',
+      operationId: 'countResources',
+      parameters: [
+        { $ref: '#/components/parameters/$filter' },
+        { $ref: '#/components/parameters/$team' },
+      ],
+      responses: {
+        200: {
+          description: 'The count of all this app’s resources of this type.',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'number',
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+    },
+  },
+  '/api/apps/{appId}/resources/{resourceType}/subscriptions': {
+    parameters: [
+      { $ref: '#/components/parameters/appId' },
+      { $ref: '#/components/parameters/resourceType' },
+      { $ref: '#/components/parameters/endpoint' },
+    ],
+    get: {
+      tags: ['resource'],
+      description: 'Get the current subscription status of this resource.',
+      operationId: 'getResourceTypeSubscription',
+      responses: {
+        200: {
+          description: 'The subscription status for this resource.',
+          content: {
+            'application/json': {
+              schema: {
+                $ref: '#/components/schemas/ResourceSubscription',
+              },
+            },
+          },
+        },
+      },
+      security: [{ studio: [] }, { app: ['openid'] }, {}],
+    },
+  },
+  '/api/apps/{appId}/resources/{resourceType}/{resourceId}': {
+    parameters: [
+      { $ref: '#/components/parameters/appId' },
+      { $ref: '#/components/parameters/resourceType' },
+      { $ref: '#/components/parameters/resourceId' },
+      { $ref: '#/components/parameters/view' },
+    ],
+    get: {
+      tags: ['resource'],
+      description: 'Get a single app resource.',
+      operationId: 'getResourceById',
+      responses: {
+        200: {
+          description: 'The resource that matches the given id.',
+          $ref: '#/components/responses/resource',
+        },
+      },
+      security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+    },
+    put: {
+      tags: ['resource'],
+      description: 'Update an existing app resource.',
+      operationId: 'updateResource',
+      requestBody: {
+        required: true,
+        $ref: '#/components/requestBodies/resource',
+      },
+      responses: {
+        200: {
+          description: 'The updated resource.',
+          $ref: '#/components/responses/resource',
+        },
+      },
+      security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    delete: {
+      tags: ['resource'],
+      description: 'Delete an existing app resource.',
+      operationId: 'deleteResource',
+      responses: {
+        204: {
+          description: 'The app resource has been deleted successfully.',
+          $ref: '#/components/responses/resource',
+        },
+      },
+      security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+  },
+  '/api/apps/{appId}/resources/{resourceType}/{resourceId}/subscriptions': {
+    parameters: [
+      { $ref: '#/components/parameters/appId' },
+      { $ref: '#/components/parameters/resourceType' },
+      { $ref: '#/components/parameters/resourceId' },
+      { $ref: '#/components/parameters/endpoint' },
+    ],
+    get: {
+      tags: ['resource'],
+      description: 'Get the subscription status of a resource.',
+      operationId: 'getResourceSubscription',
+      responses: {
+        200: {
+          description: 'The subscription status of the resource that matches the given id.',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  id: { type: 'number' },
+                  update: { type: 'boolean' },
+                  delete: { type: 'boolean' },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+};