{"id":15091375,"url":"https://github.com/neynarxyz/oas","last_synced_at":"2025-04-19T15:07:15.178Z","repository":{"id":201129023,"uuid":"706777940","full_name":"neynarxyz/OAS","owner":"neynarxyz","description":"The OpenAPI specification for the Neynar APIs","archived":false,"fork":false,"pushed_at":"2025-01-16T20:33:10.000Z","size":877,"stargazers_count":16,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-20T22:49:33.951Z","etag":null,"topics":["farcaster","neynar","openapi-specification","rest-api"],"latest_commit_sha":null,"homepage":"https://neynar.com","language":null,"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/neynarxyz.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}},"created_at":"2023-10-18T15:42:40.000Z","updated_at":"2025-01-16T16:31:40.000Z","dependencies_parsed_at":"2023-11-21T01:30:28.462Z","dependency_job_id":"8a83fd08-03df-4d99-9949-9c45f8f30eff","html_url":"https://github.com/neynarxyz/OAS","commit_stats":{"total_commits":570,"total_committers":14,"mean_commits":"40.714285714285715","dds":0.7403508771929825,"last_synced_commit":"2d5f0e51d6e7dc76f4a6098112c031d3417df0f2"},"previous_names":["neynarxyz/oas"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neynarxyz%2FOAS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neynarxyz%2FOAS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neynarxyz%2FOAS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neynarxyz%2FOAS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neynarxyz","download_url":"https://codeload.github.com/neynarxyz/OAS/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235519907,"owners_count":19003201,"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":["farcaster","neynar","openapi-specification","rest-api"],"created_at":"2024-09-25T10:40:40.370Z","updated_at":"2025-04-19T15:07:15.170Z","avatar_url":"https://github.com/neynarxyz.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# OAS\n[![Validate and Lint OpenAPI Specs](https://github.com/neynarxyz/OAS/actions/workflows/validate-oas.yml/badge.svg)](https://github.com/neynarxyz/OAS/actions/workflows/validate-oas.yml)\n\n### Overview\n\nThe OpenAPI specification for the [Neynar](https://neynar.com) [APIs](https://docs.neynar.com). \nSign up for an API key on [neynar.com](https://neynar.com).\n\n### Installing Spectral for OpenAPI Validation\n\nWe use [Spectral](https://github.com/stoplightio/spectral) to lint and validate our OpenAPI specifications. Spectral helps ensure that the OpenAPI files are compliant with the OpenAPI specification and follow best practices.\n\n#### Install Spectral\n\nYou can install Spectral globally using Yarn:\n\n```bash\nyarn global add @stoplight/spectral-cli\n```\n\n### Validating OpenAPI Specifications\n\nTo validate an OpenAPI specification file using Spectral, run:\n\n#### v2\n\n```bash\nspectral lint src/v2/spec.yaml\n```\n\n#### hub-rest-api\n\n```bash\nspectral lint src/hub-rest-api/spec.yaml\n```\n\nSpectral will output any errors or warnings found in the specification files.\n\n### Validating OpenAPI Specifications with Swagger\nIn addition to Spectral, you can use the Swagger CLI to validate your OpenAPI specifications.\n\n#### Install Swagger CLI\nYou can install Swagger CLI globally using Yarn:\n\n```bash\nyarn global add swagger-cli\n```\n\n#### Validate OpenAPI Specifications with Swagger CLI\nTo validate an OpenAPI specification file using Swagger CLI, run:\n\nv2\n```bash\nswagger-cli validate src/v2/spec.yaml\n```\n\nhub-rest-api\n```bash\nswagger-cli validate src/hub-rest-api/spec.yaml\n```\n\nThis will check for structural errors and report any issues.\n\n### Installing Client Code Generator\n\nWe use [OpenAPI Generator](https://openapi-generator.tech/) to generate client code from the OpenAPI specifications.\n\n#### Install OpenAPI Generator\n\nPrerequisite: [Java](https://www.java.com/) must be installed.\n\nInstall OpenAPI Generator using Homebrew:\n\n```bash\nbrew install openapi-generator\n```\n\n### Generating TypeScript Client Code Using the OAS Definitions\n\n#### v2\n\n```bash\nopenapi-generator generate -i src/v2/spec.yaml -g typescript-axios -o src/v2/swagger-tmp\n```\n\n#### hub-rest-api\n\n```bash\nopenapi-generator generate -i src/hub-rest-api/spec.yaml -g typescript-axios -o src/hub-rest-api/swagger-tmp\n```\n\nFor other languages, replace `\u003cgenerator\u003e` with a [desired generator](https://openapi-generator.tech/docs/generators).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneynarxyz%2Foas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneynarxyz%2Foas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneynarxyz%2Foas/lists"}