Skip to content

docs: update integrations.rst #364

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

Merged
merged 1 commit into from
Jun 16, 2021

Conversation

MichaelCurrin
Copy link
Contributor

@MichaelCurrin MichaelCurrin commented Jun 14, 2021

  • Fixed grammar - replace a when as a was needed.
  • Remove redundancy. Like no need to mention Falcon twice here when you already in the Falcon section.
    - For Falcon you can use FalconOpenAPIRequest a Falcon request factory:
    + You can use `FalconOpenAPIRequest` as a Falcon request factory:
  • Add backticks around classes
  • Use single space in URLs (some had 1 and some had 2)

@MichaelCurrin
Copy link
Contributor Author

MichaelCurrin commented Jun 14, 2021

Also possible improvement for Requests, to make openapi_request explicit.

requests_response = requests.get(url)

openapi_request = RequestsOpenAPIRequest(requests_response.request)
openapi_response = RequestsOpenAPIResponse(requests_response)
validator = RequestValidator(spec)
result = validator.validate(openapi_request, openapi_response)

I haven't run this though but guessing based on my use of requests library.

Copy link
Collaborator

@p1c2u p1c2u left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@codecov
Copy link

codecov bot commented Jun 16, 2021

Codecov Report

Merging #364 (77c00cf) into master (e0637b5) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #364   +/-   ##
=======================================
  Coverage   96.72%   96.72%           
=======================================
  Files          80       80           
  Lines        1743     1743           
=======================================
  Hits         1686     1686           
  Misses         57       57           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e0637b5...77c00cf. Read the comment docs.

@p1c2u
Copy link
Collaborator

p1c2u commented Jun 16, 2021

@MichaelCurrin thank you for the contribution

@p1c2u p1c2u merged commit bf2f13d into python-openapi:master Jun 16, 2021
@MichaelCurrin MichaelCurrin deleted the docs-update-integrations branch June 16, 2021 21:38
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