Skip to content

Commit f3cb675

Browse files
committed
test: repair API documentation links
1 parent 0991085 commit f3cb675

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515

1616
- Parses Swagger specs in **JSON** or **YAML** format
1717
- Validates against the [Swagger 2.0 schema](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json) or [OpenAPI 3.0 Schema](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v3.0/schema.json)
18-
- [Resolves](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#resolveapi-options-callback) all `$ref` pointers, including external files and URLs
19-
- Can [bundle](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#bundleapi-options-callback) all your Swagger files into a single file that only has _internal_ `$ref` pointers
20-
- Can [dereference](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#dereferenceapi-options-callback) all `$ref` pointers, giving you a normal JavaScript object that's easy to work with
18+
- [Resolves](docs/swagger-parser.md#resolveapi-options-callback) all `$ref` pointers, including external files and URLs
19+
- Can [bundle](docs/swagger-parser.md#bundleapi-options-callback) all your Swagger files into a single file that only has _internal_ `$ref` pointers
20+
- Can [dereference](docs/swagger-parser.md#dereferenceapi-options-callback) all `$ref` pointers, giving you a normal JavaScript object that's easy to work with
2121
- **[Tested](https://github.com/APIDevTools/swagger-parser/actions)** in Node.js and all modern web browsers on Mac, Windows, and Linux
2222
- Tested on **[over 1,500 real-world APIs](https://apis.guru/browse-apis/)** from Google, Microsoft, Facebook, Spotify, etc.
23-
- Supports [circular references](https://apidevtools.com/swagger-parser/docs/#circular-refs), nested references, back-references, and cross-references
23+
- Supports [circular references](docs/README.md#circular-refs), nested references, back-references, and cross-references
2424
- Maintains object reference equality — `$ref` pointers to the same value always resolve to the same object instance
2525

2626
## Related Projects
@@ -51,7 +51,7 @@ try {
5151
}
5252
```
5353

54-
For more detailed examples, please see the [API Documentation](https://apidevtools.com/swagger-parser/docs/)
54+
For more detailed examples, please see the [API Documentation](docs/README.md).
5555

5656
## Installation
5757

@@ -83,7 +83,7 @@ To use Swagger Parser in a browser, you'll need to use a bundling tool such as [
8383

8484
## API Documentation
8585

86-
Full API documentation is available [right here](https://apidevtools.com/swagger-parser/docs/)
86+
Full API documentation is available [right here](docs/README.md).
8787

8888
## Security
8989

test/specs/xquik/xquik-openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ components:
2828
apiKey:
2929
type: apiKey
3030
in: header
31-
name: X-API-Key
31+
name: x-api-key
3232
schemas:
3333
SearchTweetsResponse:
3434
type: object

test/specs/xquik/xquik.spec.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ describe("Xquik OpenAPI 3.1 fixture", () => {
1616
expect(operation.responses["200"].description).to.equal("Search results.");
1717
expect(scheme.type).to.equal("apiKey");
1818
expect(scheme.in).to.equal("header");
19-
expect(scheme.name).to.equal("X-API-Key");
19+
expect(scheme.name).to.equal("x-api-key");
2020
});
2121
});

0 commit comments

Comments
 (0)