Skip to content

How it works

Without PyFake-API-Server-Surveillance, you're working workflow of keeping PyFake-API-Server configuration to be up-to-date would be like following:

  1. Check the target API interface changes or not
  2. If it has changes, update the PyFake-API-Server-Surveillance configuration

With PyFake-API-Server-Surveillance, you'll do nothing at all and still could keep PyFake-API-Server configuration to be up-to-date automatically. And workflow of PyFake-API-Server-Surveillance is totally same with above. It just automates them.

PyFake-API-Server-Surveillance workflow

  1. Deserialize the configuration details and action inputs from CI workflow.
  2. Get the latest API documentation configuration.1
  3. Convert the API documentation configuration to PyFake-API-Server configuration and compare it with current version configuration.
  4. Update the PyFake-API-Server configuration.
  5. Commit the new changes.2
  6. Push to remote repository about the fake server configuration.2
  7. Open a pull request in remote repository.3
  8. Notify the result. (should implemented by yourself, do nothing in default)4

  1. PyFake-API-Server-Surveillance uses API documentation configuration to judge it has changes or not. ↩

  2. It would use the details about git info in configuration to do some git operations. ↩↩

  3. It would use the details about GitHub info in configuration to do some GitHub operations. ↩

  4. In default, it would do nothing. But developers could implement it with notification function in runner object. ↩