Skip to content

Commit 91b688d

Browse files
committed
Adding sdk_id to services in examples json.
1 parent fdbb71e commit 91b688d

File tree

3 files changed

+5
-0
lines changed

3 files changed

+5
-0
lines changed

aws_doc_sdk_examples_tools/doc_gen.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,7 @@ def fill_missing_fields(self):
281281
action = id_action
282282
if service_id in self.services:
283283
service_name = self.services[service_id].short
284+
example.service_sdk_id = self.services[service_id].sdk_id
284285
else:
285286
service_name = service_id
286287
example.fill_display_fields(self.categories, service_name, action)

aws_doc_sdk_examples_tools/doc_gen_test.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@ def sample_doc_gen() -> DocGen:
161161
"s3_PutObject",
162162
file=Path("filea.txt"),
163163
languages={},
164+
service_sdk_id="S3",
164165
services={"s3": set(["PutObject"])},
165166
)
166167
},
@@ -253,6 +254,7 @@ def test_doc_gen_encoder(sample_doc_gen: DocGen):
253254
"id": "s3_PutObject",
254255
"languages": {},
255256
"service_main": None,
257+
"service_sdk_id": "S3",
256258
"services": {
257259
"s3": {
258260
"__set__": [

aws_doc_sdk_examples_tools/metadata.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,8 @@ class Example:
154154
# TODO document service_main and services. Not to be used by tributaries. Part of Cross Service.
155155
# List of services used by the examples. Lines up with those in services.yaml.
156156
service_main: Optional[str] = field(default=None)
157+
# Main service sdk_id. Matches Smithy model svc_id in services.yaml.
158+
service_sdk_id: Optional[str] = field(default="")
157159
services: Dict[str, Set[str]] = field(default_factory=dict)
158160
# HTML file names corresponding to the documentation pages in the Code Library
159161
doc_filenames: Optional[DocFilenames] = field(default=None)

0 commit comments

Comments
 (0)