Migration

A migration.

APIs.ioEngineeringPlatform

Properties

Name Type Description
id integer
owner object
guid string
state string
lock_repositories boolean
exclude_metadata boolean
exclude_git_data boolean
exclude_attachments boolean
exclude_releases boolean
exclude_owner_projects boolean
org_metadata_only boolean
repositories array The repositories included in the migration. Only returned for export migrations.
url string
created_at string
updated_at string
node_id string
archive_url string
exclude array Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-migration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/migration",
  "title": "Migration",
  "description": "A migration.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 79
    },
    "owner": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "guid": {
      "type": "string",
      "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516"
    },
    "state": {
      "type": "string",
      "example": "pending"
    },
    "lock_repositories": {
      "type": "boolean",
      "example": true
    },
    "exclude_metadata": {
      "type": "boolean"
    },
    "exclude_git_data": {
      "type": "boolean"
    },
    "exclude_attachments": {
      "type": "boolean"
    },
    "exclude_releases": {
      "type": "boolean"
    },
    "exclude_owner_projects": {
      "type": "boolean"
    },
    "org_metadata_only": {
      "type": "boolean"
    },
    "repositories": {
      "type": "array",
      "description": "The repositories included in the migration. Only returned for export migrations.",
      "items": {
        "$ref": "#/components/schemas/repository"
      }
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/orgs/octo-org/migrations/79"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2015-07-06T15:33:38-07:00"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2015-07-06T15:33:38-07:00"
    },
    "node_id": {
      "type": "string"
    },
    "archive_url": {
      "type": "string",
      "format": "uri"
    },
    "exclude": {
      "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.",
      "type": "array",
      "items": {
        "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.",
        "type": "string"
      }
    }
  },
  "required": [
    "id",
    "node_id",
    "owner",
    "guid",
    "state",
    "lock_repositories",
    "exclude_metadata",
    "exclude_git_data",
    "exclude_attachments",
    "exclude_releases",
    "exclude_owner_projects",
    "org_metadata_only",
    "repositories",
    "url",
    "created_at",
    "updated_at"
  ]
}