{"id":37442232,"url":"https://github.com/faluapp/falu-openapi","last_synced_at":"2026-01-16T06:45:45.337Z","repository":{"id":223081883,"uuid":"759260506","full_name":"faluapp/falu-openapi","owner":"faluapp","description":"OpenAPI specification for Falu","archived":false,"fork":false,"pushed_at":"2024-08-22T06:12:30.000Z","size":54,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-22T07:28:15.032Z","etag":null,"topics":["falu","openapi","rest-api"],"latest_commit_sha":null,"homepage":"https://falu.io/docs/api","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/faluapp.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":"2024-02-18T04:50:32.000Z","updated_at":"2024-08-22T07:28:16.209Z","dependencies_parsed_at":"2024-04-29T16:47:55.358Z","dependency_job_id":"31f0fa86-e0e5-448e-b5d3-81efebcaf145","html_url":"https://github.com/faluapp/falu-openapi","commit_stats":null,"previous_names":["faluapp/falu-openapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/faluapp/falu-openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faluapp%2Ffalu-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faluapp%2Ffalu-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faluapp%2Ffalu-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faluapp%2Ffalu-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/faluapp","download_url":"https://codeload.github.com/faluapp/falu-openapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faluapp%2Ffalu-openapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28477944,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"last_error":"SSL_read: 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":["falu","openapi","rest-api"],"created_at":"2026-01-16T06:45:45.264Z","updated_at":"2026-01-16T06:45:45.326Z","avatar_url":"https://github.com/faluapp.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI spec for Falu\n\nThe spec files provided in the `specs` folder (`specs/openapi.{yaml,json}`) conform to the [OpenAPI specification](https://www.openapis.org/).\n\n## Extensions\n\nFalu uses several vendor-specific extensions in these spec files to provide extra information or enhance existing features. In most cases, you do not need to worry about them unless you are generating new or alternative SDKs.\n\nKnown extensions:\n\n- [`x-pii`](#x-pii)\n- [`x-error-codes`](#x-error-codes)\n- [`x-supports-pagination`](#x-supports-pagination)\n\n### `x-pii`\n\nProperties containing `x-pii` indicate that they carry Personally Identifiable Information (PII) data. These properties are redacted by removal or masking when the `/{id}/redact` endpoint for the object is invoked.\n\nIn the example below, the `body` property is marked as PII because it may contain sensitive personal information such as passwords or health information.\n\n```yaml\ncomponents:\n  ...\n  schemas:\n    ...\n    Message:\n      ...\n      properties:\n        metadata:\n        id:\n        stream:\n        body:\n          maxLength: 1600\n          type: string\n          description: |-\n            Actual message content to be sent.\n            Required if `template` is not specified.\n          nullable: true\n          example: Welcome home John!\n          x-pii: true\n```\n\n### `x-error-codes`\n\nOperations containing `x-error-codes` indicate the error codes that can result from its execution.\n\nIn the example below, calls made to `POST /v1/files` can result in 400 (Bad Request) responses with error code `file_type_not_allowed` or `file_invalid`.\n\n```yaml\npaths:\n  ...\n  /v1/files:\n    ...\n    post:\n      ...\n      x-error-codes:\n        - file_type_not_allowed\n        - file_invalid\n```\n\n\u003e All possible error codes are documented \u003chttps://falu.io/docs/error-codes\u003e\n\n### `x-supports-pagination`\n\nOperations containing `x-supports-pagination: true` indicate that pagination is supported. This is set for any operation/endpoint that returns a list of items. These operations will usually have query parameters for filtering depending on the type of object. In addition,\n\n- `ct`: a continuation token that is used for the next request.\n- `sort`: the sorting order (`asc|desc|ascending|descending`).\n- `count`: the maximum number of items (must be less than or equal to 100).\n- `created.{lt,lte,gt,gte}`: filter options for creation date.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaluapp%2Ffalu-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffaluapp%2Ffalu-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaluapp%2Ffalu-openapi/lists"}