Skip to content

Commit 67a404e

Browse files
nickghardwickanandanthony
authored andcommitted
Add API Doc for Schema Registry Version 2022-10 API (Azure#21170)
* Add Swagger for 2022-10 API * Update readme file with latest api version * Prettier fix * Re-add 2021-10 version in readme * Address comments on spelling, accept headers * Address comments * Address comments, revert breaking change * Fix typo * Revert operation id * Add x-ms-pageable to data list operations * Change "value" to "itemName" in pageable object * ✨Fix PrettierCheck * Address comment on adding x-ms-client-names * Add standardized content types for Json and custom * Update examples with new content types * Change Json to lowercase
1 parent 09f9e9b commit 67a404e

File tree

8 files changed

+746
-1
lines changed

8 files changed

+746
-1
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"parameters": {
3+
"endpoint": "mynamespace.servicebus.windows.net",
4+
"id": "b489dc4916744e3db72dda8f9693f342",
5+
"api-version": "2022-10"
6+
},
7+
"responses": {
8+
"200": {
9+
"headers": {
10+
"Location": "https://sample-namespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-schema-name/versions/3?api-version=2022-10",
11+
"Content-Type": "application/json; serialization=json",
12+
"Schema-Id": "b489dc4916744e3db72dda8f9693f342",
13+
"Schema-Id-Location": "https://sample-namespace.servicebus.windows.net/$schemagroups?api-version=2021-10&schema-id=b489dc4916744e3db72dda8f9693f342",
14+
"Schema-Group-Name": "sample-sr-group",
15+
"Schema-Name": "sample-json-schema",
16+
"Schema-Version": 4
17+
},
18+
"body": "{\"title\":\"Person\",\"type\":\"object\",\"properties\":{\"firstName\":{\"type\":\"string\",},\"lastName\":{\"type\":\"string\",},\"age\":{\"type\":\"integer\",\"minimum\":0}}}"
19+
}
20+
}
21+
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"parameters": {
3+
"endpoint": "mynamespace.servicebus.windows.net",
4+
"groupName": "sample-sr-group",
5+
"schemaName": "sample-json-schema",
6+
"schemaVersion": 25,
7+
"api-version": "2022-10"
8+
},
9+
"responses": {
10+
"200": {
11+
"headers": {
12+
"Location": "https://sample-namespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-json-schema/versions/25?api-version=2022-10",
13+
"Content-Type": "application/json; serialization=json",
14+
"Schema-Id": "b489dc4916744e3db72dda8f9693f392",
15+
"Schema-Id-Location": "https://sample-namespace.servicebus.windows.net/$schemagroups?api-version=2022-10&schema-id=b489dc4916744e3db72dda8f9693f342",
16+
"Schema-Group-Name": "sample-sr-group",
17+
"Schema-Name": "sample-json-schema",
18+
"Schema-Version": 25,
19+
"Schema-Version-Location": "https://sample-namespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-json-schema/versions/?api-version=2022-10"
20+
},
21+
"body": "{\"title\":\"Person\",\"type\":\"object\",\"properties\":{\"firstName\":{\"type\":\"string\",},\"lastName\":{\"type\":\"string\",},\"age\":{\"type\":\"integer\",\"minimum\":0}}}"
22+
}
23+
}
24+
}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"parameters": {
3+
"endpoint": "mynamespace.servicebus.windows.net",
4+
"api-version": "2022-10"
5+
},
6+
"responses": {
7+
"200": {
8+
"body": {
9+
"schemaGroups": [
10+
"group1",
11+
"group2",
12+
"group3"
13+
],
14+
"nextLink": "https://mynamespace.servicebus.windows.net/$schemagroups/?api-version=2022-10&skip=3"
15+
}
16+
}
17+
}
18+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"parameters": {
3+
"endpoint": "mynamespace.servicebus.windows.net",
4+
"groupName": "sample-sr-group",
5+
"schemaName": "sample-schema-name",
6+
"api-version": "2022-10"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"schemaVersions": [
12+
0,
13+
1,
14+
2
15+
],
16+
"nextLink": "https://mynamespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-schema-name/versions?api-version=2022-10&skip=3"
17+
}
18+
}
19+
}
20+
}
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"parameters": {
3+
"endpoint": "mynamespace.servicebus.windows.net",
4+
"groupName": "sample-sr-group",
5+
"schemaName": "sample-json-schema",
6+
"schemaContent": "{\"title\":\"Person\",\"type\":\"object\",\"properties\":{\"firstName\":{\"type\":\"string\",},\"lastName\":{\"type\":\"string\",},\"age\":{\"type\":\"integer\",\"minimum\":0}}}",
7+
"api-version": "2022-10"
8+
},
9+
"responses": {
10+
"204": {
11+
"headers": {
12+
"Location": "https://sample-namespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-json-schema/versions/3?api-version=2022-10",
13+
"Schema-Id": "b489dc4916744e3db72dda8f9693f342",
14+
"Schema-Id-Location": "https://sample-namespace.servicebus.windows.net/$schemagroups?api-version=2022-10&schema-id=b489dc4916744e3db72dda8f9693f342",
15+
"Schema-Group-Name": "sample-sr-group",
16+
"Schema-Name": "sample-json-schema",
17+
"Schema-Version": 4
18+
}
19+
}
20+
}
21+
}
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"parameters": {
3+
"endpoint": "mynamespace.servicebus.windows.net",
4+
"groupName": "sample-sr-group",
5+
"schemaName": "sample-json-schema",
6+
"schemaContent": "{\"title\":\"Person\",\"type\":\"object\",\"properties\":{\"firstName\":{\"type\":\"string\",},\"lastName\":{\"type\":\"string\",},\"age\":{\"type\":\"integer\",\"minimum\":0}}}",
7+
"api-version": "2022-10"
8+
},
9+
"responses": {
10+
"204": {
11+
"headers": {
12+
"Location": "https://sample-namespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-json-schema/versions/4?api-version=2022-10",
13+
"Schema-Id": "b489dc4916744e3db72dda8f9693f342",
14+
"Schema-Id-Location": "https://sample-namespace.servicebus.windows.net/$schemagroups?api-version=2022-10&schema-id=b489dc4916744e3db72dda8f9693f342",
15+
"Schema-Group-Name": "sample-sr-group",
16+
"Schema-Name": "sample-json-schema",
17+
"Schema-Version": 4
18+
}
19+
}
20+
}
21+
}

0 commit comments

Comments
 (0)