Sign in
Specifications

Upload a specification to the project an API key belongs to

post/v1/specifications

Request

  • Base URL: https://api.heyapi.dev (the document declares no server; this is the origin it was published from)
  • URL: https://api.heyapi.dev/v1/specifications
  • Auth: HTTP bearer

Response

OK

actorstring nullable required
actor_idstring nullable required
api_key_idstring uuid nullable required
branchstring nullable required
branch_basestring nullable required
ci_platformstring nullable required
commit_shastring nullable required
created_atstring date-time required
creator_user_idstring uuid nullable required
event_namestring nullable required
idstring uuid required
jobstring nullable required
project_idstring uuid required
refstring nullable required
ref_typestring nullable required
repositorystring nullable required
run_idstring nullable required
run_numberstring nullable required
tagsstring[] required
updated_atstring date-time required
versionstring nullable required
workflowstring nullable required

Example response

{
  "actor": "mrlubos",
  "actor_id": "12529395",
  "api_key_id": "e4ce4324-1177-47ca-aeef-b1d011bd3932",
  "branch": "feat/awesome-feature",
  "branch_base": "main",
  "ci_platform": "github",
  "commit_sha": "1c6945d83eab3580791eb4148562b3bd2e16df14",
  "created_at": "2025-02-21T02:37:15.840Z",
  "creator_user_id": "5d2827a4-b3fc-4946-bb3b-72f23e89c6aa",
  "event_name": "push",
  "id": "e4ce4324-1177-47ca-aeef-b1d011bd3932",
  "job": "ci",
  "project_id": "e4ce4324-1177-47ca-aeef-b1d011bd3932",
  "ref": "refs/heads/main",
  "ref_type": "branch",
  "repository": "hey-api/platform",
  "run_id": "13448896305",
  "run_number": "1",
  "tags": [
    "dev"
  ],
  "updated_at": "2025-02-21T02:37:15.840Z",
  "version": "1.0.0",
  "workflow": "CI"
}

Changes

No recorded changes to this operation across all 1 revision of this API.