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: Render OpenAPI content into md document, remove generated ymls from git (DEV-3443) #3254

Merged
merged 3 commits into from
May 28, 2024

Conversation

seakayone
Copy link
Contributor

@seakayone seakayone commented May 28, 2024

Pull Request Checklist

Task Description/Number

Fix the [OAD…] markdown directive to point to the right file for rendering in dsp-docs for https://docs.dasch.swiss.
Screenshot of the current faulty state.

Remove the generated yaml from git because it will be generated in dsp-docs.

Needed for dasch-swiss/dsp-docs#114

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)
  • deprecated: Deprecation warning (ideally referencing a migration guide)

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

@seakayone seakayone changed the title chore: Render OpenAPI yaml in document, remove generated ymls from git docs: Render OpenAPI yaml in document, remove generated ymls from git May 28, 2024
@seakayone seakayone changed the title docs: Render OpenAPI yaml in document, remove generated ymls from git docs: Render OpenAPI yaml in document, remove generated ymls from git (DEV-3443) May 28, 2024
Copy link

linear bot commented May 28, 2024

@seakayone seakayone marked this pull request as ready for review May 28, 2024 08:46
Copy link

codecov bot commented May 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.40%. Comparing base (a622e4f) to head (a464382).
Report is 76 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #3254       +/-   ##
===========================================
+ Coverage   13.22%   83.40%   +70.18%     
===========================================
  Files         270      280       +10     
  Lines       22244    23092      +848     
===========================================
+ Hits         2941    19261    +16320     
+ Misses      19303     3831    -15472     

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

@seakayone seakayone changed the title docs: Render OpenAPI yaml in document, remove generated ymls from git (DEV-3443) docs: Render OpenAPI content into md document, remove generated ymls from git (DEV-3443) May 28, 2024
@seakayone seakayone merged commit 7f7c0b6 into main May 28, 2024
14 checks passed
@seakayone seakayone deleted the docs/fix-openapi-rendering branch May 28, 2024 10:35
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