chore: address comments

Author: ninja-shreyash

.claude/skills/onboard-api/SKILL.md

@@ -71,7 +71,7 @@ Use the appropriate checklist based on the ticket type detected in Step 1. You m
 - Swagger/OpenAPI URL + endpoint paths → use directly
 - Missing either → stop and ask
 
-**If Jira ticket:** Parse description for URLs ending in `.json`/`.yaml`/`swagger.json`/`openapi.json`, HTTP method + path patterns, scope strings (e.g., `OR.Jobs`), and whether each endpoint requires a `folderId`. If Swagger URL missing, stop and report.
+**If Jira ticket:** Parse description for URLs ending in `.json`/`.yaml`/`swagger.json`/`openapi.json`, HTTP method + path patterns, scope strings (e.g., `OR.Jobs`), and whether each endpoint requires a `folderId` or `folderKey`. If Swagger URL missing, stop and report.
 
 **Ticket type detection:**
 - `API:` field present → **Direct API** (existing workflow)

src/models/orchestrator/jobs.models.ts

@@ -71,7 +71,7 @@ export interface JobServiceModel {
    * Gets a job by its unique key (GUID).
    *
    * Returns the full job details including state, timing, input/output arguments, and error information.
-   * Use `expand` to include related entities like Robot, Machine, or Release.
+   * Use `expand` to include related entities like `robot`, or `machine`.
    *
    * @param id - The unique key (GUID) of the job to retrieve
    * @param folderId - The folder ID where the job resides
@@ -89,7 +89,7 @@ export interface JobServiceModel {
    * ```typescript
    * // With expanded related entities
    * const job = await jobs.getById(<id>, <folderId>, {
-   *   expand: 'Robot,Machine,Release'
+   *   expand: 'robot,machine'
    * });
    * console.log(job.robot?.name, job.machine?.name);
    * ```

src/models/orchestrator/jobs.types.ts

@@ -41,7 +41,7 @@ export enum ServerlessJobType {
 /**
  * Interface for process metadata associated with a job.
  * Represents a lightweight summary of the process (release) linked to a job.
- * Available when using 'expand: "Release"' in the query.
+ * Available when using 'expand: "release"' in the query.
  */
 export interface ProcessMetadata {
   /** The unique key of the release */
@@ -146,11 +146,11 @@ export interface RawJobGetResponse extends FolderProperties {
   parentSpanId: string | null;
   /** The error code associated with a failed job */
   errorCode: string | null;
-  /** The machine associated with the job (available when using expand=Machine) */
+  /** The machine associated with the job (available when using expand=machine) */
   machine?: Machine;
-  /** The robot associated with the job (available when using expand=Robot) */
+  /** The robot associated with the job (available when using expand=robot) */
   robot?: RobotMetadata;
-  /** The process metadata associated with the job (available when using expand=Release) */
+  /** The process metadata associated with the job */
   process?: ProcessMetadata | null;
   /** Error details for the job, or null if the job has no errors */
   jobError: JobError | null;

src/services/orchestrator/jobs/jobs.ts

@@ -108,7 +108,7 @@ export class JobService extends FolderScopedService implements JobServiceModel {
    * Gets a job by its unique key (GUID).
    *
    * Returns the full job details including state, timing, input/output arguments, and error information.
-   * Use `expand` to include related entities like Robot, Machine, or Release.
+   * Use `expand` to include related entities like `robot`, or `machine`.
    *
    * @param id - The unique key (GUID) of the job to retrieve
    * @param folderId - The folder ID where the job resides
@@ -126,7 +126,7 @@ export class JobService extends FolderScopedService implements JobServiceModel {
    * ```typescript
    * // With expanded related entities
    * const job = await jobs.getById(<id>, <folderId>, {
-   *   expand: 'Robot,Machine,Release'
+   *   expand: 'robot,machine'
    * });
    * console.log(job.robot?.name, job.machine?.name);
    * ```
@@ -191,8 +191,7 @@ export class JobService extends FolderScopedService implements JobServiceModel {
       throw new ValidationError({ message: 'jobKey is required for getOutput' });
     }
 
-    // OData $select expects raw API field names (PascalCase), not SDK camelCase names
-    const job = await this.getById(jobKey, folderId, { select: 'OutputArguments,OutputFile' });
+    const job = await this.getById(jobKey, folderId, { select: 'outputArguments,outputFile' });
 
     if (job.outputArguments) {
       try {

tests/integration/shared/orchestrator/jobs.integration.test.ts

@@ -77,8 +77,7 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       });
 
       if (allJobs.items.length === 0) {
-        console.warn('No jobs available to test getById — skipping.');
-        return;
+        throw new Error('No jobs available in the test environment to test getById.');
       }
 
       const jobKey = allJobs.items[0].key;
@@ -119,13 +118,12 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       });
 
       if (allJobs.items.length === 0) {
-        console.warn('No jobs available to test getById with expand — skipping.');
-        return;
+        throw new Error('No jobs available in the test environment to test getById with expand.');
       }
 
       const jobKey = allJobs.items[0].key;
       const job = await jobs.getById(jobKey, folderId, {
-        expand: 'Robot,Machine,Release',
+        expand: 'robot,machine',
       });
 
       expect(job).toBeDefined();
@@ -139,9 +137,6 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       if (job.machine) {
         expect(job.machine.id).toBeDefined();
       }
-      if (job.process) {
-        expect(job.process.id).toBeDefined();
-      }
     });
   });
 
@@ -161,8 +156,7 @@ describe.each(modes)('Orchestrator Jobs - Integration Tests [%s]', (mode) => {
       });
 
       if (result.items.length === 0) {
-        console.warn('No successful jobs found to test getOutput — skipping.');
-        return;
+        throw new Error('No successful jobs found in the test environment to test getOutput.');
       }
 
       const job = result.items[0];

tests/unit/services/orchestrator/jobs.test.ts

@@ -230,8 +230,8 @@ describe('JobService Unit Tests', () => {
       mockApiClient.get.mockResolvedValueOnce(mockRawJob);
 
       const options: JobGetByIdOptions = {
-        expand: 'Robot,Machine,Release',
-        select: 'Key,State,ReleaseName',
+        expand: 'robot,machine',
+        select: 'key,state',
       };
 
       await jobService.getById(JOB_TEST_CONSTANTS.JOB_KEY, TEST_CONSTANTS.FOLDER_ID, options);
@@ -240,8 +240,8 @@ describe('JobService Unit Tests', () => {
         JOB_ENDPOINTS.GET_BY_KEY(JOB_TEST_CONSTANTS.JOB_KEY),
         expect.objectContaining({
           params: {
-            $expand: 'Robot,Machine,Release',
-            $select: 'Key,State,ReleaseName',
+            $expand: 'robot,machine',
+            $select: 'key,state',
           },
         })
       );
@@ -277,7 +277,7 @@ describe('JobService Unit Tests', () => {
         JOB_ENDPOINTS.GET_BY_KEY(JOB_TEST_CONSTANTS.JOB_KEY),
         expect.objectContaining({
           params: {
-            $select: 'OutputArguments,OutputFile',
+            $select: 'outputArguments,outputFile',
           },
           headers: expect.objectContaining({
             'X-UIPATH-OrganizationUnitId': String(TEST_CONSTANTS.FOLDER_ID),

tests/utils/mocks/jobs.ts

@@ -25,20 +25,54 @@ export const createMockRawJob = (overrides: Partial<any> = {}): any => {
     HostMachineName: JOB_TEST_CONSTANTS.HOST_MACHINE_NAME,
     EntryPointPath: JOB_TEST_CONSTANTS.ENTRY_POINT_PATH,
     JobPriority: JobPriority.Normal,
+    SpecificPriorityValue: 45,
     Type: JobType.Unattended,
     Source: 'Manual',
+    SourceType: JobSourceType.Manual,
+    ServerlessJobType: null,
     Info: null,
+    Reference: '',
     InputArguments: null,
     OutputArguments: null,
+    OutputFile: null,
+    EnvironmentVariables: null,
     // Using raw API field names that should be transformed
     CreationTime: JOB_TEST_CONSTANTS.CREATED_TIME,
     StartTime: JOB_TEST_CONSTANTS.START_TIME,
     EndTime: JOB_TEST_CONSTANTS.END_TIME,
     LastModificationTime: JOB_TEST_CONSTANTS.LAST_MODIFIED_TIME,
+    ResumeTime: null,
     OrganizationUnitId: TEST_CONSTANTS.FOLDER_ID,
     OrganizationUnitFullyQualifiedName: TEST_CONSTANTS.FOLDER_NAME,
+    FolderKey: null,
+    BatchExecutionKey: '00000000-0000-0000-0000-000000000000',
+    ParentJobKey: null,
+    StartingScheduleId: null,
+    StartingTriggerId: null,
+    ReleaseVersionId: null,
+    MaxExpectedRunningTimeSeconds: null,
+    RequiresUserInteraction: false,
+    ResumeOnSameContext: false,
+    ResumeVersion: null,
+    SubState: null,
+    RuntimeType: null,
+    TargetRuntime: null,
+    StopStrategy: null,
+    RemoteControlAccess: RemoteControlAccess.None,
+    TraceId: null,
+    ParentSpanId: null,
+    ErrorCode: null,
     Machine: { Id: 1, Name: 'ROBOT-01' },
     Robot: { Id: 1, Name: 'Robot1', Username: String.raw`domain\robot1` },
+    Release: {
+      Key: 'release-key-001',
+      ProcessKey: 'process-key-001',
+      ProcessVersion: '1.0.0',
+      IsLatestVersion: true,
+      Name: JOB_TEST_CONSTANTS.PROCESS_NAME,
+      Id: 1,
+    },
+    ProcessType: PackageType.Process,
     JobError: null,
   }, overrides);
 };