chore(deps): bumping out of date deps (#711)

* chore: fixing a typo

* chore(deps-dev): bumping oas-examples

* chore(deps-dev): bumping vitest

* chore(deps): bumping ssri

* chore(deps-dev): bumping out of date dev deps

* chore(deps-dev): bumping out of date dev deps

* fix: prettier issue

.github/dependabot.yml

@@ -22,7 +22,7 @@ updates:
     labels:
       - dependencies
     groups:
-      minor-developent-deps:
+      minor-development-deps:
         dependency-type: 'development'
         update-types:
           - minor
@@ -33,6 +33,9 @@ updates:
     ignore:
       # The following are packages that we're ignoring updates from because they've moved to being
       # ESM-only packages and we can't yet upgrade them.
+      - dependency-name: '@types/find-cache-dir'
+        versions:
+          - '>= 4'
       - dependency-name: chalk
         versions:
           - '>= 5'

docs/how-it-works.md

@@ -97,7 +97,7 @@ If for some reason this file gets lost, or the accessor you're supplying to `api
 {
   "d6b93e95fa1a7efdce6d1406dc599923": {
     "hash": "cbb821db3609f8983ce1a372dadd122c",
-    "original": "https://dash.readme.io/api/v1/api-registry/nysezql0wwo236",
+    "original": "https://dash.readme.com/api/v1/api-registry/nysezql0wwo236",
     "title": "API Endpoints",
     "version": "2.0.0"
   }

package.json

@@ -31,13 +31,13 @@
   "prettier": "@readme/eslint-config/prettier",
   "devDependencies": {
     "@commitlint/cli": "^17.6.6",
-    "@commitlint/config-conventional": "^17.6.6",
-    "@readme/eslint-config": "^12.0.0",
-    "alex": "^11.0.0",
-    "eslint": "^8.44.0",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@readme/eslint-config": "^12.2.1",
+    "alex": "^11.0.1",
+    "eslint": "^8.48.0",
     "husky": "^8.0.3",
-    "lerna": "^7.1.5",
-    "prettier": "^3.0.1"
+    "lerna": "^7.2.0",
+    "prettier": "^3.0.3"
   },
   "commitlint": {
     "extends": [

packages/api/package.json

@@ -72,24 +72,24 @@
     "validate-npm-package-name": "^5.0.0"
   },
   "devDependencies": {
-    "@readme/oas-examples": "^5.9.0",
-    "@types/caseless": "^0.12.2",
+    "@readme/oas-examples": "^5.12.0",
+    "@types/caseless": "^0.12.3",
     "@types/find-cache-dir": "^3.2.1",
     "@types/js-yaml": "^4.0.5",
     "@types/lodash.camelcase": "^4.3.7",
     "@types/lodash.deburr": "^4.1.7",
     "@types/lodash.merge": "^4.6.7",
     "@types/lodash.setwith": "^4.3.7",
     "@types/lodash.startcase": "^4.4.7",
-    "@types/prettier": "^2.7.2",
-    "@types/prompts": "^2.4.2",
-    "@types/semver": "^7.3.13",
+    "@types/prettier": "^3.0.0",
+    "@types/prompts": "^2.4.4",
+    "@types/semver": "^7.5.1",
     "@types/ssri": "^7.1.1",
     "@types/validate-npm-package-name": "^4.0.0",
     "@vitest/coverage-v8": "^0.34.1",
     "fetch-mock": "^9.11.0",
     "oas-normalize": "^8.3.2",
-    "type-fest": "^4.2.0",
+    "type-fest": "^4.3.1",
     "typescript": "^4.9.5",
     "unique-temp-dir": "^1.0.0",
     "vitest": "^0.34.1"

packages/api/test/__fixtures__/sdk/readme/index.ts

@@ -10,7 +10,7 @@ class SDK {
 
   constructor() {
     this.spec = Oas.init(definition);
-    this.core = new APICore(this.spec, 'readme/2.0.0 (api/<<package version>>)');
+    this.core = new APICore(this.spec, 'readme/4.355.0 (api/<<package version>>)');
   }
 
   /**
@@ -98,7 +98,7 @@ class SDK {
 
   /**
    * Upload an API specification to ReadMe. Or, to use a newer solution see
-   * https://docs.readme.com/docs/automatically-sync-api-specification-with-github.
+   * https://docs.readme.com/main/docs/rdme.
    *
    * @summary Upload specification
    * @throws FetchError<400, types.UploadApiSpecificationResponse400> There was a validation error during upload.
@@ -330,7 +330,7 @@ class SDK {
    * @throws FetchError<403, types.GetDocResponse403> Unauthorized
    * @throws FetchError<404, types.ErrorDocNotfound> The doc couldn't be found.
    */
-  getDoc(metadata: types.GetDocMetadataParam): Promise<FetchResponse<number, unknown>> {
+  getDoc(metadata: types.GetDocMetadataParam): Promise<FetchResponse<200, types.DocSchemaResponse>> {
     return this.core.fetch('/docs/{slug}', 'get', metadata);
   }
 
@@ -343,7 +343,7 @@ class SDK {
    * @throws FetchError<403, types.UpdateDocResponse403> Unauthorized
    * @throws FetchError<404, types.ErrorDocNotfound> The doc couldn't be found.
    */
-  updateDoc(body: types.Doc, metadata: types.UpdateDocMetadataParam): Promise<FetchResponse<number, unknown>> {
+  updateDoc(body: types.DocSchemaPut, metadata: types.UpdateDocMetadataParam): Promise<FetchResponse<200, types.DocSchemaResponse>> {
     return this.core.fetch('/docs/{slug}', 'put', body, metadata);
   }
 
@@ -369,7 +369,7 @@ class SDK {
    * @throws FetchError<403, types.GetProductionDocResponse403> Unauthorized
    * @throws FetchError<404, types.ErrorDocNotfound> The doc couldn't be found.
    */
-  getProductionDoc(metadata: types.GetProductionDocMetadataParam): Promise<FetchResponse<number, unknown>> {
+  getProductionDoc(metadata: types.GetProductionDocMetadataParam): Promise<FetchResponse<200, types.DocSchemaResponse>> {
     return this.core.fetch('/docs/{slug}/production', 'get', metadata);
   }
 
@@ -381,7 +381,7 @@ class SDK {
    * @throws FetchError<401, types.CreateDocResponse401> Unauthorized
    * @throws FetchError<403, types.CreateDocResponse403> Unauthorized
    */
-  createDoc(body: types.Doc, metadata?: types.CreateDocMetadataParam): Promise<FetchResponse<number, unknown>> {
+  createDoc(body: types.DocSchemaPost, metadata?: types.CreateDocMetadataParam): Promise<FetchResponse<201, types.DocSchemaResponse>> {
     return this.core.fetch('/docs', 'post', body, metadata);
   }
 
@@ -396,17 +396,6 @@ class SDK {
     return this.core.fetch('/docs/search', 'post', metadata);
   }
 
-  /**
-   * Returns with all of the error page types for this project.
-   *
-   * @summary Get errors
-   * @throws FetchError<401, types.GetErrorsResponse401> Unauthorized
-   * @throws FetchError<403, types.GetErrorsResponse403> Unauthorized
-   */
-  getErrors(): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/errors', 'get');
-  }
-
   /**
    * Returns project data for the API key.
    *
@@ -418,6 +407,15 @@ class SDK {
     return this.core.fetch('/', 'get');
   }
 
+  /**
+   * Returns a copy of our OpenAPI Definition.
+   *
+   * @summary Get our OpenAPI Definition
+   */
+  getAPISchema(): Promise<FetchResponse<200, types.GetApiSchemaResponse200>> {
+    return this.core.fetch('/schema', 'get');
+  }
+
   /**
    * Retrieve a list of versions associated with a project API key.
    *
@@ -486,4 +484,4 @@ const createSDK = (() => { return new SDK(); })()
 
 export default createSDK;
 
-export type { Apply, BaseError, Category, Changelog, CondensedProjectData, CreateCategoryMetadataParam, CreateCustomPageResponse401, CreateCustomPageResponse403, CreateDocMetadataParam, CreateDocResponse401, CreateDocResponse403, CreateVersionResponse400, CreateVersionResponse401, CreateVersionResponse403, CustomPage, DeleteApiSpecificationMetadataParam, DeleteApiSpecificationResponse401, DeleteApiSpecificationResponse403, DeleteCategoryMetadataParam, DeleteChangelogMetadataParam, DeleteCustomPageMetadataParam, DeleteCustomPageResponse401, DeleteCustomPageResponse403, DeleteDocMetadataParam, DeleteDocResponse401, DeleteDocResponse403, DeleteVersionMetadataParam, DeleteVersionResponse401, DeleteVersionResponse403, Doc, ErrorApikeyEmpty, ErrorApikeyMismatch, ErrorApikeyNotfound, ErrorApplyInvalidEmail, ErrorApplyInvalidJob, ErrorApplyInvalidName, ErrorCategoryInvalid, ErrorCategoryNotfound, ErrorChangelogInvalid, ErrorChangelogNotfound, ErrorCustompageInvalid, ErrorCustompageNotfound, ErrorDocInvalid, ErrorDocNotfound, ErrorEndpointNotfound, ErrorInternalError, ErrorProjectNeedsstaging, ErrorProjectNotfound, ErrorRegistryInvalid, ErrorRegistryNotfound, ErrorSpecFileEmpty, ErrorSpecIdDuplicate, ErrorSpecIdInvalid, ErrorSpecInvalid, ErrorSpecInvalidSchema, ErrorSpecNotfound, ErrorSpecTimeout, ErrorSpecVersionNotfound, ErrorUnexpectedError, ErrorVersionCantDemoteStable, ErrorVersionCantRemoveStable, ErrorVersionDuplicate, ErrorVersionEmpty, ErrorVersionForkEmpty, ErrorVersionForkNotfound, ErrorVersionInvalid, ErrorVersionNotfound, GetApiRegistryMetadataParam, GetApiRegistryResponse200, GetApiSpecificationMetadataParam, GetApiSpecificationResponse200, GetApiSpecificationResponse401, GetApiSpecificationResponse403, GetCategoriesMetadataParam, GetCategoriesResponse200, GetCategoryDocsMetadataParam, GetCategoryMetadataParam, GetChangelogMetadataParam, GetChangelogsMetadataParam, GetChangelogsResponse200, GetCustomPageMetadataParam, GetCustomPageResponse401, GetCustomPageResponse403, GetCustomPagesMetadataParam, GetCustomPagesResponse200, GetCustomPagesResponse401, GetCustomPagesResponse403, GetDocMetadataParam, GetDocResponse401, GetDocResponse403, GetErrorsResponse401, GetErrorsResponse403, GetOpenRolesResponse200, GetProductionDocMetadataParam, GetProductionDocResponse401, GetProductionDocResponse403, GetProjectResponse401, GetProjectResponse403, GetVersionMetadataParam, GetVersionResponse401, GetVersionResponse403, GetVersionsResponse401, GetVersionsResponse403, JobOpening, SearchDocsMetadataParam, SearchDocsResponse401, SearchDocsResponse403, UpdateApiSpecificationBodyParam, UpdateApiSpecificationMetadataParam, UpdateApiSpecificationResponse400, UpdateApiSpecificationResponse401, UpdateApiSpecificationResponse403, UpdateCategoryMetadataParam, UpdateChangelogMetadataParam, UpdateCustomPageMetadataParam, UpdateCustomPageResponse401, UpdateCustomPageResponse403, UpdateDocMetadataParam, UpdateDocResponse401, UpdateDocResponse403, UpdateVersionMetadataParam, UpdateVersionResponse401, UpdateVersionResponse403, UploadApiSpecificationBodyParam, UploadApiSpecificationMetadataParam, UploadApiSpecificationResponse400, UploadApiSpecificationResponse401, UploadApiSpecificationResponse403, Version } from './types';
+export type { Apply, BaseError, Category, Changelog, CondensedProjectData, CreateCategoryMetadataParam, CreateCustomPageResponse401, CreateCustomPageResponse403, CreateDocMetadataParam, CreateDocResponse401, CreateDocResponse403, CreateVersionResponse400, CreateVersionResponse401, CreateVersionResponse403, CustomPage, DeleteApiSpecificationMetadataParam, DeleteApiSpecificationResponse401, DeleteApiSpecificationResponse403, DeleteCategoryMetadataParam, DeleteChangelogMetadataParam, DeleteCustomPageMetadataParam, DeleteCustomPageResponse401, DeleteCustomPageResponse403, DeleteDocMetadataParam, DeleteDocResponse401, DeleteDocResponse403, DeleteVersionMetadataParam, DeleteVersionResponse401, DeleteVersionResponse403, DocSchemaPost, DocSchemaPut, DocSchemaResponse, ErrorApikeyEmpty, ErrorApikeyMismatch, ErrorApikeyNotfound, ErrorApplyInvalidEmail, ErrorApplyInvalidJob, ErrorApplyInvalidName, ErrorCategoryInvalid, ErrorCategoryNotfound, ErrorChangelogInvalid, ErrorChangelogNotfound, ErrorCustompageInvalid, ErrorCustompageNotfound, ErrorDocInvalid, ErrorDocNotfound, ErrorEndpointNotfound, ErrorInternalError, ErrorProjectNeedsstaging, ErrorProjectNotfound, ErrorRateLimited, ErrorRegistryInvalid, ErrorRegistryNotfound, ErrorSpecFileEmpty, ErrorSpecIdDuplicate, ErrorSpecIdInvalid, ErrorSpecInvalid, ErrorSpecInvalidSchema, ErrorSpecNotfound, ErrorSpecTimeout, ErrorSpecVersionNotfound, ErrorUnexpectedError, ErrorVersionCantDemoteStable, ErrorVersionCantRemoveStable, ErrorVersionDuplicate, ErrorVersionEmpty, ErrorVersionForkEmpty, ErrorVersionForkNotfound, ErrorVersionInvalid, ErrorVersionNotfound, GetApiRegistryMetadataParam, GetApiRegistryResponse200, GetApiSchemaResponse200, GetApiSpecificationMetadataParam, GetApiSpecificationResponse200, GetApiSpecificationResponse401, GetApiSpecificationResponse403, GetCategoriesMetadataParam, GetCategoriesResponse200, GetCategoryDocsMetadataParam, GetCategoryMetadataParam, GetChangelogMetadataParam, GetChangelogsMetadataParam, GetChangelogsResponse200, GetCustomPageMetadataParam, GetCustomPageResponse401, GetCustomPageResponse403, GetCustomPagesMetadataParam, GetCustomPagesResponse200, GetCustomPagesResponse401, GetCustomPagesResponse403, GetDocMetadataParam, GetDocResponse401, GetDocResponse403, GetOpenRolesResponse200, GetProductionDocMetadataParam, GetProductionDocResponse401, GetProductionDocResponse403, GetProjectResponse401, GetProjectResponse403, GetVersionMetadataParam, GetVersionResponse401, GetVersionResponse403, GetVersionsResponse401, GetVersionsResponse403, JobOpening, SearchDocsMetadataParam, SearchDocsResponse401, SearchDocsResponse403, UpdateApiSpecificationBodyParam, UpdateApiSpecificationMetadataParam, UpdateApiSpecificationResponse400, UpdateApiSpecificationResponse401, UpdateApiSpecificationResponse403, UpdateCategoryMetadataParam, UpdateChangelogMetadataParam, UpdateCustomPageMetadataParam, UpdateCustomPageResponse401, UpdateCustomPageResponse403, UpdateDocMetadataParam, UpdateDocResponse401, UpdateDocResponse403, UpdateVersionMetadataParam, UpdateVersionResponse401, UpdateVersionResponse403, UploadApiSpecificationBodyParam, UploadApiSpecificationMetadataParam, UploadApiSpecificationResponse400, UploadApiSpecificationResponse401, UploadApiSpecificationResponse403, Version } from './types';