{"id":15091378,"url":"https://github.com/square/connect-api-specification","last_synced_at":"2025-04-05T13:07:37.935Z","repository":{"id":6203811,"uuid":"54998230","full_name":"square/connect-api-specification","owner":"square","description":"This repository contains the OpenAPI specification as well as templates for generating SDKs for Square's APIs","archived":false,"fork":false,"pushed_at":"2025-03-19T17:52:44.000Z","size":5231,"stargazers_count":73,"open_issues_count":13,"forks_count":36,"subscribers_count":24,"default_branch":"master","last_synced_at":"2025-03-29T11:49:42.010Z","etag":null,"topics":["openapi","openapi-specification","sdk","swagger"],"latest_commit_sha":null,"homepage":"https://squareup.com/developers","language":"Mustache","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/square.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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":"2016-03-29T17:56:27.000Z","updated_at":"2025-03-19T17:52:48.000Z","dependencies_parsed_at":"2023-02-16T12:15:55.413Z","dependency_job_id":"80ae5cca-f881-4589-a017-4a6c2e759ba7","html_url":"https://github.com/square/connect-api-specification","commit_stats":{"total_commits":167,"total_committers":35,"mean_commits":4.771428571428571,"dds":0.8383233532934131,"last_synced_commit":"fe3f803abff656249570d5f2d5fc92a02892aed7"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/square%2Fconnect-api-specification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/square%2Fconnect-api-specification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/square%2Fconnect-api-specification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/square%2Fconnect-api-specification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/square","download_url":"https://codeload.github.com/square/connect-api-specification/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247339158,"owners_count":20923014,"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":["openapi","openapi-specification","sdk","swagger"],"created_at":"2024-09-25T10:40:42.516Z","updated_at":"2025-04-05T13:07:37.915Z","avatar_url":"https://github.com/square.png","language":"Mustache","readme":"Connecting to the Square API\n============================\n\nThis is the project that _generates_ API clients for connecting to the public Square API. You probably want to just use one of the clients that are pre-built in a language of your choice:\n\n* [Python](https://github.com/square/connect-python-sdk)\n* [C#](https://github.com/square/connect-csharp-sdk)\n* [Ruby](https://github.com/square/connect-ruby-sdk)\n* [PHP](https://github.com/square/connect-php-sdk)\n* [Java](https://github.com/square/connect-java-sdk)\n* [Javascript](https://github.com/square/connect-javascript-sdk)\n\nThe [Connect Examples](https://github.com/square/connect-api-examples/tree/master/connect-examples/) are working sample applications that you can copy from to build your own.\n\nConnect API Specifications\n=============================\n\nThis repository contains the specifications for generating client SDKs with\n[Swagger/OpenAPI](http://swagger.io/).\n\nThe canonical specification is defined in `api.json`. The templates for our\nsupported SDKs are located in `swagger-templates`. The configuration for each\nSDK (e.g. name of the library, version number, etc.) are located in\n`swagger-config`.\n\nConfigure a new language\n------------------------\n\nGenerating an SDK for a new language is possible. You'll need to have a working version of `swagger-codegen` and follow these steps:\n\n1. Check if Swagger Codegen supports the language by running:\n    ```bash\n    swagger-codegen langs\n    ```\n2. If the language is supported, note swagger's name for it. We'll call it {lang}\n3. Add a configuration file on [swagger-config](swagger-config/) named `config-{lang}.json`. You can check [this template](swagger-config/config-{lang}.json).\n4. Create a directory on [swagger-templates](swagger-templates/) named `{lang}`. Generation scripts expect to have a folder even if no custom templates are included:\n    ```bash\n    mkdir $lang\n    ```\n5. (Optional) Add custom templates for your generator. Check [Swagger Codegen Readme](https://github.com/swagger-api/swagger-codegen#modifying-the-client-library-format).\n\nContributing\n------------\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md).\n\nLicense\n-------\n\n```\nCopyright 2016 - 2021 Square, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquare%2Fconnect-api-specification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsquare%2Fconnect-api-specification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquare%2Fconnect-api-specification/lists"}