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

safekeeper: fix OpenAPI spec #9066

Merged
merged 1 commit into from
Sep 20, 2024
Merged

Conversation

bayandin
Copy link
Member

@bayandin bayandin commented Sep 19, 2024

Problem

Safekeeper's OpenAPI spec isn't correct:

Semantic error at paths./v1/tenant/{tenant_id}/timeline/{timeline_id}.get.responses.404.content.application/json.schema.$ref
$refs must reference a valid location in the document
Jump to line 126

Checked on https://editor.swagger.io/

Summary of changes

  • Add NotFoundError
  • Add description and license fields to make Cloud OpenAPI spec linter happy

Tested in https://github.com/neondatabase/cloud/pull/17654

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.
  • Do we need to implement analytics? if so did you add the relevant metrics to the dashboard?
  • If this PR requires public announcement, mark it with /release-notes label and add several sentences in this section.

Checklist before merging

  • Do not forget to reformat commit message to not include the above checklist

Copy link

github-actions bot commented Sep 19, 2024

5020 tests run: 4856 passed, 0 failed, 164 skipped (full report)


Flaky tests (7)

Postgres 17

Postgres 16

Postgres 15

Postgres 14

Code coverage* (full report)

  • functions: 31.8% (7420 of 23300 functions)
  • lines: 49.8% (59730 of 119904 lines)

* collected from Rust tests only


The comment gets automatically updated with the latest test results
6ced1dd at 2024-09-19T21:38:50.609Z :recycle:

@bayandin bayandin marked this pull request as ready for review September 19, 2024 21:53
@bayandin bayandin requested a review from a team as a code owner September 19, 2024 21:53
@bayandin bayandin merged commit 3104f0f into main Sep 20, 2024
82 checks passed
@bayandin bayandin deleted the bayandin/safekeeper-fix-openapi-spec branch September 20, 2024 11:00
davidgomes pushed a commit that referenced this pull request Sep 21, 2024
## Problem

Safekeeper's OpenAPI spec is incorrect:

```
Semantic error at paths./v1/tenant/{tenant_id}/timeline/{timeline_id}.get.responses.404.content.application/json.schema.$ref
$refs must reference a valid location in the document
Jump to line 126
```
Checked on https://editor.swagger.io

## Summary of changes
- Add `NotFoundError` 
- Add `description` and `license` fields to make Cloud OpenAPI spec
linter happy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants