11package apiSpecDoc
22
3- //ApiSpecDoc represents full API Specification document
4- //with all required data to view and execute requests
5- //Propose to not store something like components at the initial stage - leave it as update to simplify logic
6- //So each ApiMethod need to keep all schema (some duplication, but we could update it faster with extending of the model)
3+ // ApiSpecDoc represents full API Specification document
4+ // with all required data to view and execute requests
5+ // Propose to not store something like components at the initial stage - leave it as update to simplify logic
6+ // So each ApiMethod need to keep all schema (some duplication, but we could update it faster with extending of the model)
77type ApiSpecDoc struct {
88 //Type of API definition
99 //It's possible to be OpenApi, gRPC and others
@@ -13,15 +13,15 @@ type ApiSpecDoc struct {
1313 //It relates to:
1414 //Tags - Open API specs
1515 //Services - RPCs
16- Groups []Group
16+ Groups []* Group
1717
1818 //Methods at the root level without groups
19- Methods []ApiMethod
19+ Methods []* ApiMethod
2020}
2121
22- //Group represents some grouping rule
23- //Tags for the open API
24- //Services for the gRPC
22+ // Group represents some grouping rule
23+ // Tags for the open API
24+ // Services for the gRPC
2525type Group struct {
2626 //Name of the group
2727 Name string
@@ -30,10 +30,10 @@ type Group struct {
3030 Description string
3131
3232 //Methods is a set of request methods related to the group
33- Methods []ApiMethod
33+ Methods []* ApiMethod
3434}
3535
36- //ApiMethod represents particular API method to call
36+ // ApiMethod represents particular API method to call
3737type ApiMethod struct {
3838 //Path to send request
3939 //For example /open/api/info/
@@ -52,7 +52,7 @@ type ApiMethod struct {
5252 Type MethodType
5353
5454 //RequestBody is a description of ApiMethod request body, nil if no request body
55- RequestBody * MediaTypeObject
55+ RequestBody * RequestBody
5656
5757 //Servers represent available paths for requests with description.
5858 //In the case of swagger we need to calculate it taking the deepest nested servers definition
@@ -135,29 +135,29 @@ type Schema struct {
135135
136136 //Nested describe nested object/properties
137137 //If it's object and contain nested fields
138- Fields []Schema
138+ Fields []* Schema
139139}
140140
141- //MediaTypeObject represents schema for the different media types
142- //i.e. "application/json" and etc.
141+ // MediaTypeObject represents schema for the different media types
142+ // i.e. "application/json" and etc.
143143type MediaTypeObject struct {
144- Schema Schema
144+ Schema * Schema
145145}
146146
147- //RequestBody is a representation of request body
147+ // RequestBody is a representation of request body
148148type RequestBody struct {
149149 Description string
150150
151151 //Content represents request object for the different media types
152- Content map [string ]MediaTypeObject
152+ Content map [string ]* MediaTypeObject
153153
154154 //Required define is request body required
155155 Required bool
156156}
157157
158- //Server represents server description
159- //To use in the address line of view
160- //https://swagger.io/specification/#server-object
158+ // Server represents server description
159+ // To use in the address line of view
160+ // https://swagger.io/specification/#server-object
161161type Server struct {
162162 //Url to access server (no templates, real url)
163163 Url string
@@ -166,8 +166,8 @@ type Server struct {
166166 Description string
167167}
168168
169- //Parameter is abstraction of additional data to request
170- //It is headers for the REST API and metadata for the gRPC
169+ // Parameter is abstraction of additional data to request
170+ // It is headers for the REST API and metadata for the gRPC
171171type Parameter struct {
172172 Name string
173173
@@ -183,9 +183,9 @@ type Parameter struct {
183183 Required bool
184184}
185185
186- //ExternalDoc may be available for the Open API
187- //And contain link to description of request method
188- //Maybe useful also for debugging - to find failed API description rapidly
186+ // ExternalDoc may be available for the Open API
187+ // And contain link to description of request method
188+ // Maybe useful also for debugging - to find failed API description rapidly
189189type ExternalDoc struct {
190190 Description string
191191
0 commit comments