Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add operationId to openapi spec #1978

Merged
merged 4 commits into from
May 6, 2022
Merged

Add operationId to openapi spec #1978

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
047135e
Adds `operationId` to Marquez endpoints for client generation purposes.
May 6, 2022
2618862
Merge branch 'main' into feature/doc-operations
wslulciuc May 6, 2022
6c58862
Code Review feedback.
May 6, 2022
7792fd5
Merge branch 'feature/doc-operations' of https://github.com/MarquezPr…
May 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3,034 changes: 714 additions & 2,320 deletions docs/openapi.html
View file
Open in desktop

Large diffs are not rendered by default.

30 changes: 30 additions & 0 deletions spec/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ paths:
parameters:
- $ref: '#/components/parameters/namespace'
put:
operationId: createOrUpdateNamespace
summary: Create a namespace
description: Creates a new namespace object. A namespace enables the contextual grouping of related
jobs and datasets. Namespaces must contain only letters (`a-z`, `A-Z`), numbers (`0-9`),
Expand All @@ -38,6 +39,7 @@ paths:
schema:
$ref: '#/components/schemas/Namespace'
get:
operationId: getNamespace
summary: Retrieve a namespace
description: Returns a namespace.
tags:
Expand All @@ -52,6 +54,7 @@ paths:

/namespaces:
get:
operationId: getNamespaces
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
Expand All @@ -71,6 +74,7 @@ paths:
parameters:
- $ref: '#/components/parameters/source'
put:
operationId: createOrUpdateSource
summary: Create a source
description: Creates a new source object. A source is the physical location of a dataset such as
a table in PostgreSQL, or topic in Kafka. A source enables the grouping of physical datasets
Expand All @@ -91,6 +95,7 @@ paths:
schema:
$ref: '#/components/schemas/Source'
get:
operationId: getSource
summary: Retrieve a source
description: Returns a source.
tags:
Expand All @@ -105,6 +110,7 @@ paths:

/sources:
get:
operationId: getSources
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
Expand All @@ -125,6 +131,7 @@ paths:
- $ref: '#/components/parameters/namespace'
- $ref: '#/components/parameters/dataset'
put:
operationId: createOrUpdateDataset
summary: Create a dataset
description: Creates a new dataset.
deprecated: true
Expand All @@ -145,6 +152,7 @@ paths:
schema:
$ref: '#/components/schemas/Dataset'
get:
operationId: getDataset
summary: Retrieve a dataset
description: Returns a dataset.
tags:
Expand All @@ -163,6 +171,7 @@ paths:
- $ref: '#/components/parameters/dataset'
- $ref: '#/components/parameters/version'
get:
operationId: getDatasetVersion
summary: Retrieve a version for a dataset
description: Returns a version for a dataset.
tags:
Expand All @@ -180,6 +189,7 @@ paths:
- $ref: '#/components/parameters/namespace'
- $ref: '#/components/parameters/dataset'
get:
operationId: getDatasetVersions
summary: List all versions for a dataset
description: Returns a list of versions for a dataset.
tags:
Expand All @@ -197,6 +207,7 @@ paths:
- $ref: '#/components/parameters/namespace'
- $ref: '#/components/parameters/dataset'
get:
operationId: getDatasets
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
Expand All @@ -218,6 +229,7 @@ paths:
- $ref: '#/components/parameters/dataset'
- $ref: '#/components/parameters/tag'
post:
operationId: addTagToDataset
summary: Tag a dataset
description: Tag an existing dataset.
tags:
Expand All @@ -237,6 +249,7 @@ paths:
- $ref: '#/components/parameters/field'
- $ref: '#/components/parameters/tag'
post:
operationId: addTagToFieldOfDataset
summary: Tag a field
description: Tag an existing field of a dataset.
tags:
Expand All @@ -254,6 +267,7 @@ paths:
- $ref: '#/components/parameters/namespace'
- $ref: '#/components/parameters/job'
put:
operationId: createOrUpdateJob
summary: Create a job
description: Creates a new job object. All job objects are immutable and are uniquely identified by a generated ID.
Marquez will create a version of a job each time the contents of the object is modified. For example, the `location`
Expand All @@ -275,6 +289,7 @@ paths:
schema:
$ref: '#/components/schemas/Job'
get:
operationId: getJob
summary: Retrieve a job
description: Retrieve a job.
tags:
Expand All @@ -291,6 +306,7 @@ paths:
parameters:
- $ref: '#/components/parameters/namespace'
get:
operationId: getJobs
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
Expand All @@ -312,6 +328,7 @@ paths:
- $ref: '#/components/parameters/job'
- $ref: '#/components/parameters/version'
get:
operationId: getJobVersion
summary: Retrieve a version for a job
description: Returns a version for a job.
tags:
Expand All @@ -329,6 +346,7 @@ paths:
- $ref: '#/components/parameters/namespace'
- $ref: '#/components/parameters/job'
get:
operationId: getJobVersions
summary: List all versions for a job
description: Returns a list of versions for a job.
tags:
Expand All @@ -346,6 +364,7 @@ paths:
- $ref: '#/components/parameters/namespace'
- $ref: '#/components/parameters/job'
post:
operationId: createOrUpdateRun
summary: Create a run
description: Creates a new run object for a job.
deprecated: true
Expand All @@ -364,6 +383,7 @@ paths:
schema:
$ref: '#/components/schemas/Run'
get:
operationId: getRuns
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
Expand All @@ -383,6 +403,7 @@ paths:
parameters:
- $ref: '#/components/parameters/runId'
get:
operationId: getRun
summary: Retrieve a run
description: Retrieve a run.
tags:
Expand All @@ -400,6 +421,7 @@ paths:
- $ref: '#/components/parameters/runId'
- $ref: '#/components/parameters/at'
post:
operationId: startRun
summary: Start a run
description: Marks the run as `RUNNING`.
deprecated: true
Expand All @@ -418,6 +440,7 @@ paths:
- $ref: '#/components/parameters/runId'
- $ref: '#/components/parameters/at'
post:
operationId: completeRun
summary: Complete a run
description: Marks the run as `COMPLETED`.
deprecated: true
Expand All @@ -436,6 +459,7 @@ paths:
- $ref: '#/components/parameters/runId'
- $ref: '#/components/parameters/at'
post:
operationId: failRun
summary: Fail a run
description: Marks the run as `FAILED`.
deprecated: true
Expand All @@ -454,6 +478,7 @@ paths:
- $ref: '#/components/parameters/runId'
- $ref: '#/components/parameters/at'
post:
operationId: abortRun
summary: Abort a run
description: Marks the run as `ABORTED`.
deprecated: true
Expand All @@ -469,6 +494,7 @@ paths:

/lineage:
post:
operationId: createLineage
summary: Record a single lineage event
description: Receive, process, and store lineage metadata using the [OpenLineage](https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json) standard.
tags:
Expand All @@ -482,6 +508,7 @@ paths:
'200':
description: OK
get:
operationId: getLineage
parameters:
- $ref: '#/components/parameters/nodeId'
- $ref: '#/components/parameters/depth'
Expand All @@ -500,6 +527,7 @@ paths:
parameters:
- $ref: '#/components/parameters/tag'
put:
operationId: createOrUpdateTag
summary: Create a tag
description: Creates a new tag object.
tags:
Expand All @@ -519,6 +547,7 @@ paths:

/tags:
get:
operationId: getTags
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
Expand All @@ -536,6 +565,7 @@ paths:

/search:
get:
operationId: search
parameters:
- $ref: '#/components/parameters/q'
- $ref: '#/components/parameters/filter'
Expand Down