ctan-openapi-fetch
Version:
A thin wrapper around `openapi-fetch` for use with the CTAN API
124 lines (122 loc) • 5.29 kB
TypeScript
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/search/json": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Searching
* @description The search functionality can be used programmatically.
*/
get: {
parameters: {
query: {
/** @description The search phrase, i.e. the words or search expressions to query for. */
phrase: string;
/** @description The offset for paging. The accompanying parameter `max` contains the page size. This parameter contains the first hit to be returned. If a negative number is passed in then it is replaced by `0`. If the offset is larger than the number of actual hits then the list of hits will be empty. */
offset?: number;
/** @description The number of hits maximally returned. Larger values will be reduced to `256`. Lower values will be replaced by the default value. */
max?: number;
/** @description Whether the sections are requested explicitly. If the value is `false` then all default sections are searched. Otherwise the sections to be searched have to be specified with additional parameters. */
ext?: boolean;
/** @description Whether the package section should be included into the search. The package section contains the text fields of a package entry in the Catalogue. */
PKG?: boolean;
/** @description Whether the author section should be included into the search. The author section contains the names of the contributors in the Catalogue. */
AUTHORS?: boolean;
/** @description Whether the topics section should be included into the search. The topics section contains the text fields of the topics in the Catalogue. */
TOPICS?: boolean;
/** @description UNDOCUMENTED.
*
* Whether the file name in TeX archive should be included into the search. */
FILES?: boolean;
/** @description Whether the portal section should be included into the search. The portal section contains the text of the portal pages. */
PORTAL?: boolean;
/** @description UNDOCUMENTED.
*
* Enable prefix search. */
wildcard?: boolean;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SearchResult"];
};
};
default: components["responses"]["Error"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
/**
* SearchHit
* @description Search hit.
*/
SearchHit: {
/** @description The page title of the hit. */
title: string;
/** @description The absolute path on the CTAN Portal of the hit. */
path: string;
/** @description Some additional text to display. */
text: string;
};
/**
* SearchResult
* @description Search result.
*/
SearchResult: {
/** @description The total number of hits found. */
numberOfHits: number;
/** @description The offset at which the hits start. It is a repetition of the input argument `offset` which might have been adapted. */
offset: number;
/** @description The maximal number of hits in this junk. It is a repetition of the input argument `max` which might have been adapted. */
max: number;
/** @description The search phrase. It is a repetition of the input argument `phrase` which might have been adapted. */
phrase: string;
/** @description The list of hits in this junk. */
hits: components["schemas"]["SearchHit"][];
};
};
responses: {
/**
* Error
* @description The body of the response contains more or less meaningless text.
*/
Error: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export type operations = Record<string, never>;