Update the README file with the new demo api version

[renato04]

Description

Update the sample yaml file

Motivation behind this PR?

What type of change is this?

Checklist

• I have added a changelog entry / my PR does not need a new changelog entry. Instructions.
• I have added/updated unit tests. Instructions.
• New and existing unit tests pass locally with my changes. Instructions
• I have self-documented code my changes by adding docstring(s) and comment(s). Instructions
• Current PR does not significantly decrease the code coverage and docstring coverage.
• My code follows the style guidelines of this project.
• I have run ScanAPI locally and manually tested my changes. Instructions.

Issue

Closes #368

[camilamaia]

Hey @renato04, thank you very much for your contribution!

Just one more thing, can we have the screenshots also updated to match the new demo-api version?

They are on README.md from line 77 to 93:

<p align="center">
  <img
    src="https://raw.githubusercontent.com/scanapi/scanapi/master/images/report-print-closed.png"
    width="700",
    alt="An overview screenshot of the report."
  >
  <img
    src="https://raw.githubusercontent.com/scanapi/scanapi/master/images/report-print-request.png"
    width="700"
    alt="A screenshot of the report showing the request details."
  >
  <img
    src="https://raw.githubusercontent.com/scanapi/scanapi/master/images/report-print-response.png"
    width="700",
    alt="A screenshot of the report showing the response and test details"
  >
</p>

The images are stored here: https://github.com/scanapi/scanapi/tree/main/images

Thank you once again!

[renato04]

@camilamaia It's done!

[camilamaia]

Sorry, I was not clear previously. I mean, the screenshots show ScanAPI running for the previous example:

What needs to be done is:

• Run ScanAPI with the README spec example that you've updated:

endpoints:
  - name: scanapi-demo # The API's name of your API
    path: http://demo.scanapi.dev/api/ # The API's base url
    requests:
      - name: list_all_devs # The name of the first request
        path: devs/ # The path of the first request
        method: get # The HTTP method of the first request
        tests:
          - name: status_code_is_200 # The name of the first test for this request
            assert: ${{ response.status_code == 200 }} # The assertion

Take 3 screenshots and replace the old ones with the new ones in the images folder: https://github.com/scanapi/scanapi/tree/main/images

• report-print-closed.png
• report-print-request.png
• report-print-response.png

Does it make sense? Sorry for the miscommunication.

[renato04]

@camilamaia no problem.
I understood, I'm going to do that as soon as possible

[renato04]

@camilamaia It's done.
Let me know if is anything wrong.

[Pradhvan]

@renato04 just one minor change can you squash the commits into one and add a structured commit message associated with it.

You can follow the below commit template:

[Title]

[Body of the commit]

[Closes #issue number ]

Something like 👇🏾

Updates README file with the new demo api version

* updates `name`, `path` with the new new demo API
* adds updated images

Closes #<issue number>

Feel free to let me know if you need any help with any of the steps.

[renato04]

Thank you @Pradhvan for the tip!
Do I have to do that for this PR to be accepted?

[Pradhvan]

Hi @renato04 👋🏾

Do I have to do that for this PR to be accepted?

Yes, this would also be really helpful in improving standardising the GitHub workflow.

Let me know if you need any help.

[renato04]

Hi @Pradhvan!
Is it good now?

[Pradhvan]

Hi @Pradhvan!
Is it good now?

The final commit looks good. You just need to squash all 4 commits into 1 commit now.

[renato04]

@Pradhvan what about now? 😆