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

Problem: OpenAPI schema test is unreliable between different installs #202

Merged
merged 1 commit into from Apr 4, 2019

Conversation

dkliban
Copy link
Member

@dkliban dkliban commented Apr 4, 2019

Solution: Remove the test

re: #4104
https://pulp.plan.io/issues/4104

@dkliban dkliban requested a review from a team April 4, 2019 17:01
dkliban added a commit to dkliban/pulpcore that referenced this pull request Apr 4, 2019
Solution: Break up REST API docs into sections

This patch modifies the OpenAPI schema. It introduces the concept of Tags. Each tag represents a type
of resource in Pulp. E.g. Artifacts, Content, Remotes, Publishers, etc.

This patch also improves the 'summary' field for each operation also. This is achieved with a new
custom inspector class that drf_yasg can use to build the OpenAPI schema.

This patch also adds a new 'restapi.html' page to the static docs. This new page uses ReDoc and the
OpenAPI schema to display the REST API docs.

Required PR: pulp/pulp_file#202

re: pulp#4104
https://pulp.plan.io/issues/4104
@dkliban dkliban force-pushed the update-openapi-schema branch 3 times, most recently from 5bb2f9e to c659595 Compare April 4, 2019 19:11
dkliban added a commit to dkliban/pulpcore that referenced this pull request Apr 4, 2019
Solution: Break up REST API docs into sections

This patch modifies the OpenAPI schema. It introduces the concept of Tags. Each tag represents a type
of resource in Pulp. E.g. Artifacts, Content, Remotes, Publishers, etc.

This patch also improves the 'summary' field for each operation also. This is achieved with a new
custom inspector class that drf_yasg can use to build the OpenAPI schema.

This patch also adds a new 'restapi.html' page to the static docs. This new page uses ReDoc and the
OpenAPI schema to display the REST API docs.

Required PR: pulp/pulp_file#202

re: pulp#4104
https://pulp.plan.io/issues/4104
dkliban added a commit to dkliban/pulpcore that referenced this pull request Apr 4, 2019
Solution: Break up REST API docs into sections

This patch modifies the OpenAPI schema. It introduces the concept of Tags. Each tag represents a type
of resource in Pulp. E.g. Artifacts, Content, Remotes, Publishers, etc.

This patch also improves the 'summary' field for each operation also. This is achieved with a new
custom inspector class that drf_yasg can use to build the OpenAPI schema.

This patch also adds a new 'restapi.html' page to the static docs. This new page uses ReDoc and the
OpenAPI schema to display the REST API docs.

Required PR: pulp/pulp_file#202

re: pulp#4104
https://pulp.plan.io/issues/4104
@dkliban dkliban changed the title Problem: OpenAPI schema is out of date with pulpcore Problem: OpenAPI schema test is unreliable between different installs Apr 4, 2019
@dkliban dkliban merged commit 4c8ec39 into pulp:master Apr 4, 2019
@dkliban dkliban deleted the update-openapi-schema branch April 4, 2019 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants