{"id":48583401,"url":"https://github.com/serv-c/docs","last_synced_at":"2026-04-08T17:37:04.576Z","repository":{"id":183477298,"uuid":"670013007","full_name":"serv-c/docs","owner":"serv-c","description":"Documentation for all specifications and component diagrams","archived":false,"fork":false,"pushed_at":"2026-03-05T23:09:35.000Z","size":1071,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-06T02:11:25.514Z","etag":null,"topics":["lang-python"],"latest_commit_sha":null,"homepage":"https://docs.servc.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serv-c.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-07-24T05:27:35.000Z","updated_at":"2026-03-05T23:09:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"80924256-798a-410e-af23-af0546a263c0","html_url":"https://github.com/serv-c/docs","commit_stats":null,"previous_names":["serv-c/docs"],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/serv-c/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serv-c%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serv-c%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serv-c%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serv-c%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serv-c","download_url":"https://codeload.github.com/serv-c/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serv-c%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31567218,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lang-python"],"created_at":"2026-04-08T17:37:03.921Z","updated_at":"2026-04-08T17:37:04.554Z","avatar_url":"https://github.com/serv-c.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Serv-C\n\n[![Serv-C Version](https://byob.yarr.is/serv-c/docs/servc-spec-version)](https://servc.io)\n\nServ-C is an opionated framework for full E2E services at scale. This repo is the documentation of the specification and contains an action that can be used to ensure applications are compliant with the specification.\n\n## Mandatory Library Startup Interfaces\n\n**Resolvers**\n```yaml\n- method: test\n  argument: str[]\n  response:\n    false: |\n      if the argument does not meet type check. and then send a message to queue environment variable SEND_QUEUE [default: my-response-queue] with the payload being the argument\n    true: |\n      if the argument meeds the type check and then send an event with the payload under the env variable EVENT [default: my-event]\n\n- method: fail\n  arugment: any[]\n  response: raise an exception\n\n- method: hook\n  argument: str\n  response: number - representing the number of characters in the string\n- method: hook_part\n  argument: str[]\n  response: will create parts for each element in the list\n```\n\n## GitHub Action\n```yaml\nname: 'Serv-C Unit Test'\non:\n  push:\n  pull_request:\n\njobs:\n  servc:\n    runs-on: ubuntu-latest\n\n    services:\n      rabbitmq:\n        image: rabbitmq:3\n        env:\n          RABBITMQ_DEFAULT_USER: guest\n          RABBITMQ_DEFAULT_PASS: guest\n        ports:\n          - 5672/tcp\n\n      redis:\n        image: redis\n        options: \u003e-\n          --health-cmd \"redis-cli ping\"\n          --health-interval 10s\n          --health-timeout 5s\n          --health-retries 5\n        ports:\n          - 6379/tcp\n\n    steps:\n      #\n      # ADD IN ALL YOUR SETUP HERE\n      # eg: clone, install dependencies\n\n      # step: Check out the document repository\n      # description: This repo contains all the black\n      #              box testing to assert that a library\n      #              is serv-c compliant\n      - name: Checkout Serv-C\n        uses: actions/checkout@v4\n        with:\n          repository: serv-c/docs\n          ref: main\n          path: servc-docs\n          sparse-checkout: |\n            tests\n            requirements.test.txt\n            config/.placeholder\n    \n      # step: Install dependencies\n      - name: Install Serv-C Dependencies\n        run: pip install -r requirements.test.txt\n        shell: bash\n        working-directory: servc-docs\n      \n      # step: Run the Black Box Tests\n      # description: runs the tests. The\n      #              '**' can be modified to run a particular suite\n      #              the START_SCRIPT is mandatory in order to startup\n      #              the library implementation\n      - name: Run Serv-C tests\n        shell: bash\n        working-directory: servc-docs\n        env:\n          START_SCRIPT: ${{ env.CURRENT_PATH }}/start.sh\n          CACHE_URL: redis://redis\n          BUS_URL: amqp://guest:guest@rabbitmq\n        run: python -m unittest tests/**/*.py\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserv-c%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserv-c%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserv-c%2Fdocs/lists"}