Reorganize YAML

tolyo · Sep 5, 2023 · b1f68cc · b1f68cc
1 parent 6824552
commit b1f68cc
Show file tree

Hide file tree

Showing 24 changed files with 22 additions and 264 deletions.
diff --git a/Makefile b/Makefile
@@ -39,15 +39,14 @@ db-rebuild: ## Reset the database
 	$(MAKE) db-downgrade
 	$(MAKE) db-update
 
-build-api: ## Build OpenAPI
-	node node_modules/swagger-cli/swagger-cli.js bundle --dereference \
- 		-o pkg/static/docs/api/openapi.json \
- 		-t json \
- 		-r openapi/openapi.yaml
+validate-api: ## Validate api
+	npx @openapitools/openapi-generator-cli validate \
+		-i pkg/openapi.yaml \
+		--recommend
 
-generate-api: ## Generate server bindings
+generate-api: ## Generate server bindings, move model files, fix imports
 	npx @openapitools/openapi-generator-cli generate \
-		-i openapi/openapi.yaml \
+		-i pkg/openapi.yaml \
 		-g go-server \
 		-o pkg/rest \
 		--additional-properties=packageName=api \
@@ -57,4 +56,4 @@ generate-api: ## Generate server bindings
 
 help:
 	grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) \
-	| sed -n 's/^\(.*\): \(.*\)##\(.*\)/\1\3/p'
+	| sed -n 's/^\(.*\): \(.*\)##\(.*\)/\1\3/p'
diff --git a/openapi/definitions/currency.yaml → pkg/models/currency.yaml b/openapi/definitions/currency.yaml → pkg/models/currency.yaml
diff --git a/openapi/definitions/instrument.yaml → pkg/models/instrument.yaml b/openapi/definitions/instrument.yaml → pkg/models/instrument.yaml
diff --git a/openapi/definitions/order_book.yaml → pkg/models/order_book.yaml b/openapi/definitions/order_book.yaml → pkg/models/order_book.yaml
diff --git a/openapi/definitions/shared.yaml → pkg/models/shared.yaml b/openapi/definitions/shared.yaml → pkg/models/shared.yaml
diff --git a/openapi/definitions/trade.yaml → pkg/models/trade.yaml b/openapi/definitions/trade.yaml → pkg/models/trade.yaml
diff --git a/openapi/definitions/trade_order.yaml → pkg/models/trade_order.yaml b/openapi/definitions/trade_order.yaml → pkg/models/trade_order.yaml
diff --git a/openapi/definitions/trading_account.yaml → pkg/models/trading_account.yaml b/openapi/definitions/trading_account.yaml → pkg/models/trading_account.yaml
diff --git a/openapi/openapi.yaml → pkg/openapi.yaml b/openapi/openapi.yaml → pkg/openapi.yaml
@@ -28,12 +28,12 @@ components:
       scheme: basic
 paths:
   /currencies:
-    $ref: ./paths/currencies_list.yaml
+    $ref: ./rest/api/currencies_list.yaml
   /instruments:
-    $ref: paths/instruments_list.yaml
+    $ref: ./rest/api/instruments_list.yaml
   /order_books/{instrument_name}:
-    $ref: paths/order_books.yaml
+    $ref: ./rest/api/order_books.yaml
   /trades:
-    $ref: paths/trades_list.yaml
+    $ref: ./rest/api/trades_list.yaml
   /trade_orders:
-    $ref: paths/trade_orders_list.yaml
+    $ref: ./rest/api/trade_orders_list.yaml
diff --git a/pkg/rest/.openapi-generator-ignore b/pkg/rest/.openapi-generator-ignore
@@ -3,6 +3,9 @@
 
 # Use this file to prevent files from being overwritten by the generator.
 # The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
 **/routers.go
 
 # You can match any string of characters against a directory, file or extension with a single asterisk (*):

diff --git a/pkg/rest/README.md b/pkg/rest/README.md
@@ -24,7 +24,7 @@ To see how to make this your own, look here:
 [README](https://openapi-generator.tech)
 
 - API version: 1.0.0
-- Build date: 2023-09-05T22:09:37.812488+03:00[Europe/Riga]
+- Build date: 2023-09-05T23:22:31.538915+03:00[Europe/Riga]
 
 
 ### Running the server

diff --git a/openapi/paths/currencies_list.yaml → pkg/rest/api/currencies_list.yaml b/openapi/paths/currencies_list.yaml → pkg/rest/api/currencies_list.yaml
@@ -10,6 +10,6 @@ get:
       content:
         application/json:
           schema:
-            $ref: ../definitions/currency.yaml#/components/schemas/CurrencyList
+            $ref: ../../models/currency.yaml#/components/schemas/CurrencyList
     "500":
       description: Error
diff --git a/openapi/paths/instruments_list.yaml → pkg/rest/api/instruments_list.yaml b/openapi/paths/instruments_list.yaml → pkg/rest/api/instruments_list.yaml
@@ -10,6 +10,6 @@ get:
       content:
         application/json:
           schema:
-            $ref: ../definitions/instrument.yaml#/components/schemas/InstrumentList
+            $ref: ../../models/instrument.yaml#/components/schemas/InstrumentList
     "500":
       description: Error
diff --git a/pkg/rest/api/model_instrument.go b/pkg/rest/api/model_instrument.go
diff --git a/pkg/rest/api/model_order_book.go b/pkg/rest/api/model_order_book.go
diff --git a/pkg/rest/api/model_price_volume.go b/pkg/rest/api/model_price_volume.go
diff --git a/pkg/rest/api/model_trade.go b/pkg/rest/api/model_trade.go
diff --git a/pkg/rest/api/model_trade_order.go b/pkg/rest/api/model_trade_order.go
diff --git a/pkg/rest/api/model_trade_order_side.go b/pkg/rest/api/model_trade_order_side.go
diff --git a/pkg/rest/api/model_trade_order_status.go b/pkg/rest/api/model_trade_order_status.go
diff --git a/pkg/rest/api/model_trade_order_time_in_force.go b/pkg/rest/api/model_trade_order_time_in_force.go
diff --git a/openapi/paths/order_books.yaml → pkg/rest/api/order_books.yaml b/openapi/paths/order_books.yaml → pkg/rest/api/order_books.yaml
@@ -9,14 +9,14 @@ get:
       name: instrument_name
       required: true
       schema:
-        $ref: '../definitions/instrument.yaml#/components/schemas/InstrumentName'
+        $ref: '../../models/instrument.yaml#/components/schemas/InstrumentName'
 
   responses:
     "200":
       description: order book
       content:
         application/json:
           schema:
-            $ref: '../definitions/order_book.yaml#/components/schemas/OrderBook'
+            $ref: '../../models/order_book.yaml#/components/schemas/OrderBook'
     "500":
       description: Error
diff --git a/openapi/paths/trade_orders_list.yaml → pkg/rest/api/trade_orders_list.yaml b/openapi/paths/trade_orders_list.yaml → pkg/rest/api/trade_orders_list.yaml
@@ -10,6 +10,6 @@ get:
       content:
         application/json:
           schema:
-            $ref: ../definitions/trade_order.yaml#/components/schemas/TradeOrderList
+            $ref: ../../models/trade_order.yaml#/components/schemas/TradeOrderList
     "500":
       description: Error
diff --git a/openapi/paths/trades_list.yaml → pkg/rest/api/trades_list.yaml b/openapi/paths/trades_list.yaml → pkg/rest/api/trades_list.yaml
@@ -10,6 +10,6 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../definitions/trade.yaml#/components/schemas/TradeList'
+            $ref: '../../models/trade.yaml#/components/schemas/TradeList'
     "500":
       description: Error