kubernetes-sigs / kube-scheduler-simulator

The simulator for the Kubernetes scheduler
Apache License 2.0
795 stars 135 forks source link

Fix 404 errors in API reference #380

Closed Okabe-Junya closed 1 month ago

Okabe-Junya commented 1 month ago

What type of PR is this?

/area simulator /kind documentation

What this PR does / why we need it:

ResourcesForImport no longer exists. The current import of Config is performed by ResourcesForLoad, so these link should be updated

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

/label tide/merge-method-squash

Okabe-Junya commented 1 month ago

/assign sanposhiho for approval

Okabe-Junya commented 1 month ago

It seems that in the frontend components, it is being referenced under the name ResourcesForImport. It's not a major issue, but it would be a good idea to replace these as well.

$ grep -RIn "ResourcesForImport"
./web/components/TopBar/ImportButton.vue:53:import { ResourcesForImport } from "~/api/v1/export";
./web/components/TopBar/ImportButton.vue:60:  filedata: ResourcesForImport;
./web/components/TopBar/ImportButton.vue:87:        data.filedata = {} as ResourcesForImport;
./web/components/TopBar/ImportButton.vue:94:        .importScheduler(data.filedata as ResourcesForImport)
./web/components/TopBar/ImportButton.vue:107:          const filedata = <ResourcesForImport>yaml.load(
./web/api/v1/export.ts:13:      const res = await instance.get<ResourcesForImport>(`/export`, {});
./web/api/v1/export.ts:17:    importScheduler: async (data: ResourcesForImport) => {
./web/api/v1/export.ts:19:        const res = await instance.post<ResourcesForImport>(`/import`, data);
./web/api/v1/export.ts:28:export declare class ResourcesForImport {
sanposhiho commented 1 month ago

/lgtm /approve

k8s-ci-robot commented 1 month ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Okabe-Junya, sanposhiho

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubernetes-sigs/kube-scheduler-simulator/blob/master/OWNERS)~~ [sanposhiho] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment