Skip to content

Commit d89d2c5

Browse files
committed
Change schema URL to "v0" since we haven't done the 1.0 release yet
1 parent 4f46de1 commit d89d2c5

File tree

9 files changed

+16
-16
lines changed

9 files changed

+16
-16
lines changed

tsdoc-config/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ until it finds a folder containing **tsconfig.json** or **package.json**, and th
1919
**tsdoc.json** from that location.
2020

2121
The **tsdoc.json** file conforms to the [tsdoc.schema.json](
22-
https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json) JSON schema. It defines tags using
22+
https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json) JSON schema. It defines tags using
2323
similar fields as the
2424
[TSDocTagDefinition](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/configuration/TSDocTagDefinition.ts)
2525
API used by `TSDocParser` from `@microsoft/tsdoc`.
@@ -29,7 +29,7 @@ Here's a simple example:
2929
**tsdoc.json**
3030
```js
3131
{
32-
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
32+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3333
"tagDefinitions": [
3434
{
3535
"tagName": "@myTag",
@@ -45,7 +45,7 @@ a list of paths that will be mixed in with the current file:
4545
**tsdoc.json**
4646
```js
4747
{
48-
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
48+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
4949
"extends": [
5050
"my-package/dist/tsdoc-base.json",
5151
"./path/to/local/file/tsdoc-local.json"

tsdoc-config/src/TSDocConfigFile.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ interface IConfigJson {
4848
export class TSDocConfigFile {
4949
public static readonly FILENAME: string = 'tsdoc.json';
5050
public static readonly CURRENT_SCHEMA_URL: string
51-
= 'https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json';
51+
= 'https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json';
5252

5353
/**
5454
* A queryable log that reports warnings and error messages that occurred during parsing.

tsdoc-config/src/__tests__/TSDocConfigFile.test.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ test('Load p1', () => {
4141
"filePath": "assets/p1/tsdoc.json",
4242
"messages": Array [],
4343
"tagDefinitions": Array [],
44-
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
44+
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
4545
}
4646
`);
4747
});
@@ -90,7 +90,7 @@ test('Load p3', () => {
9090
"tagNameWithUpperCase": "@BASE1",
9191
},
9292
],
93-
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
93+
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
9494
},
9595
Object {
9696
"extendsFiles": Array [],
@@ -107,7 +107,7 @@ test('Load p3', () => {
107107
"tagNameWithUpperCase": "@BASE2",
108108
},
109109
],
110-
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
110+
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
111111
},
112112
],
113113
"extendsPaths": Array [
@@ -126,7 +126,7 @@ test('Load p3', () => {
126126
"tagNameWithUpperCase": "@ROOT",
127127
},
128128
],
129-
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
129+
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
130130
}
131131
`);
132132
});
@@ -149,7 +149,7 @@ test('Load p4', () => {
149149
"tagNameWithUpperCase": "@EXAMPLE",
150150
},
151151
],
152-
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
152+
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
153153
},
154154
],
155155
"extendsPaths": Array [
@@ -167,7 +167,7 @@ test('Load p4', () => {
167167
"tagNameWithUpperCase": "@ROOT",
168168
},
169169
],
170-
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
170+
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
171171
}
172172
`);
173173
});
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json"
2+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json"
33
}

tsdoc-config/src/__tests__/assets/p3/base1/tsdoc-base1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
2+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
33
"tagDefinitions": [
44
{
55
"tagName": "@base1",

tsdoc-config/src/__tests__/assets/p3/base2/tsdoc-base2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
2+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
33
"tagDefinitions": [
44
{
55
"tagName": "@base2",

tsdoc-config/src/__tests__/assets/p3/tsdoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
2+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
33
"extends": [
44
"./base1/tsdoc-base1.json",
55
"./base2/tsdoc-base2.json"

tsdoc-config/src/__tests__/assets/p4/node_modules/example-lib/dist/tsdoc-example.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tsdoc-config/src/__tests__/assets/p4/tsdoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
2+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
33
"extends": [
44
"example-lib/dist/tsdoc-example.json"
55
],

0 commit comments

Comments
 (0)