serverless-openapi-documenter 0.0.124-beta.1 → 0.1.0

package/test.js

@@ -1,204 +0,0 @@
-const $RefParser = require("@apidevtools/json-schema-ref-parser");
-
-const schema = {
-  $id: "http://schemas.aat.org.uk/build/ProgrammeRegistration.json",
-  $schema: "http://json-schema.org/draft-04/schema#",
-  title: "ProgrammeRegistration",
-  description: "Programme registration schema",
-  required: ["programmeRegistrationDetail"],
-  additionalProperties: false,
-  type: "object",
-  properties: {
-    programmeRegistrationDetail: {
-      $ref: "#/definitions/ProgrammeRegistrationType",
-    },
-    programmeRegistrationQuestionResponse: {
-      anyOf: [
-        { type: "null" },
-        {
-          type: "object",
-          additionalProperties: false,
-          properties: {
-            questions: {
-              type: "array",
-              items: { $ref: "#/definitions/QuestionResponse" },
-              minItems: 1,
-              maxItems: 30,
-              uniqueItems: true,
-            },
-          },
-        },
-      ],
-    },
-    autoOrderCreate: {
-      anyOf: [{ type: "boolean", default: false }, { type: "null" }],
-    },
-  },
-  version: "1.1.1",
-  definitions: {
-    ProgrammeRegistrationType: {
-      title: "ProgrammeRegistrationType",
-      description: "programme registration type",
-      type: "object",
-      additionalProperties: false,
-      required: [
-        "programmeRegistrationId",
-        "contactId",
-        "trainingProviderOrganisationId",
-        "qualificationId",
-        "startingLevel",
-      ],
-      properties: {
-        programmeRegistrationId: { $ref: "#/definitions/UUID" },
-        programmeRegistrationCRMId: { $ref: "#/definitions/UUID" },
-        contactId: { $ref: "#/definitions/UUID" },
-        trainingProviderOrganisationId: { $ref: "#/definitions/UUID" },
-        qualificationId: { $ref: "#/definitions/UUID" },
-        qualificationLocalCode: {
-          anyOf: [{ type: "null" }, { type: "string" }],
-        },
-        startingLevel: { $ref: "#/definitions/UUID" },
-        expectedEndLevel: {
-          anyOf: [{ $ref: "#/definitions/UUID" }, { type: "null" }],
-        },
-        currentLevel: {
-          anyOf: [{ $ref: "#/definitions/UUID" }, { type: "null" }],
-        },
-        registrationDate: {
-          anyOf: [{ $ref: "#/definitions/AATDate" }, { type: "null" }],
-        },
-        fundingType: {
-          anyOf: [
-            { type: "null" },
-            { $ref: "#/definitions/ProgrammeRegistrationFundingType" },
-          ],
-        },
-        endDate: {
-          anyOf: [{ type: "null" }, { $ref: "#/definitions/AATDate" }],
-        },
-        fundingTypeMembershipFees: {
-          anyOf: [
-            { type: "null" },
-            { $ref: "#/definitions/ProgrammeRegistrationFundingType" },
-          ],
-        },
-        apprenticeship: { type: "boolean", default: false },
-        apprenticeshipStartDate: {
-          anyOf: [{ $ref: "#/definitions/AATDate" }, { type: "null" }],
-        },
-        fullTime: { type: "boolean", default: false },
-        distanceLearning: { type: "boolean", default: false },
-        payingOrganisationId: {
-          anyOf: [{ $ref: "#/definitions/UUID" }, { type: "null" }],
-        },
-        employmentId: {
-          anyOf: [{ $ref: "#/definitions/UUID" }, { type: "null" }],
-        },
-        poNumber: {
-          anyOf: [{ type: "string", maxLength: 50 }, { type: "null" }],
-        },
-        poRequester: {
-          anyOf: [{ type: "string", maxLength: 50 }, { type: "null" }],
-        },
-        assessmentPoNumber: {
-          anyOf: [{ type: "string", maxLength: 50 }, { type: "null" }],
-        },
-        smartEPAId: {
-          anyOf: [{ $ref: "#/definitions/UUID" }, { type: "null" }],
-        },
-        autoOrderCreate: {
-          anyOf: [{ type: "boolean", default: false }, { type: "null" }],
-        },
-        membershipApplicationId: {
-          anyOf: [{ $ref: "#/definitions/UUID" }, { type: "null" }],
-        },
-        gatewayDate: {
-          anyOf: [{ $ref: "#/definitions/AATDate" }, { type: "null" }],
-        },
-        registrationStatus: {
-          anyOf: [{ type: "null" }, { type: "string" }],
-        },
-        registrationStatusDate: {
-          anyOf: [{ $ref: "#/definitions/AATDate" }, { type: "null" }],
-        },
-        givenName: { anyOf: [{ type: "null" }, { type: "string" }] },
-        familyName: { anyOf: [{ type: "null" }, { type: "string" }] },
-        memberId: { anyOf: [{ type: "null" }, { type: "string" }] },
-        birthDate: {
-          anyOf: [{ $ref: "#/definitions/AATDate" }, { type: "null" }],
-        },
-        epaRegisteredOn: {
-          anyOf: [
-            { type: "null" },
-            {
-              type: "boolean",
-              description:
-                "Indicates the user is studying the associated apprenticeship",
-            },
-          ],
-        },
-      },
-    },
-    QuestionResponse: {
-      title: "QuestionResponse",
-      description: "response to a question",
-      type: "object",
-      additionalProperties: false,
-      required: ["questionId", "responseId", "response"],
-      properties: {
-        responseId: { $ref: "#/definitions/UUID" },
-        questionId: { $ref: "#/definitions/UUID" },
-        response: {
-          type: "object",
-          anyOf: [
-            { text: { type: "string" } },
-            { multiLineText: { type: "string" } },
-            { currency: { type: "number" } },
-            { date: { $ref: "#/source/base/AATDate.json" } },
-            { decimal: { type: "number" } },
-            { optionSet: { type: "string" } },
-            { wholeNumber: { type: "integer" } },
-          ],
-        },
-      },
-    },
-    UUID: {
-      title: "UUID",
-      description: "Universally Unique Identifier (all lowercase)",
-      type: "string",
-      pattern: "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
-    },
-    AATDate: {
-      title: "AATDate",
-      description: "AAT Date formatted",
-      type: "string",
-      examples: ["2014-07-17T10:02:21Z"],
-    },
-    ProgrammeRegistrationFundingType: {
-      title: "ProgrammeRegistrationFundingType",
-      description: "funding types for programme registrations",
-      type: "string",
-      enum: [
-        "Employer",
-        "Student",
-        "Training Provider",
-        "AAT(SA)",
-        "AAT NZICA",
-        "Unknown",
-        "Government",
-      ],
-    },
-  },
-};
-
-const main = async () => {
-  let deReferencedSchema = await $RefParser
-    .dereference("schemas.aat.org.uk/build/ProgrammeRegistration.json")
-    .catch((err) => {
-      throw err;
-    });
-
-  console.log(deReferencedSchema);
-};
-
-main().catch((err) => console.error(err));

package/test2.js

@@ -1,146 +0,0 @@
-const $RefParser = require("@apidevtools/json-schema-ref-parser");
-
-const schema = {
-  $id: "http://schemas.aat.org.uk/build/TrainingProviderApprovalDetail.json",
-  $schema: "http://json-schema.org/draft-04/schema#",
-  title: "TrainingProviderApprovalDetail",
-  description: "Training Provider Approval",
-  required: ["approval"],
-  additionalProperties: false,
-  type: "object",
-  properties: {
-    abc: { type: "string" },
-    // approval: { $ref: "#/definitions/TrainingProviderApproval" },
-    // approvalQuestionResponse: {
-    //   anyOf: [
-    //     {
-    //       type: "object",
-    //       properties: {
-    //         questions: {
-    //           type: "array",
-    //           items: { $ref: "#/definitions/QuestionResponse" },
-    //           minItems: 1,
-    //           maxItems: 30,
-    //           uniqueItems: true,
-    //         },
-    //       },
-    //     },
-    //     { type: "null" },
-    //   ],
-    // },
-  },
-  version: "1.1.1",
-  definitions: {
-    // TrainingProviderApproval: {
-    //   title: "TrainingProviderApproval",
-    //   description: "Training Provider Approval",
-    //   required: [
-    //     "TPapprovalId",
-    //     "approvalCRMId",
-    //     "qualificationId",
-    //     "status",
-    //     "qualificationName",
-    //     "organisationId",
-    //   ],
-    //   additionalProperties: false,
-    //   type: "object",
-    //   properties: {
-    //     TPapprovalId: { $ref: "#/definitions/UUID" },
-    //     TPapprovalCRMId: {
-    //       anyOf: [{ $ref: "#/definitions/UUID" }, { type: "null" }],
-    //     },
-    //     approvalCRMId: { $ref: "#/definitions/UUID" },
-    //     organisationId: { $ref: "#/definitions/UUID" },
-    //     qualificationName: { type: "string", maxLength: 100 },
-    //     qualificationShortName: {
-    //       anyOf: [{ type: "string", maxLength: 100 }, { type: "null" }],
-    //     },
-    //     localCode: {
-    //       anyOf: [{ type: "string", maxLength: 20 }, { type: "null" }],
-    //     },
-    //     aatId: { anyOf: [{ type: "number" }, { type: "null" }] },
-    //     qualificationId: { $ref: "#/definitions/UUID" },
-    //     status: {
-    //       type: "string",
-    //       enum: [
-    //         "Sales Prospect",
-    //         "EOI Sent",
-    //         "EOI Received",
-    //         "EOI More Information Requested",
-    //         "EOI Declined",
-    //         "EOI Closed",
-    //         "Application On Hold By TP",
-    //         "Application Pack Sent",
-    //         "Application Pending",
-    //         "Approval Visit Scheduled",
-    //         "Approval Visit Action Plan",
-    //         "Application Closed",
-    //         "Application Withdrawn",
-    //         "Approved",
-    //         "Conditionally Approved",
-    //         "Referred to Conduct & Compliance",
-    //         "Rejected",
-    //         "Inactive",
-    //         "Withdrawn",
-    //       ],
-    //     },
-    //     statusDate: {
-    //       anyOf: [{ $ref: "#/definitions/AATDate" }, { type: "null" }],
-    //     },
-    //     fromDate: {
-    //       anyOf: [{ $ref: "#/definitions/AATDate" }, { type: "null" }],
-    //     },
-    //     untilDate: {
-    //       anyOf: [{ $ref: "#/definitions/AATDate" }, { type: "null" }],
-    //     },
-    //   },
-    // },
-    QuestionResponse: {
-      title: "QuestionResponse",
-      description: "response to a question",
-      type: "object",
-      additionalProperties: false,
-      required: ["questionId", "responseId", "response"],
-      properties: {
-        responseId: { $ref: "#/definitions/UUID" },
-        questionId: { $ref: "#/definitions/UUID" },
-        response: {
-          type: "object",
-          anyOf: [
-            { text: { type: "string" } },
-            { multiLineText: { type: "string" } },
-            { currency: { type: "number" } },
-            { date: { $ref: "#/source/base/AATDate.json" } },
-            { decimal: { type: "number" } },
-            { optionSet: { type: "string" } },
-            { wholeNumber: { type: "integer" } },
-          ],
-        },
-      },
-    },
-    UUID: {
-      title: "UUID",
-      description: "Universally Unique Identifier (all lowercase)",
-      type: "string",
-      pattern: "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
-    },
-    AATDate: {
-      title: "AATDate",
-      description: "AAT Date formatted",
-      type: "string",
-      examples: ["2014-07-17T10:02:21Z"],
-    },
-  },
-};
-
-const schema2 = { type: "object", properties: { a: { type: "string" } } };
-
-const main = async () => {
-  const bundledSchema = await $RefParser.bundle(schema).catch((err) => {
-    throw err;
-  });
-
-  console.log(bundledSchema);
-};
-
-main().catch((err) => console.error(err));

package/test3.js

@@ -1,29 +0,0 @@
-const {
-  Config,
-  lintFromString,
-  stringifyYaml,
-  createConfig,
-} = require("@redocly/openapi-core");
-
-const openAPI = require("./openapi.json");
-
-const main = async () => {
-  const config = await createConfig({
-    apis: {},
-    rules: this.REDOCLY_RULES,
-  });
-
-  const apiDesc = stringifyYaml(openAPI);
-
-  const output = await lintFromString({
-    source: apiDesc,
-    config: config,
-  }).catch((err) => {
-    console.error(err);
-    throw err;
-  });
-
-  console.log(output);
-};
-
-main().catch((err) => console.error(err));