Skip to content

@W-18575180@ Oas support Followup #230

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
vcua-mobify merged 2 commits into from
Jun 2, 2025
Merged

@W-18575180@ Oas support Followup #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c040f3
Remove duplicate config file
vcua-mobify Jun 2, 2025
103df5d
Add type to define the contents of exchange.json
vcua-mobify Jun 2, 2025
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
2 changes: 0 additions & 2 deletions config.yaml
View file
Open in desktop
Copy link
Contributor Author

@vcua-mobify vcua-mobify Jun 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a duplicate that isn't used. The config file we use is located in resources/generate-from-oas/config.yaml

This file was deleted.

19 changes: 19 additions & 0 deletions src/download/exchangeTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,22 @@ export type RawRestApi = Omit<RestApi, "categories" | "fatRaml"> & {
version: string;
}[];
};

export type ExchangeConfig = {
dependencies?: {
version: string;
assetId: string;
groupId: string;
}[];
version: string;
originalFormatVersion: string;
apiVersion: string;
descriptorVersion: string;
classifier: string;
main: string;
assetId: string;
groupId: string;
organizationId: string;
name: string;
tags: string[];
};
2 changes: 1 addition & 1 deletion src/download/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ export { extractFiles } from "./exchangeDirectoryParser";
export { groupByCategory, removeRamlLinks } from "./exchangeTools";
export { DownloadCommand } from "./downloadCommand";
export { getBearer } from "./bearerToken";
export { RestApi } from "./exchangeTypes";
export { RestApi, ExchangeConfig } from "./exchangeTypes";
4 changes: 2 additions & 2 deletions src/generate/apiModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
} from "../common/amfParser";

import { Name } from "../common/structures/name";
import { RestApi } from "../download/exchangeTypes";
import { ExchangeConfig, RestApi } from "../download/exchangeTypes";
import path from "path";
import fs from "fs-extra";
import { ramlToolLogger } from "../common/logger";
Expand Down Expand Up @@ -56,7 +56,7 @@ export class ApiModel extends ApiMetadata {
fs.lstatSync(filepath).isDirectory() &&
fs.existsSync(path.join(filepath, "exchange.json"))
) {
const exchangeConfig = fs.readJSONSync(
const exchangeConfig: ExchangeConfig = fs.readJSONSync(
Copy link
Contributor Author

@vcua-mobify vcua-mobify Jun 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line isn't necessary but I figure that since we've defined ExchangeConfig, we might as well use it in the one place we were reading the exchange.json before.

path.join(filepath, "exchange.json")
);

Expand Down