Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API Documentation to Main Menu #422

Merged
merged 3 commits into from
Mar 20, 2023
Merged

Add API Documentation to Main Menu #422

merged 3 commits into from
Mar 20, 2023

Conversation

axelstudios
Copy link
Member

@axelstudios axelstudios commented Mar 16, 2023

Bug Fixes

  • Fixes signed urls for downloads when S3_EXTERNAL_URL is a hostname (e.g. localhost) rather than an IP address
  • Fixed OpenAPI 3.1 schema validation

Improvements

  • Creates a new API DOCS menu item, and directly embeds the static documentation into the SPA routing
  • Docs are cached in memory in production rather than reading the file every time
  • npm run watch has been overhauled to watch the app/docs/server indepenently in parallel without rebuilding every component every time
  • Inlined logo for performance
  • Added StrictMode checks for development
  • Migrated to @redocly/cli from deprecated redoc-cli
  • Added path parameters to documentation
  • Zero npm vulnerabilities

image

Fixes #421

@axelstudios axelstudios force-pushed the task/embed-docs branch 2 times, most recently from c9403b4 to 26bab6d Compare March 17, 2023 21:28
@axelstudios axelstudios merged commit 74a1598 into develop Mar 20, 2023
@axelstudios axelstudios deleted the task/embed-docs branch March 20, 2023 15:03
TShapinsky added a commit that referenced this pull request Mar 28, 2023
* run integration tests with 2 workers

* Fix container name

* Make modelica use datetimes instead of floats

* fix simulation tests

* add tests for multiple workers

* add scaling tests to ci tests

* add scale to pytest markers

* add aliases to web

* Add REST API endpoints required to move client to REST. Also consolidated Run and Point Classes and Models. And other changes...

* fix integration tests

* fix tests

* fix ci tests

* fix and consolidate worker simulation tests

* fix site ui not displaying

* re-add mongoengine connect

* Small fixes

* revert change

* lock versions of dependent docker containers (#393)

* lock versions of dependent docker containers

* precommit gitlab -> github

* change print statement to use logger

* fix datetime print

* Upgrade dependencies, use python virtualenv (#394)

* use tilde for versioning
* update versions of precommit
* npm update
* install assulimo and pyfmi in venv
* fix start worker location
* remove tox pieces since we are no longer using it

* Bump setuptools from 65.3.0 to 65.5.1 (#396)

Bumps [setuptools](https://github.com/pypa/setuptools) from 65.3.0 to 65.5.1.
- [Release notes](https://github.com/pypa/setuptools/releases)
- [Changelog](https://github.com/pypa/setuptools/blob/main/CHANGES.rst)
- [Commits](pypa/setuptools@v65.3.0...v65.5.1)

---
updated-dependencies:
- dependency-name: setuptools
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* add retry if alfalfa gets bad response from e+. This can possibly happen in cases of resource constraints

* Bump luxon from 3.2.0 to 3.2.1 in /alfalfa_web

Bumps [luxon](https://github.com/moment/luxon) from 3.2.0 to 3.2.1.
- [Release notes](https://github.com/moment/luxon/releases)
- [Changelog](https://github.com/moment/luxon/blob/master/CHANGELOG.md)
- [Commits](moment/luxon@3.2.0...3.2.1)

---
updated-dependencies:
- dependency-name: luxon
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

* extend timeout for e+ simulation to start and remove workaround (#399)

* limit worker dockerfile to copying worker files

* remove annual_run job

* allow merging of osws without measures

* add minimal resstock osw and consolidate basic model testing

* fix scaling test

* add aliases to Alfalfa

* point to client with alias support

* Ternary tweak

* wait for alias to be written to database

* Dependency update and cleanup

* Update client branch

* Overhaul Point Generation  (#406)

* overhaul energyplus point generation

* add site meter sensors

* remove debug print in variables.py

* fix ems output variable in ems measures

* push updated poetry config

* update lock file

* GraphQL Removal, Bug Fixes, & Improvements (#415)

* - Migrated to AWS SDK v3 as v2 is being deprecated
- Fixed broken `mc policy` usage
- Fixed potential createModel race condition
- Fixed writeInputPoint bugs
- Added missing context argument to runSimResolver
- Fixed deprecated `collection.insert` call
- Fixed docs generation
- Zero npm vulnerabilities!

* GraphQL removal and major refactor

* Fixed FMU simulations in UI

* Add ErrorDialog

* Add API Documentation to Main Menu (#422)

* Added docs to main menu

* Fixed getSignedUrl, improved watch

* Redocly update

* Bump versions to 0.5.0 (#425)

* bump versions to 0.5.0

* Bump web to 0.5.0

---------

Co-authored-by: Alex Swindler <Alex.Swindler@nrel.gov>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Nicholas Long <1907354+nllong@users.noreply.github.com>
Co-authored-by: Anya Petersen <anyaelena@gmail.com>
Co-authored-by: Alex Swindler <Alex.Swindler@nrel.gov>
Co-authored-by: Nicholas Long <nicholas.long@nrel.gov>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
TShapinsky added a commit that referenced this pull request Mar 30, 2023
Merge Develop into Main for 0.5.0 (#427)

* run integration tests with 2 workers

* Fix container name

* Make modelica use datetimes instead of floats

* fix simulation tests

* add tests for multiple workers

* add scaling tests to ci tests

* add scale to pytest markers

* add aliases to web

* Add REST API endpoints required to move client to REST. Also consolidated Run and Point Classes and Models. And other changes...

* fix integration tests

* fix tests

* fix ci tests

* fix and consolidate worker simulation tests

* fix site ui not displaying

* re-add mongoengine connect

* Small fixes

* revert change

* lock versions of dependent docker containers (#393)

* lock versions of dependent docker containers

* precommit gitlab -> github

* change print statement to use logger

* fix datetime print

* Upgrade dependencies, use python virtualenv (#394)

* use tilde for versioning
* update versions of precommit
* npm update
* install assulimo and pyfmi in venv
* fix start worker location
* remove tox pieces since we are no longer using it

* Bump setuptools from 65.3.0 to 65.5.1 (#396)

Bumps [setuptools](https://github.com/pypa/setuptools) from 65.3.0 to 65.5.1.
- [Release notes](https://github.com/pypa/setuptools/releases)
- [Changelog](https://github.com/pypa/setuptools/blob/main/CHANGES.rst)
- [Commits](pypa/setuptools@v65.3.0...v65.5.1)

---
updated-dependencies:
- dependency-name: setuptools
  dependency-type: direct:production
...






* add retry if alfalfa gets bad response from e+. This can possibly happen in cases of resource constraints

* Bump luxon from 3.2.0 to 3.2.1 in /alfalfa_web

Bumps [luxon](https://github.com/moment/luxon) from 3.2.0 to 3.2.1.
- [Release notes](https://github.com/moment/luxon/releases)
- [Changelog](https://github.com/moment/luxon/blob/master/CHANGELOG.md)
- [Commits](moment/luxon@3.2.0...3.2.1)

---
updated-dependencies:
- dependency-name: luxon
  dependency-type: direct:production
...



* extend timeout for e+ simulation to start and remove workaround (#399)

* limit worker dockerfile to copying worker files

* remove annual_run job

* allow merging of osws without measures

* add minimal resstock osw and consolidate basic model testing

* fix scaling test

* add aliases to Alfalfa

* point to client with alias support

* Ternary tweak

* wait for alias to be written to database

* Dependency update and cleanup

* Update client branch

* Overhaul Point Generation  (#406)

* overhaul energyplus point generation

* add site meter sensors

* remove debug print in variables.py

* fix ems output variable in ems measures

* push updated poetry config

* update lock file

* GraphQL Removal, Bug Fixes, & Improvements (#415)

* - Migrated to AWS SDK v3 as v2 is being deprecated
- Fixed broken `mc policy` usage
- Fixed potential createModel race condition
- Fixed writeInputPoint bugs
- Added missing context argument to runSimResolver
- Fixed deprecated `collection.insert` call
- Fixed docs generation
- Zero npm vulnerabilities!

* GraphQL removal and major refactor

* Fixed FMU simulations in UI

* Add ErrorDialog

* Add API Documentation to Main Menu (#422)

* Added docs to main menu

* Fixed getSignedUrl, improved watch

* Redocly update

* Bump versions to 0.5.0 (#425)

* bump versions to 0.5.0

* Bump web to 0.5.0

---------



---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Nicholas Long <1907354+nllong@users.noreply.github.com>
Co-authored-by: Anya Petersen <anyaelena@gmail.com>
Co-authored-by: Alex Swindler <Alex.Swindler@nrel.gov>
Co-authored-by: Nicholas Long <nicholas.long@nrel.gov>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add link to /docs from main ui menu
2 participants