diff --git a/README.md b/README.md index df20ac3b..8e4b4d65 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ WMIs, get all makes for a certain year, and more. - [Install](https://vpic.shaggytech.com/guide/install) - [Node Quick Start](https://vpic.shaggytech.com//guide/getting-started#node-quick-start) - [Browser Quick Start](https://vpic.shaggytech.com/guide/getting-started#browser-quick-start) -- [API Reference](https://vpic.shaggytech.com/api/) +- [API Reference](https://vpic.shaggytech.com/guide/vpic/) ## Mono Repo Structure @@ -129,9 +129,9 @@ const { Results } = await DecodeVinValues("WA1A4AFY2J2008189"); const decodedVehicle = Results[0]; // equals an object of type DecodeVinValuesResults ``` -For a full example response see: [DecodeVinValues](https://vpic.shaggytech.com/api/endpoints/decode-vin-values#returns) +For a full example response see: [DecodeVinValues](https://vpic.shaggytech.com/guide/vpic/endpoints/decode-vin-values#returns) -All available endpoints can be found here: [VPIC API Endpoints](https://vpic.shaggytech.com/api/#vpic-api-endpoints) +All available endpoints can be found here: [VPIC API Endpoints](https://vpic.shaggytech.com/guide/vpic/#vpic-api-endpoints) ## Browser Install diff --git a/apps/docs/.vitepress/menu-links.ts b/apps/docs/.vitepress/menu-links.ts index 6460baa3..99657fbc 100644 --- a/apps/docs/.vitepress/menu-links.ts +++ b/apps/docs/.vitepress/menu-links.ts @@ -3,74 +3,86 @@ import { type DefaultTheme } from 'vitepress' type SidebarItem = DefaultTheme.SidebarItem const vpicEndpointLinks = [ - { text: 'DecodeVin', link: '/api/endpoints/decode-vin' }, - { text: 'DecodeVinExtended', link: '/api/endpoints/decode-vin-extended' }, - { text: 'DecodeVinValues', link: '/api/endpoints/decode-vin-values' }, + { text: 'DecodeVin', link: '/guide/vpic/endpoints/decode-vin' }, + { + text: 'DecodeVinExtended', + link: '/guide/vpic/endpoints/decode-vin-extended', + }, + { text: 'DecodeVinValues', link: '/guide/vpic/endpoints/decode-vin-values' }, { text: 'DecodeVinValuesBatch', - link: '/api/endpoints/decode-vin-values-batch', + link: '/guide/vpic/endpoints/decode-vin-values-batch', }, { text: 'DecodeVinValuesExtended', - link: '/api/endpoints/decode-vin-values-extended', + link: '/guide/vpic/endpoints/decode-vin-values-extended', + }, + { text: 'DecodeWMI', link: '/guide/vpic/endpoints/decode-wmi' }, + { text: 'GetAllMakes', link: '/guide/vpic/endpoints/get-all-makes' }, + { + text: 'GetAllManufacturers', + link: '/guide/vpic/endpoints/get-all-manufacturers', }, - { text: 'DecodeWMI', link: '/api/endpoints/decode-wmi' }, - { text: 'GetAllMakes', link: '/api/endpoints/get-all-makes' }, - { text: 'GetAllManufacturers', link: '/api/endpoints/get-all-manufacturers' }, { text: 'GetCanadianVehicleSpecifications', - link: '/api/endpoints/get-canadian-vehicle-specifications', + link: '/guide/vpic/endpoints/get-canadian-vehicle-specifications', }, { text: 'GetEquipmentPlantCodes', - link: '/api/endpoints/get-equipment-plant-codes', + link: '/guide/vpic/endpoints/get-equipment-plant-codes', }, { text: 'GetMakeForManufacturer', - link: '/api/endpoints/get-make-for-manufacturer', + link: '/guide/vpic/endpoints/get-make-for-manufacturer', }, { text: 'GetMakesForManufacturerAndYear', - link: '/api/endpoints/get-makes-for-manufacturer-and-year', + link: '/guide/vpic/endpoints/get-makes-for-manufacturer-and-year', }, { text: 'GetMakesForVehicleType', - link: '/api/endpoints/get-makes-for-vehicle-type', + link: '/guide/vpic/endpoints/get-makes-for-vehicle-type', }, { text: 'GetManufacturerDetails', - link: '/api/endpoints/get-manufacturer-details', + link: '/guide/vpic/endpoints/get-manufacturer-details', + }, + { + text: 'GetModelsForMake', + link: '/guide/vpic/endpoints/get-models-for-make', + }, + { + text: 'GetModelsForMakeId', + link: '/guide/vpic/endpoints/get-models-for-make-id', }, - { text: 'GetModelsForMake', link: '/api/endpoints/get-models-for-make' }, - { text: 'GetModelsForMakeId', link: '/api/endpoints/get-models-for-make-id' }, { text: 'GetModelsForMakeIdYear', - link: '/api/endpoints/get-models-for-make-id-year', + link: '/guide/vpic/endpoints/get-models-for-make-id-year', }, { text: 'GetModelsForMakeYear', - link: '/api/endpoints/get-models-for-make-year', + link: '/guide/vpic/endpoints/get-models-for-make-year', }, - { text: 'GetParts', link: '/api/endpoints/get-parts' }, + { text: 'GetParts', link: '/guide/vpic/endpoints/get-parts' }, { text: 'GetVehicleTypesForMake', - link: '/api/endpoints/get-vehicle-types-for-make', + link: '/guide/vpic/endpoints/get-vehicle-types-for-make', }, { text: 'GetVehicleTypesForMakeId', - link: '/api/endpoints/get-vehicle-types-for-make-id', + link: '/guide/vpic/endpoints/get-vehicle-types-for-make-id', }, { text: 'GetVehicleVariableList', - link: '/api/endpoints/get-vehicle-variable-list', + link: '/guide/vpic/endpoints/get-vehicle-variable-list', }, { text: 'GetVehicleVariableValuesList', - link: '/api/endpoints/get-vehicle-variable-values-list', + link: '/guide/vpic/endpoints/get-vehicle-variable-values-list', }, { text: 'GetWMIsForManufacturer', - link: '/api/endpoints/get-wmis-for-manufacturer', + link: '/guide/vpic/endpoints/get-wmis-for-manufacturer', }, ] @@ -217,12 +229,12 @@ const typedocLinks = [ ], }, { - text: 'Types Index', + text: 'Types', link: '/typedoc/types', }, ] -export type LinkGroup = 'guide' | 'api' | 'typedocs' +export type LinkGroup = 'guide' | 'typedocs' const groupLinks: Record = { guide: [ @@ -231,12 +243,19 @@ const groupLinks: Record = { { text: 'Getting Started', link: '/guide/getting-started' }, { text: 'Typescript', link: '/guide/typescript' }, { - text: 'Bring Your Own Fetch (BYOF)', - link: '/guide/bring-your-own-fetch', - }, - { - text: 'Support for Node Versions < 18', - link: '/guide/native-fetch', + text: 'VPIC', + items: [ + { text: 'Overview', link: '/guide/vpic/' }, + { + text: 'VPIC Response', + link: '/guide/vpic/vpic-api-response', + }, + { + text: 'VPIC Functions', + items: vpicEndpointLinks, + collapsed: true, + }, + ], }, { text: 'Examples', @@ -256,17 +275,18 @@ const groupLinks: Record = { { text: 'useNHTSA', link: '/utils/use-nhtsa' }, ], }, - ], - api: [ - { text: 'Overview', link: '/api/' }, { - text: 'VPIC Response', - link: '/api/vpic-api-response', - }, - { - text: 'VPIC Functions', - items: vpicEndpointLinks, - collapsed: false, + text: 'Misc', + items: [ + { + text: 'Bring Your Own Fetch (BYOF)', + link: '/guide/bring-your-own-fetch', + }, + { + text: 'Support for Node Versions < 18', + link: '/guide/native-fetch', + }, + ], }, ], typedocs: [{ text: 'Index', link: '/typedoc/' }, ...typedocLinks], @@ -277,10 +297,6 @@ const linkGroups: Record = { text: 'Guide', items: groupLinks.guide, }, - api: { - text: 'API', - items: groupLinks.api, - }, typedocs: { text: 'Typedocs', items: groupLinks.typedocs, diff --git a/apps/docs/.vitepress/menu.ts b/apps/docs/.vitepress/menu.ts index d3ac6cff..e78a712f 100644 --- a/apps/docs/.vitepress/menu.ts +++ b/apps/docs/.vitepress/menu.ts @@ -7,7 +7,6 @@ const pkg = require('@shaggytools/nhtsa-api-wrapper/package.json') function nav() { return [ { text: 'Guide', link: '/guide/', activeMatch: '/guide|utils/' }, - { text: 'API', link: '/api/', activeMatch: '/api/' }, { text: 'Typedocs', link: '/typedoc/', activeMatch: '/typedoc/' }, { text: pkg.version, @@ -25,7 +24,6 @@ function sidebar() { return { '/guide/': sidebarLinks(['guide']), '/utils/': sidebarLinks(['guide']), - '/api/': sidebarLinks(['api']), '/typedoc/': sidebarLinks(['typedocs']), } } diff --git a/apps/docs/src/api/index.md b/apps/docs/src/api/index.md deleted file mode 100644 index 672ff1b9..00000000 --- a/apps/docs/src/api/index.md +++ /dev/null @@ -1,39 +0,0 @@ -# API Reference - ---- - -This section of the documentation describes the main functions exported by this package, as well as -the response format returned by the NHTSA API. - -You can also find details of the VPIC API endpoints and what they return. - -## VPIC API Response - -- [VPIC API Response](../api/vpic-api-response) - -## VPIC API Endpoints - -- [DecodeVin](../api/endpoints/decode-vin) -- [DecodeVinExtended](../api/endpoints/decode-vin-extended) -- [DecodeVinValues](../api/endpoints/decode-vin-values) -- [DecodeVinValuesBatch](../api/endpoints/decode-vin-values-batch) -- [DecodeVinValuesExtended](../api/endpoints/decode-vin-values-extended) -- [DecodeWMI](../api/endpoints/decode-wmi) -- [GetAllMakes](../api/endpoints/get-all-makes) -- [GetAllManufacturers](../api/endpoints/get-all-manufacturers) -- [GetCanadianVehicleSpecifications](../api/endpoints/get-canadian-vehicle-specifications) -- [GetEquipmentPlantCodes](../api/endpoints/get-equipment-plant-codes) -- [GetMakeForManufacturer](../api/endpoints/get-make-for-manufacturer) -- [GetMakesForManufacturerAndYear](../api/endpoints/get-makes-for-manufacturer-and-year) -- [GetMakesForVehicleType](../api/endpoints/get-makes-for-vehicle-type) -- [GetManufacturerDetails](../api/endpoints/get-manufacturer-details) -- [GetModelsForMake](../api/endpoints/get-models-for-make) -- [GetModelsForMakeId](../api/endpoints/get-models-for-make-id) -- [GetModelsForMakeIdYear](../api/endpoints/get-models-for-make-id-year) -- [GetModelsForMakeYear](../api/endpoints/get-models-for-make-year) -- [GetParts](../api/endpoints/get-parts) -- [GetVehicleTypesForMake](../api/endpoints/get-vehicle-types-for-make) -- [GetVehicleTypesForMakeId](../api/endpoints/get-vehicle-types-for-make-id) -- [GetVehicleVariableList](../api/endpoints/get-vehicle-variable-list) -- [GetVehicleVariableValuesList](../api/endpoints/get-vehicle-variable-values-list) -- [GetWMIsForManufacturer](../api/endpoints/get-wmis-for-manufacturer) diff --git a/apps/docs/src/guide/getting-started.md b/apps/docs/src/guide/getting-started.md index 7aebee01..64d05393 100644 --- a/apps/docs/src/guide/getting-started.md +++ b/apps/docs/src/guide/getting-started.md @@ -54,7 +54,7 @@ Further Reading: - A more in depth explanation of how to decode a VIN and parse the data can be found on the [Decoding a VIN](../guide/vin-decoding) page. -- For a full example response see [DecodeVinValues](../api/endpoints/decode-vin-values#returns) +- For a full example response see [DecodeVinValues](../guide/vpic/endpoints/decode-vin-values#returns) documentation. - The structure of `Results[0]` in the above example can be seen on the @@ -200,5 +200,5 @@ import { - [VIN Decoding](../guide/vin-decoding) - [Offline VIN Validation](../guide/offline-vin-validation) -- [VPIC API Response](../api/vpic-api-response) -- [VPIC API Endpoints](../api/endpoints/#vpic-api-endpoints) +- [VPIC API Response](../guide/vpic/vpic-api-response) +- [VPIC API Endpoints](../guide/vpic/endpoints/#vpic-api-endpoints) diff --git a/apps/docs/src/guide/index.md b/apps/docs/src/guide/index.md index dc280523..22609b7f 100644 --- a/apps/docs/src/guide/index.md +++ b/apps/docs/src/guide/index.md @@ -4,7 +4,7 @@ ✔️ A thin Javascript client for the [NHTSA VPIC API](https://vpic.nhtsa.dot.gov/api/) -✔️ 24 helper functions to retrieve data from each of the [VPIC API endpoints](../api/index#vpic-api-endpoints) +✔️ 24 helper functions to retrieve data from each of the [VPIC API endpoints](../guide/vpic/index#vpic-api-endpoints) ✔️ Works in Node.js via package managers and in browser scripts via CDN. @@ -29,7 +29,7 @@ make interacting with the API and retrieving data less of a chore. - Provides a set of 24 helper functions to interact with each of the 24 endpoints, so you don't have to worry about the url structure, query parameters, formatting, or fetching the data. - See the [VPIC API](/api/) section for more info. + See the [VPIC API](/guide/vpic/) section for more info. - Use the built in `fetch` functionionality or provide your own. The endpoint functions can be used to build full VPIC URLs for you to use your own fetch implentation such as Axios or a polyfill. @@ -56,7 +56,7 @@ It can also be used to get all models of a make, to decode WMIs, get all makes f and more. A list of all 24 VPIC endpoints can be found in the -[NHTSA API Endpoints](../api/index#vpic-api-endpoints) section. +[NHTSA API Endpoints](../guide/vpic/index#vpic-api-endpoints) section. ::: tip :bulb: TIP diff --git a/apps/docs/src/guide/typescript.md b/apps/docs/src/guide/typescript.md index 22ddba1b..1bf4c76f 100644 --- a/apps/docs/src/guide/typescript.md +++ b/apps/docs/src/guide/typescript.md @@ -5,82 +5,29 @@ in the `@shaggytools/nhtsa-api-wrapper/dist/types`. In most cases you shouldn't directly. We've tried to be as accurate as possible typing the API responses based on testing real responses -from the NHTSA API. Please report any discrepancies you may find and they will be fixed. - -::: tip :mag: See Also: - -Check out the [API](/api/) section for more details on each endpoint helper function and their -return types. - -::: +from the NHTSA API. Please report any discrepancies you find via the +[Github Repo](https://github.com/ShaggyTech/nhtsa-api-wrapper/issues/new/choose) and they will be +fixed. --- -## Using Typescript - -This package was designed with typescript support in mind and therefore should work out of the box -with most modern code editors. - -If for some reason you're not getting any type hints or code completion, or receive errors about not -finding types for this package, you may need to add the following to your `tsconfig.json` file: - -::: code-group - -```json [tsconfig.json] -{ - "compilerOptions": { - "types": ["@shaggytools/nhtsa-api-wrapper"] - } -} -``` - -::: - -There is the potential for some confusion when using the package with Typescript. This is due to -the fact that the NHTSA API uses `PascalCase` for it's endpoint names, and Javascript -conventions are to use `camelCase` for function names and `PascalCase` for classes/types. - -In this package the endpoint wrapper functions aren't `camelCased` like most javascript functions, -they are `PascalCased`. For example `DecodeVin` and `GetAllMakes` instead of `decodeVin` and -`getAllMakes`. - -The decision was made to name package endpoint functions with the same name and casing as the -endpoints themselves, mostly for the sake of consistency between this package and the -[official VPIC documentation](https://vpic.nhtsa.dot.gov/api/). - -The package types are also `PascalCased` just like the endpoint functions. This can be confusing when -importing from this package while using intellesense/code completion in your code editor as it will -show the function names and types all grouped together in `PascalCase`. It may be hard to tell the -difference between the function names and the types if you don't know what to look for. - -Every endpoint function has a corresponding `Results` type with the same name and casing as the -function. For example `DecodeVin` has a `DecodeVinResults` type, `GetAllMakes` has a -`GetAllMakesResults` type, etc. - -A few endpoints also have other associated types, such as -typedoc/api/endpoints/DecodeVinValues/type-aliases/DecodeVinValuesResults -[`DecodeVinExtendedVariable`](../typedoc/api/endpoints/DecodeVinExtended#DecodeVinExtendedVariable) -that describe possible `Variable` values found in the `Results` array of the `DecodeVinExtended` -endpoint. - ## Exported Types ::: tip :mag: See Also: -The [Typedocs - Types](../typedoc/types) page lists all of the types this -package exports and their structure. - -
+The [Typedocs - Types](../typedoc/types) page lists all of the types this package exports and their +structure. -You can find a full list of bundled types in the `/dist/types` directory on the -[UNPKG Homepage](https://unpkg.com/browse/@shaggytools/nhtsa-api-wrapper/dist/types/) for this -package. ::: All bundled types can be found in the `@shaggytools/nhtsa-api-wrapper/dist/types` directory. You shouldn't need to import them directly from `/dist/types`. Instead, you can import them directly from the package itself. +You can find a full list of bundled types in the `/dist/types` directory on the +[UNPKG Homepage](https://unpkg.com/browse/@shaggytools/nhtsa-api-wrapper/dist/types/) for this +package. + Here's an example of how to import specific types from this package: ```ts @@ -99,6 +46,23 @@ import { } from '@shaggytools/nhtsa-api-wrapper' ``` +::: warning :mag: Note: + +If for some reason you're not getting any type hints or code completion, or receive errors about not +finding types for this package, you may need to add the following to your `tsconfig.json` file: + +::: code-group + +```json [tsconfig.json] +{ + "compilerOptions": { + "types": ["@shaggytools/nhtsa-api-wrapper"] + } +} +``` + +::: + ## NHTSA API Response Types The NHTSA VPIC API response is an object with the following structure: @@ -139,12 +103,44 @@ type NhtsaResponse = { ::: tip :mag: See Also: -The [VPIC Response](/api/vpic-api-response) page has more details +The [VPIC Response](./vpic/vpic-api-response) page has more details on the response returned by the VPIC API. ::: -## Note for Beginners +## Using Typescript With This Package + +This package was designed with typescript support in mind and therefore will work out of the box +with most modern code editors. You should get type hints, code completion, and TS errors for all of +the package functions and types. + +There is the potential for some confusion when using the package with Typescript. This is due to +the fact that the NHTSA API uses `PascalCase` for it's endpoint names, and Javascript +conventions are to use `camelCase` for function names and `PascalCase` for classes/types. + +In this package the endpoint wrapper functions aren't `camelCased` like most javascript functions, +they are `PascalCased`. For example `DecodeVin` and `GetAllMakes` instead of `decodeVin` and +`getAllMakes`. + +The decision was made to name package endpoint functions with the same name and casing as the +endpoints themselves, mostly for the sake of consistency between this package and the +[official VPIC documentation](https://vpic.nhtsa.dot.gov/api/). + +The package types are also `PascalCased` just like the endpoint functions. This can be confusing when +importing from this package while using intellesense/code completion in your code editor as it will +show the function names and types all grouped together in `PascalCase`. It may be hard to tell the +difference between the function names and the types if you don't know what to look for. + +Every endpoint function has a corresponding `Results` type with the same name and casing as the +function. For example `DecodeVin` has a `DecodeVinResults` type, `GetAllMakes` has a +`GetAllMakesResults` type, etc. + +A few endpoints also have other associated types, such as +[`DecodeVinExtendedVariable`](../typedoc/api/endpoints/DecodeVinExtended#DecodeVinExtendedVariable) +that describe possible `Variable` values found in the `Results` array of the `DecodeVinExtended` +endpoint. + +## Notes for Beginners If you're new to Typescript, you may be wondering what 'full typescript support' means. @@ -216,15 +212,15 @@ appear. This is what is known as "intellisense" or "code completion". If you were to attempt accessing `Results[0].Other` you would see that it does not exist in type `DecodeVinResults`. Your code editor would let you know that you're trying to access a property -that doesn't exist. In this way you can avoid common mistakes like typos and accessing properties -that don't exist. +that doesn't exist. In this way you can avoid common mistakes like typos and accessing non-existing +properties. Similarly, if you saved the `Results[0].ValueId` value to a variable, your code editor will know that it's of type `number` and warn you if you try to use in ways that numbers can't be used, such as `Results[0].ValueId.toUpperCase()` or similar. You would be warned that `toUpperCase` does not exist on type `number`. -
+### Conclusion These are just some of the benefits of having Typescript support. The key takeaway is that it will help you avoid common mistakes and make you a more efficient developer. It can be adopted into an diff --git a/apps/docs/src/guide/vin-decoding.md b/apps/docs/src/guide/vin-decoding.md index d7e319b0..e0cdaa0c 100644 --- a/apps/docs/src/guide/vin-decoding.md +++ b/apps/docs/src/guide/vin-decoding.md @@ -30,7 +30,7 @@ response = { */ ``` -::: tip :mag: See: [VPIC Response](../api/vpic-api-response) for more info on the response object +::: tip :mag: See: [VPIC Response](../guide/vpic/vpic-api-response) for more info on the response object ::: --- @@ -50,8 +50,8 @@ object. This object is the decoded data for the VIN. ::: tip See also: -- [DecodeVinValues](../api/endpoints/decode-vin-values) -- [DecodeVinValues Example Response](../api/endpoints/decode-vin-values#returns) +- [DecodeVinValues](../guide/vpic/endpoints/decode-vin-values) +- [DecodeVinValues Example Response](../guide/vpic/endpoints/decode-vin-values#returns) - [Type - DecodeVinValuesResults](../typedoc/api/endpoints/DecodeVinValues#decodevinvaluesresults) ::: @@ -100,5 +100,5 @@ console.log( ) ``` -::: tip :mag: See Also: [VPIC API Endpoints](../api/#vpic-api-endpoints) +::: tip :mag: See Also: [VPIC API Endpoints](../guide/vpic/#vpic-api-endpoints) ::: diff --git a/apps/docs/src/api/endpoints/decode-vin-extended.md b/apps/docs/src/guide/vpic/endpoints/decode-vin-extended.md similarity index 93% rename from apps/docs/src/api/endpoints/decode-vin-extended.md rename to apps/docs/src/guide/vpic/endpoints/decode-vin-extended.md index 531db572..98421d2e 100644 --- a/apps/docs/src/api/endpoints/decode-vin-extended.md +++ b/apps/docs/src/guide/vpic/endpoints/decode-vin-extended.md @@ -15,7 +15,7 @@ async function DecodeVinExtended ( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/DecodeVinExtended) +See: [Package Reference](../../../typedoc/api/endpoints/DecodeVinExtended) ::: ## Description @@ -54,7 +54,7 @@ Any `params` that are not listed in the table above will be ignored. As `params` is optional, it also has type `| boolean`, so you can set `doFetch` without having to pass `undefined` in place of intentionally undefined `params`. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -91,7 +91,7 @@ Returns the URL string that can be used to fetch the data, does _not_ fetch the // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/DecodeVinExtended/WA1A4AFY2J2008189?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type DecodeVinExtendedResults @@ -157,7 +157,7 @@ const response = await DecodeVinExtended('5UXWX7C5*BA') - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/decode-vin-values-batch.md b/apps/docs/src/guide/vpic/endpoints/decode-vin-values-batch.md similarity index 91% rename from apps/docs/src/api/endpoints/decode-vin-values-batch.md rename to apps/docs/src/guide/vpic/endpoints/decode-vin-values-batch.md index 05b4b8cd..c3ea5313 100644 --- a/apps/docs/src/api/endpoints/decode-vin-values-batch.md +++ b/apps/docs/src/guide/vpic/endpoints/decode-vin-values-batch.md @@ -10,7 +10,7 @@ async function DecodeVinValuesBatch( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/DecodeVinValuesBatch) +See: [Package Reference](../../../typedoc/api/endpoints/DecodeVinValuesBatch) ::: ## Description @@ -53,7 +53,7 @@ the model year if it is known at the time of decoding, but it is not required. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -91,7 +91,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da ``` ::: tip :bulb: See: -[Using doFetch](../../guide/bring-your-own-fetch#using-dofetch) for info on how to +[Using doFetch](../../bring-your-own-fetch#using-dofetch) for info on how to use the URL string to fetch the data in a POST request such as this endpoint. ::: @@ -157,9 +157,9 @@ const response = await DecodeVinValuesBatch('5UXWX7C5*BA; 5YJSA3DS*EF, 2015') - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) -- See: [Using with POST Endpoints](../../guide/bring-your-own-fetch#using-with-post-endpoints) +- See: [Using with POST Endpoints](../../bring-your-own-fetch#using-with-post-endpoints) - Returns: diff --git a/apps/docs/src/api/endpoints/decode-vin-values-extended.md b/apps/docs/src/guide/vpic/endpoints/decode-vin-values-extended.md similarity index 93% rename from apps/docs/src/api/endpoints/decode-vin-values-extended.md rename to apps/docs/src/guide/vpic/endpoints/decode-vin-values-extended.md index 849e86d6..83e5be05 100644 --- a/apps/docs/src/api/endpoints/decode-vin-values-extended.md +++ b/apps/docs/src/guide/vpic/endpoints/decode-vin-values-extended.md @@ -15,7 +15,7 @@ async function DecodeVinValuesExtended( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/DecodeVinValuesExtended) +See: [Package Reference](../../../typedoc/api/endpoints/DecodeVinValuesExtended) ::: ## Description @@ -64,7 +64,7 @@ Any `params` that are not listed in the table above will be ignored. As `params` is optional, it also has type `| boolean`, so you can set `doFetch` without having to pass `undefined` in place of intentionally undefined `params`. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -101,7 +101,7 @@ Returns the URL string that can be used to fetch the data, does _not_ fetch the // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/DecodeVinValuesExtended/WA1A4AFY2J2008189?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - DecodeVinValuesExtendedResults @@ -161,7 +161,7 @@ const response = await DecodeVinValuesExtended('5UXWX7C5*BA') - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/decode-vin-values.md b/apps/docs/src/guide/vpic/endpoints/decode-vin-values.md similarity index 93% rename from apps/docs/src/api/endpoints/decode-vin-values.md rename to apps/docs/src/guide/vpic/endpoints/decode-vin-values.md index 857ab9be..cd69c68f 100644 --- a/apps/docs/src/api/endpoints/decode-vin-values.md +++ b/apps/docs/src/guide/vpic/endpoints/decode-vin-values.md @@ -15,7 +15,7 @@ async function DecodeVinValues( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/DecodeVinValues) +See: [Package Reference](../../../typedoc/api/endpoints/DecodeVinValues) ::: ## Description @@ -60,7 +60,7 @@ Any `params` that are not listed in the table above will be ignored. As `params` is optional, it also has type `| boolean`, so you can set `doFetch` without having to pass `undefined` in place of intentionally undefined `params`. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -97,7 +97,7 @@ Returns the URL string that can be used to fetch the data, does _not_ fetch the // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/DecodeVinValues/WA1A4AFY2J2008189?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - DecodeVinValuesResults @@ -155,7 +155,7 @@ const response = await DecodeVinValues('5UXWX7C5*BA') - Does _NOT_ fetch data from VPIC API internally -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/decode-vin.md b/apps/docs/src/guide/vpic/endpoints/decode-vin.md similarity index 92% rename from apps/docs/src/api/endpoints/decode-vin.md rename to apps/docs/src/guide/vpic/endpoints/decode-vin.md index d4408bef..a536b368 100644 --- a/apps/docs/src/api/endpoints/decode-vin.md +++ b/apps/docs/src/guide/vpic/endpoints/decode-vin.md @@ -15,7 +15,7 @@ async function DecodeVin( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/DecodeVin) +See: [Package Reference](../../../typedoc/api/endpoints/DecodeVin) ::: ## Description @@ -50,7 +50,7 @@ Any `params` that are not listed in the table above will be ignored. As `params` is optional, it also has type `| boolean`, so you can set `doFetch` without having to pass `undefined` in place of intentionally undefined `params`. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -87,7 +87,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/DecodeVin/WA1A4AFY2J2008189?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - DecodeVinResults @@ -151,7 +151,7 @@ const response = await DecodeVin('5UXWX7C5*BA') - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/decode-wmi.md b/apps/docs/src/guide/vpic/endpoints/decode-wmi.md similarity index 89% rename from apps/docs/src/api/endpoints/decode-wmi.md rename to apps/docs/src/guide/vpic/endpoints/decode-wmi.md index a86ea9ec..db88cb90 100644 --- a/apps/docs/src/api/endpoints/decode-wmi.md +++ b/apps/docs/src/guide/vpic/endpoints/decode-wmi.md @@ -10,7 +10,7 @@ async function DecodeWMI( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/DecodeWMI) +See: [Package Reference](../../../typedoc/api/endpoints/DecodeWMI) ::: ## Description @@ -38,7 +38,7 @@ be available in VPIC data sets. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -75,7 +75,7 @@ Returns the URL string that can be used to fetch the data, does _not_ fetch the // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/DecodeWMI/WVW?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - DecodeWMIResults @@ -123,7 +123,7 @@ const response = await DecodeWMI('1CG', true) - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-all-makes.md b/apps/docs/src/guide/vpic/endpoints/get-all-makes.md similarity index 87% rename from apps/docs/src/api/endpoints/get-all-makes.md rename to apps/docs/src/guide/vpic/endpoints/get-all-makes.md index 7e2d688f..1e46288d 100644 --- a/apps/docs/src/api/endpoints/get-all-makes.md +++ b/apps/docs/src/guide/vpic/endpoints/get-all-makes.md @@ -9,7 +9,7 @@ async function GetAllMakes( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetAllMakes) +See: [Package Reference](../../../typedoc/api/endpoints/GetAllMakes) ::: ## Description @@ -30,7 +30,7 @@ an individual vehicle Make. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -67,7 +67,7 @@ Returns the URL string that can be used to fetch the data, does _not_ fetch the // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetAllMakes/?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetAllMakesResults @@ -115,7 +115,7 @@ const response = await GetAllMakes(true) - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-all-manufacturers.md b/apps/docs/src/guide/vpic/endpoints/get-all-manufacturers.md similarity index 92% rename from apps/docs/src/api/endpoints/get-all-manufacturers.md rename to apps/docs/src/guide/vpic/endpoints/get-all-manufacturers.md index 7b386d55..03c5b087 100644 --- a/apps/docs/src/api/endpoints/get-all-manufacturers.md +++ b/apps/docs/src/guide/vpic/endpoints/get-all-manufacturers.md @@ -15,7 +15,7 @@ async function GetAllManufacturers( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetAllManufacturers) +See: [Package Reference](../../../typedoc/api/endpoints/GetAllManufacturers) ::: ## Description @@ -46,7 +46,7 @@ Any `params` that are not listed in the table above will be ignored. As `params` is optional, it also has type `| boolean`, so you can set `doFetch` without having to pass `undefined` in place of intentionally undefined `params`. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -83,7 +83,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetParts?type=565&fromDate=1/1/2015&toDate=5/5/2015&manufacturer=hon&format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetAllManufacturersResults @@ -148,7 +148,7 @@ const response = await GetAllManufacturers({ - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-canadian-vehicle-specifications.md b/apps/docs/src/guide/vpic/endpoints/get-canadian-vehicle-specifications.md similarity index 93% rename from apps/docs/src/api/endpoints/get-canadian-vehicle-specifications.md rename to apps/docs/src/guide/vpic/endpoints/get-canadian-vehicle-specifications.md index 7eb875e3..29b2ff46 100644 --- a/apps/docs/src/api/endpoints/get-canadian-vehicle-specifications.md +++ b/apps/docs/src/guide/vpic/endpoints/get-canadian-vehicle-specifications.md @@ -15,7 +15,7 @@ async function GetCanadianVehicleSpecifications( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetCanadianVehicleSpecifications) +See: [Package Reference](../../../typedoc/api/endpoints/GetCanadianVehicleSpecifications) ::: ## Description @@ -56,7 +56,7 @@ Any `params` that are not listed in the table above will be ignored. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -94,7 +94,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetCanadianVehicleSpecifications/?Year=2011&Make=Acura&Model=&units=&format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetCanadianVehicleSpecificationsResults @@ -145,7 +145,7 @@ const response = await GetCanadianVehicleSpecifications({ - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-equipment-plant-codes.md b/apps/docs/src/guide/vpic/endpoints/get-equipment-plant-codes.md similarity index 93% rename from apps/docs/src/api/endpoints/get-equipment-plant-codes.md rename to apps/docs/src/guide/vpic/endpoints/get-equipment-plant-codes.md index 28a48c6a..1c880484 100644 --- a/apps/docs/src/api/endpoints/get-equipment-plant-codes.md +++ b/apps/docs/src/guide/vpic/endpoints/get-equipment-plant-codes.md @@ -31,7 +31,7 @@ async function GetEquipmentPlantCodes( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetEquipmentPlantCodes) +See: [Package Reference](../../../typedoc/api/endpoints/GetEquipmentPlantCodes) ::: ## Description @@ -78,7 +78,7 @@ Any `params` that are not listed in the table above will be ignored. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -116,7 +116,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetEquipmentPlantCodes?year=2015&equipmentType=1&reportType=new&format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetEquipmentPlantCodesParams @@ -166,7 +166,7 @@ const response = await GetEquipmentPlantCodes({ - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-make-for-manufacturer.md b/apps/docs/src/guide/vpic/endpoints/get-make-for-manufacturer.md similarity index 90% rename from apps/docs/src/api/endpoints/get-make-for-manufacturer.md rename to apps/docs/src/guide/vpic/endpoints/get-make-for-manufacturer.md index b653f8a9..c85e2af0 100644 --- a/apps/docs/src/api/endpoints/get-make-for-manufacturer.md +++ b/apps/docs/src/guide/vpic/endpoints/get-make-for-manufacturer.md @@ -10,7 +10,7 @@ async function GetMakeForManufacturer( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetMakeForManufacturer) +See: [Package Reference](../../../typedoc/api/endpoints/GetMakeForManufacturer) ::: ## Description @@ -36,7 +36,7 @@ that is requested. Multiple results are returned in case of multiple matches. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -73,7 +73,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetMakeForManufacturer/?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetMakeForManufacturerResults @@ -118,7 +118,7 @@ const response = await GetMakeForManufacturer(988) - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-makes-for-manufacturer-and-year.md b/apps/docs/src/guide/vpic/endpoints/get-makes-for-manufacturer-and-year.md similarity index 92% rename from apps/docs/src/api/endpoints/get-makes-for-manufacturer-and-year.md rename to apps/docs/src/guide/vpic/endpoints/get-makes-for-manufacturer-and-year.md index fba6fb80..40ba7fe1 100644 --- a/apps/docs/src/api/endpoints/get-makes-for-manufacturer-and-year.md +++ b/apps/docs/src/guide/vpic/endpoints/get-makes-for-manufacturer-and-year.md @@ -13,7 +13,7 @@ async function GetMakesForManufacturerAndYear( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetMakesForManufacturerAndYear) +See: [Package Reference](../../../typedoc/api/endpoints/GetMakesForManufacturerAndYear) ::: ## Description @@ -51,7 +51,7 @@ Any `params` that are not listed in the table above will be ignored. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -89,7 +89,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetMakesForManufacturerAndYear/volks?year=2020&format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetMakesForManufacturerAndYearResults @@ -134,7 +134,7 @@ const response = await GetMakesForManufacturerAndYear(1148, { year: 2020 }) - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-makes-for-vehicle-type.md b/apps/docs/src/guide/vpic/endpoints/get-makes-for-vehicle-type.md similarity index 88% rename from apps/docs/src/api/endpoints/get-makes-for-vehicle-type.md rename to apps/docs/src/guide/vpic/endpoints/get-makes-for-vehicle-type.md index 893da219..74f50b3f 100644 --- a/apps/docs/src/api/endpoints/get-makes-for-vehicle-type.md +++ b/apps/docs/src/guide/vpic/endpoints/get-makes-for-vehicle-type.md @@ -10,7 +10,7 @@ async function GetMakesForVehicleType( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetMakesForVehicleType) +See: [Package Reference](../../../typedoc/api/endpoints/GetMakesForVehicleType) ::: ## Description @@ -32,7 +32,7 @@ See: [Package Reference](../../typedoc/api/endpoints/GetMakesForVehicleType) Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -70,7 +70,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetMakesForVehicleType/truck?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetMakesForVehicleTypeResults @@ -107,7 +107,7 @@ const response = await GetMakesForVehicleType('truck') - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-manufacturer-details.md b/apps/docs/src/guide/vpic/endpoints/get-manufacturer-details.md similarity index 90% rename from apps/docs/src/api/endpoints/get-manufacturer-details.md rename to apps/docs/src/guide/vpic/endpoints/get-manufacturer-details.md index ffb0addc..1c5dff16 100644 --- a/apps/docs/src/api/endpoints/get-manufacturer-details.md +++ b/apps/docs/src/guide/vpic/endpoints/get-manufacturer-details.md @@ -10,7 +10,7 @@ async function GetManufacturerDetails( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetManufacturerDetails) +See: [Package Reference](../../../typedoc/api/endpoints/GetManufacturerDetails) ::: ## Description @@ -36,7 +36,7 @@ Multiple results are returned in case of multiple matches. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -74,7 +74,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetManufacturerDetails/tesla?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetManufacturerDetailsResults @@ -119,7 +119,7 @@ const response = await GetManufacturerDetails(955) - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-models-for-make-id-year.md b/apps/docs/src/guide/vpic/endpoints/get-models-for-make-id-year.md similarity index 94% rename from apps/docs/src/api/endpoints/get-models-for-make-id-year.md rename to apps/docs/src/guide/vpic/endpoints/get-models-for-make-id-year.md index fef719b9..2aeb4b28 100644 --- a/apps/docs/src/api/endpoints/get-models-for-make-id-year.md +++ b/apps/docs/src/guide/vpic/endpoints/get-models-for-make-id-year.md @@ -15,7 +15,7 @@ async function GetModelsForMakeIdYear( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetModelsForMakeIdYear) +See: [Package Reference](../../../typedoc/api/endpoints/GetModelsForMakeIdYear) ::: ## Description @@ -75,7 +75,7 @@ Any `params` that are not listed in the table above will be ignored. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -113,7 +113,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetModelsForMakeIdYear/makeId/474/modelyear/2015/vehicleType/car?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetModelsForMakeIdYearResults @@ -175,7 +175,7 @@ const response = await GetModelsForMakeIdYear({ - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-models-for-make-id.md b/apps/docs/src/guide/vpic/endpoints/get-models-for-make-id.md similarity index 89% rename from apps/docs/src/api/endpoints/get-models-for-make-id.md rename to apps/docs/src/guide/vpic/endpoints/get-models-for-make-id.md index 133bb641..5b9cbe3e 100644 --- a/apps/docs/src/api/endpoints/get-models-for-make-id.md +++ b/apps/docs/src/guide/vpic/endpoints/get-models-for-make-id.md @@ -10,7 +10,7 @@ async function GetModelsForMakeId( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetModelsForMakeId) +See: [Package Reference](../../../typedoc/api/endpoints/GetModelsForMakeId) ::: ## Description @@ -49,7 +49,7 @@ endpoint. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -87,7 +87,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetModelsForMakeId/582?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetModelsForMakeIdResults @@ -124,7 +124,7 @@ const response = await GetModelsForMakeId(582) - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-models-for-make-year.md b/apps/docs/src/guide/vpic/endpoints/get-models-for-make-year.md similarity index 93% rename from apps/docs/src/api/endpoints/get-models-for-make-year.md rename to apps/docs/src/guide/vpic/endpoints/get-models-for-make-year.md index aff0cdfb..e12315cb 100644 --- a/apps/docs/src/api/endpoints/get-models-for-make-year.md +++ b/apps/docs/src/guide/vpic/endpoints/get-models-for-make-year.md @@ -15,7 +15,7 @@ async function GetModelsForMakeYear( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetModelsForMakeYear) +See: [Package Reference](../../../typedoc/api/endpoints/GetModelsForMakeYear) ::: ## Description @@ -56,7 +56,7 @@ Any `params` that are not listed in the table above will be ignored. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -94,7 +94,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetModelsForMakeYear/make/audi/modelyear/2018/vehicleType/car?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetModelsForMakeYearResults @@ -157,7 +157,7 @@ const response = await GetModelsForMakeYear({ - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-models-for-make.md b/apps/docs/src/guide/vpic/endpoints/get-models-for-make.md similarity index 87% rename from apps/docs/src/api/endpoints/get-models-for-make.md rename to apps/docs/src/guide/vpic/endpoints/get-models-for-make.md index 9d816c83..bcd6294a 100644 --- a/apps/docs/src/api/endpoints/get-models-for-make.md +++ b/apps/docs/src/guide/vpic/endpoints/get-models-for-make.md @@ -10,7 +10,7 @@ async function GetModelsForMake( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetModelsForMake) +See: [Package Reference](../../../typedoc/api/endpoints/GetModelsForMake) ::: ## Description @@ -32,7 +32,7 @@ whose Name is LIKE the Make in vPIC Dataset. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -70,7 +70,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetModelsForMake/audi?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetModelsForMakeResults @@ -107,7 +107,7 @@ const response = await GetModelsForMake('audi') - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-parts.md b/apps/docs/src/guide/vpic/endpoints/get-parts.md similarity index 93% rename from apps/docs/src/api/endpoints/get-parts.md rename to apps/docs/src/guide/vpic/endpoints/get-parts.md index f594c62b..e0ae0591 100644 --- a/apps/docs/src/api/endpoints/get-parts.md +++ b/apps/docs/src/guide/vpic/endpoints/get-parts.md @@ -18,7 +18,7 @@ async function GetParts( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetParts) +See: [Package Reference](../../../typedoc/api/endpoints/GetParts) ::: ## Description @@ -77,7 +77,7 @@ Any `params` that are not listed in the table above will be ignored. As `params` is optional, it also has type `| boolean`, so you can set `doFetch` without having to pass `undefined` in place of intentionally undefined `params`. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -114,7 +114,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetParts?type=565&fromDate=1/1/2015&toDate=5/5/2015&manufacturer=honda&page=1format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetPartsResults @@ -165,7 +165,7 @@ const response = await GetParts({ - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-vehicle-types-for-make-id.md b/apps/docs/src/guide/vpic/endpoints/get-vehicle-types-for-make-id.md similarity index 89% rename from apps/docs/src/api/endpoints/get-vehicle-types-for-make-id.md rename to apps/docs/src/guide/vpic/endpoints/get-vehicle-types-for-make-id.md index 54826f48..eaf35aa9 100644 --- a/apps/docs/src/api/endpoints/get-vehicle-types-for-make-id.md +++ b/apps/docs/src/guide/vpic/endpoints/get-vehicle-types-for-make-id.md @@ -10,7 +10,7 @@ async function GetVehicleTypesForMakeId( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetVehicleTypesForMakeId) +See: [Package Reference](../../../typedoc/api/endpoints/GetVehicleTypesForMakeId) ::: ## Description @@ -49,7 +49,7 @@ endpoint. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -87,7 +87,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetVehicleTypesForMakeId/449?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetVehicleTypesForMakeIdResults @@ -122,7 +122,7 @@ const response = await GetVehicleTypesForMakeId(449) - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-vehicle-types-for-make.md b/apps/docs/src/guide/vpic/endpoints/get-vehicle-types-for-make.md similarity index 87% rename from apps/docs/src/api/endpoints/get-vehicle-types-for-make.md rename to apps/docs/src/guide/vpic/endpoints/get-vehicle-types-for-make.md index 96861239..669c26da 100644 --- a/apps/docs/src/api/endpoints/get-vehicle-types-for-make.md +++ b/apps/docs/src/guide/vpic/endpoints/get-vehicle-types-for-make.md @@ -10,7 +10,7 @@ async function GetVehicleTypesForMake( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetVehicleTypesForMake) +See: [Package Reference](../../../typedoc/api/endpoints/GetVehicleTypesForMake) ::: ## Description @@ -32,7 +32,7 @@ whose name is LIKE the make name in the vPIC Dataset. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -70,7 +70,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetVehicleTypesForMake/merc?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetVehicleTypesForMakeResults @@ -107,7 +107,7 @@ const response = await GetVehicleTypesForMake('merc') - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-vehicle-variable-list.md b/apps/docs/src/guide/vpic/endpoints/get-vehicle-variable-list.md similarity index 87% rename from apps/docs/src/api/endpoints/get-vehicle-variable-list.md rename to apps/docs/src/guide/vpic/endpoints/get-vehicle-variable-list.md index d4b6225c..a32b3f64 100644 --- a/apps/docs/src/api/endpoints/get-vehicle-variable-list.md +++ b/apps/docs/src/guide/vpic/endpoints/get-vehicle-variable-list.md @@ -9,7 +9,7 @@ async function GetVehicleVariableList( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetVehicleVariableList) +See: [Package Reference](../../../typedoc/api/endpoints/GetVehicleVariableList) ::: ## Description @@ -27,7 +27,7 @@ vPIC dataset. Information on the name, description and the type of the variable Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -65,7 +65,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/getvehiclevariablelist?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetVehicleVariableListResults @@ -102,7 +102,7 @@ const response = await GetVehicleVariableList() - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-vehicle-variable-values-list.md b/apps/docs/src/guide/vpic/endpoints/get-vehicle-variable-values-list.md similarity index 90% rename from apps/docs/src/api/endpoints/get-vehicle-variable-values-list.md rename to apps/docs/src/guide/vpic/endpoints/get-vehicle-variable-values-list.md index eb333c60..fa7f9a1f 100644 --- a/apps/docs/src/api/endpoints/get-vehicle-variable-values-list.md +++ b/apps/docs/src/guide/vpic/endpoints/get-vehicle-variable-values-list.md @@ -10,7 +10,7 @@ async function GetVehicleVariableValuesList( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetVehicleVariableValuesList) +See: [Package Reference](../../../typedoc/api/endpoints/GetVehicleVariableValuesList) ::: ## Description @@ -34,7 +34,7 @@ If `variableValue` is a string, it must use full name, not just part of it, e.g. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -72,7 +72,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetVehicleVariableValuesList/battery%20type?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetVehicleVariableValuesListResults @@ -117,7 +117,7 @@ const response = await GetVehicleVariableValuesList(1) - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/get-wmis-for-manufacturer.md b/apps/docs/src/guide/vpic/endpoints/get-wmis-for-manufacturer.md similarity index 93% rename from apps/docs/src/api/endpoints/get-wmis-for-manufacturer.md rename to apps/docs/src/guide/vpic/endpoints/get-wmis-for-manufacturer.md index e584f7e0..641ccf1c 100644 --- a/apps/docs/src/api/endpoints/get-wmis-for-manufacturer.md +++ b/apps/docs/src/guide/vpic/endpoints/get-wmis-for-manufacturer.md @@ -13,7 +13,7 @@ async function GetWMIsForManufacturer( ``` ::: tip :bulb: More In Depth -See: [Package Reference](../../typedoc/api/endpoints/GetWMIsForManufacturer) +See: [Package Reference](../../../typedoc/api/endpoints/GetWMIsForManufacturer) ::: ## Description @@ -58,7 +58,7 @@ Any `params` that are not listed in the table above will be ignored. Set `doFetch` to `false` if you want to fetch the data yourself. -- See [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) for more info. ::: @@ -96,7 +96,7 @@ Returns a URL string that can be used to fetch the data, does _not_ fetch the da // ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetVehicleVariableValuesList/battery%20type?format=json' ``` -::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +::: tip :bulb: See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) ::: ## Type - GetWMIsForManufacturerResults @@ -152,7 +152,7 @@ const response = await GetWMIsForManufacturer({ - Does _NOT_ fetch data from VPIC API -- See: [BYOF - Bring Your Own Fetch](../../guide/bring-your-own-fetch.md#option-1-set-dofetch-to-false) +- See: [BYOF - Bring Your Own Fetch](../../bring-your-own-fetch.md#option-1-set-dofetch-to-false) - Returns: diff --git a/apps/docs/src/api/endpoints/index.md b/apps/docs/src/guide/vpic/endpoints/index.md similarity index 100% rename from apps/docs/src/api/endpoints/index.md rename to apps/docs/src/guide/vpic/endpoints/index.md diff --git a/apps/docs/src/guide/vpic/index.md b/apps/docs/src/guide/vpic/index.md new file mode 100644 index 00000000..89eda811 --- /dev/null +++ b/apps/docs/src/guide/vpic/index.md @@ -0,0 +1,39 @@ +# API Reference + +--- + +This section of the documentation describes the main functions exported by this package, as well as +the response format returned by the NHTSA API. + +You can also find details of the VPIC API endpoints and what they return. + +## VPIC API Response + +- [VPIC API Response](./vpic-api-response) + +## VPIC API Endpoints + +- [DecodeVin](./endpoints/decode-vin) +- [DecodeVinExtended](./endpoints/decode-vin-extended) +- [DecodeVinValues](./endpoints/decode-vin-values) +- [DecodeVinValuesBatch](./endpoints/decode-vin-values-batch) +- [DecodeVinValuesExtended](./endpoints/decode-vin-values-extended) +- [DecodeWMI](./endpoints/decode-wmi) +- [GetAllMakes](./endpoints/get-all-makes) +- [GetAllManufacturers](./endpoints/get-all-manufacturers) +- [GetCanadianVehicleSpecifications](./endpoints/get-canadian-vehicle-specifications) +- [GetEquipmentPlantCodes](./endpoints/get-equipment-plant-codes) +- [GetMakeForManufacturer](./endpoints/get-make-for-manufacturer) +- [GetMakesForManufacturerAndYear](./endpoints/get-makes-for-manufacturer-and-year) +- [GetMakesForVehicleType](./endpoints/get-makes-for-vehicle-type) +- [GetManufacturerDetails](./endpoints/get-manufacturer-details) +- [GetModelsForMake](./endpoints/get-models-for-make) +- [GetModelsForMakeId](./endpoints/get-models-for-make-id) +- [GetModelsForMakeIdYear](./endpoints/get-models-for-make-id-year) +- [GetModelsForMakeYear](./endpoints/get-models-for-make-year) +- [GetParts](./endpoints/get-parts) +- [GetVehicleTypesForMake](./endpoints/get-vehicle-types-for-make) +- [GetVehicleTypesForMakeId](./endpoints/get-vehicle-types-for-make-id) +- [GetVehicleVariableList](./endpoints/get-vehicle-variable-list) +- [GetVehicleVariableValuesList](./endpoints/get-vehicle-variable-values-list) +- [GetWMIsForManufacturer](./endpoints/get-wmis-for-manufacturer) diff --git a/apps/docs/src/api/vpic-api-response.md b/apps/docs/src/guide/vpic/vpic-api-response.md similarity index 94% rename from apps/docs/src/api/vpic-api-response.md rename to apps/docs/src/guide/vpic/vpic-api-response.md index a7571b5a..54f6ba70 100644 --- a/apps/docs/src/api/vpic-api-response.md +++ b/apps/docs/src/guide/vpic/vpic-api-response.md @@ -134,11 +134,11 @@ type NhtsaResponse = { ``` ::: tip :bulb: TIP -Check out the [Api Reference](/api/) section for specific details on each -endpoint's `Results` array types. +Check out the [VPIC](/guide/vpic/) section for specific details on each endpoint's `Results` array +types. -Here's [DecodeVinResults](../api/endpoints/decode-vin#type-decodevinresults) that was mentioned in the above -example. +Here's [DecodeVinResults](./endpoints/decode-vin#type-decodevinresults) that was mentioned in +the above example. ::: ### SearchCriteria diff --git a/apps/docs/src/index.md b/apps/docs/src/index.md index 7bbb4aaf..0bdfdf58 100644 --- a/apps/docs/src/index.md +++ b/apps/docs/src/index.md @@ -19,7 +19,7 @@ hero: link: /guide/ - theme: alt text: VPIC Helper Functions - link: /api/ + link: /guide/vpic/ features: - title: Simplify the VPIC API diff --git a/apps/docs/src/parts/package-exports-types.md b/apps/docs/src/parts/package-exports-types.md index ca951ec9..0b5bb828 100644 --- a/apps/docs/src/parts/package-exports-types.md +++ b/apps/docs/src/parts/package-exports-types.md @@ -58,5 +58,5 @@ import type { ::: tip :bulb: TIP You can find specific details on each endpoint's `Results` types on their respective pages. -See [DecodeVinResults](../api/endpoints/decode-vin#type-decodevinresults) for example. +See [DecodeVinResults](../guide/vpic/endpoints/decode-vin#type-decodevinresults) for example. ::: diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeVin.md b/apps/docs/src/typedoc/api/endpoints/DecodeVin.md index 27de8d90..2414d85c 100644 --- a/apps/docs/src/typedoc/api/endpoints/DecodeVin.md +++ b/apps/docs/src/typedoc/api/endpoints/DecodeVin.md @@ -65,7 +65,7 @@ Last Updated: 02/14/2023 > **DecodeVin**(`vin`): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinResults`](DecodeVin.md#decodevinresults)\>\> ::: tip :bulb: More Information -See: [DecodeVin Documentation](/api/endpoints/decode-vin) +See: [DecodeVin Documentation](/guide/vpic/endpoints/decode-vin) ::: `DecodeVin` decodes a Vehicle Identification Number (VIN) and returns useful information about diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeVinExtended.md b/apps/docs/src/typedoc/api/endpoints/DecodeVinExtended.md index 85d375f5..64faf0de 100644 --- a/apps/docs/src/typedoc/api/endpoints/DecodeVinExtended.md +++ b/apps/docs/src/typedoc/api/endpoints/DecodeVinExtended.md @@ -65,7 +65,7 @@ Last Updated: 02/14/2023 > **DecodeVinExtended**(`vin`): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinExtendedResults`](DecodeVinExtended.md#decodevinextendedresults)\>\> ::: tip :bulb: More Information -See: [DecodeVinExtended Documentation](/api/endpoints/decode-vin-extended) +See: [DecodeVinExtended Documentation](/guide/vpic/endpoints/decode-vin-extended) ::: `DecodeVinExtended` decodes a Vehicle Identification Number (VIN) and returns useful information diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeVinValues.md b/apps/docs/src/typedoc/api/endpoints/DecodeVinValues.md index 0c21fe0a..7b246893 100644 --- a/apps/docs/src/typedoc/api/endpoints/DecodeVinValues.md +++ b/apps/docs/src/typedoc/api/endpoints/DecodeVinValues.md @@ -208,7 +208,7 @@ Single object found in the `Results` array of `DecodeVinValues` endpoint respons > **DecodeVinValues**(`vin`): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesResults`](DecodeVinValues.md#decodevinvaluesresults)\>\> ::: tip :bulb: More Information -See: [DecodeVinValues Documentation](/api/endpoints/decode-vin-values) +See: [DecodeVinValues Documentation](/guide/vpic/endpoints/decode-vin-values) ::: `DecodeVinValues` decodes a Vehicle Identification Number (VIN) and returns useful information diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesBatch.md b/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesBatch.md index bfbd533f..d8f067a4 100644 --- a/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesBatch.md +++ b/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesBatch.md @@ -189,7 +189,7 @@ Objects found in the `Results` array of `DecodeVinValuesBatch` endpoint response > **DecodeVinValuesBatch**(`inputString`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesBatchResults`](DecodeVinValuesBatch.md#decodevinvaluesbatchresults)\>\> ::: tip :bulb: More Information -See: [DecodeVinValuesBatch Documentation](/api/endpoints/decode-vin-values-batch) +See: [DecodeVinValuesBatch Documentation](/guide/vpic/endpoints/decode-vin-values-batch) ::: `DecodeVinValuesBatch` decodes a batch of Vehicle Identification Numbers (VINs) and returns diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesExtended.md b/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesExtended.md index a2d0ccbc..51d7499e 100644 --- a/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesExtended.md +++ b/apps/docs/src/typedoc/api/endpoints/DecodeVinValuesExtended.md @@ -189,7 +189,7 @@ Single object found in the `Results` array of `DecodeVinValuesExtended` endpoint > **DecodeVinValuesExtended**(`vin`): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeVinValuesExtendedResults`](DecodeVinValuesExtended.md#decodevinvaluesextendedresults)\>\> ::: tip :bulb: More Information -See: [DecodeVinValuesExtended Documentation](/api/endpoints/decode-vin-values-extended) +See: [DecodeVinValuesExtended Documentation](/guide/vpic/endpoints/decode-vin-values-extended) ::: `DecodeVinValuesExtended` decodes a Vehicle Identification Number (VIN) and returns useful diff --git a/apps/docs/src/typedoc/api/endpoints/DecodeWMI.md b/apps/docs/src/typedoc/api/endpoints/DecodeWMI.md index b576ded7..14b17907 100644 --- a/apps/docs/src/typedoc/api/endpoints/DecodeWMI.md +++ b/apps/docs/src/typedoc/api/endpoints/DecodeWMI.md @@ -48,7 +48,7 @@ Objects found in the `Results` array of `DecodeWMI` endpoint response. > **DecodeWMI**(`WMI`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`DecodeWMIResults`](DecodeWMI.md#decodewmiresults)\>\> ::: tip :bulb: More Information -See: [DecodeWMI Documentation](/api/endpoints/decode-wmi) +See: [DecodeWMI Documentation](/guide/vpic/endpoints/decode-wmi) ::: `DecodeWMI` provides information on the World Manufacturer Identifier for a specific `WMI` code. diff --git a/apps/docs/src/typedoc/api/endpoints/GetAllMakes.md b/apps/docs/src/typedoc/api/endpoints/GetAllMakes.md index 1e7352aa..23148fa7 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetAllMakes.md +++ b/apps/docs/src/typedoc/api/endpoints/GetAllMakes.md @@ -41,7 +41,7 @@ Objects found in the `Results` array of `GetAllMakes` endpoint response. > **GetAllMakes**(`doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetAllMakesResults`](GetAllMakes.md#getallmakesresults)\>\> ::: tip :bulb: More Information -See: [GetAllMakes Documentation](/api/endpoints/get-all-makes) +See: [GetAllMakes Documentation](/guide/vpic/endpoints/get-all-makes) ::: `GetAllMakes` provides a list of all the Makes available in the vPIC Dataset. diff --git a/apps/docs/src/typedoc/api/endpoints/GetAllManufacturers.md b/apps/docs/src/typedoc/api/endpoints/GetAllManufacturers.md index 8a920709..d45b4d74 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetAllManufacturers.md +++ b/apps/docs/src/typedoc/api/endpoints/GetAllManufacturers.md @@ -44,7 +44,7 @@ Objects found in the `Results` array of `GetAllManufacturers` endpoint response. > **GetAllManufacturers**(`doFetch`?, `_dummy`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetAllManufacturersResults`](GetAllManufacturers.md#getallmanufacturersresults)\>\> ::: tip :bulb: More Information -See: [GetAllManufacturers Documentation](/api/endpoints/get-all-manufacturers) +See: [GetAllManufacturers Documentation](/guide/vpic/endpoints/get-all-manufacturers) ::: `GetAllManufacturers` provides a list of all the Manufacturers available in the vPIC Dataset. diff --git a/apps/docs/src/typedoc/api/endpoints/GetCanadianVehicleSpecifications.md b/apps/docs/src/typedoc/api/endpoints/GetCanadianVehicleSpecifications.md index 33f7fcbd..64e934fb 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetCanadianVehicleSpecifications.md +++ b/apps/docs/src/typedoc/api/endpoints/GetCanadianVehicleSpecifications.md @@ -40,7 +40,7 @@ Objects found in the `Results` array of `GetCanadianVehicleSpecifications` endpo > **GetCanadianVehicleSpecifications**(`params`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetCanadianVehicleSpecificationsResults`](GetCanadianVehicleSpecifications.md#getcanadianvehiclespecificationsresults)\>\> ::: tip :bulb: More Information -See: [GetCanadianVehicleSpecifications Documentation](/api/endpoints/get-canadian-vehicle-specifications) +See: [GetCanadianVehicleSpecifications Documentation](/guide/vpic/endpoints/get-canadian-vehicle-specifications) ::: `GetCanadianVehicleSpecifications` returns data from the Canadian Vehicle Specifications (CVS). diff --git a/apps/docs/src/typedoc/api/endpoints/GetEquipmentPlantCodes.md b/apps/docs/src/typedoc/api/endpoints/GetEquipmentPlantCodes.md index e1db393b..4e098355 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetEquipmentPlantCodes.md +++ b/apps/docs/src/typedoc/api/endpoints/GetEquipmentPlantCodes.md @@ -69,7 +69,7 @@ Objects found in the `Results` array of `GetEquipmentPlantCodes` endpoint respon > **GetEquipmentPlantCodes**(`params`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetEquipmentPlantCodesResults`](GetEquipmentPlantCodes.md#getequipmentplantcodesresults)\>\> ::: tip :bulb: More Information -See: [GetEquipmentPlantCodes Documentation](/api/endpoints/get-equipment-plant-codes) +See: [GetEquipmentPlantCodes Documentation](/guide/vpic/endpoints/get-equipment-plant-codes) ::: `GetEquipmentPlantCodes` returns assigned Equipment Plant Codes. Can be filtered by Year, diff --git a/apps/docs/src/typedoc/api/endpoints/GetMakeForManufacturer.md b/apps/docs/src/typedoc/api/endpoints/GetMakeForManufacturer.md index 7751060d..fa20bee6 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetMakeForManufacturer.md +++ b/apps/docs/src/typedoc/api/endpoints/GetMakeForManufacturer.md @@ -42,7 +42,7 @@ Objects found in the `Results` array of `GetMakeForManufacturer` endpoint respon > **GetMakeForManufacturer**(`manufacturer`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetMakeForManufacturerResults`](GetMakeForManufacturer.md#getmakeformanufacturerresults)\>\> ::: tip :bulb: More Information -See: [GetMakeForManufacturer Documentation](/api/endpoints/get-make-for-manufacturer) +See: [GetMakeForManufacturer Documentation](/guide/vpic/endpoints/get-make-for-manufacturer) ::: `GetMakeForManufacturer` returns all the Makes in the vPIC dataset for a specified manufacturer diff --git a/apps/docs/src/typedoc/api/endpoints/GetMakesForManufacturerAndYear.md b/apps/docs/src/typedoc/api/endpoints/GetMakesForManufacturerAndYear.md index 11ad48e9..0cd67de8 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetMakesForManufacturerAndYear.md +++ b/apps/docs/src/typedoc/api/endpoints/GetMakesForManufacturerAndYear.md @@ -43,7 +43,7 @@ Objects found in the `Results` array of `GetMakesForManufacturerAndYear` endpoin > **GetMakesForManufacturerAndYear**(`manufacturer`, `params`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetMakesForManufacturerAndYearResults`](GetMakesForManufacturerAndYear.md#getmakesformanufacturerandyearresults)\>\> ::: tip :bulb: More Information -See: [GetMakesForManufacturerAndYear Documentation](/api/endpoints/get-makes-for-manufacturer-and-year) +See: [GetMakesForManufacturerAndYear Documentation](/guide/vpic/endpoints/get-makes-for-manufacturer-and-year) ::: `GetMakesForManufacturerAndYear` returns all the Makes in the vPIC dataset for a specified diff --git a/apps/docs/src/typedoc/api/endpoints/GetMakesForVehicleType.md b/apps/docs/src/typedoc/api/endpoints/GetMakesForVehicleType.md index e9f143bc..62b89b43 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetMakesForVehicleType.md +++ b/apps/docs/src/typedoc/api/endpoints/GetMakesForVehicleType.md @@ -43,7 +43,7 @@ Objects found in the `Results` array of `GetMakesForVehicleType` endpoint respon > **GetMakesForVehicleType**(`typeName`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetMakesForVehicleTypeResults`](GetMakesForVehicleType.md#getmakesforvehicletyperesults)\>\> ::: tip :bulb: More Information -See: [GetMakesForVehicleType Documentation](/api/endpoints/get-makes-for-vehicle-type) +See: [GetMakesForVehicleType Documentation](/guide/vpic/endpoints/get-makes-for-vehicle-type) ::: `GetMakesForVehicleType` returns all the Makes in the vPIC dataset for a specified vehicle type diff --git a/apps/docs/src/typedoc/api/endpoints/GetManufacturerDetails.md b/apps/docs/src/typedoc/api/endpoints/GetManufacturerDetails.md index 6874b151..f7585bd9 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetManufacturerDetails.md +++ b/apps/docs/src/typedoc/api/endpoints/GetManufacturerDetails.md @@ -64,7 +64,7 @@ Objects found in the `Results` array of `GetManufacturerDetails` endpoint respon > **GetManufacturerDetails**(`manufacturer`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetManufacturerDetailsResults`](GetManufacturerDetails.md#getmanufacturerdetailsresults)\>\> ::: tip :bulb: More Information -See: [GetMakesForVehicleType Documentation](/api/endpoints/get-makes-for-vehicle-type) +See: [GetMakesForVehicleType Documentation](/guide/vpic/endpoints/get-makes-for-vehicle-type) ::: `GetManufacturerDetails` provides the details for a specific manufacturer that is requested. diff --git a/apps/docs/src/typedoc/api/endpoints/GetModelsForMake.md b/apps/docs/src/typedoc/api/endpoints/GetModelsForMake.md index 2a152a71..7940d3a2 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetModelsForMake.md +++ b/apps/docs/src/typedoc/api/endpoints/GetModelsForMake.md @@ -43,7 +43,7 @@ Objects found in the `Results` array of `GetModelsForMake` endpoint response. > **GetModelsForMake**(`makeName`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeResults`](GetModelsForMake.md#getmodelsformakeresults)\>\> ::: tip :bulb: More Information -See: [GetModelsForMake Documentation](/api/endpoints/get-models-for-make) +See: [GetModelsForMake Documentation](/guide/vpic/endpoints/get-models-for-make) ::: `GetModelsForMake` returns the Models in the vPIC dataset for a specified `makeName` diff --git a/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeId.md b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeId.md index 58824b93..4e1c5682 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeId.md +++ b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeId.md @@ -43,7 +43,7 @@ Objects found in the `Results` array of `GetModelsForMakeId` endpoint response. > **GetModelsForMakeId**(`makeId`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeIdResults`](GetModelsForMakeId.md#getmodelsformakeidresults)\>\> ::: tip :bulb: More Information -See: [GetModelsForMakeId Documentation](/api/endpoints/get-models-for-make-id) +See: [GetModelsForMakeId Documentation](/guide/vpic/endpoints/get-models-for-make-id) ::: `GetModelsForMakeId` returns the Models in the vPIC dataset for a specified Make whose ID is diff --git a/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeIdYear.md b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeIdYear.md index cd432faf..eb1901a0 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeIdYear.md +++ b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeIdYear.md @@ -43,7 +43,7 @@ Objects found in the `Results` array of `GetModelsForMakeIdYear` endpoint respon > **GetModelsForMakeIdYear**(`params`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeIdYearResults`](GetModelsForMakeIdYear.md#getmodelsformakeidyearresults)\>\> ::: tip :bulb: More Information -See: [GetModelsForMakeIdYear Documentation](/api/endpoints/get-models-for-make-id-year) +See: [GetModelsForMakeIdYear Documentation](/guide/vpic/endpoints/get-models-for-make-id-year) ::: `GetModelsForMakeIdYear` returns the Models in the vPIC dataset for a specified Model Year diff --git a/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeYear.md b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeYear.md index f1d87357..6442e78a 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeYear.md +++ b/apps/docs/src/typedoc/api/endpoints/GetModelsForMakeYear.md @@ -43,7 +43,7 @@ Objects found in the `Results` array of `GetModelsForMakeYear` endpoint response > **GetModelsForMakeYear**(`params`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetModelsForMakeYearResults`](GetModelsForMakeYear.md#getmodelsformakeyearresults)\>\> ::: tip :bulb: More Information -See: [GetModelsForMakeYear Documentation](/api/endpoints/get-models-for-make-year) +See: [GetModelsForMakeYear Documentation](/guide/vpic/endpoints/get-models-for-make-year) ::: `GetModelsForMakeYear` returns the Models in the vPIC dataset for a specified Model Year and diff --git a/apps/docs/src/typedoc/api/endpoints/GetParts.md b/apps/docs/src/typedoc/api/endpoints/GetParts.md index 95a62555..8fa85ce1 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetParts.md +++ b/apps/docs/src/typedoc/api/endpoints/GetParts.md @@ -48,7 +48,7 @@ Objects found in the `Results` array of `GetParts` endpoint response. > **GetParts**(`doFetch`?, `_dummy`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetPartsResults`](GetParts.md#getpartsresults)\>\> ::: tip :bulb: More Information -See: [GetParts Documentation](/api/endpoints/get-parts) +See: [GetParts Documentation](/guide/vpic/endpoints/get-parts) ::: `GetParts` provides a list of ORGs with letter date in the given range of the dates and with diff --git a/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMake.md b/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMake.md index 44160e05..1780c7e1 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMake.md +++ b/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMake.md @@ -43,7 +43,7 @@ Objects found in the `Results` array of `GetVehicleTypesForMake` endpoint respon > **GetVehicleTypesForMake**(`makeName`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleTypesForMakeResults`](GetVehicleTypesForMake.md#getvehicletypesformakeresults)\>\> ::: tip :bulb: More Information -See: [GetVehicleTypesForMake Documentation](/api/endpoints/get-vehicle-types-for-make) +See: [GetVehicleTypesForMake Documentation](/guide/vpic/endpoints/get-vehicle-types-for-make) ::: `GetVehicleTypesForMake` returns all the Vehicle Types in the vPIC dataset for a specified Make, diff --git a/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMakeId.md b/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMakeId.md index 0ef1a8a9..f17538c5 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMakeId.md +++ b/apps/docs/src/typedoc/api/endpoints/GetVehicleTypesForMakeId.md @@ -41,7 +41,7 @@ Objects found in the `Results` array of `GetVehicleTypesForMakeId` endpoint resp > **GetVehicleTypesForMakeId**(`makeId`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleTypesForMakeIdResults`](GetVehicleTypesForMakeId.md#getvehicletypesformakeidresults)\>\> ::: tip :bulb: More Information -See: [GetVehicleTypesForMakeId Documentation](/api/endpoints/get-vehicle-types-for-make-id) +See: [GetVehicleTypesForMakeId Documentation](/guide/vpic/endpoints/get-vehicle-types-for-make-id) ::: `GetVehicleTypesForMakeId` returns the Models in the vPIC dataset for a specified Make diff --git a/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableList.md b/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableList.md index badbffa6..1c94d9ca 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableList.md +++ b/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableList.md @@ -44,7 +44,7 @@ Objects found in the `Results` array of `GetVehicleVariableList` endpoint respon > **GetVehicleVariableList**(`doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleVariableListResults`](GetVehicleVariableList.md#getvehiclevariablelistresults)\>\> ::: tip :bulb: More Information -See: [GetVehicleVariableList Documentation](/api/endpoints/get-vehicle-variable-list) +See: [GetVehicleVariableList Documentation](/guide/vpic/endpoints/get-vehicle-variable-list) ::: `GetVehicleVariableList` provides a list of all the Vehicle related variables that are in the diff --git a/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableValuesList.md b/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableValuesList.md index ff730409..9b0e8785 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableValuesList.md +++ b/apps/docs/src/typedoc/api/endpoints/GetVehicleVariableValuesList.md @@ -42,7 +42,7 @@ Objects found in the `Results` array of `GetVehicleVariableValuesList` endpoint > **GetVehicleVariableValuesList**(`variableValue`, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetVehicleVariableValuesListResults`](GetVehicleVariableValuesList.md#getvehiclevariablevalueslistresults)\>\> ::: tip :bulb: More Information -See: [GetVehicleVariableValuesList Documentation](/api/endpoints/get-vehicle-variable-values-list) +See: [GetVehicleVariableValuesList Documentation](/guide/vpic/endpoints/get-vehicle-variable-values-list) ::: `GetVehicleVariableValuesList` provides a list of all the accepted values for a given variable diff --git a/apps/docs/src/typedoc/api/endpoints/GetWMIsForManufacturer.md b/apps/docs/src/typedoc/api/endpoints/GetWMIsForManufacturer.md index 045861b4..2c81f096 100644 --- a/apps/docs/src/typedoc/api/endpoints/GetWMIsForManufacturer.md +++ b/apps/docs/src/typedoc/api/endpoints/GetWMIsForManufacturer.md @@ -47,7 +47,7 @@ Objects found in the `Results` array of `GetWMIsForManufacturer` endpoint respon > **GetWMIsForManufacturer**(`params`?, `doFetch`?): `Promise`\<[`NhtsaResponse`](../types.md#nhtsaresponset)\<[`GetWMIsForManufacturerResults`](GetWMIsForManufacturer.md#getwmisformanufacturerresults)\>\> ::: tip :bulb: More Information -See: [GetWMIsForManufacturer Documentation](/api/endpoints/get-wmis-for-manufacturer) +See: [GetWMIsForManufacturer Documentation](/guide/vpic/endpoints/get-wmis-for-manufacturer) ::: `GetWMIsForManufacturer` provides information on the World Manufacturer Identifier (WMI) for a diff --git a/apps/docs/src/utils/use-nhtsa.md b/apps/docs/src/utils/use-nhtsa.md index 7942c9a0..32568775 100644 --- a/apps/docs/src/utils/use-nhtsa.md +++ b/apps/docs/src/utils/use-nhtsa.md @@ -40,7 +40,7 @@ API. It is used internally by the package and by users to make direct requests t It contains functions for making HTTP requests to the VPIC API. All request methods return a Promise that resolves to an object containing the full response data. See the -[VPIC API Response](../api/vpic-api-response) page for more info on the full response returned by the +[VPIC API Response](../guide/vpic/vpic-api-response) page for more info on the full response returned by the request functions. It also contains functions for building and returning the URL string for the VPIC API endpoints. @@ -161,7 +161,7 @@ get() [`CreateUrlOptions`](../typedoc/api/useNHTSA#createurloptions): -- `endpointName` - The name of the endpoint to use, see [VPIC API Endpoints](../api/#vpic-api-endpoints) +- `endpointName` - The name of the endpoint to use, see [VPIC API Endpoints](../guide/vpic/#vpic-api-endpoints) (required) - `path` - The final path to use in the full url path (default: `""`) diff --git a/packages/lib/README.md b/packages/lib/README.md index 21f68e14..e8b523d1 100644 --- a/packages/lib/README.md +++ b/packages/lib/README.md @@ -61,7 +61,7 @@ WMIs, get all makes for a certain year, and more. - [Install](https://vpic.shaggytech.com/guide/install) - [Node Quick Start](https://vpic.shaggytech.com//guide/getting-started#node-quick-start) - [Browser Quick Start](https://vpic.shaggytech.com/guide/getting-started#browser-quick-start) -- [API Reference](https://vpic.shaggytech.com/api/) +- [VPIC Reference](https://vpic.shaggytech.com/guide/vpic/) ## Node Install @@ -112,9 +112,9 @@ const { Results } = await DecodeVinValues('WA1A4AFY2J2008189') const decodedVehicle = Results[0] // equals an object of type DecodeVinValuesResults ``` -For a full example response see: [DecodeVinValues](https://vpic.shaggytech.com/api/endpoints/decode-vin-values#returns) +For a full example response see: [DecodeVinValues](https://vpic.shaggytech.com/guide/vpic/endpoints/decode-vin-values#returns) -All available endpoints can be found here: [VPIC API Endpoints](https://vpic.shaggytech.com/api/#vpic-api-endpoints) +All available endpoints can be found here: [VPIC API Endpoints](https://vpic.shaggytech.com/guide/vpic/#vpic-api-endpoints) ## Browser Install diff --git a/packages/lib/src/api/endpoints/DecodeVin.ts b/packages/lib/src/api/endpoints/DecodeVin.ts index 764f6fbc..102df463 100644 --- a/packages/lib/src/api/endpoints/DecodeVin.ts +++ b/packages/lib/src/api/endpoints/DecodeVin.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [DecodeVin Documentation](/api/endpoints/decode-vin) + * See: [DecodeVin Documentation](/guide/vpic/endpoints/decode-vin) * ::: * * `DecodeVin` decodes a Vehicle Identification Number (VIN) and returns useful information about diff --git a/packages/lib/src/api/endpoints/DecodeVinExtended.ts b/packages/lib/src/api/endpoints/DecodeVinExtended.ts index edfe61fb..7ee80078 100644 --- a/packages/lib/src/api/endpoints/DecodeVinExtended.ts +++ b/packages/lib/src/api/endpoints/DecodeVinExtended.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [DecodeVinExtended Documentation](/api/endpoints/decode-vin-extended) + * See: [DecodeVinExtended Documentation](/guide/vpic/endpoints/decode-vin-extended) * ::: * * `DecodeVinExtended` decodes a Vehicle Identification Number (VIN) and returns useful information diff --git a/packages/lib/src/api/endpoints/DecodeVinValues.ts b/packages/lib/src/api/endpoints/DecodeVinValues.ts index 3c38def6..581a2863 100644 --- a/packages/lib/src/api/endpoints/DecodeVinValues.ts +++ b/packages/lib/src/api/endpoints/DecodeVinValues.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [DecodeVinValues Documentation](/api/endpoints/decode-vin-values) + * See: [DecodeVinValues Documentation](/guide/vpic/endpoints/decode-vin-values) * ::: * * `DecodeVinValues` decodes a Vehicle Identification Number (VIN) and returns useful information diff --git a/packages/lib/src/api/endpoints/DecodeVinValuesBatch.ts b/packages/lib/src/api/endpoints/DecodeVinValuesBatch.ts index 47f4ad47..5391a73c 100644 --- a/packages/lib/src/api/endpoints/DecodeVinValuesBatch.ts +++ b/packages/lib/src/api/endpoints/DecodeVinValuesBatch.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [DecodeVinValuesBatch Documentation](/api/endpoints/decode-vin-values-batch) + * See: [DecodeVinValuesBatch Documentation](/guide/vpic/endpoints/decode-vin-values-batch) * ::: * * `DecodeVinValuesBatch` decodes a batch of Vehicle Identification Numbers (VINs) and returns diff --git a/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts b/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts index f91b622a..3b3a084e 100644 --- a/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts +++ b/packages/lib/src/api/endpoints/DecodeVinValuesExtended.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [DecodeVinValuesExtended Documentation](/api/endpoints/decode-vin-values-extended) + * See: [DecodeVinValuesExtended Documentation](/guide/vpic/endpoints/decode-vin-values-extended) * ::: * * `DecodeVinValuesExtended` decodes a Vehicle Identification Number (VIN) and returns useful diff --git a/packages/lib/src/api/endpoints/DecodeWMI.ts b/packages/lib/src/api/endpoints/DecodeWMI.ts index 3c988c4d..6cf20e0c 100644 --- a/packages/lib/src/api/endpoints/DecodeWMI.ts +++ b/packages/lib/src/api/endpoints/DecodeWMI.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [DecodeWMI Documentation](/api/endpoints/decode-wmi) + * See: [DecodeWMI Documentation](/guide/vpic/endpoints/decode-wmi) * ::: * * `DecodeWMI` provides information on the World Manufacturer Identifier for a specific `WMI` code. diff --git a/packages/lib/src/api/endpoints/GetAllMakes.ts b/packages/lib/src/api/endpoints/GetAllMakes.ts index b1aae13a..88bc3bba 100644 --- a/packages/lib/src/api/endpoints/GetAllMakes.ts +++ b/packages/lib/src/api/endpoints/GetAllMakes.ts @@ -9,7 +9,7 @@ import type { NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetAllMakes Documentation](/api/endpoints/get-all-makes) + * See: [GetAllMakes Documentation](/guide/vpic/endpoints/get-all-makes) * ::: * * `GetAllMakes` provides a list of all the Makes available in the vPIC Dataset. diff --git a/packages/lib/src/api/endpoints/GetAllManufacturers.ts b/packages/lib/src/api/endpoints/GetAllManufacturers.ts index 1ef6de48..828d43ad 100644 --- a/packages/lib/src/api/endpoints/GetAllManufacturers.ts +++ b/packages/lib/src/api/endpoints/GetAllManufacturers.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetAllManufacturers Documentation](/api/endpoints/get-all-manufacturers) + * See: [GetAllManufacturers Documentation](/guide/vpic/endpoints/get-all-manufacturers) * ::: * * `GetAllManufacturers` provides a list of all the Manufacturers available in the vPIC Dataset. diff --git a/packages/lib/src/api/endpoints/GetCanadianVehicleSpecifications.ts b/packages/lib/src/api/endpoints/GetCanadianVehicleSpecifications.ts index 7813e970..e7162123 100644 --- a/packages/lib/src/api/endpoints/GetCanadianVehicleSpecifications.ts +++ b/packages/lib/src/api/endpoints/GetCanadianVehicleSpecifications.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetCanadianVehicleSpecifications Documentation](/api/endpoints/get-canadian-vehicle-specifications) + * See: [GetCanadianVehicleSpecifications Documentation](/guide/vpic/endpoints/get-canadian-vehicle-specifications) * ::: * * `GetCanadianVehicleSpecifications` returns data from the Canadian Vehicle Specifications (CVS). diff --git a/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts b/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts index 8542bffd..912ffb81 100644 --- a/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts +++ b/packages/lib/src/api/endpoints/GetEquipmentPlantCodes.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetEquipmentPlantCodes Documentation](/api/endpoints/get-equipment-plant-codes) + * See: [GetEquipmentPlantCodes Documentation](/guide/vpic/endpoints/get-equipment-plant-codes) * ::: * * `GetEquipmentPlantCodes` returns assigned Equipment Plant Codes. Can be filtered by Year, diff --git a/packages/lib/src/api/endpoints/GetMakeForManufacturer.ts b/packages/lib/src/api/endpoints/GetMakeForManufacturer.ts index 3acf0c84..f0bba5be 100644 --- a/packages/lib/src/api/endpoints/GetMakeForManufacturer.ts +++ b/packages/lib/src/api/endpoints/GetMakeForManufacturer.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetMakeForManufacturer Documentation](/api/endpoints/get-make-for-manufacturer) + * See: [GetMakeForManufacturer Documentation](/guide/vpic/endpoints/get-make-for-manufacturer) * ::: * * `GetMakeForManufacturer` returns all the Makes in the vPIC dataset for a specified manufacturer diff --git a/packages/lib/src/api/endpoints/GetMakesForManufacturerAndYear.ts b/packages/lib/src/api/endpoints/GetMakesForManufacturerAndYear.ts index 99f9a3de..952fd2f4 100644 --- a/packages/lib/src/api/endpoints/GetMakesForManufacturerAndYear.ts +++ b/packages/lib/src/api/endpoints/GetMakesForManufacturerAndYear.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetMakesForManufacturerAndYear Documentation](/api/endpoints/get-makes-for-manufacturer-and-year) + * See: [GetMakesForManufacturerAndYear Documentation](/guide/vpic/endpoints/get-makes-for-manufacturer-and-year) * ::: * * `GetMakesForManufacturerAndYear` returns all the Makes in the vPIC dataset for a specified diff --git a/packages/lib/src/api/endpoints/GetMakesForVehicleType.ts b/packages/lib/src/api/endpoints/GetMakesForVehicleType.ts index af1cd3b4..c6acf0d7 100644 --- a/packages/lib/src/api/endpoints/GetMakesForVehicleType.ts +++ b/packages/lib/src/api/endpoints/GetMakesForVehicleType.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetMakesForVehicleType Documentation](/api/endpoints/get-makes-for-vehicle-type) + * See: [GetMakesForVehicleType Documentation](/guide/vpic/endpoints/get-makes-for-vehicle-type) * ::: * * `GetMakesForVehicleType` returns all the Makes in the vPIC dataset for a specified vehicle type diff --git a/packages/lib/src/api/endpoints/GetManufacturerDetails.ts b/packages/lib/src/api/endpoints/GetManufacturerDetails.ts index 3864bd2b..c0138823 100644 --- a/packages/lib/src/api/endpoints/GetManufacturerDetails.ts +++ b/packages/lib/src/api/endpoints/GetManufacturerDetails.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetMakesForVehicleType Documentation](/api/endpoints/get-makes-for-vehicle-type) + * See: [GetMakesForVehicleType Documentation](/guide/vpic/endpoints/get-makes-for-vehicle-type) * ::: * * `GetManufacturerDetails` provides the details for a specific manufacturer that is requested. diff --git a/packages/lib/src/api/endpoints/GetModelsForMake.ts b/packages/lib/src/api/endpoints/GetModelsForMake.ts index 2c0ca311..f8b57c07 100644 --- a/packages/lib/src/api/endpoints/GetModelsForMake.ts +++ b/packages/lib/src/api/endpoints/GetModelsForMake.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetModelsForMake Documentation](/api/endpoints/get-models-for-make) + * See: [GetModelsForMake Documentation](/guide/vpic/endpoints/get-models-for-make) * ::: * * `GetModelsForMake` returns the Models in the vPIC dataset for a specified `makeName` diff --git a/packages/lib/src/api/endpoints/GetModelsForMakeId.ts b/packages/lib/src/api/endpoints/GetModelsForMakeId.ts index a9470d0b..096be823 100644 --- a/packages/lib/src/api/endpoints/GetModelsForMakeId.ts +++ b/packages/lib/src/api/endpoints/GetModelsForMakeId.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetModelsForMakeId Documentation](/api/endpoints/get-models-for-make-id) + * See: [GetModelsForMakeId Documentation](/guide/vpic/endpoints/get-models-for-make-id) * ::: * * `GetModelsForMakeId` returns the Models in the vPIC dataset for a specified Make whose ID is diff --git a/packages/lib/src/api/endpoints/GetModelsForMakeIdYear.ts b/packages/lib/src/api/endpoints/GetModelsForMakeIdYear.ts index 78a174bd..7b6b9536 100644 --- a/packages/lib/src/api/endpoints/GetModelsForMakeIdYear.ts +++ b/packages/lib/src/api/endpoints/GetModelsForMakeIdYear.ts @@ -13,7 +13,7 @@ import type { IArgToValidate, NhtsaResponse, AtLeastOne } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetModelsForMakeIdYear Documentation](/api/endpoints/get-models-for-make-id-year) + * See: [GetModelsForMakeIdYear Documentation](/guide/vpic/endpoints/get-models-for-make-id-year) * ::: * * `GetModelsForMakeIdYear` returns the Models in the vPIC dataset for a specified Model Year diff --git a/packages/lib/src/api/endpoints/GetModelsForMakeYear.ts b/packages/lib/src/api/endpoints/GetModelsForMakeYear.ts index 2ec51f5b..8e250d65 100644 --- a/packages/lib/src/api/endpoints/GetModelsForMakeYear.ts +++ b/packages/lib/src/api/endpoints/GetModelsForMakeYear.ts @@ -13,7 +13,7 @@ import type { NhtsaResponse, IArgToValidate, AtLeastOne } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetModelsForMakeYear Documentation](/api/endpoints/get-models-for-make-year) + * See: [GetModelsForMakeYear Documentation](/guide/vpic/endpoints/get-models-for-make-year) * ::: * * `GetModelsForMakeYear` returns the Models in the vPIC dataset for a specified Model Year and diff --git a/packages/lib/src/api/endpoints/GetParts.ts b/packages/lib/src/api/endpoints/GetParts.ts index 7d857a32..7142abca 100644 --- a/packages/lib/src/api/endpoints/GetParts.ts +++ b/packages/lib/src/api/endpoints/GetParts.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetParts Documentation](/api/endpoints/get-parts) + * See: [GetParts Documentation](/guide/vpic/endpoints/get-parts) * ::: * * `GetParts` provides a list of ORGs with letter date in the given range of the dates and with diff --git a/packages/lib/src/api/endpoints/GetVehicleTypesForMake.ts b/packages/lib/src/api/endpoints/GetVehicleTypesForMake.ts index 846dae1f..108bf948 100644 --- a/packages/lib/src/api/endpoints/GetVehicleTypesForMake.ts +++ b/packages/lib/src/api/endpoints/GetVehicleTypesForMake.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetVehicleTypesForMake Documentation](/api/endpoints/get-vehicle-types-for-make) + * See: [GetVehicleTypesForMake Documentation](/guide/vpic/endpoints/get-vehicle-types-for-make) * ::: * * `GetVehicleTypesForMake` returns all the Vehicle Types in the vPIC dataset for a specified Make, diff --git a/packages/lib/src/api/endpoints/GetVehicleTypesForMakeId.ts b/packages/lib/src/api/endpoints/GetVehicleTypesForMakeId.ts index bf27a14d..e52e64a5 100644 --- a/packages/lib/src/api/endpoints/GetVehicleTypesForMakeId.ts +++ b/packages/lib/src/api/endpoints/GetVehicleTypesForMakeId.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetVehicleTypesForMakeId Documentation](/api/endpoints/get-vehicle-types-for-make-id) + * See: [GetVehicleTypesForMakeId Documentation](/guide/vpic/endpoints/get-vehicle-types-for-make-id) * ::: * * `GetVehicleTypesForMakeId` returns the Models in the vPIC dataset for a specified Make diff --git a/packages/lib/src/api/endpoints/GetVehicleVariableList.ts b/packages/lib/src/api/endpoints/GetVehicleVariableList.ts index a8b57a1a..85d75855 100644 --- a/packages/lib/src/api/endpoints/GetVehicleVariableList.ts +++ b/packages/lib/src/api/endpoints/GetVehicleVariableList.ts @@ -9,7 +9,7 @@ import type { NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetVehicleVariableList Documentation](/api/endpoints/get-vehicle-variable-list) + * See: [GetVehicleVariableList Documentation](/guide/vpic/endpoints/get-vehicle-variable-list) * ::: * * `GetVehicleVariableList` provides a list of all the Vehicle related variables that are in the diff --git a/packages/lib/src/api/endpoints/GetVehicleVariableValuesList.ts b/packages/lib/src/api/endpoints/GetVehicleVariableValuesList.ts index 08349d61..88d985fc 100644 --- a/packages/lib/src/api/endpoints/GetVehicleVariableValuesList.ts +++ b/packages/lib/src/api/endpoints/GetVehicleVariableValuesList.ts @@ -9,7 +9,7 @@ import type { IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetVehicleVariableValuesList Documentation](/api/endpoints/get-vehicle-variable-values-list) + * See: [GetVehicleVariableValuesList Documentation](/guide/vpic/endpoints/get-vehicle-variable-values-list) * ::: * * `GetVehicleVariableValuesList` provides a list of all the accepted values for a given variable diff --git a/packages/lib/src/api/endpoints/GetWMIsForManufacturer.ts b/packages/lib/src/api/endpoints/GetWMIsForManufacturer.ts index e31e4184..8f91b807 100644 --- a/packages/lib/src/api/endpoints/GetWMIsForManufacturer.ts +++ b/packages/lib/src/api/endpoints/GetWMIsForManufacturer.ts @@ -9,7 +9,7 @@ import type { AtLeastOne, IArgToValidate, NhtsaResponse } from '@/types' /** * ::: tip :bulb: More Information - * See: [GetWMIsForManufacturer Documentation](/api/endpoints/get-wmis-for-manufacturer) + * See: [GetWMIsForManufacturer Documentation](/guide/vpic/endpoints/get-wmis-for-manufacturer) * ::: * * `GetWMIsForManufacturer` provides information on the World Manufacturer Identifier (WMI) for a