Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

[CO-328] Add missing '--client' option in cURL API doc examples #3212

Conversation

KtorZ
Copy link
Contributor

@KtorZ KtorZ commented Jul 9, 2018

Description

Now that client TLS verification is activated, clients are expected to provide a valid TLS client certificate. cURL command given as examples in the documentation should reflect that.

Linked issue

CO-328

Type of change

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • 🛠 New feature (non-breaking change which adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
  • 🏭 Refactoring that does not change existing functionality but does improve things like code readability, structure etc
  • 🔨 New or improved tests for existing code
  • ⛑ git-flow chore (backport, hotfix, etc)

Developer checklist

  • I have read the style guide document, and my code follows the code style of this project.
  • If my code deals with exceptions, it follows the guidelines.
  • I have updated any documentation accordingly, if needed. Documentation changes can be reflected in opening a PR on cardanodocs.com, amending the inline Haddock comments, any relevant README file or one of the document listed in the docs directory.

Testing checklist

  • I have added tests to cover my changes.
  • All new and existing tests passed.

QA Steps

Screenshots (if available)

Now that client TLS verification is activated, clients are expected to provide a valid TLS client certificate. cURL command given as
examples in the documentaiton should reflect that.
@KtorZ KtorZ merged commit 83b5400 into Squad1/CO-325/api-v1-improvements Jul 11, 2018
KtorZ added a commit that referenced this pull request Aug 8, 2018
…rl-options-in-api-doc

[CO-328] Add missing '--client' option in cURL API doc examples
KtorZ added a commit that referenced this pull request Aug 9, 2018
…rl-options-in-api-doc

[CO-328] Add missing '--client' option in cURL API doc examples
@KtorZ KtorZ deleted the KtorZ/CO-328/missing-curl-options-in-api-doc branch August 16, 2018 14:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants