Skip to content

Commit

Permalink
docs: API docs pretty url
Browse files Browse the repository at this point in the history
  • Loading branch information
@arildm
arildm committed Sep 24, 2024
1 parent e26cc27 commit 5a35b87
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/ARCHITECTURE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The Mink system consists of these pieces of software:
- **[Mink backend](https://github.com/spraakbanken/mink-backend)** runs on a server where it manages stored data and executes data processing operations
- **[Sparv](https://github.com/spraakbanken/sparv-pipeline)** is the NLP pipeline used for text analysis, operated by the Mink backend. (Sparv lives independently from Mink, but it is listed here because it is essential to Mink.)

The frontend communicates with the backend using the [Mink API](https://ws.spraakbanken.gu.se/ws/mink/api-doc). The API can also be used directly from command-line or scripts.
The frontend communicates with the backend using the [Mink API](https://ws.spraakbanken.gu.se/docs/mink). The API can also be used directly from command-line or scripts.

The Mink system is connected to these other systems:

Expand Down
50 changes: 25 additions & 25 deletions src/api/api.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,20 +57,20 @@ class MinkApi {
this.axios.defaults.headers["Authorization"] = jwt ? `Bearer ${jwt}` : null;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Documentation/operation/APIinfo */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Documentation/operation/APIinfo */
async getInfo() {
const response = await this.axios.get<MinkResponse<InfoData>>("info");
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Corpora/operation/listcorpora */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Corpora/operation/listcorpora */
async listCorpora() {
const response =
await this.axios.get<MinkResponse<ListCorporaData>>("list-corpora");
return response.data.corpora;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Corpora/operation/createcorpus */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Corpora/operation/createcorpus */
async createCorpus() {
const response =
await this.axios.post<MinkResponse<CreateCorpusData>>("create-corpus");
Expand All @@ -86,23 +86,23 @@ class MinkApi {
return response.data.resource_id;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Corpora/operation/removecorpus */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Corpora/operation/removecorpus */
async removeCorpus(corpusId: string) {
const response = await this.axios.delete<MinkResponse>("remove-corpus", {
params: { corpus_id: corpusId },
});
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Metadata/operation/removemetadata */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Metadata/operation/removemetadata */
async removeMetadata(resourceId: string) {
const response = await this.axios.delete<MinkResponse>("remove-metadata", {
params: { corpus_id: resourceId },
});
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Config/operation/uploadconfig */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Config/operation/uploadconfig */
async uploadConfig(corpusId: string, config: string) {
const formData = filesFormData(yamlAsFile("config.yaml", config));
const response = await this.axios.put<MinkResponse>(
Expand All @@ -113,7 +113,7 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Sources/operation/downloadsources */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Sources/operation/downloadsources */
async downloadSources<B extends boolean>(
corpusId: string,
filename: string,
Expand All @@ -128,15 +128,15 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Exports/operation/downloadsourcetext */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Exports/operation/downloadsourcetext */
async downloadSourceText(corpusId: string, filename: string) {
const response = await this.axios.get<string>("download-source-text", {
params: { corpus_id: corpusId, file: filename },
});
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Sources/operation/uploadsources */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Sources/operation/uploadsources */
async uploadSources(
corpusId: string,
files: File[],
Expand All @@ -154,23 +154,23 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Sources/operation/removesources */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Sources/operation/removesources */
async removeSource(corpusId: string, name: string) {
const response = await this.axios.delete<MinkResponse>("remove-sources", {
params: { corpus_id: corpusId, remove: name },
});
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Config/operation/downloadconfig */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Config/operation/downloadconfig */
async downloadConfig(corpusId: string) {
const response = await this.axios.get<string>("download-config", {
params: { corpus_id: corpusId },
});
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Metadata/operation/uploadmetadatayaml */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Metadata/operation/uploadmetadatayaml */
async uploadMetadataYaml(resourceId: string, yaml: string) {
const formData = filesFormData(yamlAsFile("metadata.yaml", yaml));
const response = await this.axios.put<MinkResponse>(
Expand All @@ -181,22 +181,22 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Metadata/operation/downloadmetadatayaml */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Metadata/operation/downloadmetadatayaml */
async downloadMetaataYaml(resourceId: string) {
const response = await this.axios.get<string>("download-metadata-yaml", {
params: { corpus_id: resourceId },
});
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Process-Corpus/operation/resourceinfo */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Process-Corpus/operation/resourceinfo */
async resourceInfoAll() {
const response =
await this.axios.get<MinkResponse<ResourceInfoAllData>>("resource-info");
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Process-Corpus/operation/resourceinfo */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Process-Corpus/operation/resourceinfo */
async resourceInfoOne(corpusId: string) {
const response = await this.axios.get<MinkResponse<ResourceInfoOneData>>(
"resource-info",
Expand All @@ -205,7 +205,7 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Process-Corpus/operation/runSparv */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Process-Corpus/operation/runSparv */
async runSparv(corpusId: string) {
const response = await this.axios
.put<MinkResponse<ResourceInfoOneData>>("run-sparv", null, {
Expand All @@ -217,7 +217,7 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Process-Corpus/operation/abortjob */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Process-Corpus/operation/abortjob */
async abortJob(corpusId: string) {
const response = await this.axios.post<MinkResponse<JobStateMap>>(
"abort-job",
Expand All @@ -227,7 +227,7 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Exports/operation/listexports */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Exports/operation/listexports */
async listExports(corpusId: string) {
const response = await this.axios.get<MinkResponse<ListExportsData>>(
"list-exports",
Expand All @@ -236,7 +236,7 @@ class MinkApi {
return response.data.contents;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Exports/operation/downloadexports */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Exports/operation/downloadexports */
async downloadExports(corpusId: string) {
const response = await this.axios
.get<Blob>("download-exports", {
Expand All @@ -247,7 +247,7 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Manage-Exports/operation/downloadexports */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Manage-Exports/operation/downloadexports */
async downloadExportFile(corpusId: string, path: string) {
const response = await this.axios
.get<Blob>("download-exports", {
Expand All @@ -258,7 +258,7 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Process-Corpus/operation/installinKorp */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Process-Corpus/operation/installinKorp */
async installKorp(corpusId: string) {
const response = await this.axios.put<MinkResponse<ResourceInfoOneData>>(
"install-korp",
Expand All @@ -268,7 +268,7 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Process-Corpus/operation/installinStrix */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Process-Corpus/operation/installinStrix */
async installStrix(corpusId: string) {
const response = await this.axios.put<MinkResponse<ResourceInfoOneData>>(
"install-strix",
Expand All @@ -278,7 +278,7 @@ class MinkApi {
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Admin-Mode/operation/adminmodestatus */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Admin-Mode/operation/adminmodestatus */
async adminModeStatus() {
const response =
await this.axios.get<MinkResponse<AdminModeStatusData>>(
Expand All @@ -287,13 +287,13 @@ class MinkApi {
return response.data.admin_mode_status;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Admin-Mode/operation/adminmodeon */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Admin-Mode/operation/adminmodeon */
async adminModeOn() {
const response = await this.axios.post<MinkResponse>("admin-mode-on");
return response.data;
}

/** @see https://ws.spraakbanken.gu.se/ws/mink/api-doc#tag/Admin-Mode/operation/adminmodeoff */
/** @see https://ws.spraakbanken.gu.se/docs/mink#tag/Admin-Mode/operation/adminmodeoff */
async adminModeOff() {
const response = await this.axios.post<MinkResponse>("admin-mode-off");
return response.data;
Expand Down

0 comments on commit 5a35b87

Please sign in to comment.