Skip to content

Commit

Permalink
fix: external links in documentation (#1348)
Browse files Browse the repository at this point in the history
## Proposed change

## Related issues

- 🐛 Fixes broken links found in #1347
  • Loading branch information
vscaiceanu-1a authored Feb 15, 2024
2 parents b0fc04d + ae04ef1 commit ba67295
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
6 changes: 6 additions & 0 deletions .github/markdown-external-links.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,11 @@
"pattern": "https://pkgs.dev.azure.com/AmadeusDigitalAirline/Otter/_packaging/otter-pr/npm/registry/"
}
],
"replacementPatterns": [
{
"pattern": "/%40",
"replacement": "/@"
}
],
"aliveStatusCodes": [200, 203]
}
14 changes: 6 additions & 8 deletions packages/@ama-sdk/schematics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ mode and only the Typescript generator is actively supported and will see future

## Typescript SDK

The Typescript SDK generator is a custom template for the OpenAPITools generator with a full integration of the
[@ama-sdk/core](https://www.npmjs.com/package/@ama-sdk/core) client capabilities.
The Typescript SDK generator is a custom template for the OpenAPITools generator with a full integration of the [@ama-sdk/core](https://www.npmjs.com/package/@ama-sdk/core) client capabilities.

It supports both Swagger 2+ and Open API 3 specifications.
- [Setup](#setup)
Expand All @@ -21,13 +20,13 @@ It supports both Swagger 2+ and Open API 3 specifications.

#### Create a new repository

Generate a new single SDK repository
Generate a new single SDK repository

```shell
npm create @ama-sdk typescript <project-name> -- [--spec-path=./path/to/spec.yaml]
```

or
or
```shell
yarn create @ama-sdk typescript <project-name> [--spec-path=./path/to/spec.yaml]
```
Expand Down Expand Up @@ -96,10 +95,9 @@ You can also use npx instead of yarn in the command.
You can correlate this data model with the [templates](https://github.com/AmadeusITGroup/otter/tree/main/packages/%40ama-sdk/schematics/schematics/typescript/core/openapi-codegen-typescript/src/main/resources/typescriptFetch) used by the generator.

### Going further
For more information on the generated SDK and how the framework supports different feature such as the Composition, you
can refer to the dedicated SDK documentation:
- [Generated SDK hierarchy and extension](https://github.com/AmadeusITGroup/otter/blob/main/docs/sdk-tools/SDK_MODELS_HIERARCHY.md)
- [Composition and Inheritance support](https://github.com/AmadeusITGroup/otter/blob/main/docs/sdk-tools/COMPOSITION_INHERITANCE.md)
For more information on the generated SDK and how the framework supports different feature such as the Composition, you can refer to the dedicated SDK documentation:
- [Generated SDK hierarchy and extension](https://github.com/AmadeusITGroup/otter/blob/main/docs/api-sdk/SDK_MODELS_HIERARCHY.md)
- [Composition and Inheritance support](https://github.com/AmadeusITGroup/otter/blob/main/docs/api-sdk/COMPOSITION_INHERITANCE.md)

## Java Client Core SDK
> **Warning**
Expand Down

0 comments on commit ba67295

Please sign in to comment.