Updates

src/index.ts

@@ -9,7 +9,7 @@ import { GENERATION_DIR } from "~/util/generateDereferencedSpec";
 async function main() {
 	const doc = getDoc();
 	console.log(inspect(doc, {
-		depth: null,
+		depth: 3,
 		colors: true,
 	}));
 	separator();

src/spec/components/index.ts

@@ -64,10 +64,28 @@ export class ComponentGenerator {
 			);
 		}
 
+		const existing = ComponentGenerator.getInstance()[comp]?.[referenceKey];
+		if (existing) {
+			if (existing !== value) {
+				throw new Error(
+					`Tried to create reference ${JSON.stringify(referenceKey)} with a different value than the existing one: ${JSON.stringify(
+						obj
+					)} in ${JSON.stringify(comp)}.`
+				);
+			}
+			return {
+				$ref: `#/components/${comp}/${referenceKey}`,
+			};
+		}
+
+		const newObj = {
+			[referenceKey]: value,
+		};
+
 		// add to instance
 		ComponentGenerator.getInstance()[comp] = {
 			...ComponentGenerator.getInstance()[comp],
-			[referenceKey]: value,
+			...newObj,
 		};
 		return {
 			$ref: `#/components/${comp}/${referenceKey}`,

src/spec/components/responses/authorsGet200.ts

@@ -4,7 +4,7 @@ import { authorsResponseSchema } from "~/spec/components/schemas/authors/authors
 export const authorsGet200: ResponseObject = {
 	content: {
 		"application/json": {
-			schema: refSchema({ authorsResponseSchema }),
+			schema: refSchema({ authors: authorsResponseSchema }),
 		},
 	},
 	description: "Authors List Response",

src/spec/components/responses/concepts/conceptsGet200Response.ts

@@ -4,7 +4,7 @@ import { conceptsResponseSchema } from "~/spec/components/schemas/concepts/conce
 export const conceptsGet200Response: ResponseObject = {
 	content: {
 		"application/json": {
-			schema: refSchema({ conceptsResponseSchema }),
+			schema: refSchema({ concepts: conceptsResponseSchema }),
 		},
 	},
 	description: "Concepts List",

src/spec/components/responses/funderGet200Response.ts

@@ -4,7 +4,7 @@ import { funderSchema } from "~/spec/components/schemas/funders/funderSchema";
 export const funderGet200Response: ResponseObject = {
 	content: {
 		"application/json": {
-			schema: refSchema({ funderSchema }),
+			schema: refSchema({ funder: funderSchema }),
 		},
 	},
 	description: "",

src/spec/components/responses/getPerson200Response.ts

@@ -4,7 +4,7 @@ import { personResponseSchema } from "~/spec/components/schemas/authors/personRe
 export const getPerson200Response: ResponseObject = {
 	content: {
 		"application/json": {
-			schema: refSchema({ personResponseSchema }),
+			schema: refSchema({ person: personResponseSchema }),
 		},
 	},
 	description: "",

src/spec/components/responses/institutionGet200Response.ts

@@ -4,7 +4,7 @@ import { institutionSchema } from "~/spec/components/schemas/institutions/instit
 export const institutionGet200Response: ResponseObject = {
 	content: {
 		"application/json": {
-			schema: refSchema({ institutionSchema })
+			schema: refSchema({ institution: institutionSchema }),
 		},
 	},
 	description: "",

src/spec/components/responses/institutionsGet200Response.ts

@@ -4,7 +4,7 @@ import { institutionsResponseSchema } from "~/spec/components/schemas/institutio
 export const institutionsGet200Response: ResponseObject = {
 	content: {
 		"application/json": {
-			schema: refSchema({ institutionsResponseSchema }),
+			schema: refSchema({ institutions: institutionsResponseSchema }),
 		},
 	},
 	description: "",

src/spec/components/responses/publisherGet200Response.ts

@@ -4,7 +4,7 @@ import { publisherSchema } from "~/spec/components/schemas/publishers/publisherS
 export const publisherGet200Response: ResponseObject = {
 	content: {
 		"application/json": {
-			schema: refSchema({ publisherSchema }),
+			schema: refSchema({ publisher: publisherSchema }),
 		},
 	},
 	description: "",

src/spec/components/responses/publishersGet200Response.ts

@@ -4,7 +4,7 @@ import { publishersResponseSchema } from "~/spec/components/schemas/publishers/p
 export const publishersGet200Response: ResponseObject = {
 	content: {
 		"application/json": {
-			schema: refSchema({ publishersResponseSchema }),
+			schema: refSchema({ publishers: publishersResponseSchema }),
 		},
 	},
 	description: "",

src/spec/components/responses/sourceGet200Response.ts

@@ -4,7 +4,7 @@ import { sourceSchema } from "~/spec/components/schemas/sources/sourceSchema";
 export const sourceGet200Response: ResponseObject = {
 	content: {
 		"application/json": {
-			schema: refSchema({ sourceSchema }),
+			schema: refSchema({ source: sourceSchema }),
 		},
 	},
 	description: "",

src/spec/components/responses/sourcesGet200Response.ts

@@ -4,8 +4,8 @@ import { sourcesArray } from "~/spec/components/schemas/sources/sourcesArray";
 export const sourcesGet200Response: ResponseObject = {
 	content: {
 		"application/json": {
-			schema: refSchema({ sourcesArray })
-		}
+			schema: refSchema({ sources: sourcesArray }),
+		},
 	},
-	description: ""
+	description: "",
 };

src/spec/components/responses/workNgramsGet200Response.ts

@@ -8,7 +8,7 @@ export const workNgramsGet200Response: ResponseObject = {
 			examples: {
 				ngram: refExample({ workNgramsGet200ResponseExample }),
 			},
-			schema: refSchema({ workNgramsSchema }),
+			schema: refSchema({ ngrams: workNgramsSchema }),
 		},
 	},
 	description: "",

src/spec/components/responses/works/work.ts

@@ -1,10 +1,10 @@
 import { refSchema } from "~/spec/components";
 import { workSchema } from "~/spec/components/schemas/works/work";
 
-export const works = {
+export const work = {
 	content: {
 		"application/json": {
-			schema: refSchema({ workSchema }),
+			schema: refSchema({ work: workSchema }),
 		},
 	},
 	description: "",

src/spec/components/responses/works/works.ts

@@ -1,26 +1,11 @@
 import { refSchema } from "~/spec/components";
+import { worksResponseSchema } from "../../schemas/works/worksResponseSchema";
 
-import { group_by_result } from "~/spec/components/schemas/system/group_by_result";
-import { meta } from "~/spec/components/schemas/system/meta";
-import { workSchema } from "~/spec/components/schemas/works/work";
 
-let worksResponseSchema: SchemaObject = {
-	properties: {
-		meta: refSchema({ meta }),
-		results: {
-			type: "array",
-			items: refSchema({ workSchema }),
-		},
-		group_by: refSchema({ group_by_result }),
-	},
-	required: ["meta", "results"],
-	type: "object",
-}
-	;
 export const works = {
 	content: {
 		"application/json": {
-			schema: refSchema({ worksResponseSchema }),
+			schema: refSchema({ worksResponse: worksResponseSchema })
 		},
 	},
 	description: "",

src/spec/components/schemas/authors/author.ts

@@ -37,7 +37,7 @@ export const author = {
 		last_known_institution: refSchema({ dehydratedInstitution }),
 		last_known_institutions: refSchema({ dehydratedInstitutionArray }),
 		orcid: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		summary_stats: refSchema({ summary_stats }),
 		updated_date: {

src/spec/components/schemas/concepts/concept.ts

@@ -18,7 +18,7 @@ export const conceptSchema = {
 			type: "string",
 		},
 		description: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		display_name: {
 			type: "string",
@@ -53,10 +53,10 @@ export const conceptSchema = {
 			type: "object",
 		},
 		image_thumbnail_url: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		image_url: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		international: refSchema({ international_display_name_and_description }),
 		level: {

src/spec/components/schemas/concepts/conceptsArray.ts

@@ -2,6 +2,6 @@ import { refSchema } from "~/spec/components";
 import { conceptSchema } from "~/spec/components/schemas/concepts/concept";
 
 export const conceptsArray = {
-	items: refSchema({ conceptSchema }),
+	items: refSchema({ concept: conceptSchema }),
 	type: "array",
 } satisfies SchemaObject;

src/spec/components/schemas/concepts/conceptsResponseSchema.ts

@@ -4,9 +4,10 @@ import { group_by_result } from "~/spec/components/schemas/system/group_by_resul
 import { meta } from "~/spec/components/schemas/system/meta";
 
 export const conceptsResponseSchema: SchemaObject = {
+	type: "object",
 	properties: {
 		group_by: refSchema({ group_by_result }),
 		meta: refSchema({ meta }),
-		results: refSchema({ conceptsArray }),
+		results: refSchema({ conceptArray: conceptsArray }),
 	},
 };

src/spec/components/schemas/concepts/dehydratedConcept.ts

@@ -14,7 +14,7 @@ export const dehydratedConcept = {
 			type: "number",
 		},
 		wikidata: {
-			type: ["string", "null"]
+			type: "string"
 		},
 	},
 	required: [

src/spec/components/schemas/funders/funderSchema.ts

@@ -17,14 +17,14 @@ export const funderSchema = {
 			type: "integer",
 		},
 		country_code: {
-			type: ["string", "null"],
+			type: "string",
 		},
 		counts_by_year: refSchema({ countsByYear }),
 		created_date: {
 			type: "string",
 		},
 		description: {
-			type: ["string", "null"],
+			type: "string",
 		},
 		display_name: {
 			type: "string",
@@ -33,17 +33,17 @@ export const funderSchema = {
 			type: "integer",
 		},
 		homepage_url: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		id: {
 			type: "string",
 		},
 		ids: refSchema({ ids }),
 		image_thumbnail_url: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		image_url: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		relevance_score: {
 			type: "number",

src/spec/components/schemas/institutions/geo.ts

@@ -7,10 +7,10 @@ export const geo = {
 			type: "string",
 		},
 		country_code: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		geonames_city_id: {
-			type: ["string", "null"],
+			type: "string",
 		},
 		latitude: {
 			type: "number",
@@ -19,7 +19,7 @@ export const geo = {
 			type: "number",
 		},
 		region: {
-			type: ["string", "null"],
+			type: "string",
 		},
 	},
 	required: [

src/spec/components/schemas/institutions/institutionSchema.ts

@@ -20,7 +20,7 @@ export const institutionSchema: SchemaObject = {
 			type: "integer",
 		},
 		country_code: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		counts_by_year: refSchema({ countsByYear }),
 		created_date: {
@@ -50,10 +50,10 @@ export const institutionSchema: SchemaObject = {
 		},
 		ids: refSchema({ ids }),
 		image_thumbnail_url: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		image_url: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		international: refSchema({ international_display_name }),
 		lineage: {

src/spec/components/schemas/institutions/international_display_name.ts

@@ -12,7 +12,7 @@ export const international_description = {
 	properties: {
 		description: refSchema({ internationalisation })
 	},
-	type: ["object", "null"],
+	type: "object",
 } satisfies SchemaObject;
 
 export const international_display_name_and_description = {

src/spec/components/schemas/publishers/publisherSchema.ts

@@ -33,17 +33,17 @@ export const publisherSchema = {
 			type: "integer",
 		},
 		homepage_url: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		id: {
 			type: "string",
 		},
 		ids: refSchema({ ids }),
 		image_thumbnail_url: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		image_url: {
-			type: ["string", "null"]
+			type: "string"
 		},
 		lineage: {
 			items: {
@@ -52,7 +52,7 @@ export const publisherSchema = {
 			type: "array",
 		},
 		parent_publisher: {
-			type: ["object", "null"],
+			type: "object",
 			properties: {
 				display_name: {
 					type: "string",

src/spec/components/schemas/sources/apc_prices.ts

@@ -1,6 +1,6 @@
 export const apc_prices: SchemaObject = {
 	additionalProperties: false,
-	type: ["array", "null"],
+	type: "array",
 	items: {
 		additionalProperties: false,
 		properties: {