8000 Support to import documentation parts by calvernaz · Pull Request #8573 · localstack/localstack · GitHub
[go: up one dir, main page]
Skip to content

Support to import documentation parts #8573

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

Jump to bottom
Merged
merged 1 commit into from
Jul 2, 2023
Merged

Support to import documentation parts #8573

merged 1 commit into from
Jul 2, 2023

Conversation

calvernaz
Copy link
Contributor
@calvernaz calvernaz commented Jun 26, 2023 •
edited
Loading

REST API supports adding documentation to an API, using the "import documentation parts" API.

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-quick-start-import-export.html

This PR adds support to "import documentation parts" for REST API but only the "override" mode.

Changes

  • implements import_documentation_parts for "overwrite" mode.
  • adds snapshot testing.

@calvernaz calvernaz marked this pull request as draft June 26, 2023 07:56
@calvernaz calvernaz added the semver: minor Non-breaking changes which can be included in minor releases, but not in patch releases label Jun 26, 2023
@github-actions
Copy link
github-actions bot commented Jun 26, 2023 •
edited
Loading

LocalStack Community integration with Pro

       2 files         2 suites   1h 23m 44s ⏱️
2 171 tests 1 841 ✔️ 330 💤 0 ❌
2 172 runs  1 841 ✔️ 331 💤 0 ❌

Results for commit 9581705.

♻️ This comment has been updated with latest results.

@coveralls
Copy link
coveralls commented Jun 26, 2023 •
edited
Loading

Coverage Status

coverage: 82.724% (+0.01%) from 82.713% when pulling 9581705 on import-documentation-parts into 3480ef3 on master.

@calvernaz calvernaz force-pushed the import-documentation-parts branch from 465f675 to b1e7dce Compare June 29, 2023 06:48
@calvernaz calvernaz marked this pull request as ready for review June 29, 2023 06:56
@calvernaz calvernaz requested review from bentsku and whummer June 29, 2023 06:56
@calvernaz calvernaz changed the title wip support to import documentation parts Support to import documentation parts Jun 29, 2023
bentsku
bentsku approved these changes Jun 30, 2023
View reviewed changes
Copy link
Contributor
@bentsku bentsku left a comment

Choose a reason for hiding this comment

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

LGTM! This is great, thanks for adding it! TIL about the import_documentation_parts API method, I had no idea it existed. Thanks a lot for the snapshot test, this is great!

@calvernaz calvernaz force-pushed the import-documentation-parts branch from b1e7dce to 9581705 Compare July 2, 2023 18:52
@calvernaz calvernaz merged commit fd4b059 into master Jul 2, 2023
@calvernaz calvernaz deleted the import-documentation-parts branch July 2, 2023 20:22
@dfangl dfangl added this to the 2.2 milestone Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bentsku bentsku bentsku approved these changes

@whummer whummer Awaiting requested review from whummer

Assignees
No one assigned
Labels
semver: minor Non-breaking changes which can be included in minor releases, but not in patch releases
Projects
None yet
Milestone
2.2
Development

Successfully merging this pull request may close these issues.
4 participants
@calvernaz @coveralls @bentsku @dfangl
0