Merge pull request #237 from cmars/fix/singletons-arent-paginated

fix: singletons are not paginated
snyk · Apr 8, 2022 · 865dc4f · 865dc4f
2 parents 5d744c8 + 1058cd0
commit 865dc4f
Show file tree

Hide file tree

Showing 3 changed files with 148 additions and 3 deletions.
diff --git a/end-end-tests/api-standards/resources/thing/2021-11-10/002-fail-singleton-no-pagination.yaml b/end-end-tests/api-standards/resources/thing/2021-11-10/002-fail-singleton-no-pagination.yaml
diff --git a/end-end-tests/api-standards/test-bulk.bash b/end-end-tests/api-standards/test-bulk.bash
@@ -33,7 +33,7 @@ cat >$tempdir/passes <<EOF
     }, {
         "from": "$HERE/resources/thing/2021-11-10/000-batch-post.yaml", "to": "$HERE/resources/thing/2021-11-10/000-batch-post.yaml", "context": {"changeDate": "2021-11-11", "changeResource": "thing", "changeVersion": {"date": "2021-11-10", "stability": "experimental"}}
     }, {
-        "from": "$HERE/resources/thing/2021-11-10/001-singleton.yaml", "to": "$HERE/resources/thing/2021-11-10/001-singleton.yaml", "context": {"changeDate": "2021-11-11", "changeResource": "thing", "changeVersion": {"date": "2021-11-10", "stability": "experimental"}}
+        "to": "$HERE/resources/thing/2021-11-10/001-singleton.yaml", "context": {"changeDate": "2021-11-11", "changeResource": "thing", "changeVersion": {"date": "2021-11-10", "stability": "experimental"}}
     }, {
         "from": "$HERE/resources/thing/2021-11-10/000-baseline-in-reform.yaml", "to": "$HERE/resources/thing/2021-11-10/002-fail-tenancy.yaml", "context": {"changeDate": "2021-11-11", "changeResource": "thing", "changeVersion": {"date": "2021-11-10", "stability": "experimental"}}
     }]
@@ -78,6 +78,8 @@ cat >$tempdir/failures <<EOF
         "from": "$HERE/resources/thing/2021-11-10/002-fail-batch-post.yaml", "to": "$HERE/resources/thing/2021-11-10/002-fail-batch-post.yaml", "context": {"changeDate": "2021-11-11", "changeResource": "thing", "changeVersion": {"date": "2021-11-10", "stability": "experimental"}}
     }, {
         "from": "$HERE/resources/thing/2021-11-10/000-baseline.yaml", "to": "$HERE/resources/thing/2021-11-10/003-jsonapi.yaml", "context": {"changeDate": "2021-11-11", "changeResource": "thing", "changeVersion": {"date": "2021-11-10", "stability": "experimental"}}
+    }, {
+        "to": "$HERE/resources/thing/2021-11-10/002-fail-singleton-no-pagination.yaml", "context": {"changeDate": "2021-11-11", "changeResource": "thing", "changeVersion": {"date": "2021-11-10", "stability": "experimental"}}
     }]
 }
 EOF

diff --git a/src/rulesets/jsonapi.ts b/src/rulesets/jsonapi.ts
@@ -261,6 +261,9 @@ export const rules = {
       "correctly support pagination parameters",
       (operation, context, docs, specItem) => {
         docs.includeDocsLink(links.jsonApi.pagination);
+        if (context.isSingletonPath) {
+          return;
+        }
         if (isOpenApiPath(context.path)) return;
         if (isItemOperation(operation)) return;
         if (operation.method !== "get") return;
@@ -289,7 +292,7 @@ export const rules = {
         docs.includeDocsLink(links.jsonApi.pagination);
         if (isOpenApiPath(context.path)) return;
         if (isItemOperation(operation)) return;
-        if (operation.method === "get") return;
+        if (operation.method === "get" && !context.isSingletonPath) return;
         const operationName = getOperationName(operation);
         const parameterNames = getParameterNames(specItem.parameters);
         const unsupportedPaginationParameters: string[] = [];
@@ -315,7 +318,7 @@ export const rules = {
         docs.includeDocsLink(links.jsonApi.pagination);
         if (isOpenApiPath(context.path)) return;
         if (isItemOperation(operation)) return;
-        if (operation.method !== "get") return;
+        if (operation.method !== "get" || context.isSingletonPath) return;
         const operationName = getOperationName(operation);
         const response = specItem.responses["200"];
         if (!("$ref" in response)) {