Edits history of script submission #18534 for ' Create a guides page (readme)'

  • bun
    One script reply has been approved by the moderators
    Ap­pro­ved
    //native
    /**
     * Create a guides page
     * Create a page in the Guides section of your ReadMe project.
    
    >📘
    > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).
     */
    export async function main(auth: RT.Readme, branch: string, body: Body) {
    	const url = new URL(`https://api.readme.com/v2/branches/${branch}/guides`)
    
    	const response = await fetch(url, {
    		method: 'POST',
    		headers: {
    			'Content-Type': 'application/json',
    			Authorization: 'Bearer ' + auth.apiKey
    		},
    		body: JSON.stringify(body)
    	})
    	if (!response.ok) {
    		const text = await response.text()
    		throw new Error(`${response.status} ${text}`)
    	}
    	return await response.json()
    }
    
    /* eslint-disable */
    /**
     * This file was automatically generated by json-schema-to-typescript.
     * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
     * and run json-schema-to-typescript to regenerate this file.
     */
    
    export interface Body {
    	/**
    	 * Allow indexing by robots.
    	 */
    	allow_crawlers?: 'enabled' | 'disabled'
    	appearance?: {
    		icon?: {
    			name?: string
    			type?: 'icon' | 'emoji'
    		}
    	}
    	category: {
    		/**
    		 * A URI to the category resource.
    		 */
    		uri: string
    	}
    	content?: {
    		body?: string
    		excerpt?: string
    		/**
    		 * Information about where this page should redirect to; only available when `type` is `link`.
    		 */
    		link?: {
    			url?: string
    			new_tab?: boolean
    		}
    		next?: {
    			description?: string
    			pages?: (
    				| {
    						slug: string
    						title: string
    						type: 'basic' | 'endpoint'
    				  }
    				| {
    						title: string
    						type: 'link'
    						url: string
    				  }
    			)[]
    		}
    	}
    	metadata?: {
    		description?: string
    		keywords?: string
    		title?: string
    		image?: {
    			uri?: string
    		}
    	}
    	parent?: {
    		uri?: string
    	}
    	privacy?: {
    		view?: 'public' | 'anyone_with_link'
    	}
    	/**
    	 * The accessible URL slug for the page.
    	 */
    	slug?: string
    	state?: 'current' | 'deprecated'
    	title: string
    	type?: 'api_config' | 'basic' | 'endpoint' | 'link' | 'webhook'
    	position?: number
    }
    

    Submitted by hugo697 235 days ago