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

chore: document endpoint tagged Unstable #4118

Merged
merged 23 commits into from Jul 4, 2023
Merged

Conversation

andreas-unleash
Copy link
Contributor

@andreas-unleash andreas-unleash commented Jun 29, 2023

Adds description and summary to all endpoints with Unstable tag

About the changes

Closes # 1-1001

Important files

Discussion points

Signed-off-by: andreas-unleash <andreas@getunleash.ai>
@vercel
Copy link

vercel bot commented Jun 29, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unleash-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 4, 2023 2:33pm
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 4, 2023 2:33pm

Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! Got some suggestions to clear up a bit. Export/import is a complicated domain, so it's hard to know how best to do it.

I also have a few questions:

  1. There's no schemas in this PR. Are you putting them in a separate PR?
  2. This PR does not include any error responses for these endpoints (400, 401, 403, etc). Is that also something you're putting in a different PR or an oversight?

src/lib/openapi/endpoint-descriptions.ts Outdated Show resolved Hide resolved
src/lib/openapi/endpoint-descriptions.ts Outdated Show resolved Hide resolved
src/lib/openapi/endpoint-descriptions.ts Outdated Show resolved Hide resolved
src/lib/openapi/endpoint-descriptions.ts Outdated Show resolved Hide resolved
src/lib/openapi/endpoint-descriptions.ts Outdated Show resolved Hide resolved
src/lib/openapi/endpoint-descriptions.ts Outdated Show resolved Hide resolved
andreas-unleash and others added 6 commits June 29, 2023 14:42
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
@andreas-unleash
Copy link
Contributor Author

andreas-unleash commented Jun 29, 2023

@thomasheartman Thanks for the feedback. I will add schema descriptions to this PR.

Signed-off-by: andreas-unleash <andreas@getunleash.ai>
Signed-off-by: andreas-unleash <andreas@getunleash.ai>
# Conflicts:
#	src/lib/openapi/util/openapi-tags.ts
Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! There's a few small things to fix (schemas don't have summaries), but nothing major, so I'll slap an approve on here so you can merge when you're ready 😄

src/lib/openapi/spec/export-result-schema.ts Outdated Show resolved Hide resolved
src/lib/openapi/spec/import-toggles-schema.ts Outdated Show resolved Hide resolved
src/lib/openapi/spec/import-toggles-validate-schema.ts Outdated Show resolved Hide resolved
andreas-unleash and others added 3 commits June 30, 2023 13:12
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
@thomasheartman thomasheartman enabled auto-merge (squash) July 4, 2023 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants