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.

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

API doc: Incorrect parameter list in Marquez API doc #2174

Closed
howardyoo opened this issue Oct 6, 2022 · 0 comments · Fixed by #2175
Closed

API doc: Incorrect parameter list in Marquez API doc #2174

howardyoo opened this issue Oct 6, 2022 · 0 comments · Fixed by #2175
Labels
api API layer changes docs

Comments

@howardyoo
Copy link
Collaborator

Problem

image

The list of parameters shown in the Marquez API doc powered by openapi does not seem to be correct, as defined in https://github.com/MarquezProject/marquez/blob/main/spec/openapi.yml

  /events/lineage:
    get:
      operationId: getLineageEvents
      parameters:
        - $ref: '#/components/parameters/sortDirection'
        - $ref: '#/components/parameters/before'
        - $ref: '#/components/parameters/after'
        - $ref: '#/components/parameters/limit'
      summary: List all received OpenLineage events.
      description: Returns a list of OpenLineage events, sorted in direction of passed sort parameter. By default it is desc.
      tags:
        - Events
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LineageEventList'

Looks like the before and after parameter does not have the correct description as shown here:

before:

after:

image

Solution

Fix the name, type to the proper format.

@howardyoo howardyoo added api API layer changes docs labels Oct 6, 2022
howardyoo added a commit that referenced this issue Oct 6, 2022
wslulciuc added a commit that referenced this issue Oct 17, 2022
#2175)

for event api.
Fixes #2174

Signed-off-by: howardyoo <[email protected]>

Signed-off-by: howardyoo <[email protected]>
Co-authored-by: Willy Lulciuc <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api API layer changes docs
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant