authelia/web
Amir Zarrinkafsh 3487fd392e
[FEATURE] Add API docs and swagger-ui (#1544)
* [FEATURE] Add API docs and swagger-ui

This change will serve out swagger-ui at the `/api/` root path.

* Update descriptions and summaries in API spec

* Utilise frontend assets from unit testing for Docker build steps

* Fix tag for /api/user/* endpoints

* Fix response schema for /api/user/info/2fa_method

* Template and inject the session name during runtime into swagger-ui

This change also factorises and renames index.go into template.go, this can now be generically utilised to template any file.

* Fix integration tests

* Add U2F endpoints

* Change swagger directory to api

This change is to more closely conform to the golang-standards project layout.

* Add authentication for u2f endpoints

* Modify u2f endpoint descriptions

* Rename and fix u2f 2fa sign endpoints

* Fix request body for /api/secondfactor/u2f/sign endpoint

Co-authored-by: James Elliott <james-d-elliott@users.noreply.github.com>
2021-01-03 15:28:46 +11:00
..
public [CI] Fix development workflow (#1465) 2020-11-16 20:58:29 +11:00
src [CI] Add linting option for frontend and enforce styling (#1565) 2021-01-02 21:58:24 +11:00
types [CI] Add linting option for frontend and enforce styling (#1565) 2021-01-02 21:58:24 +11:00
.env.development [CI] Fix development workflow (#1465) 2020-11-16 20:58:29 +11:00
.env.production [CI] Fix development workflow (#1465) 2020-11-16 20:58:29 +11:00
.eslintrc.js [CI] Add linting option for frontend and enforce styling (#1565) 2021-01-02 21:58:24 +11:00
.gitignore [FEATURE] Add API docs and swagger-ui (#1544) 2021-01-03 15:28:46 +11:00
.prettierrc.js [CI] Add linting option for frontend and enforce styling (#1565) 2021-01-02 21:58:24 +11:00
README.md Misc Spelling Corrections 2020-01-21 12:16:00 +11:00
craco.config.js [CI] Collect coverage from frontend during integration tests (#1472) 2020-11-19 12:50:34 +11:00
package.json [CI] Add linting option for frontend and enforce styling (#1565) 2021-01-02 21:58:24 +11:00
tsconfig.json [MISC] Catch OpenLDAP ppolicy error (#1508) 2020-12-16 12:30:03 +11:00
yarn.lock [CI] Add linting option for frontend and enforce styling (#1565) 2021-01-02 21:58:24 +11:00

README.md

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you cant go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point youre on your own.

You dont have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.