{"id":20324135,"url":"https://github.com/opentensor/opentensorai-connector-template","last_synced_at":"2025-04-11T19:40:27.810Z","repository":{"id":237338530,"uuid":"794315875","full_name":"opentensor/opentensorAI-connector-template","owner":"opentensor","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-12T13:01:38.000Z","size":674,"stargazers_count":1,"open_issues_count":1,"forks_count":8,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T15:33:45.331Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opentensor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-04-30T22:08:14.000Z","updated_at":"2024-06-22T05:28:20.000Z","dependencies_parsed_at":"2024-05-05T23:23:37.477Z","dependency_job_id":"d14ca5d5-8007-4362-81de-1008cffc4209","html_url":"https://github.com/opentensor/opentensorAI-connector-template","commit_stats":null,"previous_names":["opentensor/hackathon","opentensor/opentensorai-connector-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opentensor%2FopentensorAI-connector-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opentensor%2FopentensorAI-connector-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opentensor%2FopentensorAI-connector-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opentensor%2FopentensorAI-connector-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opentensor","download_url":"https://codeload.github.com/opentensor/opentensorAI-connector-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248468200,"owners_count":21108774,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-14T19:32:26.787Z","updated_at":"2025-04-11T19:40:27.783Z","avatar_url":"https://github.com/opentensor.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Connector Documentation Guidelines\r\n\r\n## TLDR / Subnet Owner's Todo List\r\n- Fork the repo and put up a PR to add OpenAPI documentation for your respective SNs API connector under the `SN_[YOUR_SUBNET_NUMBER_HERE]` directory, add @specialk111 as reviewer\r\n- Set up a walkthrough session with @specialk111\r\n- SLA\r\n- Product proposal \u0026 existing URL/frontend\r\n\r\n## Introduction\r\nTo ensure uniformity and to facilitate easier integration, we request all subnets who are collaborating with us to follow a set format for API documentation. This README outlines the requirements for submitting connector API documentation.\r\n\r\n## Documentation Format\r\nAll API documentation should be provided in the [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md), using either YAML or JSON formats. We recommend using the `Library API` documentation (located in the `SN_X` folder) as a template or reference for how your API documentation should be structured.\r\n\r\n## Required Information\r\nYour API documentation should include the following key elements:\r\n\r\n### API Details\r\n- Base URL: The root URL of your API where all endpoint paths will be appended.\r\n- Authentication: Details on the authentication mechanism (e.g., API keys, OAuth tokens).\r\n- Rate Limits: Information on any limitations on the number of API calls.\r\n\r\n### Endpoints\r\nFor each public endpoint in your API, the documentation must include:\r\n\r\n- Path: The specific URL path for the endpoint.\r\n- Method: The HTTP method (GET, POST, PUT, DELETE, etc.) used.\r\n- Parameters: Any parameters required or optional, their data types, and whether they are included in the query string, path, or body.\r\n- Request Examples: Example requests to show how data should be formatted and sent.\r\n- Response Examples: Example responses from the API including error responses and status codes.\r\n- Data Types: Clearly specify the data types that are expected by and returned from the API.\r\n\r\n### Data Types\r\nSpecify the data structures used in your API. For each data type, detail:\r\n\r\n- Properties: Name and data type of each property.\r\n- Required: Fields that are mandatory.\r\n- Example Values: Provide examples of what the data type should look like.\r\n\r\n## Non-RESTful APIs\r\nIf connecting to your system does not involve RESTful API endpoints but uses other methods (like WebSocket connections, FTP, etc.), please provide detailed documentation in any format that includes:\r\n\r\n- Connection Details: How to establish a connection from the frontend.\r\n- Data Transmission: How data is sent and received through your system.\r\n- Examples and Use Cases: Detailed examples of using your system including any initialization or setup needed.\r\n\r\n## Submission\r\nPlease fork this repo and submit a pull request with your subnet's complete connector documentation. Following the `SN_X` example, create a directory for your subnet (`SN_[YOUR_SUBNET_NUMBER_HERE]`) and add your connector details.\r\n\r\n\r\n## Web 2 and Connector Architecture\r\n\r\n```mermaid\r\nflowchart LR\r\n    Alice --\u003e web2_ELB\r\n\r\n    subgraph Web2 Networking Layer\r\n        web2_ELB[\"Web2 ELB\"]\r\n    end\r\n\r\n    subgraph Web2 EKS Cluster\r\n        web2_nginx_1[\"nginx pod\"]\r\n        web2_nginx_2[\"nginx pod\"]\r\n        web2_nginx_3[\"nginx pod\"]\r\n        mfe[\"Micro Frontends\"]\r\n    end\r\n\r\n    web2_ELB -- HTTPS --\u003e web2_nginx_1\r\n    web2_ELB -- HTTPS --\u003e web2_nginx_2\r\n    web2_ELB -- HTTPS --\u003e web2_nginx_3\r\n\r\n    web2_nginx_1 -- MESH --\u003e mfe\r\n    web2_nginx_2 -- MESH --\u003e mfe\r\n    web2_nginx_3 -- MESH --\u003e mfe\r\n\r\n    mfe -- HTTPS --\u003e connector_ELB\r\n    mfe -- STREAMS --\u003e connector_FIREHOSE\r\n    mfe -- QUEUE --\u003e connector_SQS\r\n\r\n\r\n    subgraph Connector Networking Layer\r\n        connector_ELB[\"ELB\"]\r\n        connector_FIREHOSE[\"Kinesis Firehose\"]\r\n        connector_SQS[\"SQS\"]\r\n    end\r\n\r\n    subgraph Connector EKS Cluster\r\n        connector_nginx_1[\"nginx pods\"]\r\n        connector_streams_2[\"streams pods\"]\r\n        connector_queue_3[\"queue pods\"]\r\n    end\r\n\r\n    connector_ELB -- HTTPS --\u003e connector_nginx_1\r\n    connector_FIREHOSE -- STREAMS --\u003e connector_streams_2\r\n    connector_SQS -- QUEUE --\u003e connector_queue_3\r\n\r\n    connector_nginx_1 -- HTTPS --\u003e validator_ELB\r\n    connector_streams_2 -- HTTPS --\u003e validator_ELB\r\n    connector_queue_3 -- HTTPS --\u003e validator_ELB\r\n\r\n\r\n    subgraph Validator Networking Layer\r\n        validator_ELB[\"Validator ELB\"]\r\n    end\r\n\r\n    subgraph Validator EC2 instances\r\n        validator_1\r\n        validator_2\r\n        validator_N\r\n    end\r\n\r\n    validator_ELB -- HTTPS --\u003e validator_1\r\n    validator_ELB -- HTTPS --\u003e validator_2\r\n    validator_ELB -- HTTPS --\u003e validator_N\r\n\r\n\r\n\r\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopentensor%2Fopentensorai-connector-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopentensor%2Fopentensorai-connector-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopentensor%2Fopentensorai-connector-template/lists"}