removed unused schemas, updated create collection schema field

src/models/generated/schemasPublic.d.ts

@@ -201,17 +201,6 @@ export interface EntityMention {
 }
 
 
-/**
- * Response for GET /text-reuse-clusters
- */
-export interface FindTextReuseClustersResponse {
-  clusters: unknown[];
-  info: {
-    [k: string]: unknown;
-  };
-}
-
-
 /**
  * A newspaper
  */
@@ -251,60 +240,6 @@ export interface Newspaper {
 }
 
 
-/**
- * An object containing search results for a facet
- */
-export interface SearchFacet {
-  /**
-   * The type of facet
-   */
-  type: string;
-  /**
-   * The number of buckets in the facet
-   */
-  numBuckets: number;
-  buckets: SearchFacetBucket[] | SearchFacetRangeBucket[];
-}
-/**
- * Facet bucket
- */
-export interface SearchFacetBucket {
-  /**
-   * Number of items in the bucket
-   */
-  count: number;
-  /**
-   * Value that represents the bucket.
-   */
-  value: string | number;
-  /**
-   * Label of the value, if relevant.
-   */
-  label?: string;
-}
-/**
- * Facet bucket
- */
-export interface SearchFacetRangeBucket {
-  /**
-   * Number of items in the bucket
-   */
-  count: number;
-  /**
-   * Value of the 'type' element
-   */
-  val: number;
-  /**
-   * Lower bound of the range
-   */
-  lower?: number;
-  /**
-   * Lower bound of the range
-   */
-  upper?: number;
-}
-
-
 /**
  * Facet bucket
  */
@@ -324,29 +259,6 @@ export interface SearchFacetBucket {
 }
 
 
-/**
- * Facet bucket
- */
-export interface SearchFacetRangeBucket {
-  /**
-   * Number of items in the bucket
-   */
-  count: number;
-  /**
-   * Value of the 'type' element
-   */
-  val: number;
-  /**
-   * Lower bound of the range
-   */
-  lower?: number;
-  /**
-   * Lower bound of the range
-   */
-  upper?: number;
-}
-
-
 /**
  * Text reuse cluster details.
  */

src/models/generated/shared.d.ts

@@ -413,22 +413,23 @@ export interface ImpressoNamedEntityRecognitionEntity {
 }
 
 
-export type StatusOfTheCollection = string;
-
 /**
  * Create new collection request
  */
-export interface NewCollection {
+export interface NewCollectionRequest {
   name: string;
   description?: string;
-  status?: StatusOfTheCollection;
+  /**
+   * Access level of the collection.
+   */
+  accessLevel?: "public" | "private";
 }
 
 
 /**
  * Request to update collectible items in a collection
  */
-export interface UpdateCollectableItems {
+export interface UpdateCollectableItemsRequest {
   /**
    * IDs of the items to add to the collection
    */

src/schema/schemas/ContentItem.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "ContentItem",
+  "title": "Content Item",
   "description": "A journal/magazine content item (article, advertisement, etc.)",
   "type": "object",
   "additionalProperties": false,

src/schema/schemas/EntityDetails.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "An entity like location, person, etc",
   "type": "object",
-  "title": "EntityDetails",
+  "title": "Entity Details",
   "additionalProperties": false,
   "properties": {
     "uid": {

src/schema/schemasPublic/ContentItem.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "ContentItem",
+  "title": "Content Item",
   "description": "A journal/magazine content item (article, advertisement, etc.)",
   "type": "object",
   "additionalProperties": false,

src/schema/schemasPublic/EntityDetails.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "An entity: location or person.",
   "type": "object",
-  "title": "EntityDetails",
+  "title": "Entity Details",
   "additionalProperties": false,
   "properties": {
     "uid": {

src/schema/schemasPublic/EntityMention.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "An entity (location, persion) mention.",
   "type": "object",
-  "title": "EntityMention",
+  "title": "Entity Mention",
   "additionalProperties": false,
   "properties": {
     "uid": {

src/schema/schemasPublic/TopicMention.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "TopicMention",
+  "title": "Topic Mention",
   "description": "Topic presence in a content item.",
   "type": "object",
   "additionalProperties": false,

src/schema/shared/CollectableItemsUpdatedResponse.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Request to update collectible items in a collection",
-  "title": "CollectableItemsUpdatedResponse",
+  "title": "Collectable Items Updated Response",
   "type": "object",
   "required": ["totalAdded", "totalRemoved"],
   "properties": {

src/schema/shared/NewCollection.json → src/schema/shared/NewCollectionRequest.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "New Collection",
+  "title": "New Collection Request",
   "description": "Create new collection request",
   "type": "object",
   "additionalProperties": false,
@@ -14,12 +14,10 @@
       "type": "string",
       "maxLength": 500
     },
-    "status": {
+    "accessLevel": {
       "type": "string",
-      "minLength": 2,
-      "maxLength": 3,
-      "title": "Status of the collection",
-      "examples": ["PRI", "PUB"]
+      "description": "Access level of the collection.",
+      "enum": ["public", "private"]
     }
   },
   "required": ["name"]

src/schema/shared/UpdateCollectableItems.json → src/schema/shared/UpdateCollectableItemsRequest.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Request to update collectible items in a collection",
-  "title": "UpdateCollectableItems",
+  "title": "Update Collectable Items Request",
   "type": "object",
   "properties": {
     "add": {

src/services/collectable-items/collectable-items.class.ts

@@ -5,7 +5,7 @@ import lodash from 'lodash'
 import { Op } from 'sequelize'
 import CollectableItemGroup from '../../models/collectable-items-groups.model'
 import { STATUS_DELETED, STATUS_PUBLIC, STATUS_SHARED } from '../../models/collections.model'
-import { CollectableItemsUpdatedResponse, UpdateCollectableItems } from '../../models/generated/shared'
+import { CollectableItemsUpdatedResponse, UpdateCollectableItemsRequest } from '../../models/generated/shared'
 import User from '../../models/users.model'
 import { ImpressoApplication } from '../../types'
 import { measureTime } from '../../util/instruments'
@@ -298,7 +298,7 @@ export class Service {
    */
   async patch(
     id: NullableId,
-    data: UpdateCollectableItems,
+    data: UpdateCollectableItemsRequest,
     params: Params<PatchQuery> & WithUser
   ): Promise<CollectableItemsUpdatedResponse> {
     if (id != null) throw new Error('Patch operation is not supported on a single item')

src/services/collectable-items/collectable-items.schema.ts

@@ -30,7 +30,7 @@ export const docs: ServiceSwaggerOptions = {
       // the `RefParser.bundle` will fail with an error
       // "MissingPointerError: Token ":id" does not exist."
       requestBody: {
-        content: getRequestBodyContent('UpdateCollectableItems'),
+        content: getRequestBodyContent('UpdateCollectableItemsRequest'),
       },
       responses: getStandardResponses({
         method: 'patchMulti',
@@ -43,7 +43,7 @@ export const docs: ServiceSwaggerOptions = {
       description: 'Update items in the collection',
       parameters: patchParameters,
       requestBody: {
-        content: getRequestBodyContent('UpdateCollectableItems'),
+        content: getRequestBodyContent('UpdateCollectableItemsRequest'),
       },
       responses: getStandardResponses({
         method: 'patchMulti',

src/services/collections/collections.hooks.js

@@ -70,6 +70,17 @@ module.exports = {
         },
         'POST'
       ),
+      // rename accessLevel (public schema) to status (private schema)
+      // TODO: make this nicer
+      context => {
+        if (context.data.accessLevel != null) {
+          if (context.data.accessLevel === 'public') {
+            context.data.status = 'PUB'
+          } else if (context.data.accessLevel === 'private') {
+            context.data.status = 'PRI'
+          }
+        }
+      },
     ],
     update: [],
     patch: [

src/services/collections/collections.schema.ts

@@ -99,7 +99,7 @@ export const getDocs = (isPublicApi: boolean): ServiceSwaggerOptions => ({
       operationId: 'createCollection',
       description: 'Create a new collection',
       requestBody: {
-        content: getRequestBodyContent('NewCollection'),
+        content: getRequestBodyContent('NewCollectionRequest'),
       },
       responses: getStandardResponses({
         method: 'create',
@@ -122,7 +122,7 @@ export const getDocs = (isPublicApi: boolean): ServiceSwaggerOptions => ({
         },
       ],
       requestBody: {
-        content: getRequestBodyContent('NewCollection'),
+        content: getRequestBodyContent('NewCollectionRequest'),
       },
       responses: getStandardResponses({
         method: 'patch',