optimised comments

TryGhost · Dec 11, 2018 · fa24021 · fa24021
1 parent 0ca3ed8
commit fa24021
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/core/server/api/v2/utils/serializers/input/pages.js b/core/server/api/v2/utils/serializers/input/pages.js
@@ -12,8 +12,14 @@ module.exports = {
     browse(apiConfig, frame) {
         debug('browse');
 
-        // CASE: the content api endpoints for pages forces the model layer to return static pages only.
-        //       we have to enforce the filter.
+        /**
+         * CASE:
+         *
+         * - the content api endpoints for pages forces the model layer to return static pages only
+         * - we have to enforce the filter
+         *
+         * @TODO: https://github.com/TryGhost/Ghost/issues/10268
+         */
         if (frame.options.filter) {
             frame.options.filter = `${frame.options.filter}+page:true`;
         } else {

diff --git a/core/server/api/v2/utils/serializers/input/posts.js b/core/server/api/v2/utils/serializers/input/posts.js
@@ -32,7 +32,14 @@ module.exports = {
          * - user exists? admin api access
          */
         if (utils.isContentAPI(frame)) {
-            // CASE: the content api endpoints for posts should only return non page type resources
+            /**
+             * CASE:
+             *
+             * - the content api endpoints for posts should only return non page type resources
+             * - we have to enforce the filter
+             *
+             * @TODO: https://github.com/TryGhost/Ghost/issues/10268
+             */
             if (frame.options.filter) {
                 frame.options.filter = `${frame.options.filter}+page:false`;
             } else {