From 0f1b7513f7d8c4cc44eda12391aab7fa6f2a9cdc Mon Sep 17 00:00:00 2001 From: Biniam Admikew Date: Wed, 17 Jan 2018 07:41:47 -0500 Subject: [PATCH] chore: update apidoc references (#864) --- packages/authentication/docs.json | 22 ++++---- packages/build/docs.json | 14 +++++ packages/cli/docs.json | 12 +++++ packages/context/docs.json | 30 +++++------ packages/core/docs.json | 7 +-- packages/metadata/docs.json | 11 ++-- packages/openapi-spec-builder/docs.json | 12 +---- packages/openapi-spec/docs.json | 12 +---- packages/openapi-v2/docs.json | 12 +---- packages/repository/docs.json | 68 ++++++++++++------------- packages/rest/docs.json | 10 ++-- 11 files changed, 100 insertions(+), 110 deletions(-) create mode 100644 packages/build/docs.json create mode 100644 packages/cli/docs.json diff --git a/packages/authentication/docs.json b/packages/authentication/docs.json index 5999bcf8daeb..645be558eab9 100644 --- a/packages/authentication/docs.json +++ b/packages/authentication/docs.json @@ -1,13 +1,13 @@ { - "content": [ - "index.ts", - "src/index.ts", - "src/decorator.ts", - "src/strategy-adapter.ts" - ], - "codeSectionDepth": 4, - "assets": { - "/": "/docs", - "/docs": "/docs" - } + "content": [ + "index.ts", + "src/index.ts", + "src/decorators/authenticate.ts", + "src/providers/auth-metadata.ts", + "src/providers/authenticate.ts", + "src/auth-component.ts", + "src/keys.ts", + "src/strategy-adapter.ts" + ], + "codeSectionDepth": 4 } diff --git a/packages/build/docs.json b/packages/build/docs.json new file mode 100644 index 000000000000..cab4a8ad246f --- /dev/null +++ b/packages/build/docs.json @@ -0,0 +1,14 @@ +{ + "content": [ + "index.js", + "bin/compile-package.js", + "bin/generate-apidocs.js", + "bin/run-clean.js", + "bin/run-nyc.js", + "bin/run-prettier.js", + "bin/run-tslint.js", + "bin/select-dist.js", + "bin/utils.js" + ], + "codeSectionDepth": 4 +} diff --git a/packages/cli/docs.json b/packages/cli/docs.json new file mode 100644 index 000000000000..1b37c9ac8301 --- /dev/null +++ b/packages/cli/docs.json @@ -0,0 +1,12 @@ +{ + "content": [ + "bin/cli.js", + "lib/artifact-generator.js", + "lib/base-generator.js", + "lib/debug.js", + "lib/project-generator.js", + "lib/promisify.js", + "lib/utils.js" + ], + "codeSectionDepth": 4 +} diff --git a/packages/context/docs.json b/packages/context/docs.json index a6a744fca073..e7a416007f39 100644 --- a/packages/context/docs.json +++ b/packages/context/docs.json @@ -1,19 +1,15 @@ { - "content": [ - "index.ts", - "src/binding.ts", - "src/context.ts", - "src/index.ts", - "src/inject.ts", - "src/is-promise.ts", - "src/provider.ts", - "src/reflect.ts", - "src/resolution-session.ts", - "src/resolver.ts" - ], - "codeSectionDepth": 4, - "assets": { - "/": "/docs", - "/docs": "/docs" - } + "content": [ + "index.ts", + "src/binding.ts", + "src/context.ts", + "src/index.ts", + "src/inject.ts", + "src/is-promise.ts", + "src/provider.ts", + "src/reflect.ts", + "src/resolution-session.ts", + "src/resolver.ts" + ], + "codeSectionDepth": 4 } diff --git a/packages/core/docs.json b/packages/core/docs.json index eeb5ae86a394..2c4e49f7ca88 100644 --- a/packages/core/docs.json +++ b/packages/core/docs.json @@ -4,12 +4,9 @@ "src/application.ts", "src/component.ts", "src/index.ts", + "src/keys.ts", "src/promisify.ts", "src/server.ts" ], - "codeSectionDepth": 4, - "assets": { - "/": "/docs", - "/docs": "/docs" - } + "codeSectionDepth": 4 } diff --git a/packages/metadata/docs.json b/packages/metadata/docs.json index 3072030cd637..34e694de4b4a 100644 --- a/packages/metadata/docs.json +++ b/packages/metadata/docs.json @@ -1,13 +1,10 @@ { "content": [ "index.ts", - "src/reflect.ts", "src/decorator-factory.ts", - "src/index.ts" + "src/index.ts", + "src/inspector.ts", + "src/reflect.ts" ], - "codeSectionDepth": 4, - "assets": { - "/": "/docs", - "/docs": "/docs" - } + "codeSectionDepth": 4 } diff --git a/packages/openapi-spec-builder/docs.json b/packages/openapi-spec-builder/docs.json index d3ac330747e0..b02e1bf788f3 100644 --- a/packages/openapi-spec-builder/docs.json +++ b/packages/openapi-spec-builder/docs.json @@ -1,12 +1,4 @@ { - "content": [ - "index.ts", - "src/index.ts", - "src/openapi-spec-builder.ts" - ], - "codeSectionDepth": 4, - "assets": { - "/": "/docs", - "/docs": "/docs" - } + "content": ["index.ts", "src/index.ts", "src/openapi-spec-builder.ts"], + "codeSectionDepth": 4 } diff --git a/packages/openapi-spec/docs.json b/packages/openapi-spec/docs.json index b7874de7a3be..96e509b11a85 100644 --- a/packages/openapi-spec/docs.json +++ b/packages/openapi-spec/docs.json @@ -1,12 +1,4 @@ { - "content": [ - "index.ts", - "src/index.ts", - "src/openapi-spec-v2.ts" - ], - "codeSectionDepth": 4, - "assets": { - "/": "/docs", - "/docs": "/docs" - } + "content": ["index.ts", "src/index.ts", "src/openapi-spec-v2.ts"], + "codeSectionDepth": 4 } diff --git a/packages/openapi-v2/docs.json b/packages/openapi-v2/docs.json index b8eec323b813..d39a82de95d9 100644 --- a/packages/openapi-v2/docs.json +++ b/packages/openapi-v2/docs.json @@ -1,12 +1,4 @@ { - "content": [ - "index.ts", - "src/index.ts", - "src/decorators/controller-decorators/metadata.ts" - ], - "codeSectionDepth": 4, - "assets": { - "/": "/docs", - "/docs": "/docs" - } + "content": ["index.ts", "src/controller-spec.ts", "src/index.ts"], + "codeSectionDepth": 4 } diff --git a/packages/repository/docs.json b/packages/repository/docs.json index 028d8685517c..02235d286a96 100644 --- a/packages/repository/docs.json +++ b/packages/repository/docs.json @@ -1,36 +1,36 @@ { - "content": [ - "./index.ts", - "./src/common-types.ts", - "./src/connector.ts", - "./src/crud-connector.ts", - "./src/datasource.ts", - "./src/decorators/model.ts", - "./src/decorators/relation.ts", - "./src/decorators/repository.ts", - "./src/index.ts", - "./src/kv-connector.ts", - "./src/kv-repository.ts", - "./src/legacy-juggler-bridge.ts", - "./src/loopback-datasource-juggler.ts", - "./src/mixin.ts", - "./src/model.ts", - "./src/query.ts", - "./src/repository.ts", - "./src/types/any.ts", - "./src/types/array.ts", - "./src/types/boolean.ts", - "./src/types/buffer.ts", - "./src/types/date.ts", - "./src/types/index.ts", - "./src/types/number.ts", - "./src/types/string.ts", - "./src/types/type.ts", - "./src/types/union.ts" - ], - "codeSectionDepth": 4, - "assets": { - "/": "/docs", - "/docs": "/docs" - } + "content": [ + "./index.ts", + "./src/common-types.ts", + "./src/connector.ts", + "./src/crud-connector.ts", + "./src/datasource.ts", + "./src/decorators/metadata.ts", + "./src/decorators/model.ts", + "./src/decorators/relation.ts", + "./src/decorators/repository.ts", + "./src/index.ts", + "./src/kv-connector.ts", + "./src/kv-repository.ts", + "./src/legacy-juggler-bridge.ts", + "./src/loopback-datasource-juggler.ts", + "./src/mixin.ts", + "./src/model.ts", + "./src/query.ts", + "./src/repository.ts", + "./src/repository-mixin.ts", + "./src/types/any.ts", + "./src/types/array.ts", + "./src/types/boolean.ts", + "./src/types/buffer.ts", + "./src/types/date.ts", + "./src/types/index.ts", + "./src/types/model.ts", + "./src/types/number.ts", + "./src/types/object.ts", + "./src/types/string.ts", + "./src/types/type.ts", + "./src/types/union.ts" + ], + "codeSectionDepth": 4 } diff --git a/packages/rest/docs.json b/packages/rest/docs.json index 5853e57f550f..e6f6e28598f6 100644 --- a/packages/rest/docs.json +++ b/packages/rest/docs.json @@ -4,10 +4,13 @@ "src/http-handler.ts", "src/index.ts", "src/internal-types.ts", + "src/keys.ts", "src/parser.ts", + "src/rest-application.ts", "src/providers/bind-element.ts", "src/providers/find-route.ts", "src/providers/get-from-context.ts", + "src/providers/index.ts", "src/providers/invoke-method.ts", "src/providers/log-error-provider.ts", "src/providers/parse-params.ts", @@ -15,14 +18,9 @@ "src/providers/send.ts", "src/rest-component.ts", "src/rest-server.ts", - "src/router/metadata.ts", "src/router/routing-table.ts", "src/sequence.ts", "src/writer.ts" ], - "codeSectionDepth": 4, - "assets": { - "/": "/docs", - "/docs": "/docs" - } + "codeSectionDepth": 4 }