aboutsummaryrefslogtreecommitdiff
path: root/src/api/README.md
diff options
context:
space:
mode:
authorMax Nanis2025-06-02 16:45:21 +0700
committerMax Nanis2025-06-02 16:45:21 +0700
commite6037b430935720ce60245ae36ecd3622e8a22bf (patch)
tree13919b0f73729ad47a31e06bdd710f774d70cac0 /src/api/README.md
parent8caa77413ea372e5cbd2980a9922d701af359c04 (diff)
downloadpanel-ui-e6037b430935720ce60245ae36ecd3622e8a22bf.tar.gz
panel-ui-e6037b430935720ce60245ae36ecd3622e8a22bf.zip
Updated openapi generator to use the latest version (camelCase to underscore - which respects API models). Updating views to use the new swagger definitions. AnswerSlice as a datastore alongside Questions TS interface
Diffstat (limited to 'src/api/README.md')
-rw-r--r--src/api/README.md46
1 files changed, 8 insertions, 38 deletions
diff --git a/src/api/README.md b/src/api/README.md
index 9fffca2..1b3e223 100644
--- a/src/api/README.md
+++ b/src/api/README.md
@@ -1,45 +1,15 @@
-## @1.0.0
-This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
-
-Environment
-* Node.js
-* Webpack
-* Browserify
-
-Language level
-* ES5 - you must have a Promises/A+ library installed
-* ES6
-
-Module system
-* CommonJS
-* ES6 module system
-
-It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
-
-### Building
-
-To build and compile the typescript sources to javascript use:
-```
-npm install
-npm run build
```
+brew install openjdk
+export PATH="/opt/homebrew/opt/openjdk/bin:$PATH"
+export CPPFLAGS="-I/opt/homebrew/opt/openjdk/include"
-### Publishing
+source ~/.zshrc # or source ~/.bash_profile
+java -version
-First build the package then run ```npm publish```
-### Consuming
-navigate to the folder of your consuming project and run one of the following commands.
+wget https://fsb.generalresearch.com/openapi.json
-_published:_
-
-```
-npm install @1.0.0 --save
-```
-
-_unPublished (not recommended):_
-
-```
-npm install PATH_TO_GENERATED_PACKAGE --save
+openapi-generator-cli generate -i ./openapi.json -g typescript-axios -o ./ --skip-validate-spec
+``` \ No newline at end of file