mirror of
https://github.com/empayre/fleet.git
synced 2024-11-07 01:15:22 +00:00
5de5b13223
* handling redirect * clean up redirect/notFound flow * dynamic query titles and description * dynamic docs titles * Remove locals from queries and docs, updated comment and variable names * handling FAQ page titles * update comment, title in meta, and adjust get started title * remove unneeded meta tag * handbook titles * cleaning up conditionals * update comments * removed added meta tags, change meta variable names * passing in meta description if provided, update conditionals and comments * Update FAQ.md
52 lines
1.8 KiB
JavaScript
Vendored
52 lines
1.8 KiB
JavaScript
Vendored
module.exports = {
|
|
|
|
|
|
friendlyName: 'View query detail',
|
|
|
|
|
|
description: 'Display "Query detail" page.',
|
|
|
|
|
|
inputs: {
|
|
slug: { type: 'string', required: true, description: 'A slug uniquely identifying this query in the library.', example: 'get-macos-disk-free-space-percentage' },
|
|
},
|
|
|
|
|
|
exits: {
|
|
success: { viewTemplatePath: 'pages/query-detail' },
|
|
notFound: { responseType: 'notFound' },
|
|
badConfig: { responseType: 'badConfig' },
|
|
},
|
|
|
|
|
|
fn: async function ({ slug }) {
|
|
|
|
if (!_.isObject(sails.config.builtStaticContent) || !_.isArray(sails.config.builtStaticContent.queries)) {
|
|
throw {badConfig: 'builtStaticContent.queries'};
|
|
} else if (!_.isString(sails.config.builtStaticContent.queryLibraryYmlRepoPath)) {
|
|
throw {badConfig: 'builtStaticContent.queryLibraryYmlRepoPath'};
|
|
}
|
|
|
|
// Serve appropriate content for query.
|
|
// > Inspired by https://github.com/sailshq/sailsjs.com/blob/b53c6e6a90c9afdf89e5cae00b9c9dd3f391b0e7/api/controllers/documentation/view-documentation.js
|
|
let query = _.find(sails.config.builtStaticContent.queries, { slug: slug });
|
|
if (!query) {
|
|
throw 'notFound';
|
|
}
|
|
|
|
// Setting the meta title and description of this page using the query object, and falling back to a generic title or description if query.name or query.description are missing.
|
|
let pageTitleForMeta = query.name ? query.name + ' | Query details' : 'Query details | Fleet for osquery';
|
|
let pageDescriptionForMeta = query.description ? query.description : 'View more information about a query in Fleet\'s standard query library';
|
|
// Respond with view.
|
|
return {
|
|
query,
|
|
queryLibraryYmlRepoPath: sails.config.builtStaticContent.queryLibraryYmlRepoPath,
|
|
pageTitleForMeta,
|
|
pageDescriptionForMeta,
|
|
};
|
|
|
|
}
|
|
|
|
|
|
};
|