Importing a Smithy model

Smithy is AWS’s API modelling language. Restorm imports both of its representations.

Importing

File ▸ Import (Ctrl+I) then:

• a .smithy file (the modelling language);
• or the JSON AST produced by smithy build.

Both converge on the same internal model.

What is imported

Element	What Restorm makes of it
Each service / resource	A folder
Each operation carrying @http	An HTTP request
@httpLabel	A path parameter
@httpQuery	A query parameter
@httpHeader	A header
Documentation and types	The API documentation and the enumerations

Limitations (version 1 of the import)

• An operation without an @http trait is documentation-only: it appears in the API documentation but produces no request.
• SigV4 authentication is not pre-wired: configure it by hand.
• Non-REST protocol bindings (awsJson1_1, awsQuery…) are not modelled.
• Lists, maps and unions are not first-class shapes.
• Validation traits (@pattern, @length, @paginated, @readonly…) are silently ignored.
• Smithy protocol tests are ignored.

Updating

Smithy is one of the re-syncable formats. See Updating from the source.