Problem: Pulp's OpenAPI schema has verbose Operation Ids #178
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
dkliban
added a commit
to dkliban/pulp-openapi-generator
that referenced
this pull request
Jun 19, 2019
Solution: request OpenAPI schema with 'bindings' query parameter This patch takes advantage of a new feature in pulpcore that allows generating OpenAPI schema with short Operation Ids. Required PR: pulp/pulpcore#178 re: #4989 https://pulp.plan.io/issues/4989
dkliban
force-pushed
the
bindings-openapi-schema
branch
3 times, most recently
from
3e637ea
to
3d0be48
Compare
Codecov Report
@@ Coverage Diff @@
## master #178 +/- ##
==========================================
- Coverage 67.33% 67.05% -0.29%
==========================================
Files 65 65
Lines 3089 3102 +13
==========================================
Hits 2080 2080
- Misses 1009 1022 +13
Continue to review full report at Codecov.
|
dkliban
added a commit
to dkliban/pulp-openapi-generator
that referenced
this pull request
Jun 19, 2019
Solution: request OpenAPI schema with 'bindings' query parameter This patch takes advantage of a new feature in pulpcore that allows generating OpenAPI schema with short Operation Ids. Required PR: pulp/pulpcore#178 re: #4989 https://pulp.plan.io/issues/4989
dkliban
force-pushed
the
bindings-openapi-schema
branch
2 times, most recently
from
2013eb0
to
a04afb9
Compare
dkliban
added a commit
to dkliban/pulp-openapi-generator
that referenced
this pull request
Jun 20, 2019
Solution: request OpenAPI schema with 'bindings' query parameter This patch takes advantage of a new feature in pulpcore that allows generating OpenAPI schema with short Operation Ids. Required PR: pulp/pulpcore#178 re: #4989 https://pulp.plan.io/issues/4989
dkliban
force-pushed
the
bindings-openapi-schema
branch
from
a04afb9
to
e5e18fe
Compare
|
I like the resulting bindings. |
Yes, even if it is called the same thing, the object is provided by a different package. |
dkliban
force-pushed
the
bindings-openapi-schema
branch
from
e5e18fe
to
aaeea9f
Compare
Solution: add ability to request shorter operation ids in the schema This patch adds ability to specify 'bindings' query parameter when requesting the OpenAPI schema. When specified, a short OperationId is used for each operation. This patch also changes how the OpenAPI schema operations are grouped together. Each resource now has its own tag associated with it. This results in better REST API docs and better experience for users of bindings. The tag for a resource is determined from it's URL. The plugin name is omitted from the tag. For example: URL: /pulp/api/v3/repositories/ Tag: Repositories URL: /pulp/api/v3/repositories/<uuid>/versions/ Tag: Repositories: Versions URL: /pulp/api/v3/content/file/files/ Tag: Content: Files URL: /pulp/api/v3/remotes/file/file/ Tag: Remotes: File Required PR: pulp/pulp-openapi-generator#18 re: pulp#4989 https://pulp.plan.io/issues/4989
dkliban
force-pushed
the
bindings-openapi-schema
branch
from
aaeea9f
to
7748ffd
Compare
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.
Solution: add ability to request shorter operation ids in the schema
This patch adds ability to specify 'bindings' query parameter when requesting the OpenAPI
schema. When specified, a short OperationId is used for each operation.
This patch also changes how the OpenAPI schema operations are grouped together. Each resource
now has its own tag associated with it. This results in better REST API docs and better
experience for users of bindings.
The tag for a resource is determined from it's URL. The plugin name is omitted from the tag. For
example:
URL: /pulp/api/v3/repositories/
Tag: Repositories
URL: /pulp/api/v3/repositories/uuid-of-some-sort/versions/
Tag: Repositories: Versions
URL: /pulp/api/v3/content/file/files/
Tag: Content: Files
URL: /pulp/api/v3/remotes/file/file/
Tag: Remotes: File
Required PR: pulp/pulp-openapi-generator#18
re: #4989
https://pulp.plan.io/issues/4989