Skip to content

Commit 62dfe94

Browse files
Update Project-scope-and-goals.md (apple#509)
### Motivation One of the examples no longer applies, we now do support customizing the access modifier. ### Modifications Updated the docs. ### Result More accurate docs. ### Test Plan N/A --------- Co-authored-by: Si Beaumont <[email protected]>
1 parent cc9964f commit 62dfe94

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Sources/swift-openapi-generator/Documentation.docc/Articles/Project-scope-and-goals.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,11 @@ Another example is the generation of empty structs within the input or output ty
3838

3939
Some generators offer lots of options that affect the code generation process. In order to keep the project streamlined and maintainable, Swift OpenAPI Generator offers very few options.
4040

41-
One concrete example of this is that users cannot configure the access modifier for generated code, nor does the generated code make any provision for namespace collisions in the target into which it is generated.
41+
One concrete example of this is that users cannot configure the names of generated types, such as `Client` and `APIProtocol`, and there is no attempt to prevent namespace collisions in the target into which it is generated.
4242

43-
Instead, users are advised to generate code into its own target, and use Swift's module system to separate the generated code from code that uses it.
43+
Instead, users are advised to generate code into a dedicated target, and use Swift's module system to separate the generated code from code that depends on it.
44+
45+
Another example is the lack of ability to customize how Swift names are computed from strings provided in the OpenAPI document.
4446

4547
You can read more about this in <doc:API-stability-of-generated-code>.
4648

0 commit comments

Comments
 (0)