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

200

Indicates that the entity was accepted and processed successfully

application/json

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]

]

Example (from schema)

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

400

Invalid YAML (major errors or incorrectly formatted YAML)

application/json

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]

]

Example (from schema)

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

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

Response Headers

• Retry-After

  integer

  The number of seconds until the rate limiting resets.

application/problem+json

Schema

Schema

detail string
instance uri-reference
retryAfter int32

The number of seconds until the rate limiting resets.

status int32required

Possible values: >= 100 and <= 599, [429]

title stringrequired
type uri-referencerequired

Example (from schema)

{
  "detail": "string",
  "instance": "string",
  "retryAfter": 0,
  "status": 429,
  "title": "string",
  "type": "string"
}

Loading...