Copilot Workspaces' First attempt to include a template file and documentation

README.md

@@ -28,6 +28,20 @@ This plugin is designed to integrate Postman functionality into your Backstage a
   - [Collections (Use collection tag or IDs)](#collections-use-collection-tag-or-ids)
   - [Monitors (Use monitor ID or name)](#monitors-use-monitor-id-or-name)
 
+## New Backstage Template for Postman Integration
+
+To streamline the process of integrating Postman with Backstage, we have introduced a new Backstage template named `api-creation-postman-template.yaml`. This template simplifies the setup process by providing a pre-configured structure for adding Postman metadata to your Backstage entities.
+
+### How to Use the Template
+
+To use the `api-creation-postman-template.yaml` template, follow these steps:
+
+1. Ensure the template file is located in your repository's `templates` directory.
+2. When creating a new API entity in Backstage, select the `api-creation-postman-template.yaml` from the list of available templates.
+3. Fill in the required fields, such as API name, workspace ID, and repository URL. The template includes comments to guide you through this process.
+4. Once the entity is created, the Postman metadata will be automatically integrated, allowing for seamless interaction with Postman resources directly from Backstage.
+
+For more information and to view the template, please refer to the [api-creation-postman-template.yaml](templates/api-creation-postman-template.yaml) file in the repository.
 
 # Disclaimer and Plugin Compatibility
 These backstage plugins are not officially supported by Postman and are intended for Backstage users to integrate Postman into their API documentation easily.

templates/api-creation-postman-template.yaml

@@ -0,0 +1,48 @@
+# This is a Backstage template for creating APIs with Postman metadata
+apiVersion: backstage.io/v1beta2
+kind: Template
+metadata:
+  name: api-creation-postman-template
+  title: API Creation with Postman Metadata
+  description: Template for creating APIs with integrated Postman metadata for easy monitoring and testing.
+spec:
+  owner: team-postman
+  type: service
+
+  parameters:
+    - title: API Information
+      required:
+        - name
+        - workspaceId
+        - repositoryUrl
+      properties:
+        name:
+          title: API Name
+          type: string
+          description: Unique name for the API
+        workspaceId:
+          title: Postman Workspace ID
+          type: string
+          description: The ID of the Postman workspace where the API is located
+        repositoryUrl:
+          title: Repository URL
+          type: string
+          description: The URL of the GitHub/GitLab repository associated with this API
+
+  steps:
+    - id: fetch-base
+      name: Fetch Base Template
+      action: fetch:template
+      input:
+        url: ./base-template.yaml
+
+    - id: setup-postman
+      name: Setup Postman Metadata
+      action: fetch:plain
+      input:
+        # Add instructions for setting up Postman metadata here
+
+  output:
+    # Define outputs that include Postman metadata here
+
+# Note: Replace the placeholders with actual values when using this template.