docs: fix dependencies & broken references (#5156)

Co-authored-by: Swopnil Dangol <[email protected]>

Author: dreamorosi

docs/requirements.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
+# This file is autogenerated by pip-compile with Python 3.13
 # by the following command:
 #
 #    pip-compile --generate-hashes --output-file=requirements.txt requirements.in
@@ -252,7 +252,7 @@ mergedeep==1.3.4 \
 mike==1.1.2 \
     --hash=sha256:4c307c28769834d78df10f834f57f810f04ca27d248f80a75f49c6fa2d1527ca \
     --hash=sha256:56c3f1794c2d0b5fdccfa9b9487beb013ca813de2e3ad0744724e9d34d40b77b
-    # via -r requirements.in
+    # via -r docs/requirements.in
 mkdocs==1.6.1 \
     --hash=sha256:7b432f01d928c084353ab39c57282f29f92136665bdd6abf7c1ec8d822ef86f2 \
     --hash=sha256:db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e
@@ -264,30 +264,30 @@ mkdocs==1.6.1 \
     #   mkdocs-typedoc
 mkdocs-exclude==1.0.2 \
     --hash=sha256:ba6fab3c80ddbe3fd31d3e579861fd3124513708271180a5f81846da8c7e2a51
-    # via -r requirements.in
+    # via -r docs/requirements.in
 mkdocs-get-deps==0.2.0 \
     --hash=sha256:162b3d129c7fad9b19abfdcb9c1458a651628e4b1dea628ac68790fb3061c60c \
     --hash=sha256:2bf11d0b133e77a0dd036abeeb06dec8775e46efa526dc70667d8863eefc6134
     # via mkdocs
 mkdocs-git-revision-date-plugin==0.3.2 \
     --hash=sha256:2e67956cb01823dd2418e2833f3623dee8604cdf223bddd005fe36226a56f6ef
-    # via -r requirements.in
+    # via -r docs/requirements.in
 mkdocs-llmstxt==0.5.0 \
     --hash=sha256:753c699913d2d619a9072604b26b6dc9f5fb6d257d9b107857f80c8a0b787533 \
     --hash=sha256:b2fa9e6d68df41d7467e948a4745725b6c99434a36b36204857dbd7bb3dfe041
-    # via -r requirements.in
+    # via -r docs/requirements.in
 mkdocs-material==9.7.6 \
     --hash=sha256:00bdde50574f776d328b1862fe65daeaf581ec309bd150f7bff345a098c64a69 \
     --hash=sha256:71b84353921b8ea1ba84fe11c50912cc512da8fe0881038fcc9a0761c0e635ba
-    # via -r requirements.in
+    # via -r docs/requirements.in
 mkdocs-material-extensions==1.3.1 \
     --hash=sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443 \
     --hash=sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31
     # via mkdocs-material
 mkdocs-typedoc==1.0.4 \
     --hash=sha256:839b54c51a64bbb77c1c253eb81baad12462ea5cf38d361e262f5cfa8a45567a \
     --hash=sha256:a9601d6b04ed4fd5658c7170c58a3a52f584357be2a3c1e39995c6eed3712b1e
-    # via -r requirements.in
+    # via -r docs/requirements.in
 packaging==24.1 \
     --hash=sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002 \
     --hash=sha256:5b8f2217dbdbd2f7f384c41c628544e6d52f2d0f53c6d0c3ea61aa5d1d7ff124
@@ -308,9 +308,9 @@ pygments==2.20.0 \
     --hash=sha256:6757cd03768053ff99f3039c1a36d6c0aa0b263438fcab17520b30a303a82b5f \
     --hash=sha256:81a9e26dd42fd28a23a2d169d86d7ac03b46e2f8b59ed4698fb4785f946d0176
     # via mkdocs-material
-pymdown-extensions==10.16.1 \
-    --hash=sha256:aace82bcccba3efc03e25d584e6a22d27a8e17caa3f4dd9f207e49b787aa9a91 \
-    --hash=sha256:d6ba157a6c03146a7fb122b2b9a121300056384eafeec9c9f9e584adfdb2a32d
+pymdown-extensions==10.21.2 \
+    --hash=sha256:5c0fd2a2bea14eb39af8ff284f1066d898ab2187d81b889b75d46d4348c01638 \
+    --hash=sha256:c3f55a5b8a1d0edf6699e35dcbea71d978d34ff3fa79f3d807b8a5b3fa90fbdc
     # via mkdocs-material
 python-dateutil==2.9.0.post0 \
     --hash=sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3 \
@@ -398,40 +398,6 @@ soupsieve==2.7 \
     --hash=sha256:6e60cc5c1ffaf1cebcc12e8188320b72071e922c2e897f737cadce79ad5d30c4 \
     --hash=sha256:ad282f9b6926286d2ead4750552c8a6142bc4c783fd66b0293547c8fe6ae126a
     # via beautifulsoup4
-tomli==2.2.1 \
-    --hash=sha256:023aa114dd824ade0100497eb2318602af309e5a55595f76b626d6d9f3b7b0a6 \
-    --hash=sha256:02abe224de6ae62c19f090f68da4e27b10af2b93213d36cf44e6e1c5abd19fdd \
-    --hash=sha256:286f0ca2ffeeb5b9bd4fcc8d6c330534323ec51b2f52da063b11c502da16f30c \
-    --hash=sha256:2d0f2fdd22b02c6d81637a3c95f8cd77f995846af7414c5c4b8d0545afa1bc4b \
-    --hash=sha256:33580bccab0338d00994d7f16f4c4ec25b776af3ffaac1ed74e0b3fc95e885a8 \
-    --hash=sha256:400e720fe168c0f8521520190686ef8ef033fb19fc493da09779e592861b78c6 \
-    --hash=sha256:40741994320b232529c802f8bc86da4e1aa9f413db394617b9a256ae0f9a7f77 \
-    --hash=sha256:465af0e0875402f1d226519c9904f37254b3045fc5084697cefb9bdde1ff99ff \
-    --hash=sha256:4a8f6e44de52d5e6c657c9fe83b562f5f4256d8ebbfe4ff922c495620a7f6cea \
-    --hash=sha256:4e340144ad7ae1533cb897d406382b4b6fede8890a03738ff1683af800d54192 \
-    --hash=sha256:678e4fa69e4575eb77d103de3df8a895e1591b48e740211bd1067378c69e8249 \
-    --hash=sha256:6972ca9c9cc9f0acaa56a8ca1ff51e7af152a9f87fb64623e31d5c83700080ee \
-    --hash=sha256:7fc04e92e1d624a4a63c76474610238576942d6b8950a2d7f908a340494e67e4 \
-    --hash=sha256:889f80ef92701b9dbb224e49ec87c645ce5df3fa2cc548664eb8a25e03127a98 \
-    --hash=sha256:8d57ca8095a641b8237d5b079147646153d22552f1c637fd3ba7f4b0b29167a8 \
-    --hash=sha256:8dd28b3e155b80f4d54beb40a441d366adcfe740969820caf156c019fb5c7ec4 \
-    --hash=sha256:9316dc65bed1684c9a98ee68759ceaed29d229e985297003e494aa825ebb0281 \
-    --hash=sha256:a198f10c4d1b1375d7687bc25294306e551bf1abfa4eace6650070a5c1ae2744 \
-    --hash=sha256:a38aa0308e754b0e3c67e344754dff64999ff9b513e691d0e786265c93583c69 \
-    --hash=sha256:a92ef1a44547e894e2a17d24e7557a5e85a9e1d0048b0b5e7541f76c5032cb13 \
-    --hash=sha256:ac065718db92ca818f8d6141b5f66369833d4a80a9d74435a268c52bdfa73140 \
-    --hash=sha256:b82ebccc8c8a36f2094e969560a1b836758481f3dc360ce9a3277c65f374285e \
-    --hash=sha256:c954d2250168d28797dd4e3ac5cf812a406cd5a92674ee4c8f123c889786aa8e \
-    --hash=sha256:cb55c73c5f4408779d0cf3eef9f762b9c9f147a77de7b258bef0a5628adc85cc \
-    --hash=sha256:cd45e1dc79c835ce60f7404ec8119f2eb06d38b1deba146f07ced3bbc44505ff \
-    --hash=sha256:d3f5614314d758649ab2ab3a62d4f2004c825922f9e370b29416484086b264ec \
-    --hash=sha256:d920f33822747519673ee656a4b6ac33e382eca9d331c87770faa3eef562aeb2 \
-    --hash=sha256:db2b95f9de79181805df90bedc5a5ab4c165e6ec3fe99f970d0e302f384ad222 \
-    --hash=sha256:e59e304978767a54663af13c07b3d1af22ddee3bb2fb0618ca1593e4f593a106 \
-    --hash=sha256:e85e99945e688e32d5a35c1ff38ed0b3f41f43fad8df0bdf79f72b2ba7bc5272 \
-    --hash=sha256:ece47d672db52ac607a3d9599a9d48dcb2f2f735c6c2d1f34130085bb12b112a \
-    --hash=sha256:f4039b9cbc3048b2416cc57ab3bda989a6fcf9b36cf8937f01a6e731b64f80d7
-    # via mdformat
 typing-extensions==4.13.2 \
     --hash=sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c \
     --hash=sha256:e6c81219bd689f51865d9e372991c540bda33a0379d5573cddb9a3a23f7caaef

mkdocs.yml

@@ -67,7 +67,7 @@ nav:
       - Resources:
           - "llms.txt": ./llms.txt
           - "llms.txt (full version)": ./llms-full.txt
-  - API reference: api/" target="_blank
+  - API reference: api/
   - Processes:
       - Roadmap: roadmap.md
       - Versioning policy: versioning.md

packages/event-handler/src/appsync-graphql/Router.ts

@@ -514,11 +514,7 @@ class Router {
    * ```
    *
    * @param handler - The batch handler function to be called when events are received.
-   * @param options - Batch route options including the required fieldName and optional configuration.
-   * @param options.fieldName - The name of the field to register the handler for.
-   * @param options.typeName - The name of the GraphQL type to use for the resolver, defaults to `Query`.
-   * @param options.aggregate - Whether to aggregate multiple requests into a single handler call, defaults to `true`.
-   * @param options.throwOnError - Whether to raise errors when processing individual requests (only available when aggregate is false), defaults to `false`.
+   * @param options - Batch route options including the required `fieldName`, optional `typeName` (defaults to `Query`), `aggregate` (defaults to `true`), and `throwOnError` (defaults to `false`).
    */
   public batchResolver<
     TParams extends Record<string, unknown>,
@@ -697,9 +693,7 @@ class Router {
    *
    * @param fieldName - The name of the Query field to register the batch handler for.
    * @param handler - The batch handler function to be called when events are received.
-   * @param options - Optional batch configuration including aggregate and throwOnError settings.
-   * @param options.aggregate - Whether to aggregate multiple requests into a single handler call, defaults to `true`.
-   * @param options.throwOnError - Whether to raise errors when processing individual requests (only available when aggregate is false), defaults to `false`.
+   * @param options - Optional batch configuration including `aggregate` (defaults to `true`) and `throwOnError` (defaults to `false`).
    */
   public onBatchQuery<
     TParams extends Record<string, unknown>,
@@ -894,9 +888,7 @@ class Router {
    *
    * @param fieldName - The name of the Mutation field to register the batch handler for.
    * @param handler - The batch handler function to be called when events are received.
-   * @param options - Optional batch configuration including aggregate and throwOnError settings.
-   * @param options.aggregate - Whether to aggregate multiple requests into a single handler call, defaults to `true`.
-   * @param options.throwOnError - Whether to raise errors when processing individual requests (only available when aggregate is false), defaults to `false`.
+   * @param options - Optional batch configuration including `aggregate` (defaults to `true`) and `throwOnError` (defaults to `false`).
    */
   public onBatchMutation<
     TParams extends Record<string, unknown>,

packages/event-handler/src/http/Router.ts

@@ -85,7 +85,7 @@ import {
 
 class Router<TEnv extends Env = Env> {
   /**
-   * @deprecated This property is deprecated and will be removed in a future major version, please use {@link RequestContext.shared | `requestContext.shared`} instead.
+   * @deprecated This property is deprecated and will be removed in a future major version, please use `requestContext.shared` instead.
    */
   protected context: Record<string, unknown>;
 

packages/event-handler/src/types/common.ts

@@ -4,14 +4,14 @@ type Anything = any;
 // #region resolve options
 
 /**
- * Optional object to pass to the {@link AppSyncEventsResolver.resolve | `AppSyncEventsResolver.resolve()`} or {@link AppSyncGraphQLResolver.resolve | `AppSyncGraphQLResolver.resolve()`} methods.
+ * Optional object to pass to the `AppSyncEventsResolver.resolve()` or `AppSyncGraphQLResolver.resolve()` methods.
  */
 type ResolveOptions = {
   /**
    * Reference to `this` instance of the class that is calling the `resolve` method.
    *
-   * This parameter should be used only when using {@link AppSyncEventsResolver.onPublish | `AppSyncEventsResolver.onPublish()`},
-   * {@link AppSyncEventsResolver.onSubscribe | `AppSyncEventsResolver.onSubscribe()`}, and {@link AppSyncGraphQLResolver.resolve | `AppSyncGraphQLResolver.resolve()`} as class method decorators, and
+   * This parameter should be used only when using `AppSyncEventsResolver.onPublish()`,
+   * `AppSyncEventsResolver.onSubscribe()`, and `AppSyncGraphQLResolver.resolve()` as class method decorators, and
    * it's used to bind the decorated methods to your class instance.
    *
    * @example

packages/event-handler/src/types/http.ts

@@ -208,7 +208,7 @@ interface ErrorConstructor<T extends Error = Error> {
 }
 
 /**
- * Options for the {@link Router | `Router``} class
+ * Options for the `Router` class
  */
 type HttpRouterOptions = {
   /**

packages/event-handler/typedoc.json

@@ -4,7 +4,7 @@
     "./src/appsync-events/index.ts",
     "./src/appsync-graphql/index.ts",
     "./src/bedrock-agent/index.ts",
-    "./src/rest/index.ts",
+    "./src/http/index.ts",
     "./src/types/index.ts"
   ],
   "readme": "README.md"