feat: support Konnect document objects #388
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add support for Documents in Konnect commands. Documents are informational content associated with Service Versions and Service Packages. DecK stores metadata about them in konnect.yaml and their text content separately in files that live in the same directory as konnect.yaml. The konnect.yaml document metadata includes a "path" field that indicates the relative filepath for the document's content. DecK also sets the "path" value of document objects in the Konnect API to the base of the the filepath stored in the document metadata. dumps construct filepaths for new documents using directories for the Service Package and/or Service Version attached to the document. For example, content for a document, "swagger.json" attached to version 1.2.3 of package "foobar" will be stored at "foobar/1.2.3/swagger.json". Because the standard decK diff display would be quite verbose for many documents, diff output for documents instead uses a unified diff to display only changed content with minimal context. - Add a ParentInfoer interface implemented by the ServicePackage and ServiceVersion types. Types without independent API endpoints (e.g. Document) can include a ParentInfoer reference and use it to retrieve their parent object's URL. - Disable stdout mode for Konnect commands. The separate content file model used by documents is not compatible with sending all decK output to stdout.
Codecov Report
@@ Coverage Diff @@
## main #388 +/- ##
==========================================
- Coverage 53.59% 46.97% -6.62%
==========================================
Files 62 87 +25
Lines 5034 6009 +975
==========================================
+ Hits 2698 2823 +125
- Misses 2037 2863 +826
- Partials 299 323 +24
Continue to review full report at Codecov.
|
hbagdi
approved these changes
May 17, 2021
AntoineJac
pushed a commit
that referenced
this pull request
Jan 23, 2024
- Add support for Documents in Konnect commands. Documents are informational content associated with Service Versions and Service Packages. DecK stores metadata about them in konnect.yaml and their text content separately in files that live in the same directory as konnect.yaml. The konnect.yaml document metadata includes a "path" field that indicates the relative filepath for the document's content. DecK also sets the "path" value of document objects in the Konnect API to the base of the the filepath stored in the document metadata. dumps construct filepaths for new documents using directories for the Service Package and/or Service Version attached to the document. For example, content for a document, "swagger.json" attached to version 1.2.3 of package "foobar" will be stored at "foobar/1.2.3/swagger.json". Because the standard decK diff display would be quite verbose for many documents, diff output for documents instead uses a unified diff to display only changed content with minimal context. - Add a ParentInfoer interface implemented by the ServicePackage and ServiceVersion types. Types without independent API endpoints (e.g. Document) can include a ParentInfoer reference and use it to retrieve their parent object's URL. - Disable stdout mode for Konnect commands. The separate content file model used by documents is not compatible with sending all decK output to stdout.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Squashed version of the commits currently in feat/konnect-documents. Previous discussion was in #336 and #358.