Documented pulp_file bindings client #386
Closed
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
|
Attached issue: https://pulp.plan.io/issues/6518 |
fao89
commented
Apr 28, 2020
| # app setup hook | ||
| def setup(app): | ||
| app.add_config_value('recommonmark_config', { | ||
| 'auto_toc_tree_section': 'Client Documentation', |
There was a problem hiding this comment.
Defining the section that will be used as toctree
fao89
commented
Apr 28, 2020
Comment on lines
+29
to
+33
| echo "## Client Documentation" >> client.md | ||
| for f in client/* | ||
| do | ||
| echo "- [$(basename ${f%.md*})](${f})" >> client.md | ||
| done |
There was a problem hiding this comment.
Creating the toctree section
fao89
commented
Apr 28, 2020
Comment on lines
+166
to
+195
| ## Client Documentation | ||
| - [AsyncOperationResponse](client/AsyncOperationResponse.md) | ||
| - [ContentFilesApi](client/ContentFilesApi.md) | ||
| - [ContentSummary](client/ContentSummary.md) | ||
| - [DistributionsFileApi](client/DistributionsFileApi.md) | ||
| - [ExportersFileExportsApi](client/ExportersFileExportsApi.md) | ||
| - [ExportersFilesystemApi](client/ExportersFilesystemApi.md) | ||
| - [Export](client/Export.md) | ||
| - [FileFileContent](client/FileFileContent.md) | ||
| - [FileFileDistribution](client/FileFileDistribution.md) | ||
| - [FileFileFileSystemExporter](client/FileFileFileSystemExporter.md) | ||
| - [FileFilePublication](client/FileFilePublication.md) | ||
| - [FileFileRemote](client/FileFileRemote.md) | ||
| - [FileFileRepository](client/FileFileRepository.md) | ||
| - [InlineResponse2001](client/InlineResponse2001.md) | ||
| - [InlineResponse2002](client/InlineResponse2002.md) | ||
| - [InlineResponse2003](client/InlineResponse2003.md) | ||
| - [InlineResponse2004](client/InlineResponse2004.md) | ||
| - [InlineResponse2005](client/InlineResponse2005.md) | ||
| - [InlineResponse2006](client/InlineResponse2006.md) | ||
| - [InlineResponse2007](client/InlineResponse2007.md) | ||
| - [InlineResponse200](client/InlineResponse200.md) | ||
| - [PublicationExport](client/PublicationExport.md) | ||
| - [PublicationsFileApi](client/PublicationsFileApi.md) | ||
| - [RemotesFileApi](client/RemotesFileApi.md) | ||
| - [RepositoriesFileApi](client/RepositoriesFileApi.md) | ||
| - [RepositoriesFileVersionsApi](client/RepositoriesFileVersionsApi.md) | ||
| - [RepositoryAddRemoveContent](client/RepositoryAddRemoveContent.md) | ||
| - [RepositorySyncURL](client/RepositorySyncURL.md) | ||
| - [RepositoryVersion](client/RepositoryVersion.md) |
fao89
commented
Apr 28, 2020
|
|
||
| export VERSION=$(http :24817/pulp/api/v3/status/ | jq --arg plugin $1 -r '.versions[] | select(.component == $plugin) | .version') | ||
|
|
||
| podman run -u $(id -u) --rm -v ${PWD}:/local openapitools/openapi-generator-cli:v4.2.3 generate \ |
There was a problem hiding this comment.
podman due dev environment, as it is likely to be done manually
|
Closing as it is not interesting to have two formats |
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.
https://pulp.plan.io/issues/6659
closes #6659