Skip to content

feat(env): add comments and sections to env without reading values #83

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
agentHits merged 1 commit into from
Oct 25, 2026
Merged

feat(env): add comments and sections to env without reading values #83

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
53 changes: 50 additions & 3 deletions apps/dokploy/__test__/api/openapi-document.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,36 @@ describe("OpenAPI document", () => {
);
});

it("serves blind env management at GET /env.keys and POST /env.apply", () => {
it("serves blind env management at GET /env.keys, GET /env.layout and POST /env.apply", () => {
const paths = generate().paths ?? {};
const keys = paths["/env.keys"]?.get as
| { operationId?: string; parameters?: { name: string; in: string }[] }
| undefined;
const layout = paths["/env.layout"]?.get as
| { operationId?: string; parameters?: { name: string; in: string }[] }
| undefined;
const apply = paths["/env.apply"]?.post as
| { operationId?: string; requestBody?: unknown }
| undefined;

expect(
Object.keys(paths).filter((path) => path.startsWith("/env.")),
).toEqual(["/env.keys", "/env.apply"]);
).toEqual(["/env.keys", "/env.layout", "/env.apply"]);
expect(Object.keys(paths["/env.keys"] ?? {})).toEqual(["get"]);
expect(Object.keys(paths["/env.layout"] ?? {})).toEqual(["get"]);
expect(Object.keys(paths["/env.apply"] ?? {})).toEqual(["post"]);
expect(keys?.operationId).toBe("env-keys");
expect(keys?.parameters).toEqual([
expect.objectContaining({ name: "scope", in: "query", required: true }),
expect.objectContaining({ name: "id", in: "query", required: true }),
expect.objectContaining({ name: "field", in: "query" }),
]);
expect(layout?.operationId).toBe("env-layout");
expect(layout?.parameters?.map(({ name }) => name)).toEqual([
"scope",
"id",
"field",
]);
expect(apply?.operationId).toBe("env-apply");
expect(
Object.keys(
Expand All @@ -63,6 +73,7 @@ describe("OpenAPI document", () => {
"remove",
"generate",
"copy",
"layout",
"dryRun",
"expectedRevision",
]);
Expand Down Expand Up @@ -95,7 +106,23 @@ describe("OpenAPI document", () => {
}
).responses[200].content["application/json"].schema;
const keys = responseSchema(paths["/env.keys"]?.get);
const layout = responseSchema(paths["/env.layout"]?.get);
const apply = responseSchema(paths["/env.apply"]?.post);
const layoutItems = (schema: unknown) =>
(
schema as {
properties: {
layout: {
items: {
oneOf: {
properties: object;
additionalProperties: boolean;
}[];
};
};
};
}
).properties.layout.items.oneOf;

expect(Object.keys(keys.properties)).toEqual([
"scope",
Expand All @@ -117,14 +144,34 @@ describe("OpenAPI document", () => {
"revision",
"dryRun",
"variables",
"layout",
]);
expect(Object.keys(layout.properties)).toEqual([
"scope",
"id",
"field",
"revision",
"variables",
"layout",
]);
for (const items of [layoutItems(layout), layoutItems(apply)]) {
expect(items.map(({ properties }) => Object.keys(properties))).toEqual([
["type", "name"],
["type", "ref", "text"],
["type", "ref", "kind", "variable"],
["type"],
]);
for (const item of items) {
expect(item.additionalProperties).toBe(false);
}
}
expect(Object.keys(apply.properties.variables.items.properties)).toEqual([
"name",
"action",
"source",
"secret",
]);
for (const schema of [keys, apply]) {
for (const schema of [keys, layout, apply]) {
expect(schema.additionalProperties).toBe(false);
expect(schema.properties.variables.items.additionalProperties).toBe(
false,
Expand Down
Loading