Skip to content

feat: add OpenAPI mapping validation and schema support #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ndenny merged 1 commit into from
Mar 13, 2026
Merged

feat: add OpenAPI mapping validation and schema support #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Mode rules:

- `openapi_file` is exclusive with `file` and `template`.
- `openapi_mapping_file` and `base_project_file` require `openapi_file`.
- `openapi_mapping_file` is validated against [src/openapi-mapping.schema.json](src/openapi-mapping.schema.json).

## Usage

Expand Down Expand Up @@ -85,6 +86,8 @@ Mode rules:
### OpenAPI mapping file example

```yaml
# yaml-language-server: $schema=../src/openapi-mapping.schema.json

server_url: https://api.example.com/v1

include:
Expand All @@ -111,6 +114,11 @@ workflow:
name: OpenAPI Sync Workflow
```

### Mapping validation

- The action validates `openapi_mapping_file` before OpenAPI transformation.
- Validation uses [src/openapi-mapping.schema.json](src/openapi-mapping.schema.json) and fails fast with JSON pointer paths in error output.

### Dry-run OpenAPI sync and save generated payload

```yaml
Expand Down
2 changes: 2 additions & 0 deletions api/apim-mapping.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=../src/openapi-mapping.schema.json

server_url: https://api.example.com/v1

default_tags:
Expand Down
51 changes: 51 additions & 0 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,26 @@ function buildProjectFromOpenApi(openapiDoc, mappingDoc, options = {}) {
throw new Error("OpenAPI mapping document must be an object.");
}

if (mappingDoc && mappingDoc.include !== undefined && !Array.isArray(mappingDoc.include)) {
throw new Error("OpenAPI mapping include must be an array when provided.");
}

if (mappingDoc && mappingDoc.exclude !== undefined && !Array.isArray(mappingDoc.exclude)) {
throw new Error("OpenAPI mapping exclude must be an array when provided.");
}

if (mappingDoc && mappingDoc.operations !== undefined && !Array.isArray(mappingDoc.operations)) {
throw new Error("OpenAPI mapping operations must be an array when provided.");
}

if (
mappingDoc &&
mappingDoc.defaults !== undefined &&
(!mappingDoc.defaults || typeof mappingDoc.defaults !== "object" || Array.isArray(mappingDoc.defaults))
) {
throw new Error("OpenAPI mapping defaults must be an object when provided.");
}

const generatedTag = options.generatedTag || "openapi-sync";
const cleanupGenerated = options.cleanupGenerated !== false;
const baseProjectDocument = normalizeBaseProject(options.baseProjectDocument);
Expand Down Expand Up @@ -714,6 +734,13 @@ function summarizeDocument(document) {

module.exports = { parseBoolean, summarizeDocument };

/***/ }),

/***/ 669:
/***/ ((module) => {

module.exports = JSON.parse('{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://apimetrics.io/schemas/openapi-mapping.schema.json","title":"APIm OpenAPI Mapping","type":"object","additionalProperties":false,"properties":{"server_url":{"type":"string","minLength":1},"default_tags":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"$ref":"#/definitions/selector"}},"exclude":{"type":"array","items":{"$ref":"#/definitions/selector"}},"defaults":{"type":"object","additionalProperties":false,"properties":{"headers":{"type":"object","additionalProperties":{}},"query":{"type":"object","additionalProperties":{}},"path":{"type":"object","additionalProperties":{}},"body":{}}},"operations":{"type":"array","items":{"$ref":"#/definitions/operationOverride"}},"workflow":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"stop_on_failure":{"type":"boolean"}}}},"definitions":{"selector":{"oneOf":[{"type":"string","minLength":1},{"type":"object","additionalProperties":false,"properties":{"operationId":{"type":"string","minLength":1},"method":{"type":"string","minLength":1},"path":{"type":"string","minLength":1}},"anyOf":[{"required":["operationId"]},{"required":["method"]},{"required":["path"]}]}]},"operationOverride":{"type":"object","additionalProperties":false,"properties":{"operationId":{"type":"string","minLength":1},"method":{"type":"string","minLength":1},"path":{"type":"string","minLength":1},"include":{"type":"boolean"},"id":{"type":"string","minLength":1},"call_id":{"type":"string","minLength":1},"name":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"call":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"description":{"type":"string"}}},"request":{"type":"object","additionalProperties":false,"properties":{"method":{"type":"string","minLength":1},"headers":{"type":"object","additionalProperties":{}},"parameters":{"type":"object","additionalProperties":{}},"path":{"type":"object","additionalProperties":{}},"body":{},"auth_id":{},"token_id":{}}}},"anyOf":[{"required":["operationId"]},{"required":["method"]},{"required":["path"]}]}}}');

/***/ })

/******/ });
Expand Down Expand Up @@ -766,6 +793,7 @@ const os = __nccwpck_require__(37);
const { execFile } = __nccwpck_require__(81);
const { promisify } = __nccwpck_require__(837);
const { buildProjectFromOpenApi } = __nccwpck_require__(465);
const openApiMappingSchema = __nccwpck_require__(669);
const { parseBoolean, summarizeDocument } = __nccwpck_require__(880);

const execFileAsync = promisify(execFile);
Expand All @@ -790,6 +818,7 @@ function fileExists(filePath) {

const moduleCache = new Map();
let moduleBaseDir = "";
let validateOpenApiMappingDocumentFn = null;

async function ensureModule(moduleName, version) {
if (moduleCache.has(moduleName)) {
Expand Down Expand Up @@ -929,6 +958,27 @@ async function validateSchema(document, schemaUrl) {
}
}

async function validateOpenApiMapping(document) {
const Ajv = await ensureModule("ajv", "8.12.0");
const addFormats = await ensureModule("ajv-formats", "2.1.1");

if (!validateOpenApiMappingDocumentFn) {
const ajv = new Ajv({ allErrors: true, strict: false });
addFormats(ajv);
validateOpenApiMappingDocumentFn = ajv.compile(openApiMappingSchema);
}

const valid = validateOpenApiMappingDocumentFn(document);
if (!valid) {
const details = (validateOpenApiMappingDocumentFn.errors || [])
.map((error) => `${error.instancePath || "/"} ${error.message}`.trim())
.slice(0, 25)
.join("\n");

throw new Error(`OpenAPI mapping validation failed:\n${details}`);
}
}

function sanitizeSchemaIds(node, isRoot) {
if (!node || typeof node !== "object") return;

Expand Down Expand Up @@ -1019,6 +1069,7 @@ async function run() {
if (openApiMode) {
const openApiDoc = await loadDocumentFromFile(openapiFile);
const mappingDoc = openapiMappingFile ? await loadDocumentFromFile(openapiMappingFile) : {};
await validateOpenApiMapping(mappingDoc);
const baseDoc = baseProjectFile ? await loadDocumentFromFile(baseProjectFile) : null;
const transformed = buildProjectFromOpenApi(openApiDoc, mappingDoc, {
baseProjectDocument: baseDoc,
Expand Down
24 changes: 24 additions & 0 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const os = require("os");
const { execFile } = require("child_process");
const { promisify } = require("util");
const { buildProjectFromOpenApi } = require("./openapi");
const openApiMappingSchema = require("./openapi-mapping.schema.json");
const { parseBoolean, summarizeDocument } = require("./utils");

const execFileAsync = promisify(execFile);
Expand All @@ -31,6 +32,7 @@ function fileExists(filePath) {

const moduleCache = new Map();
let moduleBaseDir = "";
let validateOpenApiMappingDocumentFn = null;

async function ensureModule(moduleName, version) {
if (moduleCache.has(moduleName)) {
Expand Down Expand Up @@ -170,6 +172,27 @@ async function validateSchema(document, schemaUrl) {
}
}

async function validateOpenApiMapping(document) {
const Ajv = await ensureModule("ajv", "8.12.0");
const addFormats = await ensureModule("ajv-formats", "2.1.1");

if (!validateOpenApiMappingDocumentFn) {
const ajv = new Ajv({ allErrors: true, strict: false });
addFormats(ajv);
validateOpenApiMappingDocumentFn = ajv.compile(openApiMappingSchema);
}

const valid = validateOpenApiMappingDocumentFn(document);
if (!valid) {
const details = (validateOpenApiMappingDocumentFn.errors || [])
.map((error) => `${error.instancePath || "/"} ${error.message}`.trim())
.slice(0, 25)
.join("\n");

throw new Error(`OpenAPI mapping validation failed:\n${details}`);
}
}

function sanitizeSchemaIds(node, isRoot) {
if (!node || typeof node !== "object") return;

Expand Down Expand Up @@ -260,6 +283,7 @@ async function run() {
if (openApiMode) {
const openApiDoc = await loadDocumentFromFile(openapiFile);
const mappingDoc = openapiMappingFile ? await loadDocumentFromFile(openapiMappingFile) : {};
await validateOpenApiMapping(mappingDoc);
const baseDoc = baseProjectFile ? await loadDocumentFromFile(baseProjectFile) : null;
const transformed = buildProjectFromOpenApi(openApiDoc, mappingDoc, {
baseProjectDocument: baseDoc,
Expand Down
Loading
Loading