Skip to content

Commit 4cb79b3

Browse files
authored
docs(apidom-reference): update links and add missing docs (#5060)
1 parent a22a823 commit 4cb79b3

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

packages/apidom-reference/README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ This parser is uniquely identified by `binary` name.
370370
#### Parser plugins execution order
371371

372372
It's important to understand that default parser plugins are run in specific order. The order is determined
373-
by the [options.parse.parsers](https://github.com/swagger-api/apidom/blob/main/packages/apidom-reference/src/configuration/saturated.ts#L32) option.
373+
by the [options.parse.parsers](https://github.com/swagger-api/apidom/blob/main/packages/apidom-reference/src/configuration/saturated.ts#L35) option.
374374
Every plugin is pulled from `options.parse.parsers` option, and it's `canParse` method is called to determine
375375
whether the plugin can parse the URI. If `canParse` returns `true`, `parse` method of plugin is called
376376
and result from parsing is returned. No subsequent parser plugins are run. If `canParse` returns
@@ -848,7 +848,7 @@ const string = buffer.toString('utf-8');
848848
##### Resolver plugins execution order
849849

850850
It's important to understand that default resolver plugins are run in specific order. The order is determined
851-
by the [options.resolve.resolvers]https://github.com/swagger-api/apidom/blob/ba888d711a4292e8ed0b72e343c4902a4bf0d45a/packages/apidom-reference/src/configuration/saturated.ts#L36) option.
851+
by the [options.resolve.resolvers](https://github.com/swagger-api/apidom/blob/main/packages/apidom-reference/src/configuration/saturated.ts#L56) option.
852852
Every plugin is pulled from `options.resolve.resolvers` option, and it's `canRead` method is called to determine
853853
whether the plugin can resolve the URI. If `canRead` returns `true`, `read` method of plugin is called
854854
and result from reading the file is returned. No subsequent resolver plugins are run.
@@ -1246,7 +1246,7 @@ Supported media types:
12461246
##### External resolution strategies execution order
12471247

12481248
It's important to understand that default external resolution strategies are run in specific order. The order is determined
1249-
by the [options.resolve.strategies](https://github.com/swagger-api/apidom/blob/main/packages/apidom-reference/src/configuration/saturated.ts#L56) option.
1249+
by the [options.resolve.strategies](https://github.com/swagger-api/apidom/blob/main/packages/apidom-reference/src/configuration/saturated.ts#L61) option.
12501250
Every strategy is pulled from `options.resolve.strategies` option and its `canResolve` method is called to determine
12511251
whether the strategy can externally resolve the URI. If `canResolve` returns `true`, `resolve` method of strategy is called
12521252
and result from external resolution is returned. No subsequent strategies are run. If `canResolve` returns
@@ -1259,6 +1259,7 @@ returns `true` or until entire list of strategies is exhausted (throws error).
12591259
new OpenAPI3_0ResolveStrategy(),
12601260
new OpenAPI3_1ResolveStrategy(),
12611261
new AsyncAPI2ResolveStrategy(),
1262+
new ApiDOMResolveStrategy(),
12621263
]
12631264
```
12641265
Most specific strategies are listed first, most generic are listed last.
@@ -1267,6 +1268,7 @@ It's possible to **change** strategies **order globally** by mutating global `re
12671268

12681269
```js
12691270
import { options } from '@swagger-api/apidom-reference';
1271+
import ApiDOMResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/apidom';
12701272
import AsyncAPI2ResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/asyncapi-2';
12711273
import OpenAPI2ResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/openapi-2';
12721274
import OpenAPI3_0ResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/openapi-3-0';
@@ -1277,13 +1279,15 @@ options.resolve.strategies = [
12771279
new OpenAPI3_0ResolveStrategy(),
12781280
new OpenAPI3_1ResolveStrategy(),
12791281
new AsyncAPI2ResolveStrategy(),
1282+
new ApiDOMResolveStrategy(),
12801283
];
12811284
```
12821285

12831286
To **change** the strategies **order** on ad-hoc basis:
12841287

12851288
```js
12861289
import { resolve } from '@swagger-api/apidom-reference';
1290+
import ApiDOMResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/apidom';
12871291
import AsyncAPI2ResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/asyncapi-2';
12881292
import OpenAPI2ResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/openapi-2';
12891293
import OpenAPI3_0ResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/openapi-3-0';
@@ -1300,6 +1304,7 @@ await resolve('/home/user/oas.json', {
13001304
new OpenAPI2ResolveStrategy(),
13011305
new OpenAPI3_0ResolveStrategy(),
13021306
new OpenAPI3_1ResolveStrategy(),
1307+
new ApiDOMResolveStrategy(),
13031308
]
13041309
}
13051310
});
@@ -1617,7 +1622,7 @@ Supported media types:
16171622
##### Dereference strategies execution order
16181623

16191624
It's important to understand that default dereference strategies are run in specific order. The order is determined
1620-
by the [options.dereference.strategies](https://github.com/swagger-api/apidom/blob/main/packages/apidom-reference/src/configuration/saturated.ts#L64) option.
1625+
by the [options.dereference.strategies](https://github.com/swagger-api/apidom/blob/main/packages/apidom-reference/src/configuration/saturated.ts#L69) option.
16211626
Every strategy is pulled from `options.dereference.strategies` option and it's `canDereference` method is called to determine
16221627
whether the strategy can dereference the URI. If `canDereference` returns `true`, `dereference` method of strategy is called
16231628
and result from dereferencing is returned. No subsequent strategies are run. If `canDereference` returns
@@ -1630,6 +1635,7 @@ returns `true` or until entire list of strategies is exhausted (throws error).
16301635
new OpenAPI3_0DereferenceStrategy(),
16311636
new OpenAPI3_1DereferenceStrategy(),
16321637
new AsyncAPI2DereferenceStrategy(),
1638+
new AsyncAPI3DereferenceStrategy(),
16331639
new ApiDOMDereferenceStrategy(),
16341640
]
16351641
```
@@ -1640,6 +1646,7 @@ It's possible to **change** strategies **order globally** by mutating global `de
16401646
```js
16411647
import { options } from '@swagger-api/apidom-reference';
16421648
import AsyncAPI2DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/asyncapi-2';
1649+
import AsyncAPI3DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/asyncapi-3';
16431650
import OpenAPI2DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/openapi-2';
16441651
import OpenAPI3_0DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/openapi-3-0';
16451652
import OpenAPI3_1DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/openapi-3-1';
@@ -1650,6 +1657,7 @@ options.dereference.strategies = [
16501657
new OpenAPI3_0DereferenceStrategy(),
16511658
new OpenAPI3_1DereferenceStrategy(),
16521659
new AsyncAPI2DereferenceStrategy(),
1660+
new AsyncAPI3DereferenceStrategy(),
16531661
new ApiDOMDereferenceStrategy(),
16541662
];
16551663
```
@@ -1659,6 +1667,7 @@ To **change** the strategies **order** on ad-hoc basis:
16591667
```js
16601668
import { dereference } from '@swagger-api/apidom-reference';
16611669
import AsyncAPI2DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/asyncapi-2';
1670+
import AsyncAPI3DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/asyncapi-3';
16621671
import OpenAPI2DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/openapi-2';
16631672
import OpenAPI3_0DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/openapi-3-0';
16641673
import OpenAPI3_1DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/openapi-3-1';
@@ -1672,6 +1681,7 @@ await dereference('/home/user/oas.json', {
16721681
dereference: {
16731682
strategies: [
16741683
new AsyncAPI2DereferenceStrategy(),
1684+
new AsyncAPI3DereferenceStrategy(),
16751685
new OpenAPI2DereferenceStrategy(),
16761686
new OpenAPI3_0DereferenceStrategy(),
16771687
new OpenAPI3_1DereferenceStrategy(),
@@ -1913,7 +1923,7 @@ Supported media types:
19131923
##### Bundle strategies execution order
19141924

19151925
It's important to understand that default bundle strategies are run in specific order. The order is determined
1916-
by the `options.bundle.strategies` option.
1926+
by the [options.bundle.strategies](https://github.com/swagger-api/apidom/blob/main/packages/apidom-reference/src/configuration/saturated.ts#L78) option.
19171927
Every strategy is pulled from `options.bundle.strategies` option, and it's `canBundle` method is called to determine
19181928
whether the strategy can bundle the URI. If `canBundle` returns `true`, `bundle` method of strategy is called
19191929
and result from bundling is returned. No subsequent strategies are run. If `canBundle` returns

0 commit comments

Comments
 (0)