From dbd952f4be72055a1b3f4767adfad1766cbb218c Mon Sep 17 00:00:00 2001
From: ManifoldFR <wilson.jallet@gmail.com>
Date: Wed, 28 Feb 2018 10:56:31 +0100
Subject: [PATCH] Updated doc
---
doc/db_knex_router.js.html | 2 +-
doc/global.html | 2 +-
doc/index.html | 97 +------------------------
doc/knexfile.js.html | 2 +-
doc/src_admin_view_admin_router.js.html | 2 +-
doc/src_index.js.html | 2 +-
doc/src_ldap_auth_ldap_auth.js.html | 29 ++++----
doc/src_ldap_data_ldap_data.js.html | 2 +-
doc/src_server.js.html | 5 +-
9 files changed, 25 insertions(+), 118 deletions(-)
diff --git a/doc/db_knex_router.js.html b/doc/db_knex_router.js.html
index f5a52b6..e8790ff 100644
--- a/doc/db_knex_router.js.html
+++ b/doc/db_knex_router.js.html
@@ -51,7 +51,7 @@ module.exports = require('knex')(config);</code></pre>
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:15:16 GMT+0100 (Paris, Madrid)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:56:16 GMT+0100 (Romance Standard Time)
</footer>
<script> prettyPrint(); </script>
diff --git a/doc/global.html b/doc/global.html
index 5042c70..c0fdf18 100644
--- a/doc/global.html
+++ b/doc/global.html
@@ -735,7 +735,7 @@
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:15:16 GMT+0100 (Paris, Madrid)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:56:16 GMT+0100 (Romance Standard Time)
</footer>
<script> prettyPrint(); </script>
diff --git a/doc/index.html b/doc/index.html
index 210794c..ebcbb29 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -442,7 +442,7 @@
<div class="container-overview">
- <div class="description"><p>Ce fichier gère les authentifications avec le LDAP précisé dans config.json.</p></div>
+ <div class="description"><p>ldap_auth</p></div>
@@ -476,99 +476,6 @@
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="src_ldap_auth_ldap_auth.js.html">src/ldap_auth/ldap_auth.js</a>, <a href="src_ldap_auth_ldap_auth.js.html#line11">line 11</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-</dl>
-
-
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-</article>
-
-</section>
-
-
-
-
-
-
-
-<section>
-
-<header>
-
- <h2>src/ldap_auth/ldap_auth.js</h2>
-
-
-</header>
-
-<article>
- <div class="container-overview">
-
-
- <div class="description"><p>ldap_auth</p></div>
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -821,7 +728,7 @@
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:15:16 GMT+0100 (Paris, Madrid)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:56:16 GMT+0100 (Romance Standard Time)
</footer>
<script> prettyPrint(); </script>
diff --git a/doc/knexfile.js.html b/doc/knexfile.js.html
index f149d4d..6ccae9f 100644
--- a/doc/knexfile.js.html
+++ b/doc/knexfile.js.html
@@ -72,7 +72,7 @@ module.exports = {
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:15:16 GMT+0100 (Paris, Madrid)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:56:16 GMT+0100 (Romance Standard Time)
</footer>
<script> prettyPrint(); </script>
diff --git a/doc/src_admin_view_admin_router.js.html b/doc/src_admin_view_admin_router.js.html
index 2f6365d..49620d2 100644
--- a/doc/src_admin_view_admin_router.js.html
+++ b/doc/src_admin_view_admin_router.js.html
@@ -156,7 +156,7 @@ export default router;
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:15:16 GMT+0100 (Paris, Madrid)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:56:16 GMT+0100 (Romance Standard Time)
</footer>
<script> prettyPrint(); </script>
diff --git a/doc/src_index.js.html b/doc/src_index.js.html
index fd0cd9a..1c6942c 100644
--- a/doc/src_index.js.html
+++ b/doc/src_index.js.html
@@ -66,7 +66,7 @@ server.listen(port, () => {
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:15:16 GMT+0100 (Paris, Madrid)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:56:16 GMT+0100 (Romance Standard Time)
</footer>
<script> prettyPrint(); </script>
diff --git a/doc/src_ldap_auth_ldap_auth.js.html b/doc/src_ldap_auth_ldap_auth.js.html
index a4327d8..2e035a7 100644
--- a/doc/src_ldap_auth_ldap_auth.js.html
+++ b/doc/src_ldap_auth_ldap_auth.js.html
@@ -28,30 +28,27 @@
<article>
<pre class="prettyprint source linenums"><code>/**
* @file ldap_auth
- * @summary Setup de l'auth ldap avec passport-ldapauth
+ * @author Wangounet
+ * @summary Configuration de l'authentification LDAP du backend via passport-ldap
*/
-
import passport from 'passport';
import LdapStrategy from 'passport-ldapauth';
import session from 'express-session';
import fs from 'fs';
-/**
- * @file Ce fichier gère les authentifications avec le LDAP précisé dans config.json.
- * @author Wangounet
- */
+let config = JSON.parse(fs.readFileSync('config.json', 'utf8'));
+
+passport.use(new LdapStrategy({
+ server: {
+ url: config.ldap.server,
+ searchBase: config.ldap.searchBase,
+ searchFilter: config.ldap.searchFilter
+ }
+}));
function setupLdapAuth(server) {
- var config = JSON.parse(fs.readFileSync('config.json', 'utf8'));
- passport.use(new LdapStrategy({
- server: {
- url: config.ldap.server,
- searchBase: config.ldap.searchBase,
- searchFilter: config.ldap.searchFilter
- }
- }));
-
+ // Define new login strategy
server.use(session({
secret: config.sessionSecret,
//store: a modifier avant de lancer en prod
@@ -91,7 +88,7 @@ export default setupLdapAuth;
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:15:16 GMT+0100 (Paris, Madrid)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:56:16 GMT+0100 (Romance Standard Time)
</footer>
<script> prettyPrint(); </script>
diff --git a/doc/src_ldap_data_ldap_data.js.html b/doc/src_ldap_data_ldap_data.js.html
index 415cd8d..b69555a 100644
--- a/doc/src_ldap_data_ldap_data.js.html
+++ b/doc/src_ldap_data_ldap_data.js.html
@@ -97,7 +97,7 @@ listGroups("quentin.chevalier","Ie42fds'eaJm1").then((grList) => { console.log(g
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:15:16 GMT+0100 (Paris, Madrid)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:56:16 GMT+0100 (Romance Standard Time)
</footer>
<script> prettyPrint(); </script>
diff --git a/doc/src_server.js.html b/doc/src_server.js.html
index 5897b90..e2b1dc5 100644
--- a/doc/src_server.js.html
+++ b/doc/src_server.js.html
@@ -71,6 +71,7 @@ const typeDefs = `
type Group {
name: String!
id: ID!
+ website: String
updatedAt: String!
description: String
school: String!
@@ -88,8 +89,10 @@ const schema = makeExecutableSchema({
resolvers
});
+// Charge le middleware express pour GraphQL
server.use('/graphql', bodyParser.json(), graphqlExpress({schema}));
+// GraphiQL est une console interactive pour faire des requêtes au schéma GraphQL
server.use('/graphiql', graphiqlExpress({ endpointURL: '/graphql'}));
@@ -110,7 +113,7 @@ export default server;
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:15:16 GMT+0100 (Paris, Madrid)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 28 2018 10:56:16 GMT+0100 (Romance Standard Time)
</footer>
<script> prettyPrint(); </script>
--
GitLab