Skip to content

Commit 399176f

Browse files
authored
Merge pull request #5025 from swagger-api/chore/OSS-12-update-apidom-to-apidom-core-in-documentation
2 parents fc33809 + 6c29cab commit 399176f

File tree

12 files changed

+15
-15
lines changed

12 files changed

+15
-15
lines changed

packages/apidom-core/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,7 @@ If multiple plugins with the same visitor method are defined, they run in parall
493493

494494
#### Element identity plugin
495495

496-
`apidom` package comes with `refractorPluginElementIdentity`. When used, this plugin will
496+
`apidom-core` package comes with `refractorPluginElementIdentity`. When used, this plugin will
497497
assign unique ID to all elements in ApiDOM tree.
498498

499499
```js
@@ -528,7 +528,7 @@ objectElement.getMember('a').value.id; // Ki4tWmf9xw9Lwb8MxkXJq1uONmJrmhXifmsI
528528

529529
#### Semantic element identity plugin
530530

531-
`apidom` package comes with `refractorPluginSemanticElementIdentity`. When used, this plugin will
531+
`apidom-core` package comes with `refractorPluginSemanticElementIdentity`. When used, this plugin will
532532
assign unique ID to all non-primitive elements in ApiDOM tree. Primitive elements include
533533
`ObjectElement`, `ArrayElement`, `StringElement`, `BooleanElement`, `NullElement` and `NumberElement`.
534534

@@ -574,7 +574,7 @@ objectElement.getMember('info').value.id; // 'OnReGGrO7fMd9ztacvGfwGbOdGKuOFLiQQ
574574

575575
## Traversal
576576

577-
`apidom` comes with its own traversal algorithm along with couple of convenient abstractions on top of it.
577+
`apidom-core` comes with its own traversal algorithm along with couple of convenient abstractions on top of it.
578578

579579
### visit
580580

@@ -605,7 +605,7 @@ const newElement = visit(element, visitor); // => ObjectElement<{a: 2}>
605605
```
606606

607607
This function originally comes from [@swagger-api/apidom-ast package](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/src/visitor.ts)
608-
and is originally designed to work with [CST](https://en.wikipedia.org/wiki/Parse_tree). `apidom` package
608+
and is originally designed to work with [CST](https://en.wikipedia.org/wiki/Parse_tree). `apidom-core` package
609609
imports it, specializes it to work with ApiDOM and re-export it.
610610

611611
All following algorithms are based on `visit` function.

packages/apidom-ns-api-design-systems/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ isMainElement(mainElement); // => true
5252

5353
## Traversal
5454

55-
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom` package.
55+
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom-core` package.
5656
This package comes with its own [keyMap](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-api-design-systems/src/traversal/visitor.ts) and and [nodeTypeGetter](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-api-design-systems/src/traversal/visitor.ts).
5757
To learn more about these `visit` configuration options please refer to [@swagger-api/apidom-ast documentation](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/README.md#visit).
5858

packages/apidom-ns-arazzo-1/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ isArazzoSpecification1Element(arazzoElement); // => true
5252

5353
## Traversal
5454

55-
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom` package.
55+
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom-core` package.
5656
This package comes with its own [keyMap](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-arazzo-1/src/traversal/visitor.ts) and [nodeTypeGetter](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-arazzo-1/src/traversal/visitor.ts).
5757
To learn more about these `visit` configuration options please refer to [@swagger-api/apidom-ast documentation](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/README.md#visit).
5858

packages/apidom-ns-asyncapi-2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ isAsyncApi2Element(asyncApiElement); // => true
6161

6262
## Traversal
6363

64-
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom` package.
64+
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom-core` package.
6565
This package comes with its own [keyMap](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-asyncapi-2/src/traversal/visitor.ts#L11) and [nodeTypeGetter](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-asyncapi-2/src/traversal/visitor.ts#L4).
6666
To learn more about these `visit` configuration options please refer to [@swagger-api/apidom-ast documentation](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/README.md#visit).
6767

packages/apidom-ns-json-schema-2019-09/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ isJSONSchemaElement(jsonSchemaElement); // => true
5252

5353
## Traversal
5454

55-
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom` package.
55+
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom-core` package.
5656
This package comes with its own [keyMap](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-json-schema-2019-09/src/traversal/visitor.ts#L11) and [nodeTypeGetter](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-json-schema-2019-09/src/traversal/visitor.ts#L4).
5757
To learn more about these `visit` configuration options please refer to [@swagger-api/apidom-ast documentation](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/README.md#visit).
5858

packages/apidom-ns-json-schema-2020-12/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ isJSONSchemaElement(jsonSchemaElement); // => true
5252

5353
## Traversal
5454

55-
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom` package.
55+
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom-core` package.
5656
This package comes with its own [keyMap](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-json-schema-2020-12/src/traversal/visitor.ts#L11) and [nodeTypeGetter](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-json-schema-2020-12/src/traversal/visitor.ts#L4).
5757
To learn more about these `visit` configuration options please refer to [@swagger-api/apidom-ast documentation](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/README.md#visit).
5858

packages/apidom-ns-json-schema-draft-4/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ isJSONSchemaElement(jsonSchemaElement); // => true
5656

5757
## Traversal
5858

59-
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom` package.
59+
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom-core` package.
6060
This package comes with its own [keyMap](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-json-schema-draft-4/src/traversal/visitor.ts#L11) and [nodeTypeGetter](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-json-schema-draft-4/src/traversal/visitor.ts#L4).
6161
To learn more about these `visit` configuration options please refer to [@swagger-api/apidom-ast documentation](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/README.md#visit).
6262

packages/apidom-ns-json-schema-draft-6/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ isJSONSchemaElement(jsonSchemaElement); // => true
5454

5555
## Traversal
5656

57-
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom` package.
57+
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom-core` package.
5858
This package comes with its own [keyMap](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-json-schema-draft-6/src/traversal/visitor.ts#L11) and [nodeTypeGetter](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-json-schema-draft-6/src/traversal/visitor.ts#L4).
5959
To learn more about these `visit` configuration options please refer to [@swagger-api/apidom-ast documentation](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/README.md#visit).
6060

packages/apidom-ns-json-schema-draft-7/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ isJSONSchemaElement(jsonSchemaElement); // => true
5353

5454
## Traversal
5555

56-
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom` package.
56+
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom-core` package.
5757
This package comes with its own [keyMap](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-json-schema-draft-7/src/traversal/visitor.ts#L11) and [nodeTypeGetter](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-json-schema-draft-7/src/traversal/visitor.ts#L4).
5858
To learn more about these `visit` configuration options please refer to [@swagger-api/apidom-ast documentation](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/README.md#visit).
5959

packages/apidom-ns-openapi-2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ isSwaggerElement(swaggerElement); // => true
5454

5555
## Traversal
5656

57-
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom` package.
57+
Traversing ApiDOM in this namespace is possible by using `visit` function from `apidom-core` package.
5858
This package comes with its own [keyMap](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-openapi-2/src/traversal/visitor.ts#L11) and [nodeTypeGetter](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ns-openapi-2/src/traversal/visitor.ts#L4).
5959
To learn more about these `visit` configuration options please refer to [@swagger-api/apidom-ast documentation](https://github.com/swagger-api/apidom/blob/main/packages/apidom-ast/README.md#visit).
6060

0 commit comments

Comments
 (0)