Skip to content

Commit 1db165d

Browse files
Fix a few typos
1 parent 47cc676 commit 1db165d

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A C# application for parsing OpenAPI specifications and generating Dyalog APL client code.
44

5-
**This project is in active development and is not yet functional.**
5+
**This project is in active development and is not yet fully functional. Many features remain unimplemented.**
66

77
## Project Structure
88

docs/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ result←api.pet.addPet.syncDetailed (client:client ⋄ Pet:newPet)
3737
:If result.statusCode≡200
3838
⎕←'Created pet with ID: ',⍕result.parsed.id
3939
:Else
40-
⎕←'Error: ',result.Error
40+
⎕←'Error'
4141
:EndIf
4242
```
4343

docs/generated-code.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The `Client.aplc` file contains the main client class that serves as the entry p
5858
:field public Initialised←0
5959
6060
∇ (rc msg)←Initialise
61-
Initialize HttpCommand
61+
←Initialise HttpCommand
6262
⍝ Checks parent namespace
6363
6464
:EndClass
@@ -95,8 +95,8 @@ Each API operation generates an individual namespace containing helper functions
9595
9696
9797
∇ r←parseResponse response
98-
Parse HTTP response based on status code
99-
HttpCommand automatically parses JSON
98+
HttpCommand returns the response body already JSON-decoded (if applicable)
99+
This function interprets that data per status code and maps it to models or errors
100100
⍝ Returns: Parsed data or error information
101101
102102
:EndNamespace
@@ -152,7 +152,7 @@ Data models are generated from OpenAPI schemas:
152152
### Model Features
153153

154154
- **Type Annotations**: Comments document field types and requirements
155-
- **Namespace Constructor**: Accepts a namespace to initialize fields
155+
- **Namespace Constructor**: Accepts a namespace to initialise fields
156156
- **FormatNS Method**: Builds namespace for JSON serialization, excluding undefined fields
157157
- **Helper Functions**: `isVarDefined` checks field existence
158158
- **Nested Objects**: Reference types point to other model classes
@@ -174,7 +174,7 @@ The generated client surfaces errors through HTTP status codes and the `HttpComm
174174
- Each operation's `parseResponse` handles expected status codes
175175
- HttpCommand provides `HttpStatus` field for checking responses
176176
- Error responses are returned as-is (pre-parsed by HttpCommand)
177-
- Client code should check `resp.statusCode` (if using syncDetailed) to determine success/failure
177+
- Client code should check `result.statusCode` (if using syncDetailed) to determine success/failure
178178

179179
## Customization
180180

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Welcome to the documentation for the Dyalog APL OpenAPI Client Generator. This t
44

55
!!! warning "Development Status"
66
This project is in active development and is not yet fully functional.
7+
The documentation is also in active development, and as such many sections remain incomplete.
78

89
## Overview
910

docs/usage-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This will create a complete APL client in the `./output` directory.
3434
client ← ⎕NEW Client
3535
3636
⍝ Call an API method
37-
result ← api.pet.findPetsByStatus (client:client ⋄ status:'available')
37+
result ← api.pet.findPetsByStatus.syncDetailed (client:client ⋄ status:'available')
3838
3939
⍝ Handle the response
4040
:If result.statusCode≡200

0 commit comments

Comments
 (0)