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

docs: Integrate OpenApi generated documentation for admin api (DEV-3381) #3104

Merged
merged 3 commits into from Mar 8, 2024

Conversation

seakayone
Copy link
Collaborator

@seakayone seakayone commented Mar 8, 2024

Added just targets, among others:

  • docs-install-requirements - Install the required Python dependencies (you might want to create a virtual env for that)
  • docs-serve - Start this and visit http://localhost:8000/03-endpoints/api-admin/ to see the OpenApi documentation

Out of scope for this PR is polishing the actual OpenApi documentation, I will create a followup for this.

Pull Request Checklist

Task Description/Number

Issue Number: DEV-

PR Type

  • build/chore: maintenance tasks (no production code change)
  • docs: documentation changes (no production code change)
  • feat: represents new features
  • fix: represents bug fixes
  • perf: performance improvements
  • refactor: represents production code refactoring
  • test: adding or refactoring tests (no production code change)

Basic requirements for bug fixes and features

  • Tests for the changes have been added
  • Docs have been added / updated

Does this PR introduce a breaking change?

  • Yes

Does this PR change client-test-data?

  • Yes

@seakayone seakayone changed the title docs: Integrate OpenApi generated documentation for admin api docs: Integrate OpenApi generated documentation for admin api (DEV-3381) Mar 8, 2024
Copy link

codecov bot commented Mar 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 12.92%. Comparing base (eac5751) to head (8873cc0).
Report is 119 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3104      +/-   ##
==========================================
+ Coverage   11.74%   12.92%   +1.18%     
==========================================
  Files         246      260      +14     
  Lines       22907    22339     -568     
==========================================
+ Hits         2690     2887     +197     
+ Misses      20217    19452     -765     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@seakayone seakayone marked this pull request as ready for review March 8, 2024 07:35
@mpro7
Copy link
Collaborator

mpro7 commented Mar 8, 2024

@seakayone should we look at the YML file or it's auto-generated?

@seakayone
Copy link
Collaborator Author

@mpro7 You may look. It is generated just dog.

@seakayone seakayone enabled auto-merge (squash) March 8, 2024 12:01
@seakayone seakayone merged commit 241ea9b into main Mar 8, 2024
13 checks passed
@seakayone seakayone deleted the doc/integrate-admin-openapi-in-docs-DEV-3381 branch March 8, 2024 12:18
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.

None yet

3 participants