Create or update entity

POST /api/v1/open-api

Create a catalog entity using a descriptor YAML. If the YAML refers to an entity that already exists (as referenced by the x-cortex-tag), this API will update the existing entity.

Request

Query Parameters

dryRun boolean

When true, this endpoint only validates the descriptor contents and returns any errors or warnings.

githubPullRequest int32

Add a comment with validation errors on the pull request with the given ID

application/openapi;charset=UTF-8

Body

Raw text of the YAML
See examples of cortex.yaml files for each entity type here

any

Responses

Returns a 200 even if there are errors

application/json

Schema
Example (from schema)

Schema

ok booleanrequired

violations

object[]

required

Array [

description string

endLine int32

paths string[]required

pointer string

ruleLink string

startLine int32

title string

violationType string

Possible values: [MUST, SHOULD, MAY, HINT]

]

{
  "ok": true,
  "violations": [
    {
      "description": "string",
      "endLine": 0,
      "paths": [
        "string"
      ],
      "pointer": "string",
      "ruleLink": "string",
      "startLine": 0,
      "title": "string",
      "violationType": "MUST"
    }
  ]
}

Invalid YAML (major errors or incorrectly formatted YAML)

Schema
Example (from schema)