Skip to content

Commit 616302e

Browse files
nickghardwickJoshLove-msft
nickghardwick
and
JoshLove-msft
authored
Add OpenAPI Doc for Schema Registry 2023-07-01 API (#24789)
* Add 2023-07 API version for Protobuf schema type * Update samples with Protobuf schema info * Update README * Add "protobuf" to custom words * Fix typo in spec description Co-authored-by: JoshLove-msft <[email protected]> * Change API version to '2023-07-01' * Update README with new API version * Address PrettierCheck fix --------- Co-authored-by: JoshLove-msft <[email protected]>
1 parent 6d49d86 commit 616302e

File tree

9 files changed

+751
-1
lines changed

9 files changed

+751
-1
lines changed

‎custom-words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2055,6 +2055,7 @@ projecthilo
20552055
propagations
20562056
propogation
20572057
protectable
2058+
protobuf
20582059
providerhub
20592060
providerport
20602061
provisioner

‎specification/schemaregistry/data-plane/Microsoft.EventHub/stable/2023-07-01/examples/OperationSchema_GetById.json

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": "2023-07-01"
6+
},
7+
"responses": {
8+
"200": {
9+
"headers": {
10+
"Location": "https://sample-namespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-protobuf-schema/versions/5?api-version=2023-07",
11+
"Content-Type": "text/vnd.ms.protobuf",
12+
"Schema-Id": "b489dc4916744e3db72dda8f9693f342",
13+
"Schema-Id-Location": "https://sample-namespace.servicebus.windows.net/$schemagroups?api-version=2023-07&schema-id=b489dc4916744e3db72dda8f9693f342",
14+
"Schema-Group-Name": "sample-sr-group",
15+
"Schema-Name": "sample-protobuf-schema",
16+
"Schema-Version": 5
17+
},
18+
"body": "syntax=\"proto3\"; message SearchRequest{string query=1; int32 page_number=2; int32 results_per_page=3;}"
19+
}
20+
}
21+
}

‎specification/schemaregistry/data-plane/Microsoft.EventHub/stable/2023-07-01/examples/OperationSchema_GetByVersion.json

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-protobuf-schema",
6+
"schemaVersion": 25,
7+
"api-version": "2023-07-01"
8+
},
9+
"responses": {
10+
"200": {
11+
"headers": {
12+
"Location": "https://sample-namespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-protobuf-schema/versions/25?api-version=2023-07",
13+
"Content-Type": "text/vnd.ms.protobuf",
14+
"Schema-Id": "b489dc4916744e3db72dda8f9693f392",
15+
"Schema-Id-Location": "https://sample-namespace.servicebus.windows.net/$schemagroups?api-version=2023-07&schema-id=b489dc4916744e3db72dda8f9693f342",
16+
"Schema-Group-Name": "sample-sr-group",
17+
"Schema-Name": "sample-protobuf-schema",
18+
"Schema-Version": 25,
19+
"Schema-Version-Location": "https://sample-namespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-protobuf-schema/versions/?api-version=2023-07"
20+
},
21+
"body": "syntax=\"proto3\"; message SearchRequest{string query=1; int32 page_number=2; int32 results_per_page=3;}"
22+
}
23+
}
24+
}

‎specification/schemaregistry/data-plane/Microsoft.EventHub/stable/2023-07-01/examples/OperationSchema_GetSchemaGroups.json

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": "2023-07-01"
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=2023-07&skip=3"
15+
}
16+
}
17+
}
18+
}

‎specification/schemaregistry/data-plane/Microsoft.EventHub/stable/2023-07-01/examples/OperationSchema_GetSchemaVersions.json

Lines changed: 20 additions & 0 deletions
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": "2023-07-01"
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=2023-07&skip=3"
17+
}
18+
}
19+
}
20+
}

‎specification/schemaregistry/data-plane/Microsoft.EventHub/stable/2023-07-01/examples/OperationSchema_QueryIdByContent.json

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-protobuf-schema",
6+
"schemaContent": "syntax=\"proto3\"; message SearchRequest{string query=1; int32 page_number=2; int32 results_per_page=3;}",
7+
"api-version": "2023-07-01"
8+
},
9+
"responses": {
10+
"204": {
11+
"headers": {
12+
"Location": "https://sample-namespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-protobuf-schema/versions/3?api-version=2023-07",
13+
"Schema-Id": "b489dc4916744e3db72dda8f9693f342",
14+
"Schema-Id-Location": "https://sample-namespace.servicebus.windows.net/$schemagroups?api-version=2023-07&schema-id=b489dc4916744e3db72dda8f9693f342",
15+
"Schema-Group-Name": "sample-sr-group",
16+
"Schema-Name": "sample-protobuf-schema",
17+
"Schema-Version": 5
18+
}
19+
}
20+
}
21+
}

‎specification/schemaregistry/data-plane/Microsoft.EventHub/stable/2023-07-01/examples/OperationSchema_Register.json

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": "syntax=\"proto3\"; message SearchRequest{string query=1; int32 page_number=2; int32 results_per_page=3;}",
7+
"api-version": "2023-07-01"
8+
},
9+
"responses": {
10+
"204": {
11+
"headers": {
12+
"Location": "https://sample-namespace.servicebus.windows.net/$schemagroups/sample-sr-group/schemas/sample-protobuf-schema/versions/4?api-version=2022-10",
13+
"Schema-Id": "b489dc4916744e3db72dda8f9693f342",
14+
"Schema-Id-Location": "https://sample-namespace.servicebus.windows.net/$schemagroups?api-version=2023-07&schema-id=b489dc4916744e3db72dda8f9693f342",
15+
"Schema-Group-Name": "sample-sr-group",
16+
"Schema-Name": "sample-protobuf-schema",
17+
"Schema-Version": 4
18+
}
19+
}
20+
}
21+
}

0 commit comments

Comments
 (0)