@backstage/plugin-catalog-backend 1.13.0-next.1 → 1.13.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/plugin-catalog-backend
 
+## 1.13.0-next.2
+
+### Patch Changes
+
+- acffa17027b6: Added some examples to the catalog OpenAPI definition
+- 45947d3b2759: Fixes an issue where `order` was not a recognized parameter for the `/entities` endpoint.
+- 814feeed7343: Update to handle invalid luxon values
+- Updated dependencies
+  - @backstage/config@1.1.0-next.1
+  - @backstage/backend-tasks@0.5.8-next.2
+  - @backstage/backend-common@0.19.5-next.2
+  - @backstage/plugin-auth-node@0.3.0-next.2
+  - @backstage/plugin-catalog-node@1.4.4-next.2
+  - @backstage/plugin-permission-node@0.7.14-next.2
+  - @backstage/plugin-search-backend-module-catalog@0.1.7-next.2
+  - @backstage/integration@1.7.0-next.2
+  - @backstage/backend-plugin-api@0.6.3-next.2
+  - @backstage/catalog-model@1.4.2-next.1
+  - @backstage/plugin-permission-common@0.7.8-next.1
+  - @backstage/backend-openapi-utils@0.0.3
+  - @backstage/catalog-client@1.4.4-next.1
+  - @backstage/errors@1.2.1
+  - @backstage/types@1.1.0
+  - @backstage/plugin-catalog-common@1.0.16-next.1
+  - @backstage/plugin-events-node@0.2.12-next.2
+  - @backstage/plugin-scaffolder-common@1.4.1-next.1
+  - @backstage/plugin-search-common@1.2.6-next.1
+
 ## 1.13.0-next.1
 
 ### Minor Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend",
-  "version": "1.13.0-next.1",
+  "version": "1.13.0-next.2",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var alpha = require('@backstage/plugin-catalog-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
-var CatalogBuilder = require('./cjs/CatalogBuilder-e344ff09.cjs.js');
+var CatalogBuilder = require('./cjs/CatalogBuilder-c40214f8.cjs.js');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
 var backendCommon = require('@backstage/backend-common');

package/dist/cjs/{CatalogBuilder-e344ff09.cjs.js → CatalogBuilder-c40214f8.cjs.js}

@@ -3657,6 +3657,14 @@ const spec = {
           items: {
             type: "string"
           }
+        },
+        examples: {
+          "Get name and the entire relations collection": {
+            value: ["metadata.name", "relations"]
+          },
+          "Get kind, name and namespace": {
+            value: ["kind", "metadata.name", "metadata.namespace"]
+          }
         }
       },
       filter: {
@@ -3670,6 +3678,16 @@ const spec = {
           items: {
             type: "string"
           }
+        },
+        examples: {
+          "Get groups": {
+            value: ["kind=group"]
+          },
+          "Get orphaned components": {
+            value: [
+              "kind=component,metadata.annotations.backstage.io/orphan=true"
+            ]
+          }
         }
       },
       offset: {
@@ -3708,7 +3726,15 @@ const spec = {
           }
         },
         explode: true,
-        style: "form"
+        style: "form",
+        examples: {
+          "Order ascending by name": {
+            value: ["metadata.name,asc"]
+          },
+          "Order descending by owner": {
+            value: ["spec.owner,desc"]
+          }
+        }
       }
     },
     requestBodies: {},
@@ -4335,6 +4361,18 @@ const spec = {
           },
           {
             $ref: "#/components/parameters/after"
+          },
+          {
+            name: "order",
+            in: "query",
+            allowReserved: true,
+            required: false,
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            }
           }
         ]
       }
@@ -4506,6 +4544,22 @@ const spec = {
                     }
                   }
                 }
+              },
+              examples: {
+                "Fetch Backstage entities": {
+                  value: {
+                    entityRefs: [
+                      "component:default/backstage",
+                      "api:default/backstage"
+                    ]
+                  }
+                },
+                "Fetch annotations for backstage entity": {
+                  value: {
+                    entityRefs: ["component:default/backstage"],
+                    fields: ["metadata.annotations"]
+                  }
+                }
               }
             }
           }
@@ -4611,6 +4665,14 @@ const spec = {
               items: {
                 type: "string"
               }
+            },
+            examples: {
+              "Entities by kind": {
+                value: ["kind"]
+              },
+              "Entities by spec type": {
+                value: ["spec.type"]
+              }
             }
           },
           {
@@ -6688,4 +6750,4 @@ exports.createCatalogPermissionRule = createCatalogPermissionRule;
 exports.createRandomProcessingInterval = createRandomProcessingInterval;
 exports.parseEntityYaml = parseEntityYaml;
 exports.permissionRules = permissionRules;
-//# sourceMappingURL=CatalogBuilder-e344ff09.cjs.js.map
+//# sourceMappingURL=CatalogBuilder-c40214f8.cjs.js.map