Get a spec's generation status

2 parameters

projectIdstringrequired

The project's ID, from listProjects.

specIdstringrequired

The specId returned when the spec was ingested.

3 status codes

200The generation status.

generationobjectrequired

projectobjectrequired

rebuildobjectrequired

specobjectrequired

401The API key is missing or invalid.

errorobjectrequired

404The project or resource does not exist in this organisation.

errorobjectrequired

Error handling

A 401 is returned: The API key is missing or invalid. A 404 is returned: The project or resource does not exist in this organisation.

import { Octri } from "octri-api-sdk";

const client = new Octri({
  baseUrl: "https://api.octri.dev",
  auth: { apiKeyAuth: process.env.OCTRI_API_KEY! },
});

const result = await client.specs.getStatus({
  projectId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  specId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "generation": {
    "allComplete": true,
    "anyFailed": true,
    "jobs": [
      {
        "progress": {
          "completed": 1,
          "failed": 1,
          "total": 42
        },
        "status": "active",
        "type": "standard"
      }
    ],
    "overallStatus": "queued",
    "percentComplete": 1
  },
  "project": {
    "docsUrl": "https://example.com",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "active"
  },
  "rebuild": {
    "status": "active",
    "triggered": true
  },
  "spec": {
    "endpointCount": 42,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "isCurrent": true,
    "status": "active",
    "version": "example_value"
  }
}

Request

Response

Errors