From ec912cc28d1b0a39bda9e8a398a9b59b928f031c Mon Sep 17 00:00:00 2001 From: scalarbot Date: Wed, 30 Sep 2026 19:59:14 +0000 Subject: [PATCH 1/7] feat(api)!: update SDK surface (15 changes) - Regenerated with generator `0.36.0` (previously `0.32.14`). - Added `oauth2` auth scheme `OAuth2`. - Removed body field `lastKnownVersionSha` from `registry.updateApiDocumentVersion`. - Removed body field `lastKnownVersionSha` from `registry.createApiDocumentVersion`. - Added optional body field `force` to `schemas.version.create`. - Response of `schemas.version.create` changed from `uid` to `none`. - Schema `slug` shape changed. - Schema `namespace` shape changed. - Added required property `managed_doc_version.endpointCount`. - Removed optional property `managed_doc_version.versionSha`. - Schema `method` shape changed. - Added optional property `managed_schema_version.yamlSha`. - Added optional property `managed_schema_version.jsonSha`. - Added required property `github_project.userInfoHookUrl`. - Added required property `github_project.analyticsEnabled`. BREAKING CHANGE: 10 breaking changes to the SDK surface. - Removed body field `lastKnownVersionSha` from `registry.updateApiDocumentVersion`. - Removed body field `lastKnownVersionSha` from `registry.createApiDocumentVersion`. - Response of `schemas.version.create` changed from `uid` to `none`. - Schema `slug` shape changed. - Schema `namespace` shape changed. - Added required property `managed_doc_version.endpointCount`. - Removed optional property `managed_doc_version.versionSha`. - Schema `method` shape changed. - Added required property `github_project.userInfoHookUrl`. - Added required property `github_project.analyticsEnabled`. Build: DSSyanrPJAu7bGPDEx7Kw --- .claude/skills/scalar-ruby-sdk/SKILL.md | 13 +- .github/workflows/release-please.yml | 12 +- .github/workflows/release-title-edit.yml | 4 +- .github/workflows/sdk-ci.yml | 2 +- .github/workflows/sdk-release.yml | 10 +- CONTRIBUTING.md | 6 +- Gemfile.lock | 4 +- README.md | 11 +- SKILL.md | 13 +- VERSIONING.md | 14 ++ api.md | 160 ++++++++--------- examples/usage.rb | 2 +- lib/scalar-api-ruby.rb | 146 --------------- lib/scalar_api_ruby.rb | 147 +++++++++++++++ .../client.rb | 32 +++- .../errors.rb | 0 .../file_part.rb | 0 .../internal.rb | 0 .../internal/transport/base_client.rb | 0 .../transport/pooled_net_requester.rb | 0 .../internal/type/array_of.rb | 0 .../internal/type/base_model.rb | 0 .../internal/type/base_page.rb | 0 .../internal/type/boolean.rb | 0 .../internal/type/converter.rb | 0 .../internal/type/enum.rb | 0 .../internal/type/file_input.rb | 0 .../internal/type/hash_of.rb | 0 .../internal/type/request_parameters.rb | 0 .../internal/type/union.rb | 0 .../internal/type/unknown.rb | 0 .../internal/util.rb | 0 .../models.rb | 0 .../models/400.rb | 0 .../models/401.rb | 0 .../models/403.rb | 0 .../models/404.rb | 0 .../models/422.rb | 0 .../models/500.rb | 0 .../models/access_group.rb | 0 ...tication_exchange_personal_token_params.rb | 0 ...cation_exchange_personal_token_response.rb | 0 ...authentication_list_current_user_params.rb | 0 ...thentication_list_current_user_response.rb | 0 .../models/login_portal_create_params.rb | 0 .../models/login_portal_delete_params.rb | 0 .../models/login_portal_email.rb | 0 .../models/login_portal_list_params.rb | 0 .../models/login_portal_list_response.rb | 0 .../models/login_portal_page.rb | 0 .../models/login_portal_retrieve_params.rb | 0 .../models/login_portal_retrieve_response.rb | 0 .../models/login_portal_update_params.rb | 0 .../models/managed_doc_version.rb | 15 +- .../models/namespace.rb | 0 .../models/namespace_list_params.rb | 0 .../models/namespace_list_response.rb | 0 .../models/nanoid.rb | 0 ...create_api_document_access_group_params.rb | 0 .../registry_create_api_document_params.rb | 0 .../registry_create_api_document_response.rb | 8 +- ...stry_create_api_document_version_params.rb | 8 +- ...delete_api_document_access_group_params.rb | 0 .../registry_delete_api_document_params.rb | 0 ...stry_delete_api_document_version_params.rb | 0 .../registry_list_all_api_documents_params.rb | 0 ...egistry_list_all_api_documents_response.rb | 0 ...st_api_document_version_metadata_params.rb | 0 .../registry_list_api_documents_params.rb | 0 .../registry_list_api_documents_response.rb | 0 ...ry_retrieve_api_document_version_params.rb | 0 ..._retrieve_api_document_version_response.rb | 0 .../registry_update_api_document_params.rb | 0 ...stry_update_api_document_version_params.rb | 8 +- ...ry_update_api_document_version_response.rb | 8 +- ...rule_create_ruleset_access_group_params.rb | 0 .../models/rule_create_ruleset_params.rb | 0 ...rule_delete_ruleset_access_group_params.rb | 0 .../models/rule_delete_ruleset_params.rb | 0 .../models/rule_list_rulesets_params.rb | 0 .../models/rule_list_rulesets_response.rb | 0 .../rule_retrieve_ruleset_document_params.rb | 0 ...rule_retrieve_ruleset_document_response.rb | 0 .../models/rule_update_ruleset_params.rb | 0 .../models/scalar_doc_create_guide_params.rb | 0 .../scalar_doc_create_guide_response.rb | 0 .../models/scalar_doc_list_guides_params.rb | 0 .../models/scalar_doc_list_guides_response.rb | 14 +- .../models/scalar_doc_publish_guide_params.rb | 0 .../scalar_doc_publish_guide_response.rb | 0 .../models/schema_create_params.rb | 0 .../models/schema_delete_params.rb | 0 .../models/schema_list_params.rb | 0 .../models/schema_list_response.rb | 14 +- .../models/schema_update_params.rb | 0 .../schemas/access_group_create_params.rb | 0 .../schemas/access_group_delete_params.rb | 0 .../models/schemas/version_create_params.rb | 8 +- .../models/schemas/version_create_response.rb | 18 ++ .../models/schemas/version_delete_params.rb | 0 .../models/schemas/version_retrieve_params.rb | 0 .../schemas/version_retrieve_response.rb | 0 .../models/slug.rb | 0 .../models/team_list_params.rb | 0 .../models/team_list_response.rb | 0 .../models/theme_create_params.rb | 0 .../models/theme_delete_params.rb | 0 .../models/theme_list_params.rb | 0 .../models/theme_list_response.rb | 0 .../models/theme_replace_document_params.rb | 0 .../models/theme_retrieve_params.rb | 0 .../models/theme_retrieve_response.rb | 0 .../models/theme_update_params.rb | 0 .../models/timestamp.rb | 0 .../models/uid.rb | 0 .../models/version.rb | 0 .../request_options.rb | 0 .../resources/authentication.rb | 0 .../resources/login_portals.rb | 0 .../resources/namespaces.rb | 0 .../resources/registry.rb | 8 +- .../resources/rules.rb | 0 .../resources/scalar_docs.rb | 0 .../resources/schemas.rb | 0 .../resources/schemas/access_group.rb | 0 .../resources/schemas/version.rb | 8 +- .../resources/teams.rb | 0 .../resources/themes.rb | 0 .../version.rb | 0 .../client.rbi | 9 +- .../errors.rbi | 0 .../file_part.rbi | 0 .../internal.rbi | 0 .../internal/transport/base_client.rbi | 0 .../transport/pooled_net_requester.rbi | 0 .../internal/type/array_of.rbi | 0 .../internal/type/base_model.rbi | 0 .../internal/type/base_page.rbi | 0 .../internal/type/boolean.rbi | 0 .../internal/type/converter.rbi | 0 .../internal/type/enum.rbi | 0 .../internal/type/file_input.rbi | 0 .../internal/type/hash_of.rbi | 0 .../internal/type/request_parameters.rbi | 0 .../internal/type/union.rbi | 0 .../internal/type/unknown.rbi | 0 .../internal/util.rbi | 0 .../models.rbi | 0 .../models/400.rbi | 0 .../models/401.rbi | 0 .../models/403.rbi | 0 .../models/404.rbi | 0 .../models/422.rbi | 0 .../models/500.rbi | 0 .../models/access_group.rbi | 0 ...ication_exchange_personal_token_params.rbi | 0 ...ation_exchange_personal_token_response.rbi | 0 ...uthentication_list_current_user_params.rbi | 0 ...hentication_list_current_user_response.rbi | 0 .../models/login_portal_create_params.rbi | 0 .../models/login_portal_delete_params.rbi | 0 .../models/login_portal_email.rbi | 0 .../models/login_portal_list_params.rbi | 0 .../models/login_portal_list_response.rbi | 0 .../models/login_portal_page.rbi | 0 .../models/login_portal_retrieve_params.rbi | 0 .../models/login_portal_retrieve_response.rbi | 0 .../models/login_portal_update_params.rbi | 0 .../models/managed_doc_version.rbi | 17 +- .../models/namespace.rbi | 0 .../models/namespace_list_params.rbi | 0 .../models/namespace_list_response.rbi | 0 .../models/nanoid.rbi | 0 ...reate_api_document_access_group_params.rbi | 0 .../registry_create_api_document_params.rbi | 0 .../registry_create_api_document_response.rbi | 14 +- ...try_create_api_document_version_params.rbi | 9 - ...elete_api_document_access_group_params.rbi | 0 .../registry_delete_api_document_params.rbi | 0 ...try_delete_api_document_version_params.rbi | 0 ...registry_list_all_api_documents_params.rbi | 0 ...gistry_list_all_api_documents_response.rbi | 0 ...t_api_document_version_metadata_params.rbi | 0 .../registry_list_api_documents_params.rbi | 0 .../registry_list_api_documents_response.rbi | 0 ...y_retrieve_api_document_version_params.rbi | 0 ...retrieve_api_document_version_response.rbi | 0 .../registry_update_api_document_params.rbi | 0 ...try_update_api_document_version_params.rbi | 17 +- ...y_update_api_document_version_response.rbi | 15 +- ...ule_create_ruleset_access_group_params.rbi | 0 .../models/rule_create_ruleset_params.rbi | 0 ...ule_delete_ruleset_access_group_params.rbi | 0 .../models/rule_delete_ruleset_params.rbi | 0 .../models/rule_list_rulesets_params.rbi | 0 .../models/rule_list_rulesets_response.rbi | 0 .../rule_retrieve_ruleset_document_params.rbi | 0 ...ule_retrieve_ruleset_document_response.rbi | 0 .../models/rule_update_ruleset_params.rbi | 0 .../models/scalar_doc_create_guide_params.rbi | 0 .../scalar_doc_create_guide_response.rbi | 0 .../models/scalar_doc_list_guides_params.rbi | 0 .../scalar_doc_list_guides_response.rbi | 12 ++ .../scalar_doc_publish_guide_params.rbi | 0 .../scalar_doc_publish_guide_response.rbi | 0 .../models/schema_create_params.rbi | 0 .../models/schema_delete_params.rbi | 0 .../models/schema_list_params.rbi | 0 .../models/schema_list_response.rbi | 29 ++- .../models/schema_update_params.rbi | 0 .../schemas/access_group_create_params.rbi | 0 .../schemas/access_group_delete_params.rbi | 0 .../models/schemas/version_create_params.rbi | 9 + .../schemas/version_create_response.rbi | 28 +++ .../models/schemas/version_delete_params.rbi | 0 .../schemas/version_retrieve_params.rbi | 0 .../schemas/version_retrieve_response.rbi | 0 .../models/slug.rbi | 0 .../models/team_list_params.rbi | 0 .../models/team_list_response.rbi | 0 .../models/theme_create_params.rbi | 0 .../models/theme_delete_params.rbi | 0 .../models/theme_list_params.rbi | 0 .../models/theme_list_response.rbi | 0 .../models/theme_replace_document_params.rbi | 0 .../models/theme_retrieve_params.rbi | 0 .../models/theme_retrieve_response.rbi | 0 .../models/theme_update_params.rbi | 0 .../models/timestamp.rbi | 0 .../models/uid.rbi | 0 .../models/version.rbi | 0 .../request_options.rbi | 0 .../resources/authentication.rbi | 0 .../resources/login_portals.rbi | 0 .../resources/namespaces.rbi | 0 .../resources/registry.rbi | 6 - .../resources/rules.rbi | 0 .../resources/scalar_docs.rbi | 0 .../resources/schemas.rbi | 0 .../resources/schemas/access_group.rbi | 0 .../resources/schemas/version.rbi | 5 +- .../resources/teams.rbi | 0 .../resources/themes.rbi | 0 .../version.rbi | 0 release-please-config.json | 3 +- scalar-sdk.manifest.json | 169 ++++++++++++------ ...pi-ruby.gemspec => scalar_api_ruby.gemspec | 4 +- ...y_update_api_document_version_response.rbs | 26 --- .../client.rbs | 5 +- .../errors.rbs | 0 .../file_part.rbs | 0 .../internal.rbs | 0 .../internal/transport/base_client.rbs | 0 .../transport/pooled_net_requester.rbs | 0 .../internal/type/array_of.rbs | 0 .../internal/type/base_model.rbs | 0 .../internal/type/base_page.rbs | 0 .../internal/type/boolean.rbs | 0 .../internal/type/converter.rbs | 0 .../internal/type/enum.rbs | 0 .../internal/type/file_input.rbs | 0 .../internal/type/hash_of.rbs | 0 .../internal/type/request_parameters.rbs | 0 .../internal/type/union.rbs | 0 .../internal/type/unknown.rbs | 0 .../internal/util.rbs | 0 .../models.rbs | 0 .../models/400.rbs | 0 .../models/401.rbs | 0 .../models/403.rbs | 0 .../models/404.rbs | 0 .../models/422.rbs | 0 .../models/500.rbs | 0 .../models/access_group.rbs | 0 ...ication_exchange_personal_token_params.rbs | 0 ...ation_exchange_personal_token_response.rbs | 0 ...uthentication_list_current_user_params.rbs | 0 ...hentication_list_current_user_response.rbs | 0 .../models/login_portal_create_params.rbs | 0 .../models/login_portal_delete_params.rbs | 0 .../models/login_portal_email.rbs | 0 .../models/login_portal_list_params.rbs | 0 .../models/login_portal_list_response.rbs | 0 .../models/login_portal_page.rbs | 0 .../models/login_portal_retrieve_params.rbs | 0 .../models/login_portal_retrieve_response.rbs | 0 .../models/login_portal_update_params.rbs | 0 .../models/managed_doc_version.rbs | 23 ++- .../models/namespace.rbs | 0 .../models/namespace_list_params.rbs | 0 .../models/namespace_list_response.rbs | 0 .../models/nanoid.rbs | 0 ...reate_api_document_access_group_params.rbs | 0 .../registry_create_api_document_params.rbs | 0 .../registry_create_api_document_response.rbs | 5 - ...try_create_api_document_version_params.rbs | 9 +- ...elete_api_document_access_group_params.rbs | 0 .../registry_delete_api_document_params.rbs | 0 ...try_delete_api_document_version_params.rbs | 0 ...registry_list_all_api_documents_params.rbs | 0 ...gistry_list_all_api_documents_response.rbs | 0 ...t_api_document_version_metadata_params.rbs | 0 .../registry_list_api_documents_params.rbs | 0 .../registry_list_api_documents_response.rbs | 0 ...y_retrieve_api_document_version_params.rbs | 0 ...retrieve_api_document_version_response.rbs | 0 .../registry_update_api_document_params.rbs | 0 ...try_update_api_document_version_params.rbs | 14 +- ...y_update_api_document_version_response.rbs | 16 ++ ...ule_create_ruleset_access_group_params.rbs | 0 .../models/rule_create_ruleset_params.rbs | 0 ...ule_delete_ruleset_access_group_params.rbs | 0 .../models/rule_delete_ruleset_params.rbs | 0 .../models/rule_list_rulesets_params.rbs | 0 .../models/rule_list_rulesets_response.rbs | 0 .../rule_retrieve_ruleset_document_params.rbs | 0 ...ule_retrieve_ruleset_document_response.rbs | 0 .../models/rule_update_ruleset_params.rbs | 0 .../models/scalar_doc_create_guide_params.rbs | 0 .../scalar_doc_create_guide_response.rbs | 0 .../models/scalar_doc_list_guides_params.rbs | 0 .../scalar_doc_list_guides_response.rbs | 10 ++ .../scalar_doc_publish_guide_params.rbs | 0 .../scalar_doc_publish_guide_response.rbs | 0 .../models/schema_create_params.rbs | 0 .../models/schema_delete_params.rbs | 0 .../models/schema_list_params.rbs | 0 .../models/schema_list_response.rbs | 20 ++- .../models/schema_update_params.rbs | 0 .../schemas/access_group_create_params.rbs | 0 .../schemas/access_group_delete_params.rbs | 0 .../models/schemas/version_create_params.rbs | 14 +- .../schemas/version_create_response.rbs | 15 ++ .../models/schemas/version_delete_params.rbs | 0 .../schemas/version_retrieve_params.rbs | 0 .../schemas/version_retrieve_response.rbs | 0 .../models/slug.rbs | 0 .../models/team_list_params.rbs | 0 .../models/team_list_response.rbs | 0 .../models/theme_create_params.rbs | 0 .../models/theme_delete_params.rbs | 0 .../models/theme_list_params.rbs | 0 .../models/theme_list_response.rbs | 0 .../models/theme_replace_document_params.rbs | 0 .../models/theme_retrieve_params.rbs | 0 .../models/theme_retrieve_response.rbs | 0 .../models/theme_update_params.rbs | 0 .../models/timestamp.rbs | 0 .../models/uid.rbs | 0 .../models/version.rbs | 0 .../request_options.rbs | 0 .../resources/authentication.rbs | 0 .../resources/login_portals.rbs | 0 .../resources/namespaces.rbs | 0 .../resources/registry.rbs | 2 - .../resources/rules.rbs | 0 .../resources/scalar_docs.rbs | 0 .../resources/schemas.rbs | 0 .../resources/schemas/access_group.rbs | 0 .../resources/schemas/version.rbs | 3 +- .../resources/teams.rbs | 0 .../resources/themes.rbs | 0 .../version.rbs | 0 tests/smoke-test.rb | 54 +++--- 364 files changed, 719 insertions(+), 536 deletions(-) delete mode 100644 lib/scalar-api-ruby.rb create mode 100644 lib/scalar_api_ruby.rb rename lib/{scalar-api-ruby => scalar_api_ruby}/client.rb (81%) rename lib/{scalar-api-ruby => scalar_api_ruby}/errors.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/file_part.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/transport/base_client.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/transport/pooled_net_requester.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/array_of.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/base_model.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/base_page.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/boolean.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/converter.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/enum.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/file_input.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/hash_of.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/request_parameters.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/union.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/type/unknown.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/internal/util.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/400.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/401.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/403.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/404.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/422.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/500.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/access_group.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/authentication_exchange_personal_token_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/authentication_exchange_personal_token_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/authentication_list_current_user_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/authentication_list_current_user_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_create_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_delete_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_email.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_list_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_list_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_page.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_retrieve_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_retrieve_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_update_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/managed_doc_version.rb (91%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/namespace.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/namespace_list_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/namespace_list_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/nanoid.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_access_group_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_response.rb (78%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_version_params.rb (80%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_delete_api_document_access_group_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_delete_api_document_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_delete_api_document_version_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_all_api_documents_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_all_api_documents_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_api_document_version_metadata_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_api_documents_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_api_documents_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_retrieve_api_document_version_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_retrieve_api_document_version_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_update_api_document_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_update_api_document_version_params.rb (79%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/registry_update_api_document_version_response.rb (70%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/rule_create_ruleset_access_group_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/rule_create_ruleset_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/rule_delete_ruleset_access_group_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/rule_delete_ruleset_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/rule_list_rulesets_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/rule_list_rulesets_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/rule_retrieve_ruleset_document_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/rule_retrieve_ruleset_document_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/rule_update_ruleset_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_create_guide_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_create_guide_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_list_guides_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_list_guides_response.rb (90%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_publish_guide_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_publish_guide_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schema_create_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schema_delete_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schema_list_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schema_list_response.rb (86%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schema_update_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schemas/access_group_create_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schemas/access_group_delete_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_create_params.rb (83%) create mode 100644 lib/scalar_api_ruby/models/schemas/version_create_response.rb rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_delete_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_retrieve_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_retrieve_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/slug.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/team_list_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/team_list_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/theme_create_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/theme_delete_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/theme_list_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/theme_list_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/theme_replace_document_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/theme_retrieve_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/theme_retrieve_response.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/theme_update_params.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/timestamp.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/uid.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/models/version.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/request_options.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/authentication.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/login_portals.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/namespaces.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/registry.rb (97%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/rules.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/scalar_docs.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/schemas.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/schemas/access_group.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/schemas/version.rb (93%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/teams.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/resources/themes.rb (100%) rename lib/{scalar-api-ruby => scalar_api_ruby}/version.rb (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/client.rbi (86%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/errors.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/file_part.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/transport/base_client.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/transport/pooled_net_requester.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/array_of.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/base_model.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/base_page.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/boolean.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/converter.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/enum.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/file_input.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/hash_of.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/request_parameters.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/union.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/type/unknown.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/internal/util.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/400.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/401.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/403.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/404.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/422.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/500.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/access_group.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/authentication_exchange_personal_token_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/authentication_exchange_personal_token_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/authentication_list_current_user_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/authentication_list_current_user_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_create_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_delete_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_email.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_list_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_list_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_page.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_retrieve_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_retrieve_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_update_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/managed_doc_version.rbi (95%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/namespace.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/namespace_list_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/namespace_list_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/nanoid.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_access_group_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_response.rbi (80%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_version_params.rbi (83%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_delete_api_document_access_group_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_delete_api_document_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_delete_api_document_version_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_all_api_documents_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_all_api_documents_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_api_document_version_metadata_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_api_documents_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_api_documents_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_retrieve_api_document_version_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_retrieve_api_document_version_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_update_api_document_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_update_api_document_version_params.rbi (73%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/registry_update_api_document_version_response.rbi (58%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/rule_create_ruleset_access_group_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/rule_create_ruleset_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/rule_delete_ruleset_access_group_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/rule_delete_ruleset_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/rule_list_rulesets_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/rule_list_rulesets_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/rule_retrieve_ruleset_document_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/rule_retrieve_ruleset_document_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/rule_update_ruleset_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_create_guide_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_create_guide_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_list_guides_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_list_guides_response.rbi (95%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_publish_guide_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_publish_guide_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schema_create_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schema_delete_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schema_list_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schema_list_response.rbi (80%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schema_update_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schemas/access_group_create_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schemas/access_group_delete_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_create_params.rbi (85%) create mode 100644 rbi/scalar_api_ruby/models/schemas/version_create_response.rbi rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_delete_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_retrieve_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_retrieve_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/slug.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/team_list_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/team_list_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/theme_create_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/theme_delete_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/theme_list_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/theme_list_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/theme_replace_document_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/theme_retrieve_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/theme_retrieve_response.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/theme_update_params.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/timestamp.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/uid.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/models/version.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/request_options.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/authentication.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/login_portals.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/namespaces.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/registry.rbi (96%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/rules.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/scalar_docs.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/schemas.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/schemas/access_group.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/schemas/version.rbi (91%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/teams.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/resources/themes.rbi (100%) rename rbi/{scalar-api-ruby => scalar_api_ruby}/version.rbi (100%) rename scalar-api-ruby.gemspec => scalar_api_ruby.gemspec (91%) delete mode 100644 sig/scalar-api-ruby/models/registry_update_api_document_version_response.rbs rename sig/{scalar-api-ruby => scalar_api_ruby}/client.rbs (91%) rename sig/{scalar-api-ruby => scalar_api_ruby}/errors.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/file_part.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/transport/base_client.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/transport/pooled_net_requester.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/array_of.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/base_model.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/base_page.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/boolean.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/converter.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/enum.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/file_input.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/hash_of.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/request_parameters.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/union.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/type/unknown.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/internal/util.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/400.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/401.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/403.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/404.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/422.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/500.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/access_group.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/authentication_exchange_personal_token_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/authentication_exchange_personal_token_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/authentication_list_current_user_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/authentication_list_current_user_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_create_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_delete_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_email.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_list_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_list_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_page.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_retrieve_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_retrieve_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/login_portal_update_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/managed_doc_version.rbs (91%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/namespace.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/namespace_list_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/namespace_list_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/nanoid.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_access_group_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_response.rbs (86%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_create_api_document_version_params.rbs (81%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_delete_api_document_access_group_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_delete_api_document_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_delete_api_document_version_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_all_api_documents_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_all_api_documents_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_api_document_version_metadata_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_api_documents_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_list_api_documents_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_retrieve_api_document_version_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_retrieve_api_document_version_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_update_api_document_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/registry_update_api_document_version_params.rbs (71%) create mode 100644 sig/scalar_api_ruby/models/registry_update_api_document_version_response.rbs rename sig/{scalar-api-ruby => scalar_api_ruby}/models/rule_create_ruleset_access_group_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/rule_create_ruleset_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/rule_delete_ruleset_access_group_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/rule_delete_ruleset_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/rule_list_rulesets_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/rule_list_rulesets_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/rule_retrieve_ruleset_document_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/rule_retrieve_ruleset_document_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/rule_update_ruleset_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_create_guide_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_create_guide_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_list_guides_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_list_guides_response.rbs (94%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_publish_guide_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/scalar_doc_publish_guide_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schema_create_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schema_delete_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schema_list_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schema_list_response.rbs (82%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schema_update_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schemas/access_group_create_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schemas/access_group_delete_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_create_params.rbs (77%) create mode 100644 sig/scalar_api_ruby/models/schemas/version_create_response.rbs rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_delete_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_retrieve_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/schemas/version_retrieve_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/slug.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/team_list_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/team_list_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/theme_create_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/theme_delete_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/theme_list_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/theme_list_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/theme_replace_document_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/theme_retrieve_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/theme_retrieve_response.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/theme_update_params.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/timestamp.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/uid.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/models/version.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/request_options.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/authentication.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/login_portals.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/namespaces.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/registry.rbs (97%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/rules.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/scalar_docs.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/schemas.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/schemas/access_group.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/schemas/version.rbs (88%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/teams.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/resources/themes.rbs (100%) rename sig/{scalar-api-ruby => scalar_api_ruby}/version.rbs (100%) diff --git a/.claude/skills/scalar-ruby-sdk/SKILL.md b/.claude/skills/scalar-ruby-sdk/SKILL.md index e3e554b..e0a42bf 100644 --- a/.claude/skills/scalar-ruby-sdk/SKILL.md +++ b/.claude/skills/scalar-ruby-sdk/SKILL.md @@ -1,30 +1,30 @@ --- name: scalar-ruby-sdk -description: "Ruby SDK for Scalar API. Use when writing Ruby code that calls Scalar API with the scalar-api-ruby package: installing it, constructing and authenticating the client, and calling API operations." +description: "Ruby SDK for Scalar API. Use when writing Ruby code that calls Scalar API with the scalar_api_ruby package: installing it, constructing and authenticating the client, and calling API operations." --- # Scalar Ruby SDK -Generated Ruby client for Scalar API, published as `scalar-api-ruby`. Use the generated client instead of hand-writing HTTP requests. +Generated Ruby client for Scalar API, published as `scalar_api_ruby`. Use the generated client instead of hand-writing HTTP requests. ## Install Add the gem to your application's `Gemfile`: ```ruby -gem "scalar-api-ruby", "~> 0.1.0" # x-release-please-version +gem "scalar_api_ruby", "~> 0.1.0" # x-release-please-version ``` Or install it directly: ```sh -gem install scalar-api-ruby +gem install scalar_api_ruby ``` ## Client setup and authentication ```ruby -require "scalar-api-ruby" +require "scalar_api_ruby" client = Scalar::Client.new( bearer_auth: ENV["BEARER_AUTH"], # defaults to the BEARER_AUTH env var @@ -34,11 +34,12 @@ client = Scalar::Client.new( Provide credentials using the options below. Environment variables are read automatically when the target runtime supports them: - `bearer_auth` (env: `BEARER_AUTH`) — Credential for the BearerAuth authentication scheme. +- `o_auth2` (env: `SCALAR_O_AUTH2`) — Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. ## Calling operations ```ruby -require "scalar-api-ruby" +require "scalar_api_ruby" client = Scalar::Client.new( bearer_auth: ENV["BEARER_AUTH"], # defaults to the BEARER_AUTH env var diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 50ddcd5..c51160e 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml @@ -43,7 +43,7 @@ jobs: # credential (so their CI runs without manual approval); this workflow only # cuts the tag + GitHub Release once a release PR is merged. skip-github-pull-request: true - - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 if: ${{ steps.release.outputs.release_created == 'true' }} with: fetch-depth: 0 @@ -87,7 +87,7 @@ jobs: # (never a reusable-workflow call). The release-please job cut the tag earlier in this # run; checking it out publishes exactly the released commit, not the branch head that # triggered the workflow. - - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 with: ref: ${{ needs.release-please.outputs.tag_name }} - uses: ruby/setup-ruby@9eb537ca036ebaed86729dcb9309076e4c5c3b74 # v1.314.0 @@ -104,10 +104,10 @@ jobs: uses: rubygems/configure-rubygems-credentials@dc5a8d8553e6ee01fc26761a49e99e733d17954a # v2.1.0 - name: Publish to RubyGems run: | - gem build *.gemspec --output scalar-api-ruby.gem + gem build *.gemspec --output scalar_api_ruby.gem GEM_VERSION="$(ruby -e 'puts Gem::Specification.load(Dir.glob("*.gemspec").first).version')" - if curl -sf -A "scalar-sdk-release" "https://rubygems.org/api/v1/versions/scalar-api-ruby.json" | grep -q "\"number\":\"${GEM_VERSION}\""; then - echo "scalar-api-ruby ${GEM_VERSION} already on RubyGems, skipping" + if curl -sf -A "scalar-sdk-release" "https://rubygems.org/api/v1/versions/scalar_api_ruby.json" | grep -q "\"number\":\"${GEM_VERSION}\""; then + echo "scalar_api_ruby ${GEM_VERSION} already on RubyGems, skipping" else - gem push scalar-api-ruby.gem + gem push scalar_api_ruby.gem fi diff --git a/.github/workflows/release-title-edit.yml b/.github/workflows/release-title-edit.yml index d1827b1..c836f65 100644 --- a/.github/workflows/release-title-edit.yml +++ b/.github/workflows/release-title-edit.yml @@ -35,7 +35,7 @@ jobs: && startsWith(github.event.pull_request.title, 'release: ') }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 with: # The version committed on the PR head is what merging would actually release. ref: ${{ github.event.pull_request.head.sha }} @@ -108,7 +108,7 @@ jobs: permissions: contents: write steps: - - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 with: # The PR head, so the version the pull request currently carries can be read before # deciding whether anything needs to change. diff --git a/.github/workflows/sdk-ci.yml b/.github/workflows/sdk-ci.yml index 26dd7f1..3a7d241 100644 --- a/.github/workflows/sdk-ci.yml +++ b/.github/workflows/sdk-ci.yml @@ -14,7 +14,7 @@ jobs: verify: runs-on: ubuntu-latest steps: - - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - uses: ruby/setup-ruby@9eb537ca036ebaed86729dcb9309076e4c5c3b74 # v1.314.0 with: ruby-version: "3.2" diff --git a/.github/workflows/sdk-release.yml b/.github/workflows/sdk-release.yml index 25d1609..2f07c53 100644 --- a/.github/workflows/sdk-release.yml +++ b/.github/workflows/sdk-release.yml @@ -22,7 +22,7 @@ jobs: env: VERSIONING_POLICY: manual steps: - - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - uses: ruby/setup-ruby@9eb537ca036ebaed86729dcb9309076e4c5c3b74 # v1.314.0 with: ruby-version: "3.2" @@ -37,10 +37,10 @@ jobs: uses: rubygems/configure-rubygems-credentials@dc5a8d8553e6ee01fc26761a49e99e733d17954a # v2.1.0 - name: Publish to RubyGems run: | - gem build *.gemspec --output scalar-api-ruby.gem + gem build *.gemspec --output scalar_api_ruby.gem GEM_VERSION="$(ruby -e 'puts Gem::Specification.load(Dir.glob("*.gemspec").first).version')" - if curl -sf -A "scalar-sdk-release" "https://rubygems.org/api/v1/versions/scalar-api-ruby.json" | grep -q "\"number\":\"${GEM_VERSION}\""; then - echo "scalar-api-ruby ${GEM_VERSION} already on RubyGems, skipping" + if curl -sf -A "scalar-sdk-release" "https://rubygems.org/api/v1/versions/scalar_api_ruby.json" | grep -q "\"number\":\"${GEM_VERSION}\""; then + echo "scalar_api_ruby ${GEM_VERSION} already on RubyGems, skipping" else - gem push scalar-api-ruby.gem + gem push scalar_api_ruby.gem fi diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9873731..1480a20 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ Files under `examples/` are never modified by the generator. #!/usr/bin/env ruby # frozen_string_literal: true -require_relative "../lib/scalar-api-ruby" +require_relative "../lib/scalar_api_ruby" # ... ``` @@ -40,13 +40,13 @@ $ ruby ./examples/.rb To install from git in your `Gemfile`: ```ruby -gem "scalar-api-ruby", git: "" +gem "scalar_api_ruby", git: "" ``` Or reference a local checkout: ```ruby -gem "scalar-api-ruby", path: "/path/to/scalar-api-ruby" +gem "scalar_api_ruby", path: "/path/to/scalar_api_ruby" ``` ## Linting, formatting, and typechecking diff --git a/Gemfile.lock b/Gemfile.lock index 00247bf..f062ed1 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - scalar-api-ruby (0.1.0) + scalar_api_ruby (0.1.0) cgi connection_pool @@ -149,7 +149,7 @@ DEPENDENCIES rbs redcarpet rubocop - scalar-api-ruby! + scalar_api_ruby! sorbet steep syntax_tree diff --git a/README.md b/README.md index 26bea36..5197f79 100644 --- a/README.md +++ b/README.md @@ -26,13 +26,13 @@ The full API of this library can be found in [api.md](./api.md). Add the gem to your application's `Gemfile`: ```ruby -gem "scalar-api-ruby", "~> 0.1.0" # x-release-please-version +gem "scalar_api_ruby", "~> 0.1.0" # x-release-please-version ``` Or install it directly: ```sh -gem install scalar-api-ruby +gem install scalar_api_ruby ```
@@ -40,7 +40,7 @@ gem install scalar-api-ruby ## Usage ```ruby -require "scalar-api-ruby" +require "scalar_api_ruby" client = Scalar::Client.new( bearer_auth: ENV["BEARER_AUTH"], # defaults to the BEARER_AUTH env var @@ -64,10 +64,12 @@ Pass credentials to the generated client constructor. Environment variables are | Option | Type | Default | Description | | --- | --- | --- | --- | | `bearer_auth` | `String \| nil` | - | Credential for the BearerAuth authentication scheme. Defaults to BEARER_AUTH. | +| `o_auth2` | `String \| nil` | - | Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. Defaults to SCALAR_O_AUTH2. | Declared schemes: - `BearerAuth` bearer token +- `OAuth2` OAuth2/OpenID Connect
@@ -95,7 +97,7 @@ Documented error statuses: `400`, `401`, `403`, `404`, `422`, `500`. Configure the generated client by setting any of these options when you create it. ```ruby -require "scalar-api-ruby" +require "scalar_api_ruby" client = Scalar::Client.new( timeout: 60.0, @@ -106,6 +108,7 @@ client = Scalar::Client.new( | Option | Type | Default | Description | | --- | --- | --- | --- | | `bearer_auth` | `String \| nil` | `ENV["BEARER_AUTH"]` | Credential for the BearerAuth authentication scheme. | +| `o_auth2` | `String \| nil` | `ENV["SCALAR_O_AUTH2"]` | Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. | | `base_url` | `String \| nil` | `ENV["SCALAR_BASE_URL"]` | Override the default API base URL. | | `max_retries` | `Integer` | `2` | Max number of retries to attempt after a failed retryable request. | | `timeout` | `Float` | `60.0` | Seconds to wait for a response before timing out. | diff --git a/SKILL.md b/SKILL.md index e0c2beb..1170acb 100644 --- a/SKILL.md +++ b/SKILL.md @@ -1,30 +1,30 @@ --- name: scalar-ruby-sdk -description: "Ruby SDK for Scalar API. Use when writing Ruby code that calls Scalar API with the scalar-api-ruby package: installing it, constructing and authenticating the client, and calling API operations." +description: "Ruby SDK for Scalar API. Use when writing Ruby code that calls Scalar API with the scalar_api_ruby package: installing it, constructing and authenticating the client, and calling API operations." --- # Scalar Ruby SDK -Generated Ruby client for Scalar API, published as `scalar-api-ruby`. Use the generated client instead of hand-writing HTTP requests. +Generated Ruby client for Scalar API, published as `scalar_api_ruby`. Use the generated client instead of hand-writing HTTP requests. ## Install Add the gem to your application's `Gemfile`: ```ruby -gem "scalar-api-ruby", "~> 0.1.0" # x-release-please-version +gem "scalar_api_ruby", "~> 0.1.0" # x-release-please-version ``` Or install it directly: ```sh -gem install scalar-api-ruby +gem install scalar_api_ruby ``` ## Client setup and authentication ```ruby -require "scalar-api-ruby" +require "scalar_api_ruby" client = Scalar::Client.new( bearer_auth: ENV["BEARER_AUTH"], # defaults to the BEARER_AUTH env var @@ -34,11 +34,12 @@ client = Scalar::Client.new( Provide credentials using the options below. Environment variables are read automatically when the target runtime supports them: - `bearer_auth` (env: `BEARER_AUTH`) — Credential for the BearerAuth authentication scheme. +- `o_auth2` (env: `SCALAR_O_AUTH2`) — Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. ## Calling operations ```ruby -require "scalar-api-ruby" +require "scalar_api_ruby" client = Scalar::Client.new( bearer_auth: ENV["BEARER_AUTH"], # defaults to the BEARER_AUTH env var diff --git a/VERSIONING.md b/VERSIONING.md index 662f2b6..f9cf7dd 100644 --- a/VERSIONING.md +++ b/VERSIONING.md @@ -73,6 +73,10 @@ different fixes: platform and the `github-actions` bot to push (or be left unprotected); the default branch only ever advances by merging release PRs, and `scalar-next` receives each released state back from the release workflow. +- **`scalar-next` must not enable "Require linear history."** The Scalar platform merges each + regeneration into it, and merges a resolved conflict back the same way; the release sync + adds another merge whenever a release PR is squash- or rebase-merged. That setting rejects + all of them. - No Actions settings changes are required: the generated workflows declare their own permissions and never create pull requests. - If this package publishes through OIDC trusted publishing (for example PyPI or npm), @@ -84,3 +88,13 @@ different fixes: manual re-publishes at an existing tag; register it as an additional trusted publisher only if you use it. If the publish job is configured with a deployment environment, include that environment in the registration too. + +### Recommended, not required + +Releases work without this; it closes a window where one can go out at the wrong version. + +- **If this repository uses auto-merge, make the `Release PR version` check a required status + check.** Auto-merge merges as soon as the checks that are *required* go green, with no + human present — so a check that is not required but still red at that moment stops + nothing, which is exactly the window between retitling a release PR and the platform + re-rendering it. diff --git a/api.md b/api.md index 665d0ae..f3e12a1 100644 --- a/api.md +++ b/api.md @@ -65,7 +65,7 @@ Complete reference of every operation, grouped by resource. See [the README](./R ## Setup ```ruby -require "scalar-api-ruby" +require "scalar_api_ruby" client = Scalar::Client.new( bearer_auth: ENV["BEARER_AUTH"], # defaults to the BEARER_AUTH env var @@ -82,8 +82,8 @@ List all API documents across every namespace the caller can access. | Direction | Type | | --- | --- | -| Request | [`RegistryListAllAPIDocumentsParams`](././lib/scalar-api-ruby/models/registry_list_all_api_documents_params.rb) | -| Response | [`RegistryListAllAPIDocumentsResponseItem`](././lib/scalar-api-ruby/models/registry_list_all_api_documents_response.rb) | +| Request | [`RegistryListAllAPIDocumentsParams`](././lib/scalar_api_ruby/models/registry_list_all_api_documents_params.rb) | +| Response | [`RegistryListAllAPIDocumentsResponseItem`](././lib/scalar_api_ruby/models/registry_list_all_api_documents_response.rb) | ```ruby response = client.registry.list_all_api_documents @@ -97,8 +97,8 @@ List API documents in a namespace. | Direction | Type | | --- | --- | -| Request | [`RegistryListAPIDocumentsParams`](././lib/scalar-api-ruby/models/registry_list_api_documents_params.rb) | -| Response | [`RegistryListAPIDocumentsResponseItem`](././lib/scalar-api-ruby/models/registry_list_api_documents_response.rb) | +| Request | [`RegistryListAPIDocumentsParams`](././lib/scalar_api_ruby/models/registry_list_api_documents_params.rb) | +| Response | [`RegistryListAPIDocumentsResponseItem`](././lib/scalar_api_ruby/models/registry_list_api_documents_response.rb) | ```ruby response = client.registry.list_api_documents("namespace") @@ -112,8 +112,8 @@ Create an API document. | Direction | Type | | --- | --- | -| Request | [`RegistryCreateAPIDocumentParams`](././lib/scalar-api-ruby/models/registry_create_api_document_params.rb) | -| Response | [`RegistryCreateAPIDocumentResponse`](././lib/scalar-api-ruby/models/registry_create_api_document_response.rb) | +| Request | [`RegistryCreateAPIDocumentParams`](././lib/scalar_api_ruby/models/registry_create_api_document_params.rb) | +| Response | [`RegistryCreateAPIDocumentResponse`](././lib/scalar_api_ruby/models/registry_create_api_document_response.rb) | ```ruby response = client.registry.create_api_document("namespace", { document: "", slug: "", title: "", version: "x", description: "", is_private: false, ruleset: "" }) @@ -127,7 +127,7 @@ Update metadata for an API document. | Direction | Type | | --- | --- | -| Request | [`RegistryUpdateAPIDocumentParams`](././lib/scalar-api-ruby/models/registry_update_api_document_params.rb) | +| Request | [`RegistryUpdateAPIDocumentParams`](././lib/scalar_api_ruby/models/registry_update_api_document_params.rb) | ```ruby response = client.registry.update_api_document("slug", { namespace: "namespace", description: "", is_private: false, ruleset: "", title: "" }) @@ -141,7 +141,7 @@ Delete an API document and all versions. | Direction | Type | | --- | --- | -| Request | [`RegistryDeleteAPIDocumentParams`](././lib/scalar-api-ruby/models/registry_delete_api_document_params.rb) | +| Request | [`RegistryDeleteAPIDocumentParams`](././lib/scalar_api_ruby/models/registry_delete_api_document_params.rb) | ```ruby response = client.registry.delete_api_document("slug", { namespace: "namespace" }) @@ -155,7 +155,7 @@ Get a specific API document version. | Direction | Type | | --- | --- | -| Request | [`RegistryRetrieveAPIDocumentVersionParams`](././lib/scalar-api-ruby/models/registry_retrieve_api_document_version_params.rb) | +| Request | [`RegistryRetrieveAPIDocumentVersionParams`](././lib/scalar_api_ruby/models/registry_retrieve_api_document_version_params.rb) | ```ruby response = client.registry.retrieve_api_document_version("semver", { namespace: "namespace", slug: "slug" }) @@ -169,11 +169,11 @@ Update the registry file content for an API document version. | Direction | Type | | --- | --- | -| Request | [`RegistryUpdateAPIDocumentVersionParams`](././lib/scalar-api-ruby/models/registry_update_api_document_version_params.rb) | -| Response | [`RegistryUpdateAPIDocumentVersionResponse`](././lib/scalar-api-ruby/models/registry_update_api_document_version_response.rb) | +| Request | [`RegistryUpdateAPIDocumentVersionParams`](././lib/scalar_api_ruby/models/registry_update_api_document_version_params.rb) | +| Response | [`RegistryUpdateAPIDocumentVersionResponse`](././lib/scalar_api_ruby/models/registry_update_api_document_version_response.rb) | ```ruby -response = client.registry.update_api_document_version("semver", { namespace: "namespace", slug: "slug", document: "", last_known_version_sha: "" }) +response = client.registry.update_api_document_version("semver", { namespace: "namespace", slug: "slug", document: "" }) puts response.inspect ``` @@ -184,7 +184,7 @@ Delete a specific API document version. | Direction | Type | | --- | --- | -| Request | [`RegistryDeleteAPIDocumentVersionParams`](././lib/scalar-api-ruby/models/registry_delete_api_document_version_params.rb) | +| Request | [`RegistryDeleteAPIDocumentVersionParams`](././lib/scalar_api_ruby/models/registry_delete_api_document_version_params.rb) | ```ruby response = client.registry.delete_api_document_version("semver", { namespace: "namespace", slug: "slug" }) @@ -198,8 +198,8 @@ Get metadata (uid, content shas, version sha, tags) for a specific API document | Direction | Type | | --- | --- | -| Request | [`RegistryListAPIDocumentVersionMetadataParams`](././lib/scalar-api-ruby/models/registry_list_api_document_version_metadata_params.rb) | -| Response | [`ManagedDocVersion`](././lib/scalar-api-ruby/models/managed_doc_version.rb) | +| Request | [`RegistryListAPIDocumentVersionMetadataParams`](././lib/scalar_api_ruby/models/registry_list_api_document_version_metadata_params.rb) | +| Response | [`ManagedDocVersion`](././lib/scalar_api_ruby/models/managed_doc_version.rb) | ```ruby response = client.registry.list_api_document_version_metadata("semver", { namespace: "namespace", slug: "slug" }) @@ -213,11 +213,11 @@ Create a new API document version. | Direction | Type | | --- | --- | -| Request | [`RegistryCreateAPIDocumentVersionParams`](././lib/scalar-api-ruby/models/registry_create_api_document_version_params.rb) | -| Response | [`ManagedDocVersion`](././lib/scalar-api-ruby/models/managed_doc_version.rb) | +| Request | [`RegistryCreateAPIDocumentVersionParams`](././lib/scalar_api_ruby/models/registry_create_api_document_version_params.rb) | +| Response | [`ManagedDocVersion`](././lib/scalar_api_ruby/models/managed_doc_version.rb) | ```ruby -response = client.registry.create_api_document_version("slug", { namespace: "namespace", document: "", version: "x", force: false, last_known_version_sha: "" }) +response = client.registry.create_api_document_version("slug", { namespace: "namespace", document: "", version: "x", force: false }) puts response.inspect ``` @@ -228,10 +228,10 @@ Add an access group to an API document. | Direction | Type | | --- | --- | -| Request | [`RegistryCreateAPIDocumentAccessGroupParams`](././lib/scalar-api-ruby/models/registry_create_api_document_access_group_params.rb) | +| Request | [`RegistryCreateAPIDocumentAccessGroupParams`](././lib/scalar_api_ruby/models/registry_create_api_document_access_group_params.rb) | ```ruby -response = client.registry.create_api_document_access_group("slug", { access_group_slug: "xxx", namespace: "namespace" }) +response = client.registry.create_api_document_access_group("slug", { access_group_slug: "x", namespace: "namespace" }) puts response.inspect ``` @@ -242,10 +242,10 @@ Remove an access group from an API document. | Direction | Type | | --- | --- | -| Request | [`RegistryDeleteAPIDocumentAccessGroupParams`](././lib/scalar-api-ruby/models/registry_delete_api_document_access_group_params.rb) | +| Request | [`RegistryDeleteAPIDocumentAccessGroupParams`](././lib/scalar_api_ruby/models/registry_delete_api_document_access_group_params.rb) | ```ruby -response = client.registry.delete_api_document_access_group("slug", { access_group_slug: "xxx", namespace: "namespace" }) +response = client.registry.delete_api_document_access_group("slug", { access_group_slug: "x", namespace: "namespace" }) puts response.inspect ``` @@ -260,8 +260,8 @@ List schemas in a namespace. | Direction | Type | | --- | --- | -| Request | [`SchemaListParams`](././lib/scalar-api-ruby/models/schema_list_params.rb) | -| Response | [`SchemaListResponseItem`](././lib/scalar-api-ruby/models/schema_list_response.rb) | +| Request | [`SchemaListParams`](././lib/scalar_api_ruby/models/schema_list_params.rb) | +| Response | [`SchemaListResponseItem`](././lib/scalar_api_ruby/models/schema_list_response.rb) | ```ruby response = client.schemas.list("namespace") @@ -275,8 +275,8 @@ Create a schema in a namespace. | Direction | Type | | --- | --- | -| Request | [`SchemaCreateParams`](././lib/scalar-api-ruby/models/schema_create_params.rb) | -| Response | [`UID`](././lib/scalar-api-ruby/models/uid.rb) | +| Request | [`SchemaCreateParams`](././lib/scalar_api_ruby/models/schema_create_params.rb) | +| Response | [`UID`](././lib/scalar_api_ruby/models/uid.rb) | ```ruby response = client.schemas.create("namespace", { document: "", slug: "", title: "", version: "x", description: "", is_private: false }) @@ -290,7 +290,7 @@ Update schema metadata. | Direction | Type | | --- | --- | -| Request | [`SchemaUpdateParams`](././lib/scalar-api-ruby/models/schema_update_params.rb) | +| Request | [`SchemaUpdateParams`](././lib/scalar_api_ruby/models/schema_update_params.rb) | ```ruby response = client.schemas.update("slug", { namespace: "namespace", description: "", is_private: false, title: "" }) @@ -304,7 +304,7 @@ Delete a schema and all related versions. | Direction | Type | | --- | --- | -| Request | [`SchemaDeleteParams`](././lib/scalar-api-ruby/models/schema_delete_params.rb) | +| Request | [`SchemaDeleteParams`](././lib/scalar_api_ruby/models/schema_delete_params.rb) | ```ruby response = client.schemas.delete("slug", { namespace: "namespace" }) @@ -322,7 +322,7 @@ Get a specific schema version document. | Direction | Type | | --- | --- | -| Request | [`VersionRetrieveParams`](././lib/scalar-api-ruby/models/schemas/version_retrieve_params.rb) | +| Request | [`VersionRetrieveParams`](././lib/scalar_api_ruby/models/schemas/version_retrieve_params.rb) | ```ruby response = client.schemas.version.retrieve("semver", { namespace: "namespace", slug: "slug" }) @@ -336,7 +336,7 @@ Delete a schema version. | Direction | Type | | --- | --- | -| Request | [`VersionDeleteParams`](././lib/scalar-api-ruby/models/schemas/version_delete_params.rb) | +| Request | [`VersionDeleteParams`](././lib/scalar_api_ruby/models/schemas/version_delete_params.rb) | ```ruby response = client.schemas.version.delete("semver", { namespace: "namespace", slug: "slug" }) @@ -350,11 +350,11 @@ Create a schema version. | Direction | Type | | --- | --- | -| Request | [`VersionCreateParams`](././lib/scalar-api-ruby/models/schemas/version_create_params.rb) | -| Response | [`UID`](././lib/scalar-api-ruby/models/uid.rb) | +| Request | [`VersionCreateParams`](././lib/scalar_api_ruby/models/schemas/version_create_params.rb) | +| Response | [`Schemas::VersionCreateResponse`](././lib/scalar_api_ruby/models/schemas/version_create_response.rb) | ```ruby -response = client.schemas.version.create("slug", { namespace: "namespace", document: "", version: "x" }) +response = client.schemas.version.create("slug", { namespace: "namespace", document: "", version: "x", force: false }) puts response.inspect ``` @@ -369,10 +369,10 @@ Add an access group to a schema. | Direction | Type | | --- | --- | -| Request | [`AccessGroupCreateParams`](././lib/scalar-api-ruby/models/schemas/access_group_create_params.rb) | +| Request | [`AccessGroupCreateParams`](././lib/scalar_api_ruby/models/schemas/access_group_create_params.rb) | ```ruby -response = client.schemas.access_group.create("slug", { access_group_slug: "xxx", namespace: "namespace" }) +response = client.schemas.access_group.create("slug", { access_group_slug: "x", namespace: "namespace" }) puts response.inspect ``` @@ -383,10 +383,10 @@ Remove an access group from a schema. | Direction | Type | | --- | --- | -| Request | [`AccessGroupDeleteParams`](././lib/scalar-api-ruby/models/schemas/access_group_delete_params.rb) | +| Request | [`AccessGroupDeleteParams`](././lib/scalar_api_ruby/models/schemas/access_group_delete_params.rb) | ```ruby -response = client.schemas.access_group.delete("slug", { access_group_slug: "xxx", namespace: "namespace" }) +response = client.schemas.access_group.delete("slug", { access_group_slug: "x", namespace: "namespace" }) puts response.inspect ``` @@ -401,8 +401,8 @@ Get a login portal by slug. | Direction | Type | | --- | --- | -| Request | [`LoginPortalRetrieveParams`](././lib/scalar-api-ruby/models/login_portal_retrieve_params.rb) | -| Response | [`LoginPortalRetrieveResponse`](././lib/scalar-api-ruby/models/login_portal_retrieve_response.rb) | +| Request | [`LoginPortalRetrieveParams`](././lib/scalar_api_ruby/models/login_portal_retrieve_params.rb) | +| Response | [`LoginPortalRetrieveResponse`](././lib/scalar_api_ruby/models/login_portal_retrieve_response.rb) | ```ruby response = client.login_portals.retrieve("slug") @@ -416,7 +416,7 @@ Update metadata for a login portal. | Direction | Type | | --- | --- | -| Request | [`LoginPortalUpdateParams`](././lib/scalar-api-ruby/models/login_portal_update_params.rb) | +| Request | [`LoginPortalUpdateParams`](././lib/scalar_api_ruby/models/login_portal_update_params.rb) | ```ruby response = client.login_portals.update("slug", { title: "" }) @@ -430,7 +430,7 @@ Delete a login portal. | Direction | Type | | --- | --- | -| Request | [`LoginPortalDeleteParams`](././lib/scalar-api-ruby/models/login_portal_delete_params.rb) | +| Request | [`LoginPortalDeleteParams`](././lib/scalar_api_ruby/models/login_portal_delete_params.rb) | ```ruby response = client.login_portals.delete("slug") @@ -444,11 +444,11 @@ Create a login portal for the current team. | Direction | Type | | --- | --- | -| Request | [`LoginPortalCreateParams`](././lib/scalar-api-ruby/models/login_portal_create_params.rb) | -| Response | [`UID`](././lib/scalar-api-ruby/models/uid.rb) | +| Request | [`LoginPortalCreateParams`](././lib/scalar_api_ruby/models/login_portal_create_params.rb) | +| Response | [`UID`](././lib/scalar_api_ruby/models/uid.rb) | ```ruby -response = client.login_portals.create({ email: { "logo" => "", "logoSize" => "100", "buttonText" => "Login", "message" => "Click to access private documentation hosted by scalar.com", "title" => "Private Docs", "mainColor" => "\#2a2f45", "mainBackground" => "\#f6f6f6", "cardColor" => "2a2f45", "cardBackground" => "\#fff", "buttonColor" => "\#fff", "buttonBackground" => "\#0f0f0f" }, page: { "title" => "Scalar Private Docs", "description" => "Login to access your documentation", "head" => "", "script" => "", "theme" => "", "companyName" => "", "logo" => "", "logoURL" => "", "favicon" => "", "termsLink" => "", "privacyLink" => "", "formTitle" => "Scalar Private Docs", "formDescription" => "Login to access your documentation", "formImage" => "" }, slug: "", title: "" }) +response = client.login_portals.create({ email: { "logo" => "", "logoSize" => "100", "buttonText" => "Login", "message" => "Click to access private documentation hosted by scalar.com", "title" => "Private Docs", "mainColor" => "\#2a2f45", "mainBackground" => "\#f6f6f6", "cardColor" => "\#2a2f45", "cardBackground" => "\#fff", "buttonColor" => "\#fff", "buttonBackground" => "\#0f0f0f" }, page: { "title" => "Scalar Private Docs", "description" => "Login to access your documentation", "head" => "", "script" => "", "theme" => "", "companyName" => "", "logo" => "", "logoURL" => "", "favicon" => "", "termsLink" => "", "privacyLink" => "", "formTitle" => "Scalar Private Docs", "formDescription" => "Login to access your documentation", "formImage" => "" }, slug: "", title: "" }) puts response.inspect ``` @@ -459,8 +459,8 @@ List all login portals for the current team. | Direction | Type | | --- | --- | -| Request | [`LoginPortalListParams`](././lib/scalar-api-ruby/models/login_portal_list_params.rb) | -| Response | [`LoginPortalListResponseItem`](././lib/scalar-api-ruby/models/login_portal_list_response.rb) | +| Request | [`LoginPortalListParams`](././lib/scalar_api_ruby/models/login_portal_list_params.rb) | +| Response | [`LoginPortalListResponseItem`](././lib/scalar_api_ruby/models/login_portal_list_response.rb) | ```ruby response = client.login_portals.list @@ -478,8 +478,8 @@ List all rulesets in a namespace. | Direction | Type | | --- | --- | -| Request | [`RuleListRulesetsParams`](././lib/scalar-api-ruby/models/rule_list_rulesets_params.rb) | -| Response | [`RuleListRulesetsResponseItem`](././lib/scalar-api-ruby/models/rule_list_rulesets_response.rb) | +| Request | [`RuleListRulesetsParams`](././lib/scalar_api_ruby/models/rule_list_rulesets_params.rb) | +| Response | [`RuleListRulesetsResponseItem`](././lib/scalar_api_ruby/models/rule_list_rulesets_response.rb) | ```ruby response = client.rules.list_rulesets("namespace") @@ -493,8 +493,8 @@ Create a rule in a namespace. | Direction | Type | | --- | --- | -| Request | [`RuleCreateRulesetParams`](././lib/scalar-api-ruby/models/rule_create_ruleset_params.rb) | -| Response | [`UID`](././lib/scalar-api-ruby/models/uid.rb) | +| Request | [`RuleCreateRulesetParams`](././lib/scalar_api_ruby/models/rule_create_ruleset_params.rb) | +| Response | [`UID`](././lib/scalar_api_ruby/models/uid.rb) | ```ruby response = client.rules.create_ruleset("namespace", { document: "", slug: "", title: "", description: "", is_private: false }) @@ -508,7 +508,7 @@ Update rule metadata by slug. | Direction | Type | | --- | --- | -| Request | [`RuleUpdateRulesetParams`](././lib/scalar-api-ruby/models/rule_update_ruleset_params.rb) | +| Request | [`RuleUpdateRulesetParams`](././lib/scalar_api_ruby/models/rule_update_ruleset_params.rb) | ```ruby response = client.rules.update_ruleset("path_slug", { path_namespace: "path_namespace", description: "", is_private: false, body_namespace: "", body_slug: "", title: "" }) @@ -522,7 +522,7 @@ Delete a rule by slug. | Direction | Type | | --- | --- | -| Request | [`RuleDeleteRulesetParams`](././lib/scalar-api-ruby/models/rule_delete_ruleset_params.rb) | +| Request | [`RuleDeleteRulesetParams`](././lib/scalar_api_ruby/models/rule_delete_ruleset_params.rb) | ```ruby response = client.rules.delete_ruleset("slug", { namespace: "namespace" }) @@ -536,7 +536,7 @@ Get a rule document by slug. | Direction | Type | | --- | --- | -| Request | [`RuleRetrieveRulesetDocumentParams`](././lib/scalar-api-ruby/models/rule_retrieve_ruleset_document_params.rb) | +| Request | [`RuleRetrieveRulesetDocumentParams`](././lib/scalar_api_ruby/models/rule_retrieve_ruleset_document_params.rb) | ```ruby response = client.rules.retrieve_ruleset_document("slug", { namespace: "namespace" }) @@ -550,10 +550,10 @@ Grant an access group to a rule. | Direction | Type | | --- | --- | -| Request | [`RuleCreateRulesetAccessGroupParams`](././lib/scalar-api-ruby/models/rule_create_ruleset_access_group_params.rb) | +| Request | [`RuleCreateRulesetAccessGroupParams`](././lib/scalar_api_ruby/models/rule_create_ruleset_access_group_params.rb) | ```ruby -response = client.rules.create_ruleset_access_group("slug", { access_group_slug: "xxx", namespace: "namespace" }) +response = client.rules.create_ruleset_access_group("slug", { access_group_slug: "x", namespace: "namespace" }) puts response.inspect ``` @@ -564,10 +564,10 @@ Remove an access group from a rule. | Direction | Type | | --- | --- | -| Request | [`RuleDeleteRulesetAccessGroupParams`](././lib/scalar-api-ruby/models/rule_delete_ruleset_access_group_params.rb) | +| Request | [`RuleDeleteRulesetAccessGroupParams`](././lib/scalar_api_ruby/models/rule_delete_ruleset_access_group_params.rb) | ```ruby -response = client.rules.delete_ruleset_access_group("slug", { access_group_slug: "xxx", namespace: "namespace" }) +response = client.rules.delete_ruleset_access_group("slug", { access_group_slug: "x", namespace: "namespace" }) puts response.inspect ``` @@ -582,8 +582,8 @@ List all team themes. | Direction | Type | | --- | --- | -| Request | [`ThemeListParams`](././lib/scalar-api-ruby/models/theme_list_params.rb) | -| Response | [`ThemeListResponseItem`](././lib/scalar-api-ruby/models/theme_list_response.rb) | +| Request | [`ThemeListParams`](././lib/scalar_api_ruby/models/theme_list_params.rb) | +| Response | [`ThemeListResponseItem`](././lib/scalar_api_ruby/models/theme_list_response.rb) | ```ruby response = client.themes.list @@ -597,8 +597,8 @@ Create a team theme. | Direction | Type | | --- | --- | -| Request | [`ThemeCreateParams`](././lib/scalar-api-ruby/models/theme_create_params.rb) | -| Response | [`UID`](././lib/scalar-api-ruby/models/uid.rb) | +| Request | [`ThemeCreateParams`](././lib/scalar_api_ruby/models/theme_create_params.rb) | +| Response | [`UID`](././lib/scalar_api_ruby/models/uid.rb) | ```ruby response = client.themes.create({ document: "", name: "", slug: "", description: "" }) @@ -612,7 +612,7 @@ Update theme metadata. | Direction | Type | | --- | --- | -| Request | [`ThemeUpdateParams`](././lib/scalar-api-ruby/models/theme_update_params.rb) | +| Request | [`ThemeUpdateParams`](././lib/scalar_api_ruby/models/theme_update_params.rb) | ```ruby response = client.themes.update("slug", { description: "", name: "" }) @@ -626,7 +626,7 @@ Replace the theme document. | Direction | Type | | --- | --- | -| Request | [`ThemeReplaceDocumentParams`](././lib/scalar-api-ruby/models/theme_replace_document_params.rb) | +| Request | [`ThemeReplaceDocumentParams`](././lib/scalar_api_ruby/models/theme_replace_document_params.rb) | ```ruby response = client.themes.replace_document("slug", { document: "" }) @@ -640,7 +640,7 @@ Delete a theme by slug. | Direction | Type | | --- | --- | -| Request | [`ThemeDeleteParams`](././lib/scalar-api-ruby/models/theme_delete_params.rb) | +| Request | [`ThemeDeleteParams`](././lib/scalar_api_ruby/models/theme_delete_params.rb) | ```ruby response = client.themes.delete("slug") @@ -654,7 +654,7 @@ Get the theme document by slug. | Direction | Type | | --- | --- | -| Request | [`ThemeRetrieveParams`](././lib/scalar-api-ruby/models/theme_retrieve_params.rb) | +| Request | [`ThemeRetrieveParams`](././lib/scalar_api_ruby/models/theme_retrieve_params.rb) | ```ruby response = client.themes.retrieve("slug") @@ -672,8 +672,8 @@ List all available teams | Direction | Type | | --- | --- | -| Request | [`TeamListParams`](././lib/scalar-api-ruby/models/team_list_params.rb) | -| Response | [`TeamListResponseItem`](././lib/scalar-api-ruby/models/team_list_response.rb) | +| Request | [`TeamListParams`](././lib/scalar_api_ruby/models/team_list_params.rb) | +| Response | [`TeamListResponseItem`](././lib/scalar_api_ruby/models/team_list_response.rb) | ```ruby response = client.teams.list @@ -691,8 +691,8 @@ List all guide projects. | Direction | Type | | --- | --- | -| Request | [`ScalarDocListGuidesParams`](././lib/scalar-api-ruby/models/scalar_doc_list_guides_params.rb) | -| Response | [`ScalarDocListGuidesResponseItem`](././lib/scalar-api-ruby/models/scalar_doc_list_guides_response.rb) | +| Request | [`ScalarDocListGuidesParams`](././lib/scalar_api_ruby/models/scalar_doc_list_guides_params.rb) | +| Response | [`ScalarDocListGuidesResponseItem`](././lib/scalar_api_ruby/models/scalar_doc_list_guides_response.rb) | ```ruby response = client.scalar_docs.list_guides @@ -706,11 +706,11 @@ Create a guide project. | Direction | Type | | --- | --- | -| Request | [`ScalarDocCreateGuideParams`](././lib/scalar-api-ruby/models/scalar_doc_create_guide_params.rb) | -| Response | [`ScalarDocCreateGuideResponse`](././lib/scalar-api-ruby/models/scalar_doc_create_guide_response.rb) | +| Request | [`ScalarDocCreateGuideParams`](././lib/scalar_api_ruby/models/scalar_doc_create_guide_params.rb) | +| Response | [`ScalarDocCreateGuideResponse`](././lib/scalar_api_ruby/models/scalar_doc_create_guide_response.rb) | ```ruby -response = client.scalar_docs.create_guide({ allowed_domains: [], allowed_users: [], is_private: false, name: "", slug: "xxx" }) +response = client.scalar_docs.create_guide({ allowed_domains: [], allowed_users: [], is_private: false, name: "", slug: "x" }) puts response.inspect ``` @@ -721,8 +721,8 @@ Start a new publish process. | Direction | Type | | --- | --- | -| Request | [`ScalarDocPublishGuideParams`](././lib/scalar-api-ruby/models/scalar_doc_publish_guide_params.rb) | -| Response | [`ScalarDocPublishGuideResponse`](././lib/scalar-api-ruby/models/scalar_doc_publish_guide_response.rb) | +| Request | [`ScalarDocPublishGuideParams`](././lib/scalar_api_ruby/models/scalar_doc_publish_guide_params.rb) | +| Response | [`ScalarDocPublishGuideResponse`](././lib/scalar_api_ruby/models/scalar_doc_publish_guide_response.rb) | ```ruby response = client.scalar_docs.publish_guide("slug") @@ -740,7 +740,7 @@ Get all namespaces for the current team | Direction | Type | | --- | --- | -| Request | [`NamespaceListParams`](././lib/scalar-api-ruby/models/namespace_list_params.rb) | +| Request | [`NamespaceListParams`](././lib/scalar_api_ruby/models/namespace_list_params.rb) | ```ruby response = client.namespaces.list @@ -758,8 +758,8 @@ Exchange an API key for an access token. | Direction | Type | | --- | --- | -| Request | [`AuthenticationExchangePersonalTokenParams`](././lib/scalar-api-ruby/models/authentication_exchange_personal_token_params.rb) | -| Response | [`AuthenticationExchangePersonalTokenResponse`](././lib/scalar-api-ruby/models/authentication_exchange_personal_token_response.rb) | +| Request | [`AuthenticationExchangePersonalTokenParams`](././lib/scalar_api_ruby/models/authentication_exchange_personal_token_params.rb) | +| Response | [`AuthenticationExchangePersonalTokenResponse`](././lib/scalar_api_ruby/models/authentication_exchange_personal_token_response.rb) | ```ruby response = client.authentication.exchange_personal_token({ personal_token: "" }) @@ -773,8 +773,8 @@ Get the authenticated user, including their available teams and theme. | Direction | Type | | --- | --- | -| Request | [`AuthenticationListCurrentUserParams`](././lib/scalar-api-ruby/models/authentication_list_current_user_params.rb) | -| Response | [`AuthenticationListCurrentUserResponse`](././lib/scalar-api-ruby/models/authentication_list_current_user_response.rb) | +| Request | [`AuthenticationListCurrentUserParams`](././lib/scalar_api_ruby/models/authentication_list_current_user_params.rb) | +| Response | [`AuthenticationListCurrentUserResponse`](././lib/scalar_api_ruby/models/authentication_list_current_user_response.rb) | ```ruby response = client.authentication.list_current_user diff --git a/examples/usage.rb b/examples/usage.rb index 36a408d..f6f0569 100644 --- a/examples/usage.rb +++ b/examples/usage.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -require "scalar-api-ruby" +require "scalar_api_ruby" client = Scalar::Client.new # response = client.your_resource.your_method({ request_options: { timeout: 30 } }) diff --git a/lib/scalar-api-ruby.rb b/lib/scalar-api-ruby.rb deleted file mode 100644 index bc2fd96..0000000 --- a/lib/scalar-api-ruby.rb +++ /dev/null @@ -1,146 +0,0 @@ -# frozen_string_literal: true - -# Standard libraries. -# rubocop:disable Lint/RedundantRequireStatement -require "English" -require "cgi" -require "date" -require "erb" -require "etc" -require "json" -require "net/http" -require "openssl" -require "pathname" -require "rbconfig" -require "securerandom" -require "set" -require "stringio" -require "time" -require "uri" -# rubocop:enable Lint/RedundantRequireStatement - -# We already ship the preferred sorbet manifests in the package itself. -# `tapioca` currently does not offer us a way to opt out of unnecessary compilation. -if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) && - ARGV.none?(/dsl/) - return -end - -# Gems. -require "connection_pool" - -# Package files. -require_relative "scalar-api-ruby/version" -require_relative "scalar-api-ruby/internal/util" -require_relative "scalar-api-ruby/internal/type/converter" -require_relative "scalar-api-ruby/internal/type/unknown" -require_relative "scalar-api-ruby/internal/type/boolean" -require_relative "scalar-api-ruby/internal/type/file_input" -require_relative "scalar-api-ruby/internal/type/enum" -require_relative "scalar-api-ruby/internal/type/union" -require_relative "scalar-api-ruby/internal/type/array_of" -require_relative "scalar-api-ruby/internal/type/hash_of" -require_relative "scalar-api-ruby/internal/type/base_model" -require_relative "scalar-api-ruby/internal/type/base_page" -require_relative "scalar-api-ruby/internal/type/request_parameters" -require_relative "scalar-api-ruby/internal" -require_relative "scalar-api-ruby/request_options" -require_relative "scalar-api-ruby/file_part" -require_relative "scalar-api-ruby/errors" -require_relative "scalar-api-ruby/internal/transport/base_client" -require_relative "scalar-api-ruby/internal/transport/pooled_net_requester" -require_relative "scalar-api-ruby/client" -require_relative "scalar-api-ruby/models/access_group" -require_relative "scalar-api-ruby/models/400" -require_relative "scalar-api-ruby/models/401" -require_relative "scalar-api-ruby/models/403" -require_relative "scalar-api-ruby/models/404" -require_relative "scalar-api-ruby/models/422" -require_relative "scalar-api-ruby/models/500" -require_relative "scalar-api-ruby/models/authentication_exchange_personal_token_params" -require_relative "scalar-api-ruby/models/authentication_exchange_personal_token_response" -require_relative "scalar-api-ruby/models/authentication_list_current_user_params" -require_relative "scalar-api-ruby/models/authentication_list_current_user_response" -require_relative "scalar-api-ruby/models/login_portal_create_params" -require_relative "scalar-api-ruby/models/login_portal_delete_params" -require_relative "scalar-api-ruby/models/login_portal_email" -require_relative "scalar-api-ruby/models/login_portal_list_params" -require_relative "scalar-api-ruby/models/login_portal_list_response" -require_relative "scalar-api-ruby/models/login_portal_page" -require_relative "scalar-api-ruby/models/login_portal_retrieve_params" -require_relative "scalar-api-ruby/models/login_portal_retrieve_response" -require_relative "scalar-api-ruby/models/login_portal_update_params" -require_relative "scalar-api-ruby/models/managed_doc_version" -require_relative "scalar-api-ruby/models/namespace" -require_relative "scalar-api-ruby/models/namespace_list_params" -require_relative "scalar-api-ruby/models/namespace_list_response" -require_relative "scalar-api-ruby/models/nanoid" -require_relative "scalar-api-ruby/models/registry_create_api_document_access_group_params" -require_relative "scalar-api-ruby/models/registry_create_api_document_params" -require_relative "scalar-api-ruby/models/registry_create_api_document_response" -require_relative "scalar-api-ruby/models/registry_create_api_document_version_params" -require_relative "scalar-api-ruby/models/registry_delete_api_document_access_group_params" -require_relative "scalar-api-ruby/models/registry_delete_api_document_params" -require_relative "scalar-api-ruby/models/registry_delete_api_document_version_params" -require_relative "scalar-api-ruby/models/registry_list_all_api_documents_params" -require_relative "scalar-api-ruby/models/registry_list_all_api_documents_response" -require_relative "scalar-api-ruby/models/registry_list_api_documents_params" -require_relative "scalar-api-ruby/models/registry_list_api_documents_response" -require_relative "scalar-api-ruby/models/registry_list_api_document_version_metadata_params" -require_relative "scalar-api-ruby/models/registry_retrieve_api_document_version_params" -require_relative "scalar-api-ruby/models/registry_retrieve_api_document_version_response" -require_relative "scalar-api-ruby/models/registry_update_api_document_params" -require_relative "scalar-api-ruby/models/registry_update_api_document_version_params" -require_relative "scalar-api-ruby/models/registry_update_api_document_version_response" -require_relative "scalar-api-ruby/models/rule_create_ruleset_access_group_params" -require_relative "scalar-api-ruby/models/rule_create_ruleset_params" -require_relative "scalar-api-ruby/models/rule_delete_ruleset_access_group_params" -require_relative "scalar-api-ruby/models/rule_delete_ruleset_params" -require_relative "scalar-api-ruby/models/rule_list_rulesets_params" -require_relative "scalar-api-ruby/models/rule_list_rulesets_response" -require_relative "scalar-api-ruby/models/rule_retrieve_ruleset_document_params" -require_relative "scalar-api-ruby/models/rule_retrieve_ruleset_document_response" -require_relative "scalar-api-ruby/models/rule_update_ruleset_params" -require_relative "scalar-api-ruby/models/scalar_doc_create_guide_params" -require_relative "scalar-api-ruby/models/scalar_doc_create_guide_response" -require_relative "scalar-api-ruby/models/scalar_doc_list_guides_params" -require_relative "scalar-api-ruby/models/scalar_doc_list_guides_response" -require_relative "scalar-api-ruby/models/scalar_doc_publish_guide_params" -require_relative "scalar-api-ruby/models/scalar_doc_publish_guide_response" -require_relative "scalar-api-ruby/models/schema_create_params" -require_relative "scalar-api-ruby/models/schema_delete_params" -require_relative "scalar-api-ruby/models/schema_list_params" -require_relative "scalar-api-ruby/models/schema_list_response" -require_relative "scalar-api-ruby/models/schemas/access_group_create_params" -require_relative "scalar-api-ruby/models/schemas/access_group_delete_params" -require_relative "scalar-api-ruby/models/schemas/version_create_params" -require_relative "scalar-api-ruby/models/schemas/version_delete_params" -require_relative "scalar-api-ruby/models/schemas/version_retrieve_params" -require_relative "scalar-api-ruby/models/schemas/version_retrieve_response" -require_relative "scalar-api-ruby/models/schema_update_params" -require_relative "scalar-api-ruby/models/slug" -require_relative "scalar-api-ruby/models/team_list_params" -require_relative "scalar-api-ruby/models/team_list_response" -require_relative "scalar-api-ruby/models/theme_create_params" -require_relative "scalar-api-ruby/models/theme_delete_params" -require_relative "scalar-api-ruby/models/theme_list_params" -require_relative "scalar-api-ruby/models/theme_list_response" -require_relative "scalar-api-ruby/models/theme_replace_document_params" -require_relative "scalar-api-ruby/models/theme_retrieve_params" -require_relative "scalar-api-ruby/models/theme_retrieve_response" -require_relative "scalar-api-ruby/models/theme_update_params" -require_relative "scalar-api-ruby/models/timestamp" -require_relative "scalar-api-ruby/models/uid" -require_relative "scalar-api-ruby/models/version" -require_relative "scalar-api-ruby/models" -require_relative "scalar-api-ruby/resources/registry" -require_relative "scalar-api-ruby/resources/schemas" -require_relative "scalar-api-ruby/resources/schemas/version" -require_relative "scalar-api-ruby/resources/schemas/access_group" -require_relative "scalar-api-ruby/resources/login_portals" -require_relative "scalar-api-ruby/resources/rules" -require_relative "scalar-api-ruby/resources/themes" -require_relative "scalar-api-ruby/resources/teams" -require_relative "scalar-api-ruby/resources/scalar_docs" -require_relative "scalar-api-ruby/resources/namespaces" -require_relative "scalar-api-ruby/resources/authentication" diff --git a/lib/scalar_api_ruby.rb b/lib/scalar_api_ruby.rb new file mode 100644 index 0000000..ff61cbe --- /dev/null +++ b/lib/scalar_api_ruby.rb @@ -0,0 +1,147 @@ +# frozen_string_literal: true + +# Standard libraries. +# rubocop:disable Lint/RedundantRequireStatement +require "English" +require "cgi" +require "date" +require "erb" +require "etc" +require "json" +require "net/http" +require "openssl" +require "pathname" +require "rbconfig" +require "securerandom" +require "set" +require "stringio" +require "time" +require "uri" +# rubocop:enable Lint/RedundantRequireStatement + +# We already ship the preferred sorbet manifests in the package itself. +# `tapioca` currently does not offer us a way to opt out of unnecessary compilation. +if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) && + ARGV.none?(/dsl/) + return +end + +# Gems. +require "connection_pool" + +# Package files. +require_relative "scalar_api_ruby/version" +require_relative "scalar_api_ruby/internal/util" +require_relative "scalar_api_ruby/internal/type/converter" +require_relative "scalar_api_ruby/internal/type/unknown" +require_relative "scalar_api_ruby/internal/type/boolean" +require_relative "scalar_api_ruby/internal/type/file_input" +require_relative "scalar_api_ruby/internal/type/enum" +require_relative "scalar_api_ruby/internal/type/union" +require_relative "scalar_api_ruby/internal/type/array_of" +require_relative "scalar_api_ruby/internal/type/hash_of" +require_relative "scalar_api_ruby/internal/type/base_model" +require_relative "scalar_api_ruby/internal/type/base_page" +require_relative "scalar_api_ruby/internal/type/request_parameters" +require_relative "scalar_api_ruby/internal" +require_relative "scalar_api_ruby/request_options" +require_relative "scalar_api_ruby/file_part" +require_relative "scalar_api_ruby/errors" +require_relative "scalar_api_ruby/internal/transport/base_client" +require_relative "scalar_api_ruby/internal/transport/pooled_net_requester" +require_relative "scalar_api_ruby/client" +require_relative "scalar_api_ruby/models/access_group" +require_relative "scalar_api_ruby/models/400" +require_relative "scalar_api_ruby/models/401" +require_relative "scalar_api_ruby/models/403" +require_relative "scalar_api_ruby/models/404" +require_relative "scalar_api_ruby/models/422" +require_relative "scalar_api_ruby/models/500" +require_relative "scalar_api_ruby/models/authentication_exchange_personal_token_params" +require_relative "scalar_api_ruby/models/authentication_exchange_personal_token_response" +require_relative "scalar_api_ruby/models/authentication_list_current_user_params" +require_relative "scalar_api_ruby/models/authentication_list_current_user_response" +require_relative "scalar_api_ruby/models/login_portal_create_params" +require_relative "scalar_api_ruby/models/login_portal_delete_params" +require_relative "scalar_api_ruby/models/login_portal_email" +require_relative "scalar_api_ruby/models/login_portal_list_params" +require_relative "scalar_api_ruby/models/login_portal_list_response" +require_relative "scalar_api_ruby/models/login_portal_page" +require_relative "scalar_api_ruby/models/login_portal_retrieve_params" +require_relative "scalar_api_ruby/models/login_portal_retrieve_response" +require_relative "scalar_api_ruby/models/login_portal_update_params" +require_relative "scalar_api_ruby/models/managed_doc_version" +require_relative "scalar_api_ruby/models/namespace" +require_relative "scalar_api_ruby/models/namespace_list_params" +require_relative "scalar_api_ruby/models/namespace_list_response" +require_relative "scalar_api_ruby/models/nanoid" +require_relative "scalar_api_ruby/models/registry_create_api_document_access_group_params" +require_relative "scalar_api_ruby/models/registry_create_api_document_params" +require_relative "scalar_api_ruby/models/registry_create_api_document_response" +require_relative "scalar_api_ruby/models/registry_create_api_document_version_params" +require_relative "scalar_api_ruby/models/registry_delete_api_document_access_group_params" +require_relative "scalar_api_ruby/models/registry_delete_api_document_params" +require_relative "scalar_api_ruby/models/registry_delete_api_document_version_params" +require_relative "scalar_api_ruby/models/registry_list_all_api_documents_params" +require_relative "scalar_api_ruby/models/registry_list_all_api_documents_response" +require_relative "scalar_api_ruby/models/registry_list_api_documents_params" +require_relative "scalar_api_ruby/models/registry_list_api_documents_response" +require_relative "scalar_api_ruby/models/registry_list_api_document_version_metadata_params" +require_relative "scalar_api_ruby/models/registry_retrieve_api_document_version_params" +require_relative "scalar_api_ruby/models/registry_retrieve_api_document_version_response" +require_relative "scalar_api_ruby/models/registry_update_api_document_params" +require_relative "scalar_api_ruby/models/registry_update_api_document_version_params" +require_relative "scalar_api_ruby/models/registry_update_api_document_version_response" +require_relative "scalar_api_ruby/models/rule_create_ruleset_access_group_params" +require_relative "scalar_api_ruby/models/rule_create_ruleset_params" +require_relative "scalar_api_ruby/models/rule_delete_ruleset_access_group_params" +require_relative "scalar_api_ruby/models/rule_delete_ruleset_params" +require_relative "scalar_api_ruby/models/rule_list_rulesets_params" +require_relative "scalar_api_ruby/models/rule_list_rulesets_response" +require_relative "scalar_api_ruby/models/rule_retrieve_ruleset_document_params" +require_relative "scalar_api_ruby/models/rule_retrieve_ruleset_document_response" +require_relative "scalar_api_ruby/models/rule_update_ruleset_params" +require_relative "scalar_api_ruby/models/scalar_doc_create_guide_params" +require_relative "scalar_api_ruby/models/scalar_doc_create_guide_response" +require_relative "scalar_api_ruby/models/scalar_doc_list_guides_params" +require_relative "scalar_api_ruby/models/scalar_doc_list_guides_response" +require_relative "scalar_api_ruby/models/scalar_doc_publish_guide_params" +require_relative "scalar_api_ruby/models/scalar_doc_publish_guide_response" +require_relative "scalar_api_ruby/models/schema_create_params" +require_relative "scalar_api_ruby/models/schema_delete_params" +require_relative "scalar_api_ruby/models/schema_list_params" +require_relative "scalar_api_ruby/models/schema_list_response" +require_relative "scalar_api_ruby/models/schemas/access_group_create_params" +require_relative "scalar_api_ruby/models/schemas/access_group_delete_params" +require_relative "scalar_api_ruby/models/schemas/version_create_params" +require_relative "scalar_api_ruby/models/schemas/version_create_response" +require_relative "scalar_api_ruby/models/schemas/version_delete_params" +require_relative "scalar_api_ruby/models/schemas/version_retrieve_params" +require_relative "scalar_api_ruby/models/schemas/version_retrieve_response" +require_relative "scalar_api_ruby/models/schema_update_params" +require_relative "scalar_api_ruby/models/slug" +require_relative "scalar_api_ruby/models/team_list_params" +require_relative "scalar_api_ruby/models/team_list_response" +require_relative "scalar_api_ruby/models/theme_create_params" +require_relative "scalar_api_ruby/models/theme_delete_params" +require_relative "scalar_api_ruby/models/theme_list_params" +require_relative "scalar_api_ruby/models/theme_list_response" +require_relative "scalar_api_ruby/models/theme_replace_document_params" +require_relative "scalar_api_ruby/models/theme_retrieve_params" +require_relative "scalar_api_ruby/models/theme_retrieve_response" +require_relative "scalar_api_ruby/models/theme_update_params" +require_relative "scalar_api_ruby/models/timestamp" +require_relative "scalar_api_ruby/models/uid" +require_relative "scalar_api_ruby/models/version" +require_relative "scalar_api_ruby/models" +require_relative "scalar_api_ruby/resources/registry" +require_relative "scalar_api_ruby/resources/schemas" +require_relative "scalar_api_ruby/resources/schemas/version" +require_relative "scalar_api_ruby/resources/schemas/access_group" +require_relative "scalar_api_ruby/resources/login_portals" +require_relative "scalar_api_ruby/resources/rules" +require_relative "scalar_api_ruby/resources/themes" +require_relative "scalar_api_ruby/resources/teams" +require_relative "scalar_api_ruby/resources/scalar_docs" +require_relative "scalar_api_ruby/resources/namespaces" +require_relative "scalar_api_ruby/resources/authentication" diff --git a/lib/scalar-api-ruby/client.rb b/lib/scalar_api_ruby/client.rb similarity index 81% rename from lib/scalar-api-ruby/client.rb rename to lib/scalar_api_ruby/client.rb index aabc01b..739f3f4 100644 --- a/lib/scalar-api-ruby/client.rb +++ b/lib/scalar_api_ruby/client.rb @@ -15,9 +15,14 @@ class Client < Scalar::Internal::Transport::BaseClient # Default max retry delay in seconds. DEFAULT_MAX_RETRY_DELAY = 8.0 - # @return [String] + # @return [String, nil] attr_reader :bearer_auth + # Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. + # Each scope implies the weaker ones. + # @return [String, nil] + attr_reader :o_auth2 + # Registry # @return [Scalar::Resources::Registry] attr_reader :registry @@ -58,13 +63,30 @@ class Client < Scalar::Internal::Transport::BaseClient # # @return [Hash{String=>String}] private def auth_headers + {**auth_bearer_auth, **auth_o_auth2} + end + + # @api private + # + # @return [Hash{String=>String}] + private def auth_bearer_auth {"authorization" => "Bearer #{@bearer_auth}"} end + # @api private + # + # @return [Hash{String=>String}] + private def auth_o_auth2 + {"authorization" => "Bearer #{@o_auth2}"} + end + # Creates and returns a new client for interacting with the API. # # @param bearer_auth [String, nil] Defaults to `ENV["BEARER_AUTH"]` # + # @param o_auth2 [String, nil] Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. + # Each scope implies the weaker ones. Defaults to `ENV["SCALAR_O_AUTH2"]` + # # @param base_url [String, nil] Override the default base URL for the API, e.g., # `"https://api.example.com/v2/"`. Defaults to `ENV["SCALAR_BASE_URL"]` # @@ -77,6 +99,7 @@ class Client < Scalar::Internal::Transport::BaseClient # @param max_retry_delay [Float] def initialize( bearer_auth: ENV["BEARER_AUTH"], + o_auth2: ENV["SCALAR_O_AUTH2"], base_url: ENV["SCALAR_BASE_URL"], max_retries: self.class::DEFAULT_MAX_RETRIES, timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS, @@ -85,10 +108,6 @@ def initialize( ) base_url ||= "https://access.scalar.com" - if bearer_auth.nil? - raise ArgumentError.new("bearer_auth is required, and can be set via environ: \"BEARER_AUTH\"") - end - headers = {} custom_headers_env = ENV["SCALAR_CUSTOM_HEADERS"] unless custom_headers_env.nil? @@ -102,7 +121,8 @@ def initialize( headers = parsed.merge(headers) end - @bearer_auth = bearer_auth.to_s + @bearer_auth = bearer_auth&.to_s + @o_auth2 = o_auth2&.to_s super( base_url: base_url, diff --git a/lib/scalar-api-ruby/errors.rb b/lib/scalar_api_ruby/errors.rb similarity index 100% rename from lib/scalar-api-ruby/errors.rb rename to lib/scalar_api_ruby/errors.rb diff --git a/lib/scalar-api-ruby/file_part.rb b/lib/scalar_api_ruby/file_part.rb similarity index 100% rename from lib/scalar-api-ruby/file_part.rb rename to lib/scalar_api_ruby/file_part.rb diff --git a/lib/scalar-api-ruby/internal.rb b/lib/scalar_api_ruby/internal.rb similarity index 100% rename from lib/scalar-api-ruby/internal.rb rename to lib/scalar_api_ruby/internal.rb diff --git a/lib/scalar-api-ruby/internal/transport/base_client.rb b/lib/scalar_api_ruby/internal/transport/base_client.rb similarity index 100% rename from lib/scalar-api-ruby/internal/transport/base_client.rb rename to lib/scalar_api_ruby/internal/transport/base_client.rb diff --git a/lib/scalar-api-ruby/internal/transport/pooled_net_requester.rb b/lib/scalar_api_ruby/internal/transport/pooled_net_requester.rb similarity index 100% rename from lib/scalar-api-ruby/internal/transport/pooled_net_requester.rb rename to lib/scalar_api_ruby/internal/transport/pooled_net_requester.rb diff --git a/lib/scalar-api-ruby/internal/type/array_of.rb b/lib/scalar_api_ruby/internal/type/array_of.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/array_of.rb rename to lib/scalar_api_ruby/internal/type/array_of.rb diff --git a/lib/scalar-api-ruby/internal/type/base_model.rb b/lib/scalar_api_ruby/internal/type/base_model.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/base_model.rb rename to lib/scalar_api_ruby/internal/type/base_model.rb diff --git a/lib/scalar-api-ruby/internal/type/base_page.rb b/lib/scalar_api_ruby/internal/type/base_page.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/base_page.rb rename to lib/scalar_api_ruby/internal/type/base_page.rb diff --git a/lib/scalar-api-ruby/internal/type/boolean.rb b/lib/scalar_api_ruby/internal/type/boolean.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/boolean.rb rename to lib/scalar_api_ruby/internal/type/boolean.rb diff --git a/lib/scalar-api-ruby/internal/type/converter.rb b/lib/scalar_api_ruby/internal/type/converter.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/converter.rb rename to lib/scalar_api_ruby/internal/type/converter.rb diff --git a/lib/scalar-api-ruby/internal/type/enum.rb b/lib/scalar_api_ruby/internal/type/enum.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/enum.rb rename to lib/scalar_api_ruby/internal/type/enum.rb diff --git a/lib/scalar-api-ruby/internal/type/file_input.rb b/lib/scalar_api_ruby/internal/type/file_input.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/file_input.rb rename to lib/scalar_api_ruby/internal/type/file_input.rb diff --git a/lib/scalar-api-ruby/internal/type/hash_of.rb b/lib/scalar_api_ruby/internal/type/hash_of.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/hash_of.rb rename to lib/scalar_api_ruby/internal/type/hash_of.rb diff --git a/lib/scalar-api-ruby/internal/type/request_parameters.rb b/lib/scalar_api_ruby/internal/type/request_parameters.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/request_parameters.rb rename to lib/scalar_api_ruby/internal/type/request_parameters.rb diff --git a/lib/scalar-api-ruby/internal/type/union.rb b/lib/scalar_api_ruby/internal/type/union.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/union.rb rename to lib/scalar_api_ruby/internal/type/union.rb diff --git a/lib/scalar-api-ruby/internal/type/unknown.rb b/lib/scalar_api_ruby/internal/type/unknown.rb similarity index 100% rename from lib/scalar-api-ruby/internal/type/unknown.rb rename to lib/scalar_api_ruby/internal/type/unknown.rb diff --git a/lib/scalar-api-ruby/internal/util.rb b/lib/scalar_api_ruby/internal/util.rb similarity index 100% rename from lib/scalar-api-ruby/internal/util.rb rename to lib/scalar_api_ruby/internal/util.rb diff --git a/lib/scalar-api-ruby/models.rb b/lib/scalar_api_ruby/models.rb similarity index 100% rename from lib/scalar-api-ruby/models.rb rename to lib/scalar_api_ruby/models.rb diff --git a/lib/scalar-api-ruby/models/400.rb b/lib/scalar_api_ruby/models/400.rb similarity index 100% rename from lib/scalar-api-ruby/models/400.rb rename to lib/scalar_api_ruby/models/400.rb diff --git a/lib/scalar-api-ruby/models/401.rb b/lib/scalar_api_ruby/models/401.rb similarity index 100% rename from lib/scalar-api-ruby/models/401.rb rename to lib/scalar_api_ruby/models/401.rb diff --git a/lib/scalar-api-ruby/models/403.rb b/lib/scalar_api_ruby/models/403.rb similarity index 100% rename from lib/scalar-api-ruby/models/403.rb rename to lib/scalar_api_ruby/models/403.rb diff --git a/lib/scalar-api-ruby/models/404.rb b/lib/scalar_api_ruby/models/404.rb similarity index 100% rename from lib/scalar-api-ruby/models/404.rb rename to lib/scalar_api_ruby/models/404.rb diff --git a/lib/scalar-api-ruby/models/422.rb b/lib/scalar_api_ruby/models/422.rb similarity index 100% rename from lib/scalar-api-ruby/models/422.rb rename to lib/scalar_api_ruby/models/422.rb diff --git a/lib/scalar-api-ruby/models/500.rb b/lib/scalar_api_ruby/models/500.rb similarity index 100% rename from lib/scalar-api-ruby/models/500.rb rename to lib/scalar_api_ruby/models/500.rb diff --git a/lib/scalar-api-ruby/models/access_group.rb b/lib/scalar_api_ruby/models/access_group.rb similarity index 100% rename from lib/scalar-api-ruby/models/access_group.rb rename to lib/scalar_api_ruby/models/access_group.rb diff --git a/lib/scalar-api-ruby/models/authentication_exchange_personal_token_params.rb b/lib/scalar_api_ruby/models/authentication_exchange_personal_token_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/authentication_exchange_personal_token_params.rb rename to lib/scalar_api_ruby/models/authentication_exchange_personal_token_params.rb diff --git a/lib/scalar-api-ruby/models/authentication_exchange_personal_token_response.rb b/lib/scalar_api_ruby/models/authentication_exchange_personal_token_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/authentication_exchange_personal_token_response.rb rename to lib/scalar_api_ruby/models/authentication_exchange_personal_token_response.rb diff --git a/lib/scalar-api-ruby/models/authentication_list_current_user_params.rb b/lib/scalar_api_ruby/models/authentication_list_current_user_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/authentication_list_current_user_params.rb rename to lib/scalar_api_ruby/models/authentication_list_current_user_params.rb diff --git a/lib/scalar-api-ruby/models/authentication_list_current_user_response.rb b/lib/scalar_api_ruby/models/authentication_list_current_user_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/authentication_list_current_user_response.rb rename to lib/scalar_api_ruby/models/authentication_list_current_user_response.rb diff --git a/lib/scalar-api-ruby/models/login_portal_create_params.rb b/lib/scalar_api_ruby/models/login_portal_create_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/login_portal_create_params.rb rename to lib/scalar_api_ruby/models/login_portal_create_params.rb diff --git a/lib/scalar-api-ruby/models/login_portal_delete_params.rb b/lib/scalar_api_ruby/models/login_portal_delete_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/login_portal_delete_params.rb rename to lib/scalar_api_ruby/models/login_portal_delete_params.rb diff --git a/lib/scalar-api-ruby/models/login_portal_email.rb b/lib/scalar_api_ruby/models/login_portal_email.rb similarity index 100% rename from lib/scalar-api-ruby/models/login_portal_email.rb rename to lib/scalar_api_ruby/models/login_portal_email.rb diff --git a/lib/scalar-api-ruby/models/login_portal_list_params.rb b/lib/scalar_api_ruby/models/login_portal_list_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/login_portal_list_params.rb rename to lib/scalar_api_ruby/models/login_portal_list_params.rb diff --git a/lib/scalar-api-ruby/models/login_portal_list_response.rb b/lib/scalar_api_ruby/models/login_portal_list_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/login_portal_list_response.rb rename to lib/scalar_api_ruby/models/login_portal_list_response.rb diff --git a/lib/scalar-api-ruby/models/login_portal_page.rb b/lib/scalar_api_ruby/models/login_portal_page.rb similarity index 100% rename from lib/scalar-api-ruby/models/login_portal_page.rb rename to lib/scalar_api_ruby/models/login_portal_page.rb diff --git a/lib/scalar-api-ruby/models/login_portal_retrieve_params.rb b/lib/scalar_api_ruby/models/login_portal_retrieve_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/login_portal_retrieve_params.rb rename to lib/scalar_api_ruby/models/login_portal_retrieve_params.rb diff --git a/lib/scalar-api-ruby/models/login_portal_retrieve_response.rb b/lib/scalar_api_ruby/models/login_portal_retrieve_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/login_portal_retrieve_response.rb rename to lib/scalar_api_ruby/models/login_portal_retrieve_response.rb diff --git a/lib/scalar-api-ruby/models/login_portal_update_params.rb b/lib/scalar_api_ruby/models/login_portal_update_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/login_portal_update_params.rb rename to lib/scalar_api_ruby/models/login_portal_update_params.rb diff --git a/lib/scalar-api-ruby/models/managed_doc_version.rb b/lib/scalar_api_ruby/models/managed_doc_version.rb similarity index 91% rename from lib/scalar-api-ruby/models/managed_doc_version.rb rename to lib/scalar_api_ruby/models/managed_doc_version.rb index d44fec6..39653ae 100644 --- a/lib/scalar-api-ruby/models/managed_doc_version.rb +++ b/lib/scalar_api_ruby/models/managed_doc_version.rb @@ -16,6 +16,11 @@ class ManagedDocVersion < Scalar::Internal::Type::BaseModel api_name: :embedStatus, nil?: true + # @!attribute endpoint_count + # + # @return [Integer, nil] + required :endpoint_count, Integer, api_name: :endpointCount, nil?: true + # @!attribute tags # # @return [Array] @@ -46,26 +51,21 @@ class ManagedDocVersion < Scalar::Internal::Type::BaseModel # @return [Array, nil] optional :tools, -> { Scalar::Internal::Type::ArrayOf[Scalar::ManagedDocVersion::Tool] } - # @!attribute version_sha - # - # @return [String, nil] - optional :version_sha, String, api_name: :versionSha - # @!attribute yaml_sha # # @return [String, nil] optional :yaml_sha, String, api_name: :yamlSha - # @!method initialize(created_at:, embed_status:, tags:, uid:, upgraded:, version:, json_sha: nil, tools: nil, version_sha: nil, yaml_sha: nil) + # @!method initialize(created_at:, embed_status:, endpoint_count:, tags:, uid:, upgraded:, version:, json_sha: nil, tools: nil, yaml_sha: nil) # @param created_at [Float] # @param embed_status [Symbol, Scalar::Models::ManagedDocVersion::EmbedStatus, nil] + # @param endpoint_count [Integer, nil] # @param tags [Array] # @param uid [String] # @param upgraded [Boolean] # @param version [String] # @param json_sha [String] # @param tools [Array] - # @param version_sha [String] # @param yaml_sha [String] # @see Scalar::Models::ManagedDocVersion#embed_status @@ -123,6 +123,7 @@ module Method PATCH = :patch POST = :post PUT = :put + QUERY = :query TRACE = :trace # @!method self.values diff --git a/lib/scalar-api-ruby/models/namespace.rb b/lib/scalar_api_ruby/models/namespace.rb similarity index 100% rename from lib/scalar-api-ruby/models/namespace.rb rename to lib/scalar_api_ruby/models/namespace.rb diff --git a/lib/scalar-api-ruby/models/namespace_list_params.rb b/lib/scalar_api_ruby/models/namespace_list_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/namespace_list_params.rb rename to lib/scalar_api_ruby/models/namespace_list_params.rb diff --git a/lib/scalar-api-ruby/models/namespace_list_response.rb b/lib/scalar_api_ruby/models/namespace_list_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/namespace_list_response.rb rename to lib/scalar_api_ruby/models/namespace_list_response.rb diff --git a/lib/scalar-api-ruby/models/nanoid.rb b/lib/scalar_api_ruby/models/nanoid.rb similarity index 100% rename from lib/scalar-api-ruby/models/nanoid.rb rename to lib/scalar_api_ruby/models/nanoid.rb diff --git a/lib/scalar-api-ruby/models/registry_create_api_document_access_group_params.rb b/lib/scalar_api_ruby/models/registry_create_api_document_access_group_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_create_api_document_access_group_params.rb rename to lib/scalar_api_ruby/models/registry_create_api_document_access_group_params.rb diff --git a/lib/scalar-api-ruby/models/registry_create_api_document_params.rb b/lib/scalar_api_ruby/models/registry_create_api_document_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_create_api_document_params.rb rename to lib/scalar_api_ruby/models/registry_create_api_document_params.rb diff --git a/lib/scalar-api-ruby/models/registry_create_api_document_response.rb b/lib/scalar_api_ruby/models/registry_create_api_document_response.rb similarity index 78% rename from lib/scalar-api-ruby/models/registry_create_api_document_response.rb rename to lib/scalar_api_ruby/models/registry_create_api_document_response.rb index 6aa7f21..63f47b7 100644 --- a/lib/scalar-api-ruby/models/registry_create_api_document_response.rb +++ b/lib/scalar_api_ruby/models/registry_create_api_document_response.rb @@ -19,11 +19,6 @@ class RegistryCreateAPIDocumentResponse < Scalar::Internal::Type::BaseModel # @return [String] required :uid, String - # @!attribute version_sha - # - # @return [String] - required :version_sha, String, api_name: :versionSha - # @!attribute version_uid # # @return [String] @@ -34,11 +29,10 @@ class RegistryCreateAPIDocumentResponse < Scalar::Internal::Type::BaseModel # @return [String] required :yaml_sha, String, api_name: :yamlSha - # @!method initialize(json_sha:, title:, uid:, version_sha:, version_uid:, yaml_sha:) + # @!method initialize(json_sha:, title:, uid:, version_uid:, yaml_sha:) # @param json_sha [String] # @param title [String] # @param uid [String] - # @param version_sha [String] # @param version_uid [String] # @param yaml_sha [String] end diff --git a/lib/scalar-api-ruby/models/registry_create_api_document_version_params.rb b/lib/scalar_api_ruby/models/registry_create_api_document_version_params.rb similarity index 80% rename from lib/scalar-api-ruby/models/registry_create_api_document_version_params.rb rename to lib/scalar_api_ruby/models/registry_create_api_document_version_params.rb index 61d8869..b375e22 100644 --- a/lib/scalar-api-ruby/models/registry_create_api_document_version_params.rb +++ b/lib/scalar_api_ruby/models/registry_create_api_document_version_params.rb @@ -32,18 +32,12 @@ class RegistryCreateAPIDocumentVersionParams < Scalar::Internal::Type::BaseModel # @return [Boolean, nil] optional :force, Scalar::Internal::Type::Boolean - # @!attribute last_known_version_sha - # - # @return [String, nil] - optional :last_known_version_sha, String, api_name: :lastKnownVersionSha - - # @!method initialize(namespace:, slug:, document:, version:, force: nil, last_known_version_sha: nil, request_options: {}) + # @!method initialize(namespace:, slug:, document:, version:, force: nil, request_options: {}) # @param namespace [String] # @param slug [String] # @param document [String] # @param version [String] # @param force [Boolean] - # @param last_known_version_sha [String] # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/scalar-api-ruby/models/registry_delete_api_document_access_group_params.rb b/lib/scalar_api_ruby/models/registry_delete_api_document_access_group_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_delete_api_document_access_group_params.rb rename to lib/scalar_api_ruby/models/registry_delete_api_document_access_group_params.rb diff --git a/lib/scalar-api-ruby/models/registry_delete_api_document_params.rb b/lib/scalar_api_ruby/models/registry_delete_api_document_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_delete_api_document_params.rb rename to lib/scalar_api_ruby/models/registry_delete_api_document_params.rb diff --git a/lib/scalar-api-ruby/models/registry_delete_api_document_version_params.rb b/lib/scalar_api_ruby/models/registry_delete_api_document_version_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_delete_api_document_version_params.rb rename to lib/scalar_api_ruby/models/registry_delete_api_document_version_params.rb diff --git a/lib/scalar-api-ruby/models/registry_list_all_api_documents_params.rb b/lib/scalar_api_ruby/models/registry_list_all_api_documents_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_list_all_api_documents_params.rb rename to lib/scalar_api_ruby/models/registry_list_all_api_documents_params.rb diff --git a/lib/scalar-api-ruby/models/registry_list_all_api_documents_response.rb b/lib/scalar_api_ruby/models/registry_list_all_api_documents_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_list_all_api_documents_response.rb rename to lib/scalar_api_ruby/models/registry_list_all_api_documents_response.rb diff --git a/lib/scalar-api-ruby/models/registry_list_api_document_version_metadata_params.rb b/lib/scalar_api_ruby/models/registry_list_api_document_version_metadata_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_list_api_document_version_metadata_params.rb rename to lib/scalar_api_ruby/models/registry_list_api_document_version_metadata_params.rb diff --git a/lib/scalar-api-ruby/models/registry_list_api_documents_params.rb b/lib/scalar_api_ruby/models/registry_list_api_documents_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_list_api_documents_params.rb rename to lib/scalar_api_ruby/models/registry_list_api_documents_params.rb diff --git a/lib/scalar-api-ruby/models/registry_list_api_documents_response.rb b/lib/scalar_api_ruby/models/registry_list_api_documents_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_list_api_documents_response.rb rename to lib/scalar_api_ruby/models/registry_list_api_documents_response.rb diff --git a/lib/scalar-api-ruby/models/registry_retrieve_api_document_version_params.rb b/lib/scalar_api_ruby/models/registry_retrieve_api_document_version_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_retrieve_api_document_version_params.rb rename to lib/scalar_api_ruby/models/registry_retrieve_api_document_version_params.rb diff --git a/lib/scalar-api-ruby/models/registry_retrieve_api_document_version_response.rb b/lib/scalar_api_ruby/models/registry_retrieve_api_document_version_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_retrieve_api_document_version_response.rb rename to lib/scalar_api_ruby/models/registry_retrieve_api_document_version_response.rb diff --git a/lib/scalar-api-ruby/models/registry_update_api_document_params.rb b/lib/scalar_api_ruby/models/registry_update_api_document_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/registry_update_api_document_params.rb rename to lib/scalar_api_ruby/models/registry_update_api_document_params.rb diff --git a/lib/scalar-api-ruby/models/registry_update_api_document_version_params.rb b/lib/scalar_api_ruby/models/registry_update_api_document_version_params.rb similarity index 79% rename from lib/scalar-api-ruby/models/registry_update_api_document_version_params.rb rename to lib/scalar_api_ruby/models/registry_update_api_document_version_params.rb index 037a667..e5cbf7a 100644 --- a/lib/scalar-api-ruby/models/registry_update_api_document_version_params.rb +++ b/lib/scalar_api_ruby/models/registry_update_api_document_version_params.rb @@ -27,17 +27,11 @@ class RegistryUpdateAPIDocumentVersionParams < Scalar::Internal::Type::BaseModel # @return [String] required :document, String - # @!attribute last_known_version_sha - # - # @return [String, nil] - optional :last_known_version_sha, String, api_name: :lastKnownVersionSha - - # @!method initialize(namespace:, slug:, semver:, document:, last_known_version_sha: nil, request_options: {}) + # @!method initialize(namespace:, slug:, semver:, document:, request_options: {}) # @param namespace [String] # @param slug [String] # @param semver [String] # @param document [String] - # @param last_known_version_sha [String] # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/scalar-api-ruby/models/registry_update_api_document_version_response.rb b/lib/scalar_api_ruby/models/registry_update_api_document_version_response.rb similarity index 70% rename from lib/scalar-api-ruby/models/registry_update_api_document_version_response.rb rename to lib/scalar_api_ruby/models/registry_update_api_document_version_response.rb index 59a9973..adc0029 100644 --- a/lib/scalar-api-ruby/models/registry_update_api_document_version_response.rb +++ b/lib/scalar_api_ruby/models/registry_update_api_document_version_response.rb @@ -9,19 +9,13 @@ class RegistryUpdateAPIDocumentVersionResponse < Scalar::Internal::Type::BaseMod # @return [String] required :json_sha, String, api_name: :jsonSha - # @!attribute version_sha - # - # @return [String] - required :version_sha, String, api_name: :versionSha - # @!attribute yaml_sha # # @return [String] required :yaml_sha, String, api_name: :yamlSha - # @!method initialize(json_sha:, version_sha:, yaml_sha:) + # @!method initialize(json_sha:, yaml_sha:) # @param json_sha [String] - # @param version_sha [String] # @param yaml_sha [String] end end diff --git a/lib/scalar-api-ruby/models/rule_create_ruleset_access_group_params.rb b/lib/scalar_api_ruby/models/rule_create_ruleset_access_group_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/rule_create_ruleset_access_group_params.rb rename to lib/scalar_api_ruby/models/rule_create_ruleset_access_group_params.rb diff --git a/lib/scalar-api-ruby/models/rule_create_ruleset_params.rb b/lib/scalar_api_ruby/models/rule_create_ruleset_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/rule_create_ruleset_params.rb rename to lib/scalar_api_ruby/models/rule_create_ruleset_params.rb diff --git a/lib/scalar-api-ruby/models/rule_delete_ruleset_access_group_params.rb b/lib/scalar_api_ruby/models/rule_delete_ruleset_access_group_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/rule_delete_ruleset_access_group_params.rb rename to lib/scalar_api_ruby/models/rule_delete_ruleset_access_group_params.rb diff --git a/lib/scalar-api-ruby/models/rule_delete_ruleset_params.rb b/lib/scalar_api_ruby/models/rule_delete_ruleset_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/rule_delete_ruleset_params.rb rename to lib/scalar_api_ruby/models/rule_delete_ruleset_params.rb diff --git a/lib/scalar-api-ruby/models/rule_list_rulesets_params.rb b/lib/scalar_api_ruby/models/rule_list_rulesets_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/rule_list_rulesets_params.rb rename to lib/scalar_api_ruby/models/rule_list_rulesets_params.rb diff --git a/lib/scalar-api-ruby/models/rule_list_rulesets_response.rb b/lib/scalar_api_ruby/models/rule_list_rulesets_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/rule_list_rulesets_response.rb rename to lib/scalar_api_ruby/models/rule_list_rulesets_response.rb diff --git a/lib/scalar-api-ruby/models/rule_retrieve_ruleset_document_params.rb b/lib/scalar_api_ruby/models/rule_retrieve_ruleset_document_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/rule_retrieve_ruleset_document_params.rb rename to lib/scalar_api_ruby/models/rule_retrieve_ruleset_document_params.rb diff --git a/lib/scalar-api-ruby/models/rule_retrieve_ruleset_document_response.rb b/lib/scalar_api_ruby/models/rule_retrieve_ruleset_document_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/rule_retrieve_ruleset_document_response.rb rename to lib/scalar_api_ruby/models/rule_retrieve_ruleset_document_response.rb diff --git a/lib/scalar-api-ruby/models/rule_update_ruleset_params.rb b/lib/scalar_api_ruby/models/rule_update_ruleset_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/rule_update_ruleset_params.rb rename to lib/scalar_api_ruby/models/rule_update_ruleset_params.rb diff --git a/lib/scalar-api-ruby/models/scalar_doc_create_guide_params.rb b/lib/scalar_api_ruby/models/scalar_doc_create_guide_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/scalar_doc_create_guide_params.rb rename to lib/scalar_api_ruby/models/scalar_doc_create_guide_params.rb diff --git a/lib/scalar-api-ruby/models/scalar_doc_create_guide_response.rb b/lib/scalar_api_ruby/models/scalar_doc_create_guide_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/scalar_doc_create_guide_response.rb rename to lib/scalar_api_ruby/models/scalar_doc_create_guide_response.rb diff --git a/lib/scalar-api-ruby/models/scalar_doc_list_guides_params.rb b/lib/scalar_api_ruby/models/scalar_doc_list_guides_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/scalar_doc_list_guides_params.rb rename to lib/scalar_api_ruby/models/scalar_doc_list_guides_params.rb diff --git a/lib/scalar-api-ruby/models/scalar_doc_list_guides_response.rb b/lib/scalar_api_ruby/models/scalar_doc_list_guides_response.rb similarity index 90% rename from lib/scalar-api-ruby/models/scalar_doc_list_guides_response.rb rename to lib/scalar_api_ruby/models/scalar_doc_list_guides_response.rb index f695a6d..474a3e7 100644 --- a/lib/scalar-api-ruby/models/scalar_doc_list_guides_response.rb +++ b/lib/scalar_api_ruby/models/scalar_doc_list_guides_response.rb @@ -26,6 +26,11 @@ class ScalarDocListGuidesResponseItem < Scalar::Internal::Type::BaseModel # @return [Boolean] required :agent_enabled, Scalar::Internal::Type::Boolean, api_name: :agentEnabled + # @!attribute analytics_enabled + # + # @return [Boolean] + required :analytics_enabled, Scalar::Internal::Type::Boolean, api_name: :analyticsEnabled + # @!attribute created_at # # @return [Integer] @@ -81,6 +86,11 @@ class ScalarDocListGuidesResponseItem < Scalar::Internal::Type::BaseModel # @return [Integer] required :updated_at, Integer, api_name: :updatedAt + # @!attribute user_info_hook_url + # + # @return [String] + required :user_info_hook_url, String, api_name: :userInfoHookUrl + # @!attribute repository # # @return [Scalar::Models::ScalarDocListGuidesResponseItem::Repository, nil] @@ -91,11 +101,12 @@ class ScalarDocListGuidesResponseItem < Scalar::Internal::Type::BaseModel # @return [Float, nil] optional :typesense_id, Float, api_name: :typesenseId - # @!method initialize(access_groups:, active_deployment:, active_theme_id:, agent_enabled:, created_at:, is_private:, last_published:, last_published_uid:, login_portal_uid:, name:, publish_message:, publish_status:, slug:, uid:, updated_at:, repository: nil, typesense_id: nil) + # @!method initialize(access_groups:, active_deployment:, active_theme_id:, agent_enabled:, analytics_enabled:, created_at:, is_private:, last_published:, last_published_uid:, login_portal_uid:, name:, publish_message:, publish_status:, slug:, uid:, updated_at:, user_info_hook_url:, repository: nil, typesense_id: nil) # @param access_groups [Object] # @param active_deployment [Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment, nil] # @param active_theme_id [String] # @param agent_enabled [Boolean] + # @param analytics_enabled [Boolean] # @param created_at [Integer] # @param is_private [Boolean] # @param last_published [Integer, nil] @@ -107,6 +118,7 @@ class ScalarDocListGuidesResponseItem < Scalar::Internal::Type::BaseModel # @param slug [String] # @param uid [String] # @param updated_at [Integer] + # @param user_info_hook_url [String] # @param repository [Scalar::Models::ScalarDocListGuidesResponseItem::Repository, nil] # @param typesense_id [Float] diff --git a/lib/scalar-api-ruby/models/scalar_doc_publish_guide_params.rb b/lib/scalar_api_ruby/models/scalar_doc_publish_guide_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/scalar_doc_publish_guide_params.rb rename to lib/scalar_api_ruby/models/scalar_doc_publish_guide_params.rb diff --git a/lib/scalar-api-ruby/models/scalar_doc_publish_guide_response.rb b/lib/scalar_api_ruby/models/scalar_doc_publish_guide_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/scalar_doc_publish_guide_response.rb rename to lib/scalar_api_ruby/models/scalar_doc_publish_guide_response.rb diff --git a/lib/scalar-api-ruby/models/schema_create_params.rb b/lib/scalar_api_ruby/models/schema_create_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/schema_create_params.rb rename to lib/scalar_api_ruby/models/schema_create_params.rb diff --git a/lib/scalar-api-ruby/models/schema_delete_params.rb b/lib/scalar_api_ruby/models/schema_delete_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/schema_delete_params.rb rename to lib/scalar_api_ruby/models/schema_delete_params.rb diff --git a/lib/scalar-api-ruby/models/schema_list_params.rb b/lib/scalar_api_ruby/models/schema_list_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/schema_list_params.rb rename to lib/scalar_api_ruby/models/schema_list_params.rb diff --git a/lib/scalar-api-ruby/models/schema_list_response.rb b/lib/scalar_api_ruby/models/schema_list_response.rb similarity index 86% rename from lib/scalar-api-ruby/models/schema_list_response.rb rename to lib/scalar_api_ruby/models/schema_list_response.rb index fa4f1b2..5507566 100644 --- a/lib/scalar-api-ruby/models/schema_list_response.rb +++ b/lib/scalar_api_ruby/models/schema_list_response.rb @@ -69,11 +69,23 @@ class Version < Scalar::Internal::Type::BaseModel # @return [String] required :version, String - # @!method initialize(created_at:, uid:, updated_at:, version:) + # @!attribute json_sha + # + # @return [String, nil] + optional :json_sha, String, api_name: :jsonSha + + # @!attribute yaml_sha + # + # @return [String, nil] + optional :yaml_sha, String, api_name: :yamlSha + + # @!method initialize(created_at:, uid:, updated_at:, version:, json_sha: nil, yaml_sha: nil) # @param created_at [Integer] # @param uid [String] # @param updated_at [Integer] # @param version [String] + # @param json_sha [String] + # @param yaml_sha [String] end end diff --git a/lib/scalar-api-ruby/models/schema_update_params.rb b/lib/scalar_api_ruby/models/schema_update_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/schema_update_params.rb rename to lib/scalar_api_ruby/models/schema_update_params.rb diff --git a/lib/scalar-api-ruby/models/schemas/access_group_create_params.rb b/lib/scalar_api_ruby/models/schemas/access_group_create_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/schemas/access_group_create_params.rb rename to lib/scalar_api_ruby/models/schemas/access_group_create_params.rb diff --git a/lib/scalar-api-ruby/models/schemas/access_group_delete_params.rb b/lib/scalar_api_ruby/models/schemas/access_group_delete_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/schemas/access_group_delete_params.rb rename to lib/scalar_api_ruby/models/schemas/access_group_delete_params.rb diff --git a/lib/scalar-api-ruby/models/schemas/version_create_params.rb b/lib/scalar_api_ruby/models/schemas/version_create_params.rb similarity index 83% rename from lib/scalar-api-ruby/models/schemas/version_create_params.rb rename to lib/scalar_api_ruby/models/schemas/version_create_params.rb index 95d1186..8c1c6b1 100644 --- a/lib/scalar-api-ruby/models/schemas/version_create_params.rb +++ b/lib/scalar_api_ruby/models/schemas/version_create_params.rb @@ -28,11 +28,17 @@ class VersionCreateParams < Scalar::Internal::Type::BaseModel # @return [String] required :version, String - # @!method initialize(namespace:, slug:, document:, version:, request_options: {}) + # @!attribute force + # + # @return [Boolean, nil] + optional :force, Scalar::Internal::Type::Boolean + + # @!method initialize(namespace:, slug:, document:, version:, force: nil, request_options: {}) # @param namespace [String] # @param slug [String] # @param document [String] # @param version [String] + # @param force [Boolean] # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/scalar_api_ruby/models/schemas/version_create_response.rb b/lib/scalar_api_ruby/models/schemas/version_create_response.rb new file mode 100644 index 0000000..6b16912 --- /dev/null +++ b/lib/scalar_api_ruby/models/schemas/version_create_response.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Schemas + # @see Scalar::Resources::Schemas::Version#create + class VersionCreateResponse < Scalar::Internal::Type::BaseModel + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(uid:) + # @param uid [String] + end + end + end +end diff --git a/lib/scalar-api-ruby/models/schemas/version_delete_params.rb b/lib/scalar_api_ruby/models/schemas/version_delete_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/schemas/version_delete_params.rb rename to lib/scalar_api_ruby/models/schemas/version_delete_params.rb diff --git a/lib/scalar-api-ruby/models/schemas/version_retrieve_params.rb b/lib/scalar_api_ruby/models/schemas/version_retrieve_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/schemas/version_retrieve_params.rb rename to lib/scalar_api_ruby/models/schemas/version_retrieve_params.rb diff --git a/lib/scalar-api-ruby/models/schemas/version_retrieve_response.rb b/lib/scalar_api_ruby/models/schemas/version_retrieve_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/schemas/version_retrieve_response.rb rename to lib/scalar_api_ruby/models/schemas/version_retrieve_response.rb diff --git a/lib/scalar-api-ruby/models/slug.rb b/lib/scalar_api_ruby/models/slug.rb similarity index 100% rename from lib/scalar-api-ruby/models/slug.rb rename to lib/scalar_api_ruby/models/slug.rb diff --git a/lib/scalar-api-ruby/models/team_list_params.rb b/lib/scalar_api_ruby/models/team_list_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/team_list_params.rb rename to lib/scalar_api_ruby/models/team_list_params.rb diff --git a/lib/scalar-api-ruby/models/team_list_response.rb b/lib/scalar_api_ruby/models/team_list_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/team_list_response.rb rename to lib/scalar_api_ruby/models/team_list_response.rb diff --git a/lib/scalar-api-ruby/models/theme_create_params.rb b/lib/scalar_api_ruby/models/theme_create_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/theme_create_params.rb rename to lib/scalar_api_ruby/models/theme_create_params.rb diff --git a/lib/scalar-api-ruby/models/theme_delete_params.rb b/lib/scalar_api_ruby/models/theme_delete_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/theme_delete_params.rb rename to lib/scalar_api_ruby/models/theme_delete_params.rb diff --git a/lib/scalar-api-ruby/models/theme_list_params.rb b/lib/scalar_api_ruby/models/theme_list_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/theme_list_params.rb rename to lib/scalar_api_ruby/models/theme_list_params.rb diff --git a/lib/scalar-api-ruby/models/theme_list_response.rb b/lib/scalar_api_ruby/models/theme_list_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/theme_list_response.rb rename to lib/scalar_api_ruby/models/theme_list_response.rb diff --git a/lib/scalar-api-ruby/models/theme_replace_document_params.rb b/lib/scalar_api_ruby/models/theme_replace_document_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/theme_replace_document_params.rb rename to lib/scalar_api_ruby/models/theme_replace_document_params.rb diff --git a/lib/scalar-api-ruby/models/theme_retrieve_params.rb b/lib/scalar_api_ruby/models/theme_retrieve_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/theme_retrieve_params.rb rename to lib/scalar_api_ruby/models/theme_retrieve_params.rb diff --git a/lib/scalar-api-ruby/models/theme_retrieve_response.rb b/lib/scalar_api_ruby/models/theme_retrieve_response.rb similarity index 100% rename from lib/scalar-api-ruby/models/theme_retrieve_response.rb rename to lib/scalar_api_ruby/models/theme_retrieve_response.rb diff --git a/lib/scalar-api-ruby/models/theme_update_params.rb b/lib/scalar_api_ruby/models/theme_update_params.rb similarity index 100% rename from lib/scalar-api-ruby/models/theme_update_params.rb rename to lib/scalar_api_ruby/models/theme_update_params.rb diff --git a/lib/scalar-api-ruby/models/timestamp.rb b/lib/scalar_api_ruby/models/timestamp.rb similarity index 100% rename from lib/scalar-api-ruby/models/timestamp.rb rename to lib/scalar_api_ruby/models/timestamp.rb diff --git a/lib/scalar-api-ruby/models/uid.rb b/lib/scalar_api_ruby/models/uid.rb similarity index 100% rename from lib/scalar-api-ruby/models/uid.rb rename to lib/scalar_api_ruby/models/uid.rb diff --git a/lib/scalar-api-ruby/models/version.rb b/lib/scalar_api_ruby/models/version.rb similarity index 100% rename from lib/scalar-api-ruby/models/version.rb rename to lib/scalar_api_ruby/models/version.rb diff --git a/lib/scalar-api-ruby/request_options.rb b/lib/scalar_api_ruby/request_options.rb similarity index 100% rename from lib/scalar-api-ruby/request_options.rb rename to lib/scalar_api_ruby/request_options.rb diff --git a/lib/scalar-api-ruby/resources/authentication.rb b/lib/scalar_api_ruby/resources/authentication.rb similarity index 100% rename from lib/scalar-api-ruby/resources/authentication.rb rename to lib/scalar_api_ruby/resources/authentication.rb diff --git a/lib/scalar-api-ruby/resources/login_portals.rb b/lib/scalar_api_ruby/resources/login_portals.rb similarity index 100% rename from lib/scalar-api-ruby/resources/login_portals.rb rename to lib/scalar_api_ruby/resources/login_portals.rb diff --git a/lib/scalar-api-ruby/resources/namespaces.rb b/lib/scalar_api_ruby/resources/namespaces.rb similarity index 100% rename from lib/scalar-api-ruby/resources/namespaces.rb rename to lib/scalar_api_ruby/resources/namespaces.rb diff --git a/lib/scalar-api-ruby/resources/registry.rb b/lib/scalar_api_ruby/resources/registry.rb similarity index 97% rename from lib/scalar-api-ruby/resources/registry.rb rename to lib/scalar_api_ruby/resources/registry.rb index 2b6ae55..dd83e6b 100644 --- a/lib/scalar-api-ruby/resources/registry.rb +++ b/lib/scalar_api_ruby/resources/registry.rb @@ -62,7 +62,7 @@ def create_api_document_access_group(slug, params) # Create a new API document version. # - # @overload create_api_document_version(slug, namespace:, document:, version:, force: nil, last_known_version_sha: nil, request_options: {}) + # @overload create_api_document_version(slug, namespace:, document:, version:, force: nil, request_options: {}) # # @param slug [String] Path param # @@ -74,8 +74,6 @@ def create_api_document_access_group(slug, params) # # @param force [Boolean] Body param # - # @param last_known_version_sha [String] Body param - # # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Scalar::Models::ManagedDocVersion] @@ -297,7 +295,7 @@ def update_api_document(slug, params) # Update the registry file content for an API document version. # - # @overload update_api_document_version(semver, namespace:, slug:, document:, last_known_version_sha: nil, request_options: {}) + # @overload update_api_document_version(semver, namespace:, slug:, document:, request_options: {}) # # @param semver [String] Path param # @@ -307,8 +305,6 @@ def update_api_document(slug, params) # # @param document [String] Body param # - # @param last_known_version_sha [String] Body param - # # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Scalar::Models::RegistryUpdateAPIDocumentVersionResponse] diff --git a/lib/scalar-api-ruby/resources/rules.rb b/lib/scalar_api_ruby/resources/rules.rb similarity index 100% rename from lib/scalar-api-ruby/resources/rules.rb rename to lib/scalar_api_ruby/resources/rules.rb diff --git a/lib/scalar-api-ruby/resources/scalar_docs.rb b/lib/scalar_api_ruby/resources/scalar_docs.rb similarity index 100% rename from lib/scalar-api-ruby/resources/scalar_docs.rb rename to lib/scalar_api_ruby/resources/scalar_docs.rb diff --git a/lib/scalar-api-ruby/resources/schemas.rb b/lib/scalar_api_ruby/resources/schemas.rb similarity index 100% rename from lib/scalar-api-ruby/resources/schemas.rb rename to lib/scalar_api_ruby/resources/schemas.rb diff --git a/lib/scalar-api-ruby/resources/schemas/access_group.rb b/lib/scalar_api_ruby/resources/schemas/access_group.rb similarity index 100% rename from lib/scalar-api-ruby/resources/schemas/access_group.rb rename to lib/scalar_api_ruby/resources/schemas/access_group.rb diff --git a/lib/scalar-api-ruby/resources/schemas/version.rb b/lib/scalar_api_ruby/resources/schemas/version.rb similarity index 93% rename from lib/scalar-api-ruby/resources/schemas/version.rb rename to lib/scalar_api_ruby/resources/schemas/version.rb index 0839efc..a595c1e 100644 --- a/lib/scalar-api-ruby/resources/schemas/version.rb +++ b/lib/scalar_api_ruby/resources/schemas/version.rb @@ -7,7 +7,7 @@ class Schemas class Version # Create a schema version. # - # @overload create(slug, namespace:, document:, version:, request_options: {}) + # @overload create(slug, namespace:, document:, version:, force: nil, request_options: {}) # # @param slug [String] Path param # @@ -17,9 +17,11 @@ class Version # # @param version [String] Body param # + # @param force [Boolean] Body param + # # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Scalar::Models::UID] + # @return [Scalar::Models::Schemas::VersionCreateResponse] # # @see Scalar::Models::Schemas::VersionCreateParams def create(slug, params) @@ -30,7 +32,7 @@ def create(slug, params) method: :post, path: ["v1/schemas/%1$s/%2$s/version", namespace, slug], body: parsed, - model: Scalar::UID, + model: Scalar::Models::Schemas::VersionCreateResponse, options: options ) end diff --git a/lib/scalar-api-ruby/resources/teams.rb b/lib/scalar_api_ruby/resources/teams.rb similarity index 100% rename from lib/scalar-api-ruby/resources/teams.rb rename to lib/scalar_api_ruby/resources/teams.rb diff --git a/lib/scalar-api-ruby/resources/themes.rb b/lib/scalar_api_ruby/resources/themes.rb similarity index 100% rename from lib/scalar-api-ruby/resources/themes.rb rename to lib/scalar_api_ruby/resources/themes.rb diff --git a/lib/scalar-api-ruby/version.rb b/lib/scalar_api_ruby/version.rb similarity index 100% rename from lib/scalar-api-ruby/version.rb rename to lib/scalar_api_ruby/version.rb diff --git a/rbi/scalar-api-ruby/client.rbi b/rbi/scalar_api_ruby/client.rbi similarity index 86% rename from rbi/scalar-api-ruby/client.rbi rename to rbi/scalar_api_ruby/client.rbi index 4498e58..c6a5904 100644 --- a/rbi/scalar-api-ruby/client.rbi +++ b/rbi/scalar_api_ruby/client.rbi @@ -10,9 +10,12 @@ module Scalar DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float) - sig { returns(String) } + sig { returns(T.nilable(String)) } attr_reader :bearer_auth + sig { returns(T.nilable(String)) } + attr_reader :o_auth2 + # Registry sig { returns(Scalar::Resources::Registry) } attr_reader :registry @@ -58,6 +61,7 @@ module Scalar sig do params( bearer_auth: T.nilable(String), + o_auth2: T.nilable(String), base_url: T.nilable(String), max_retries: Integer, timeout: Float, @@ -68,6 +72,9 @@ module Scalar def self.new( # Defaults to `ENV["BEARER_AUTH"]` bearer_auth: ENV["BEARER_AUTH"], + # Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. + # Each scope implies the weaker ones. Defaults to `ENV["SCALAR_O_AUTH2"]` + o_auth2: ENV["SCALAR_O_AUTH2"], # Override the default base URL for the API, e.g., # `"https://api.example.com/v2/"`. Defaults to `ENV["SCALAR_BASE_URL"]` base_url: ENV["SCALAR_BASE_URL"], diff --git a/rbi/scalar-api-ruby/errors.rbi b/rbi/scalar_api_ruby/errors.rbi similarity index 100% rename from rbi/scalar-api-ruby/errors.rbi rename to rbi/scalar_api_ruby/errors.rbi diff --git a/rbi/scalar-api-ruby/file_part.rbi b/rbi/scalar_api_ruby/file_part.rbi similarity index 100% rename from rbi/scalar-api-ruby/file_part.rbi rename to rbi/scalar_api_ruby/file_part.rbi diff --git a/rbi/scalar-api-ruby/internal.rbi b/rbi/scalar_api_ruby/internal.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal.rbi rename to rbi/scalar_api_ruby/internal.rbi diff --git a/rbi/scalar-api-ruby/internal/transport/base_client.rbi b/rbi/scalar_api_ruby/internal/transport/base_client.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/transport/base_client.rbi rename to rbi/scalar_api_ruby/internal/transport/base_client.rbi diff --git a/rbi/scalar-api-ruby/internal/transport/pooled_net_requester.rbi b/rbi/scalar_api_ruby/internal/transport/pooled_net_requester.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/transport/pooled_net_requester.rbi rename to rbi/scalar_api_ruby/internal/transport/pooled_net_requester.rbi diff --git a/rbi/scalar-api-ruby/internal/type/array_of.rbi b/rbi/scalar_api_ruby/internal/type/array_of.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/array_of.rbi rename to rbi/scalar_api_ruby/internal/type/array_of.rbi diff --git a/rbi/scalar-api-ruby/internal/type/base_model.rbi b/rbi/scalar_api_ruby/internal/type/base_model.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/base_model.rbi rename to rbi/scalar_api_ruby/internal/type/base_model.rbi diff --git a/rbi/scalar-api-ruby/internal/type/base_page.rbi b/rbi/scalar_api_ruby/internal/type/base_page.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/base_page.rbi rename to rbi/scalar_api_ruby/internal/type/base_page.rbi diff --git a/rbi/scalar-api-ruby/internal/type/boolean.rbi b/rbi/scalar_api_ruby/internal/type/boolean.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/boolean.rbi rename to rbi/scalar_api_ruby/internal/type/boolean.rbi diff --git a/rbi/scalar-api-ruby/internal/type/converter.rbi b/rbi/scalar_api_ruby/internal/type/converter.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/converter.rbi rename to rbi/scalar_api_ruby/internal/type/converter.rbi diff --git a/rbi/scalar-api-ruby/internal/type/enum.rbi b/rbi/scalar_api_ruby/internal/type/enum.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/enum.rbi rename to rbi/scalar_api_ruby/internal/type/enum.rbi diff --git a/rbi/scalar-api-ruby/internal/type/file_input.rbi b/rbi/scalar_api_ruby/internal/type/file_input.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/file_input.rbi rename to rbi/scalar_api_ruby/internal/type/file_input.rbi diff --git a/rbi/scalar-api-ruby/internal/type/hash_of.rbi b/rbi/scalar_api_ruby/internal/type/hash_of.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/hash_of.rbi rename to rbi/scalar_api_ruby/internal/type/hash_of.rbi diff --git a/rbi/scalar-api-ruby/internal/type/request_parameters.rbi b/rbi/scalar_api_ruby/internal/type/request_parameters.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/request_parameters.rbi rename to rbi/scalar_api_ruby/internal/type/request_parameters.rbi diff --git a/rbi/scalar-api-ruby/internal/type/union.rbi b/rbi/scalar_api_ruby/internal/type/union.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/union.rbi rename to rbi/scalar_api_ruby/internal/type/union.rbi diff --git a/rbi/scalar-api-ruby/internal/type/unknown.rbi b/rbi/scalar_api_ruby/internal/type/unknown.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/type/unknown.rbi rename to rbi/scalar_api_ruby/internal/type/unknown.rbi diff --git a/rbi/scalar-api-ruby/internal/util.rbi b/rbi/scalar_api_ruby/internal/util.rbi similarity index 100% rename from rbi/scalar-api-ruby/internal/util.rbi rename to rbi/scalar_api_ruby/internal/util.rbi diff --git a/rbi/scalar-api-ruby/models.rbi b/rbi/scalar_api_ruby/models.rbi similarity index 100% rename from rbi/scalar-api-ruby/models.rbi rename to rbi/scalar_api_ruby/models.rbi diff --git a/rbi/scalar-api-ruby/models/400.rbi b/rbi/scalar_api_ruby/models/400.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/400.rbi rename to rbi/scalar_api_ruby/models/400.rbi diff --git a/rbi/scalar-api-ruby/models/401.rbi b/rbi/scalar_api_ruby/models/401.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/401.rbi rename to rbi/scalar_api_ruby/models/401.rbi diff --git a/rbi/scalar-api-ruby/models/403.rbi b/rbi/scalar_api_ruby/models/403.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/403.rbi rename to rbi/scalar_api_ruby/models/403.rbi diff --git a/rbi/scalar-api-ruby/models/404.rbi b/rbi/scalar_api_ruby/models/404.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/404.rbi rename to rbi/scalar_api_ruby/models/404.rbi diff --git a/rbi/scalar-api-ruby/models/422.rbi b/rbi/scalar_api_ruby/models/422.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/422.rbi rename to rbi/scalar_api_ruby/models/422.rbi diff --git a/rbi/scalar-api-ruby/models/500.rbi b/rbi/scalar_api_ruby/models/500.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/500.rbi rename to rbi/scalar_api_ruby/models/500.rbi diff --git a/rbi/scalar-api-ruby/models/access_group.rbi b/rbi/scalar_api_ruby/models/access_group.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/access_group.rbi rename to rbi/scalar_api_ruby/models/access_group.rbi diff --git a/rbi/scalar-api-ruby/models/authentication_exchange_personal_token_params.rbi b/rbi/scalar_api_ruby/models/authentication_exchange_personal_token_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/authentication_exchange_personal_token_params.rbi rename to rbi/scalar_api_ruby/models/authentication_exchange_personal_token_params.rbi diff --git a/rbi/scalar-api-ruby/models/authentication_exchange_personal_token_response.rbi b/rbi/scalar_api_ruby/models/authentication_exchange_personal_token_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/authentication_exchange_personal_token_response.rbi rename to rbi/scalar_api_ruby/models/authentication_exchange_personal_token_response.rbi diff --git a/rbi/scalar-api-ruby/models/authentication_list_current_user_params.rbi b/rbi/scalar_api_ruby/models/authentication_list_current_user_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/authentication_list_current_user_params.rbi rename to rbi/scalar_api_ruby/models/authentication_list_current_user_params.rbi diff --git a/rbi/scalar-api-ruby/models/authentication_list_current_user_response.rbi b/rbi/scalar_api_ruby/models/authentication_list_current_user_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/authentication_list_current_user_response.rbi rename to rbi/scalar_api_ruby/models/authentication_list_current_user_response.rbi diff --git a/rbi/scalar-api-ruby/models/login_portal_create_params.rbi b/rbi/scalar_api_ruby/models/login_portal_create_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/login_portal_create_params.rbi rename to rbi/scalar_api_ruby/models/login_portal_create_params.rbi diff --git a/rbi/scalar-api-ruby/models/login_portal_delete_params.rbi b/rbi/scalar_api_ruby/models/login_portal_delete_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/login_portal_delete_params.rbi rename to rbi/scalar_api_ruby/models/login_portal_delete_params.rbi diff --git a/rbi/scalar-api-ruby/models/login_portal_email.rbi b/rbi/scalar_api_ruby/models/login_portal_email.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/login_portal_email.rbi rename to rbi/scalar_api_ruby/models/login_portal_email.rbi diff --git a/rbi/scalar-api-ruby/models/login_portal_list_params.rbi b/rbi/scalar_api_ruby/models/login_portal_list_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/login_portal_list_params.rbi rename to rbi/scalar_api_ruby/models/login_portal_list_params.rbi diff --git a/rbi/scalar-api-ruby/models/login_portal_list_response.rbi b/rbi/scalar_api_ruby/models/login_portal_list_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/login_portal_list_response.rbi rename to rbi/scalar_api_ruby/models/login_portal_list_response.rbi diff --git a/rbi/scalar-api-ruby/models/login_portal_page.rbi b/rbi/scalar_api_ruby/models/login_portal_page.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/login_portal_page.rbi rename to rbi/scalar_api_ruby/models/login_portal_page.rbi diff --git a/rbi/scalar-api-ruby/models/login_portal_retrieve_params.rbi b/rbi/scalar_api_ruby/models/login_portal_retrieve_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/login_portal_retrieve_params.rbi rename to rbi/scalar_api_ruby/models/login_portal_retrieve_params.rbi diff --git a/rbi/scalar-api-ruby/models/login_portal_retrieve_response.rbi b/rbi/scalar_api_ruby/models/login_portal_retrieve_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/login_portal_retrieve_response.rbi rename to rbi/scalar_api_ruby/models/login_portal_retrieve_response.rbi diff --git a/rbi/scalar-api-ruby/models/login_portal_update_params.rbi b/rbi/scalar_api_ruby/models/login_portal_update_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/login_portal_update_params.rbi rename to rbi/scalar_api_ruby/models/login_portal_update_params.rbi diff --git a/rbi/scalar-api-ruby/models/managed_doc_version.rbi b/rbi/scalar_api_ruby/models/managed_doc_version.rbi similarity index 95% rename from rbi/scalar-api-ruby/models/managed_doc_version.rbi rename to rbi/scalar_api_ruby/models/managed_doc_version.rbi index db5cfa4..316b3c2 100644 --- a/rbi/scalar-api-ruby/models/managed_doc_version.rbi +++ b/rbi/scalar_api_ruby/models/managed_doc_version.rbi @@ -16,6 +16,9 @@ module Scalar end attr_accessor :embed_status + sig { returns(T.nilable(Integer)) } + attr_accessor :endpoint_count + sig { returns(T::Array[String]) } attr_accessor :tags @@ -42,12 +45,6 @@ module Scalar end attr_writer :tools - sig { returns(T.nilable(String)) } - attr_reader :version_sha - - sig { params(version_sha: String).void } - attr_writer :version_sha - sig { returns(T.nilable(String)) } attr_reader :yaml_sha @@ -59,26 +56,26 @@ module Scalar created_at: Float, embed_status: T.nilable(Scalar::ManagedDocVersion::EmbedStatus::OrSymbol), + endpoint_count: T.nilable(Integer), tags: T::Array[String], uid: String, upgraded: T::Boolean, version: String, json_sha: String, tools: T::Array[Scalar::ManagedDocVersion::Tool::OrHash], - version_sha: String, yaml_sha: String ).returns(T.attached_class) end def self.new( created_at:, embed_status:, + endpoint_count:, tags:, uid:, upgraded:, version:, json_sha: nil, tools: nil, - version_sha: nil, yaml_sha: nil ) end @@ -89,13 +86,13 @@ module Scalar created_at: Float, embed_status: T.nilable(Scalar::ManagedDocVersion::EmbedStatus::TaggedSymbol), + endpoint_count: T.nilable(Integer), tags: T::Array[String], uid: String, upgraded: T::Boolean, version: String, json_sha: String, tools: T::Array[Scalar::ManagedDocVersion::Tool], - version_sha: String, yaml_sha: String } ) @@ -229,6 +226,8 @@ module Scalar T.let(:post, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) PUT = T.let(:put, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) + QUERY = + T.let(:query, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) TRACE = T.let(:trace, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) diff --git a/rbi/scalar-api-ruby/models/namespace.rbi b/rbi/scalar_api_ruby/models/namespace.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/namespace.rbi rename to rbi/scalar_api_ruby/models/namespace.rbi diff --git a/rbi/scalar-api-ruby/models/namespace_list_params.rbi b/rbi/scalar_api_ruby/models/namespace_list_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/namespace_list_params.rbi rename to rbi/scalar_api_ruby/models/namespace_list_params.rbi diff --git a/rbi/scalar-api-ruby/models/namespace_list_response.rbi b/rbi/scalar_api_ruby/models/namespace_list_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/namespace_list_response.rbi rename to rbi/scalar_api_ruby/models/namespace_list_response.rbi diff --git a/rbi/scalar-api-ruby/models/nanoid.rbi b/rbi/scalar_api_ruby/models/nanoid.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/nanoid.rbi rename to rbi/scalar_api_ruby/models/nanoid.rbi diff --git a/rbi/scalar-api-ruby/models/registry_create_api_document_access_group_params.rbi b/rbi/scalar_api_ruby/models/registry_create_api_document_access_group_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_create_api_document_access_group_params.rbi rename to rbi/scalar_api_ruby/models/registry_create_api_document_access_group_params.rbi diff --git a/rbi/scalar-api-ruby/models/registry_create_api_document_params.rbi b/rbi/scalar_api_ruby/models/registry_create_api_document_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_create_api_document_params.rbi rename to rbi/scalar_api_ruby/models/registry_create_api_document_params.rbi diff --git a/rbi/scalar-api-ruby/models/registry_create_api_document_response.rbi b/rbi/scalar_api_ruby/models/registry_create_api_document_response.rbi similarity index 80% rename from rbi/scalar-api-ruby/models/registry_create_api_document_response.rbi rename to rbi/scalar_api_ruby/models/registry_create_api_document_response.rbi index 2f20f30..b8ed255 100644 --- a/rbi/scalar-api-ruby/models/registry_create_api_document_response.rbi +++ b/rbi/scalar_api_ruby/models/registry_create_api_document_response.rbi @@ -20,9 +20,6 @@ module Scalar sig { returns(String) } attr_accessor :uid - sig { returns(String) } - attr_accessor :version_sha - sig { returns(String) } attr_accessor :version_uid @@ -34,19 +31,11 @@ module Scalar json_sha: String, title: String, uid: String, - version_sha: String, version_uid: String, yaml_sha: String ).returns(T.attached_class) end - def self.new( - json_sha:, - title:, - uid:, - version_sha:, - version_uid:, - yaml_sha: - ) + def self.new(json_sha:, title:, uid:, version_uid:, yaml_sha:) end sig do @@ -55,7 +44,6 @@ module Scalar json_sha: String, title: String, uid: String, - version_sha: String, version_uid: String, yaml_sha: String } diff --git a/rbi/scalar-api-ruby/models/registry_create_api_document_version_params.rbi b/rbi/scalar_api_ruby/models/registry_create_api_document_version_params.rbi similarity index 83% rename from rbi/scalar-api-ruby/models/registry_create_api_document_version_params.rbi rename to rbi/scalar_api_ruby/models/registry_create_api_document_version_params.rbi index a32bea1..c6ef746 100644 --- a/rbi/scalar-api-ruby/models/registry_create_api_document_version_params.rbi +++ b/rbi/scalar_api_ruby/models/registry_create_api_document_version_params.rbi @@ -32,12 +32,6 @@ module Scalar sig { params(force: T::Boolean).void } attr_writer :force - sig { returns(T.nilable(String)) } - attr_reader :last_known_version_sha - - sig { params(last_known_version_sha: String).void } - attr_writer :last_known_version_sha - sig do params( namespace: String, @@ -45,7 +39,6 @@ module Scalar document: String, version: String, force: T::Boolean, - last_known_version_sha: String, request_options: Scalar::RequestOptions::OrHash ).returns(T.attached_class) end @@ -55,7 +48,6 @@ module Scalar document:, version:, force: nil, - last_known_version_sha: nil, request_options: {} ) end @@ -68,7 +60,6 @@ module Scalar document: String, version: String, force: T::Boolean, - last_known_version_sha: String, request_options: Scalar::RequestOptions } ) diff --git a/rbi/scalar-api-ruby/models/registry_delete_api_document_access_group_params.rbi b/rbi/scalar_api_ruby/models/registry_delete_api_document_access_group_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_delete_api_document_access_group_params.rbi rename to rbi/scalar_api_ruby/models/registry_delete_api_document_access_group_params.rbi diff --git a/rbi/scalar-api-ruby/models/registry_delete_api_document_params.rbi b/rbi/scalar_api_ruby/models/registry_delete_api_document_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_delete_api_document_params.rbi rename to rbi/scalar_api_ruby/models/registry_delete_api_document_params.rbi diff --git a/rbi/scalar-api-ruby/models/registry_delete_api_document_version_params.rbi b/rbi/scalar_api_ruby/models/registry_delete_api_document_version_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_delete_api_document_version_params.rbi rename to rbi/scalar_api_ruby/models/registry_delete_api_document_version_params.rbi diff --git a/rbi/scalar-api-ruby/models/registry_list_all_api_documents_params.rbi b/rbi/scalar_api_ruby/models/registry_list_all_api_documents_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_list_all_api_documents_params.rbi rename to rbi/scalar_api_ruby/models/registry_list_all_api_documents_params.rbi diff --git a/rbi/scalar-api-ruby/models/registry_list_all_api_documents_response.rbi b/rbi/scalar_api_ruby/models/registry_list_all_api_documents_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_list_all_api_documents_response.rbi rename to rbi/scalar_api_ruby/models/registry_list_all_api_documents_response.rbi diff --git a/rbi/scalar-api-ruby/models/registry_list_api_document_version_metadata_params.rbi b/rbi/scalar_api_ruby/models/registry_list_api_document_version_metadata_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_list_api_document_version_metadata_params.rbi rename to rbi/scalar_api_ruby/models/registry_list_api_document_version_metadata_params.rbi diff --git a/rbi/scalar-api-ruby/models/registry_list_api_documents_params.rbi b/rbi/scalar_api_ruby/models/registry_list_api_documents_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_list_api_documents_params.rbi rename to rbi/scalar_api_ruby/models/registry_list_api_documents_params.rbi diff --git a/rbi/scalar-api-ruby/models/registry_list_api_documents_response.rbi b/rbi/scalar_api_ruby/models/registry_list_api_documents_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_list_api_documents_response.rbi rename to rbi/scalar_api_ruby/models/registry_list_api_documents_response.rbi diff --git a/rbi/scalar-api-ruby/models/registry_retrieve_api_document_version_params.rbi b/rbi/scalar_api_ruby/models/registry_retrieve_api_document_version_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_retrieve_api_document_version_params.rbi rename to rbi/scalar_api_ruby/models/registry_retrieve_api_document_version_params.rbi diff --git a/rbi/scalar-api-ruby/models/registry_retrieve_api_document_version_response.rbi b/rbi/scalar_api_ruby/models/registry_retrieve_api_document_version_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_retrieve_api_document_version_response.rbi rename to rbi/scalar_api_ruby/models/registry_retrieve_api_document_version_response.rbi diff --git a/rbi/scalar-api-ruby/models/registry_update_api_document_params.rbi b/rbi/scalar_api_ruby/models/registry_update_api_document_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/registry_update_api_document_params.rbi rename to rbi/scalar_api_ruby/models/registry_update_api_document_params.rbi diff --git a/rbi/scalar-api-ruby/models/registry_update_api_document_version_params.rbi b/rbi/scalar_api_ruby/models/registry_update_api_document_version_params.rbi similarity index 73% rename from rbi/scalar-api-ruby/models/registry_update_api_document_version_params.rbi rename to rbi/scalar_api_ruby/models/registry_update_api_document_version_params.rbi index fe5f020..4da71a8 100644 --- a/rbi/scalar-api-ruby/models/registry_update_api_document_version_params.rbi +++ b/rbi/scalar_api_ruby/models/registry_update_api_document_version_params.rbi @@ -26,30 +26,16 @@ module Scalar sig { returns(String) } attr_accessor :document - sig { returns(T.nilable(String)) } - attr_reader :last_known_version_sha - - sig { params(last_known_version_sha: String).void } - attr_writer :last_known_version_sha - sig do params( namespace: String, slug: String, semver: String, document: String, - last_known_version_sha: String, request_options: Scalar::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new( - namespace:, - slug:, - semver:, - document:, - last_known_version_sha: nil, - request_options: {} - ) + def self.new(namespace:, slug:, semver:, document:, request_options: {}) end sig do @@ -59,7 +45,6 @@ module Scalar slug: String, semver: String, document: String, - last_known_version_sha: String, request_options: Scalar::RequestOptions } ) diff --git a/rbi/scalar-api-ruby/models/registry_update_api_document_version_response.rbi b/rbi/scalar_api_ruby/models/registry_update_api_document_version_response.rbi similarity index 58% rename from rbi/scalar-api-ruby/models/registry_update_api_document_version_response.rbi rename to rbi/scalar_api_ruby/models/registry_update_api_document_version_response.rbi index 7e52803..afa4479 100644 --- a/rbi/scalar-api-ruby/models/registry_update_api_document_version_response.rbi +++ b/rbi/scalar_api_ruby/models/registry_update_api_document_version_response.rbi @@ -14,25 +14,16 @@ module Scalar sig { returns(String) } attr_accessor :json_sha - sig { returns(String) } - attr_accessor :version_sha - sig { returns(String) } attr_accessor :yaml_sha sig do - params(json_sha: String, version_sha: String, yaml_sha: String).returns( - T.attached_class - ) + params(json_sha: String, yaml_sha: String).returns(T.attached_class) end - def self.new(json_sha:, version_sha:, yaml_sha:) + def self.new(json_sha:, yaml_sha:) end - sig do - override.returns( - { json_sha: String, version_sha: String, yaml_sha: String } - ) - end + sig { override.returns({ json_sha: String, yaml_sha: String }) } def to_hash end end diff --git a/rbi/scalar-api-ruby/models/rule_create_ruleset_access_group_params.rbi b/rbi/scalar_api_ruby/models/rule_create_ruleset_access_group_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/rule_create_ruleset_access_group_params.rbi rename to rbi/scalar_api_ruby/models/rule_create_ruleset_access_group_params.rbi diff --git a/rbi/scalar-api-ruby/models/rule_create_ruleset_params.rbi b/rbi/scalar_api_ruby/models/rule_create_ruleset_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/rule_create_ruleset_params.rbi rename to rbi/scalar_api_ruby/models/rule_create_ruleset_params.rbi diff --git a/rbi/scalar-api-ruby/models/rule_delete_ruleset_access_group_params.rbi b/rbi/scalar_api_ruby/models/rule_delete_ruleset_access_group_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/rule_delete_ruleset_access_group_params.rbi rename to rbi/scalar_api_ruby/models/rule_delete_ruleset_access_group_params.rbi diff --git a/rbi/scalar-api-ruby/models/rule_delete_ruleset_params.rbi b/rbi/scalar_api_ruby/models/rule_delete_ruleset_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/rule_delete_ruleset_params.rbi rename to rbi/scalar_api_ruby/models/rule_delete_ruleset_params.rbi diff --git a/rbi/scalar-api-ruby/models/rule_list_rulesets_params.rbi b/rbi/scalar_api_ruby/models/rule_list_rulesets_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/rule_list_rulesets_params.rbi rename to rbi/scalar_api_ruby/models/rule_list_rulesets_params.rbi diff --git a/rbi/scalar-api-ruby/models/rule_list_rulesets_response.rbi b/rbi/scalar_api_ruby/models/rule_list_rulesets_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/rule_list_rulesets_response.rbi rename to rbi/scalar_api_ruby/models/rule_list_rulesets_response.rbi diff --git a/rbi/scalar-api-ruby/models/rule_retrieve_ruleset_document_params.rbi b/rbi/scalar_api_ruby/models/rule_retrieve_ruleset_document_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/rule_retrieve_ruleset_document_params.rbi rename to rbi/scalar_api_ruby/models/rule_retrieve_ruleset_document_params.rbi diff --git a/rbi/scalar-api-ruby/models/rule_retrieve_ruleset_document_response.rbi b/rbi/scalar_api_ruby/models/rule_retrieve_ruleset_document_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/rule_retrieve_ruleset_document_response.rbi rename to rbi/scalar_api_ruby/models/rule_retrieve_ruleset_document_response.rbi diff --git a/rbi/scalar-api-ruby/models/rule_update_ruleset_params.rbi b/rbi/scalar_api_ruby/models/rule_update_ruleset_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/rule_update_ruleset_params.rbi rename to rbi/scalar_api_ruby/models/rule_update_ruleset_params.rbi diff --git a/rbi/scalar-api-ruby/models/scalar_doc_create_guide_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_create_guide_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/scalar_doc_create_guide_params.rbi rename to rbi/scalar_api_ruby/models/scalar_doc_create_guide_params.rbi diff --git a/rbi/scalar-api-ruby/models/scalar_doc_create_guide_response.rbi b/rbi/scalar_api_ruby/models/scalar_doc_create_guide_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/scalar_doc_create_guide_response.rbi rename to rbi/scalar_api_ruby/models/scalar_doc_create_guide_response.rbi diff --git a/rbi/scalar-api-ruby/models/scalar_doc_list_guides_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_guides_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/scalar_doc_list_guides_params.rbi rename to rbi/scalar_api_ruby/models/scalar_doc_list_guides_params.rbi diff --git a/rbi/scalar-api-ruby/models/scalar_doc_list_guides_response.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_guides_response.rbi similarity index 95% rename from rbi/scalar-api-ruby/models/scalar_doc_list_guides_response.rbi rename to rbi/scalar_api_ruby/models/scalar_doc_list_guides_response.rbi index 244b9b6..be945d6 100644 --- a/rbi/scalar-api-ruby/models/scalar_doc_list_guides_response.rbi +++ b/rbi/scalar_api_ruby/models/scalar_doc_list_guides_response.rbi @@ -39,6 +39,9 @@ module Scalar sig { returns(T::Boolean) } attr_accessor :agent_enabled + sig { returns(T::Boolean) } + attr_accessor :analytics_enabled + sig { returns(Integer) } attr_accessor :created_at @@ -72,6 +75,9 @@ module Scalar sig { returns(Integer) } attr_accessor :updated_at + sig { returns(String) } + attr_accessor :user_info_hook_url + sig do returns( T.nilable(Scalar::Models::ScalarDocListGuidesResponseItem::Repository) @@ -104,6 +110,7 @@ module Scalar ), active_theme_id: String, agent_enabled: T::Boolean, + analytics_enabled: T::Boolean, created_at: Integer, is_private: T::Boolean, last_published: T.nilable(Integer), @@ -115,6 +122,7 @@ module Scalar slug: String, uid: String, updated_at: Integer, + user_info_hook_url: String, repository: T.nilable( Scalar::Models::ScalarDocListGuidesResponseItem::Repository::OrHash @@ -127,6 +135,7 @@ module Scalar active_deployment:, active_theme_id:, agent_enabled:, + analytics_enabled:, created_at:, is_private:, last_published:, @@ -138,6 +147,7 @@ module Scalar slug:, uid:, updated_at:, + user_info_hook_url:, repository: nil, typesense_id: nil ) @@ -153,6 +163,7 @@ module Scalar ), active_theme_id: String, agent_enabled: T::Boolean, + analytics_enabled: T::Boolean, created_at: Integer, is_private: T::Boolean, last_published: T.nilable(Integer), @@ -164,6 +175,7 @@ module Scalar slug: String, uid: String, updated_at: Integer, + user_info_hook_url: String, repository: T.nilable( Scalar::Models::ScalarDocListGuidesResponseItem::Repository diff --git a/rbi/scalar-api-ruby/models/scalar_doc_publish_guide_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_publish_guide_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/scalar_doc_publish_guide_params.rbi rename to rbi/scalar_api_ruby/models/scalar_doc_publish_guide_params.rbi diff --git a/rbi/scalar-api-ruby/models/scalar_doc_publish_guide_response.rbi b/rbi/scalar_api_ruby/models/scalar_doc_publish_guide_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/scalar_doc_publish_guide_response.rbi rename to rbi/scalar_api_ruby/models/scalar_doc_publish_guide_response.rbi diff --git a/rbi/scalar-api-ruby/models/schema_create_params.rbi b/rbi/scalar_api_ruby/models/schema_create_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/schema_create_params.rbi rename to rbi/scalar_api_ruby/models/schema_create_params.rbi diff --git a/rbi/scalar-api-ruby/models/schema_delete_params.rbi b/rbi/scalar_api_ruby/models/schema_delete_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/schema_delete_params.rbi rename to rbi/scalar_api_ruby/models/schema_delete_params.rbi diff --git a/rbi/scalar-api-ruby/models/schema_list_params.rbi b/rbi/scalar_api_ruby/models/schema_list_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/schema_list_params.rbi rename to rbi/scalar_api_ruby/models/schema_list_params.rbi diff --git a/rbi/scalar-api-ruby/models/schema_list_response.rbi b/rbi/scalar_api_ruby/models/schema_list_response.rbi similarity index 80% rename from rbi/scalar-api-ruby/models/schema_list_response.rbi rename to rbi/scalar_api_ruby/models/schema_list_response.rbi index a19b187..2c4a97b 100644 --- a/rbi/scalar-api-ruby/models/schema_list_response.rbi +++ b/rbi/scalar_api_ruby/models/schema_list_response.rbi @@ -92,15 +92,36 @@ module Scalar sig { returns(String) } attr_accessor :version + sig { returns(T.nilable(String)) } + attr_reader :json_sha + + sig { params(json_sha: String).void } + attr_writer :json_sha + + sig { returns(T.nilable(String)) } + attr_reader :yaml_sha + + sig { params(yaml_sha: String).void } + attr_writer :yaml_sha + sig do params( created_at: Integer, uid: String, updated_at: Integer, - version: String + version: String, + json_sha: String, + yaml_sha: String ).returns(T.attached_class) end - def self.new(created_at:, uid:, updated_at:, version:) + def self.new( + created_at:, + uid:, + updated_at:, + version:, + json_sha: nil, + yaml_sha: nil + ) end sig do @@ -109,7 +130,9 @@ module Scalar created_at: Integer, uid: String, updated_at: Integer, - version: String + version: String, + json_sha: String, + yaml_sha: String } ) end diff --git a/rbi/scalar-api-ruby/models/schema_update_params.rbi b/rbi/scalar_api_ruby/models/schema_update_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/schema_update_params.rbi rename to rbi/scalar_api_ruby/models/schema_update_params.rbi diff --git a/rbi/scalar-api-ruby/models/schemas/access_group_create_params.rbi b/rbi/scalar_api_ruby/models/schemas/access_group_create_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/schemas/access_group_create_params.rbi rename to rbi/scalar_api_ruby/models/schemas/access_group_create_params.rbi diff --git a/rbi/scalar-api-ruby/models/schemas/access_group_delete_params.rbi b/rbi/scalar_api_ruby/models/schemas/access_group_delete_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/schemas/access_group_delete_params.rbi rename to rbi/scalar_api_ruby/models/schemas/access_group_delete_params.rbi diff --git a/rbi/scalar-api-ruby/models/schemas/version_create_params.rbi b/rbi/scalar_api_ruby/models/schemas/version_create_params.rbi similarity index 85% rename from rbi/scalar-api-ruby/models/schemas/version_create_params.rbi rename to rbi/scalar_api_ruby/models/schemas/version_create_params.rbi index 5201ad2..665e3b7 100644 --- a/rbi/scalar-api-ruby/models/schemas/version_create_params.rbi +++ b/rbi/scalar_api_ruby/models/schemas/version_create_params.rbi @@ -27,12 +27,19 @@ module Scalar sig { returns(String) } attr_accessor :version + sig { returns(T.nilable(T::Boolean)) } + attr_reader :force + + sig { params(force: T::Boolean).void } + attr_writer :force + sig do params( namespace: String, slug: String, document: String, version: String, + force: T::Boolean, request_options: Scalar::RequestOptions::OrHash ).returns(T.attached_class) end @@ -41,6 +48,7 @@ module Scalar slug:, document:, version:, + force: nil, request_options: {} ) end @@ -52,6 +60,7 @@ module Scalar slug: String, document: String, version: String, + force: T::Boolean, request_options: Scalar::RequestOptions } ) diff --git a/rbi/scalar_api_ruby/models/schemas/version_create_response.rbi b/rbi/scalar_api_ruby/models/schemas/version_create_response.rbi new file mode 100644 index 0000000..2661880 --- /dev/null +++ b/rbi/scalar_api_ruby/models/schemas/version_create_response.rbi @@ -0,0 +1,28 @@ +# typed: strong + +module Scalar + module Models + module Schemas + class VersionCreateResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::Schemas::VersionCreateResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :uid + + sig { params(uid: String).returns(T.attached_class) } + def self.new(uid:) + end + + sig { override.returns({ uid: String }) } + def to_hash + end + end + end + end +end diff --git a/rbi/scalar-api-ruby/models/schemas/version_delete_params.rbi b/rbi/scalar_api_ruby/models/schemas/version_delete_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/schemas/version_delete_params.rbi rename to rbi/scalar_api_ruby/models/schemas/version_delete_params.rbi diff --git a/rbi/scalar-api-ruby/models/schemas/version_retrieve_params.rbi b/rbi/scalar_api_ruby/models/schemas/version_retrieve_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/schemas/version_retrieve_params.rbi rename to rbi/scalar_api_ruby/models/schemas/version_retrieve_params.rbi diff --git a/rbi/scalar-api-ruby/models/schemas/version_retrieve_response.rbi b/rbi/scalar_api_ruby/models/schemas/version_retrieve_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/schemas/version_retrieve_response.rbi rename to rbi/scalar_api_ruby/models/schemas/version_retrieve_response.rbi diff --git a/rbi/scalar-api-ruby/models/slug.rbi b/rbi/scalar_api_ruby/models/slug.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/slug.rbi rename to rbi/scalar_api_ruby/models/slug.rbi diff --git a/rbi/scalar-api-ruby/models/team_list_params.rbi b/rbi/scalar_api_ruby/models/team_list_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/team_list_params.rbi rename to rbi/scalar_api_ruby/models/team_list_params.rbi diff --git a/rbi/scalar-api-ruby/models/team_list_response.rbi b/rbi/scalar_api_ruby/models/team_list_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/team_list_response.rbi rename to rbi/scalar_api_ruby/models/team_list_response.rbi diff --git a/rbi/scalar-api-ruby/models/theme_create_params.rbi b/rbi/scalar_api_ruby/models/theme_create_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/theme_create_params.rbi rename to rbi/scalar_api_ruby/models/theme_create_params.rbi diff --git a/rbi/scalar-api-ruby/models/theme_delete_params.rbi b/rbi/scalar_api_ruby/models/theme_delete_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/theme_delete_params.rbi rename to rbi/scalar_api_ruby/models/theme_delete_params.rbi diff --git a/rbi/scalar-api-ruby/models/theme_list_params.rbi b/rbi/scalar_api_ruby/models/theme_list_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/theme_list_params.rbi rename to rbi/scalar_api_ruby/models/theme_list_params.rbi diff --git a/rbi/scalar-api-ruby/models/theme_list_response.rbi b/rbi/scalar_api_ruby/models/theme_list_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/theme_list_response.rbi rename to rbi/scalar_api_ruby/models/theme_list_response.rbi diff --git a/rbi/scalar-api-ruby/models/theme_replace_document_params.rbi b/rbi/scalar_api_ruby/models/theme_replace_document_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/theme_replace_document_params.rbi rename to rbi/scalar_api_ruby/models/theme_replace_document_params.rbi diff --git a/rbi/scalar-api-ruby/models/theme_retrieve_params.rbi b/rbi/scalar_api_ruby/models/theme_retrieve_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/theme_retrieve_params.rbi rename to rbi/scalar_api_ruby/models/theme_retrieve_params.rbi diff --git a/rbi/scalar-api-ruby/models/theme_retrieve_response.rbi b/rbi/scalar_api_ruby/models/theme_retrieve_response.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/theme_retrieve_response.rbi rename to rbi/scalar_api_ruby/models/theme_retrieve_response.rbi diff --git a/rbi/scalar-api-ruby/models/theme_update_params.rbi b/rbi/scalar_api_ruby/models/theme_update_params.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/theme_update_params.rbi rename to rbi/scalar_api_ruby/models/theme_update_params.rbi diff --git a/rbi/scalar-api-ruby/models/timestamp.rbi b/rbi/scalar_api_ruby/models/timestamp.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/timestamp.rbi rename to rbi/scalar_api_ruby/models/timestamp.rbi diff --git a/rbi/scalar-api-ruby/models/uid.rbi b/rbi/scalar_api_ruby/models/uid.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/uid.rbi rename to rbi/scalar_api_ruby/models/uid.rbi diff --git a/rbi/scalar-api-ruby/models/version.rbi b/rbi/scalar_api_ruby/models/version.rbi similarity index 100% rename from rbi/scalar-api-ruby/models/version.rbi rename to rbi/scalar_api_ruby/models/version.rbi diff --git a/rbi/scalar-api-ruby/request_options.rbi b/rbi/scalar_api_ruby/request_options.rbi similarity index 100% rename from rbi/scalar-api-ruby/request_options.rbi rename to rbi/scalar_api_ruby/request_options.rbi diff --git a/rbi/scalar-api-ruby/resources/authentication.rbi b/rbi/scalar_api_ruby/resources/authentication.rbi similarity index 100% rename from rbi/scalar-api-ruby/resources/authentication.rbi rename to rbi/scalar_api_ruby/resources/authentication.rbi diff --git a/rbi/scalar-api-ruby/resources/login_portals.rbi b/rbi/scalar_api_ruby/resources/login_portals.rbi similarity index 100% rename from rbi/scalar-api-ruby/resources/login_portals.rbi rename to rbi/scalar_api_ruby/resources/login_portals.rbi diff --git a/rbi/scalar-api-ruby/resources/namespaces.rbi b/rbi/scalar_api_ruby/resources/namespaces.rbi similarity index 100% rename from rbi/scalar-api-ruby/resources/namespaces.rbi rename to rbi/scalar_api_ruby/resources/namespaces.rbi diff --git a/rbi/scalar-api-ruby/resources/registry.rbi b/rbi/scalar_api_ruby/resources/registry.rbi similarity index 96% rename from rbi/scalar-api-ruby/resources/registry.rbi rename to rbi/scalar_api_ruby/resources/registry.rbi index b7fc177..eec1e76 100644 --- a/rbi/scalar-api-ruby/resources/registry.rbi +++ b/rbi/scalar_api_ruby/resources/registry.rbi @@ -59,7 +59,6 @@ module Scalar document: String, version: String, force: T::Boolean, - last_known_version_sha: String, request_options: Scalar::RequestOptions::OrHash ).returns(Scalar::ManagedDocVersion) end @@ -74,8 +73,6 @@ module Scalar version:, # Body param force: nil, - # Body param - last_known_version_sha: nil, request_options: {} ) end @@ -220,7 +217,6 @@ module Scalar namespace: String, slug: String, document: String, - last_known_version_sha: String, request_options: Scalar::RequestOptions::OrHash ).returns(Scalar::Models::RegistryUpdateAPIDocumentVersionResponse) end @@ -233,8 +229,6 @@ module Scalar slug:, # Body param document:, - # Body param - last_known_version_sha: nil, request_options: {} ) end diff --git a/rbi/scalar-api-ruby/resources/rules.rbi b/rbi/scalar_api_ruby/resources/rules.rbi similarity index 100% rename from rbi/scalar-api-ruby/resources/rules.rbi rename to rbi/scalar_api_ruby/resources/rules.rbi diff --git a/rbi/scalar-api-ruby/resources/scalar_docs.rbi b/rbi/scalar_api_ruby/resources/scalar_docs.rbi similarity index 100% rename from rbi/scalar-api-ruby/resources/scalar_docs.rbi rename to rbi/scalar_api_ruby/resources/scalar_docs.rbi diff --git a/rbi/scalar-api-ruby/resources/schemas.rbi b/rbi/scalar_api_ruby/resources/schemas.rbi similarity index 100% rename from rbi/scalar-api-ruby/resources/schemas.rbi rename to rbi/scalar_api_ruby/resources/schemas.rbi diff --git a/rbi/scalar-api-ruby/resources/schemas/access_group.rbi b/rbi/scalar_api_ruby/resources/schemas/access_group.rbi similarity index 100% rename from rbi/scalar-api-ruby/resources/schemas/access_group.rbi rename to rbi/scalar_api_ruby/resources/schemas/access_group.rbi diff --git a/rbi/scalar-api-ruby/resources/schemas/version.rbi b/rbi/scalar_api_ruby/resources/schemas/version.rbi similarity index 91% rename from rbi/scalar-api-ruby/resources/schemas/version.rbi rename to rbi/scalar_api_ruby/resources/schemas/version.rbi index 28a6d50..7a13a2f 100644 --- a/rbi/scalar-api-ruby/resources/schemas/version.rbi +++ b/rbi/scalar_api_ruby/resources/schemas/version.rbi @@ -12,8 +12,9 @@ module Scalar namespace: String, document: String, version: String, + force: T::Boolean, request_options: Scalar::RequestOptions::OrHash - ).returns(Scalar::UID) + ).returns(Scalar::Models::Schemas::VersionCreateResponse) end def create( # Path param @@ -24,6 +25,8 @@ module Scalar document:, # Body param version:, + # Body param + force: nil, request_options: {} ) end diff --git a/rbi/scalar-api-ruby/resources/teams.rbi b/rbi/scalar_api_ruby/resources/teams.rbi similarity index 100% rename from rbi/scalar-api-ruby/resources/teams.rbi rename to rbi/scalar_api_ruby/resources/teams.rbi diff --git a/rbi/scalar-api-ruby/resources/themes.rbi b/rbi/scalar_api_ruby/resources/themes.rbi similarity index 100% rename from rbi/scalar-api-ruby/resources/themes.rbi rename to rbi/scalar_api_ruby/resources/themes.rbi diff --git a/rbi/scalar-api-ruby/version.rbi b/rbi/scalar_api_ruby/version.rbi similarity index 100% rename from rbi/scalar-api-ruby/version.rbi rename to rbi/scalar_api_ruby/version.rbi diff --git a/release-please-config.json b/release-please-config.json index d5b9aa1..1dc13a6 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -2,9 +2,8 @@ "packages": { ".": { "release-type": "ruby", - "component": "scalar-api-ruby", + "component": "scalar_api_ruby", "extra-files": [ - "lib/scalar-api-ruby/version.rb", "README.md", "SKILL.md", ".claude/skills/scalar-ruby-sdk/SKILL.md" diff --git a/scalar-sdk.manifest.json b/scalar-sdk.manifest.json index 7a423b0..be91ffa 100644 --- a/scalar-sdk.manifest.json +++ b/scalar-sdk.manifest.json @@ -1,7 +1,7 @@ { "name": "Scalar", "slug": "scalar", - "generatorVersion": "0.32.14", + "generatorVersion": "0.36.0", "servers": [ "https://access.scalar.com" ], @@ -12,13 +12,31 @@ "production" ], "auth": [ - "bearer" + "bearer", + "oauth2" ], "authDetails": [ { "kind": "bearer", "id": "BearerAuth", "bearerFormat": "JWT" + }, + { + "kind": "oauth2", + "id": "OAuth2", + "flows": [ + { + "kind": "authorizationCode", + "authorizationUrl": "https://access.scalar.com/v1/oauth/authorize", + "tokenUrl": "https://access.scalar.com/v1/oauth/token", + "refreshUrl": "https://access.scalar.com/v1/oauth/token", + "scopes": [ + "read", + "write", + "admin" + ] + } + ] } ], "clientHeaderParams": [], @@ -358,7 +376,7 @@ "type": "string", "validation": { "pattern": "^[a-z](?:[a-z0-9-]*[a-z0-9])?$", - "minLength": 3, + "minLength": 1, "maxLength": 60 } } @@ -373,7 +391,7 @@ "type": "string", "validation": { "pattern": "^[a-zA-Z0-9-_]+$", - "minLength": 3, + "minLength": 2, "maxLength": 50 } } @@ -426,6 +444,28 @@ "type": "boolean" } }, + { + "name": "endpointCount", + "publicName": "endpointCount", + "required": true, + "deprecated": false, + "type": { + "kind": "union", + "variants": [ + { + "kind": "primitive", + "type": "integer", + "validation": { + "minimum": -9007199254740991, + "maximum": 9007199254740991 + } + }, + { + "kind": "null" + } + ] + } + }, { "name": "embedStatus", "publicName": "embedStatus", @@ -546,16 +586,6 @@ "kind": "primitive", "type": "string" } - }, - { - "name": "versionSha", - "publicName": "versionSha", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string" - } } ], "additionalProperties": false @@ -576,6 +606,7 @@ "patch", "post", "put", + "query", "trace" ], "names": [ @@ -586,6 +617,7 @@ "Patch", "Post", "Put", + "Query", "Trace" ], "deprecations": [ @@ -596,6 +628,7 @@ false, false, false, + false, false ] } @@ -757,6 +790,32 @@ "kind": "ref", "name": "version" } + }, + { + "name": "yamlSha", + "publicName": "yamlSha", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "pattern": "^[a-f0-9]{64}$" + } + } + }, + { + "name": "jsonSha", + "publicName": "jsonSha", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "pattern": "^[a-f0-9]{64}$" + } + } } ], "additionalProperties": false @@ -1368,6 +1427,20 @@ "type": "string" } }, + { + "name": "email", + "source": "email", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "format": "email", + "validation": { + "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" + } + } + }, { "name": "github_project", "source": "github_project", @@ -1480,6 +1553,16 @@ "type": "string" } }, + { + "name": "userInfoHookUrl", + "publicName": "userInfoHookUrl", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, { "name": "activeThemeId", "publicName": "activeThemeId", @@ -1520,6 +1603,16 @@ "type": "boolean" } }, + { + "name": "analyticsEnabled", + "publicName": "analyticsEnabled", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "boolean" + } + }, { "name": "accessGroups", "publicName": "accessGroups", @@ -1728,20 +1821,6 @@ "additionalProperties": false } }, - { - "name": "email", - "source": "email", - "publicAliases": [], - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "format": "email", - "validation": { - "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" - } - } - }, { "name": "team_summary", "source": "team_summary", @@ -2978,21 +3057,15 @@ "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "document", - "lastKnownVersionSha" + "document" ], "publicBodyParams": [ - "document", - "lastKnownVersionSha" + "document" ], "bodyParamDetails": [ { "name": "document", "required": true - }, - { - "name": "lastKnownVersionSha", - "required": false } ], "pathParamDetails": [ @@ -3520,14 +3593,12 @@ "bodyParams": [ "version", "document", - "force", - "lastKnownVersionSha" + "force" ], "publicBodyParams": [ "version", "document", - "force", - "lastKnownVersionSha" + "force" ], "bodyParamDetails": [ { @@ -3541,10 +3612,6 @@ { "name": "force", "required": false - }, - { - "name": "lastKnownVersionSha", - "required": false } ], "pathParamDetails": [ @@ -5155,11 +5222,13 @@ "publicHeaderParams": [], "bodyParams": [ "version", - "document" + "document", + "force" ], "publicBodyParams": [ "version", - "document" + "document", + "force" ], "bodyParamDetails": [ { @@ -5169,6 +5238,10 @@ { "name": "document", "required": true + }, + { + "name": "force", + "required": false } ], "pathParamDetails": [ @@ -5217,10 +5290,6 @@ } ] }, - "responseModel": { - "name": "uid", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ diff --git a/scalar-api-ruby.gemspec b/scalar_api_ruby.gemspec similarity index 91% rename from scalar-api-ruby.gemspec rename to scalar_api_ruby.gemspec index a884a2e..c627b90 100644 --- a/scalar-api-ruby.gemspec +++ b/scalar_api_ruby.gemspec @@ -1,9 +1,9 @@ # frozen_string_literal: true -require_relative "lib/scalar-api-ruby/version" +require_relative "lib/scalar_api_ruby/version" Gem::Specification.new do |spec| - spec.name = "scalar-api-ruby" + spec.name = "scalar_api_ruby" spec.version = Scalar::VERSION spec.summary = "Ruby library to access the Scalar API" spec.authors = ["Scalar"] diff --git a/sig/scalar-api-ruby/models/registry_update_api_document_version_response.rbs b/sig/scalar-api-ruby/models/registry_update_api_document_version_response.rbs deleted file mode 100644 index c843cb8..0000000 --- a/sig/scalar-api-ruby/models/registry_update_api_document_version_response.rbs +++ /dev/null @@ -1,26 +0,0 @@ -module Scalar - module Models - type registry_update_api_document_version_response = - { json_sha: String, version_sha: String, yaml_sha: String } - - class RegistryUpdateAPIDocumentVersionResponse < Scalar::Internal::Type::BaseModel - attr_accessor json_sha: String - - attr_accessor version_sha: String - - attr_accessor yaml_sha: String - - def initialize: ( - json_sha: String, - version_sha: String, - yaml_sha: String - ) -> void - - def to_hash: -> { - json_sha: String, - version_sha: String, - yaml_sha: String - } - end - end -end diff --git a/sig/scalar-api-ruby/client.rbs b/sig/scalar_api_ruby/client.rbs similarity index 91% rename from sig/scalar-api-ruby/client.rbs rename to sig/scalar_api_ruby/client.rbs index 35b5137..2ebf533 100644 --- a/sig/scalar-api-ruby/client.rbs +++ b/sig/scalar_api_ruby/client.rbs @@ -8,7 +8,9 @@ module Scalar DEFAULT_MAX_RETRY_DELAY: Float - attr_reader bearer_auth: String + attr_reader bearer_auth: String? + + attr_reader o_auth2: String? attr_reader registry: Scalar::Resources::Registry @@ -32,6 +34,7 @@ module Scalar def initialize: ( ?bearer_auth: String?, + ?o_auth2: String?, ?base_url: String?, ?max_retries: Integer, ?timeout: Float, diff --git a/sig/scalar-api-ruby/errors.rbs b/sig/scalar_api_ruby/errors.rbs similarity index 100% rename from sig/scalar-api-ruby/errors.rbs rename to sig/scalar_api_ruby/errors.rbs diff --git a/sig/scalar-api-ruby/file_part.rbs b/sig/scalar_api_ruby/file_part.rbs similarity index 100% rename from sig/scalar-api-ruby/file_part.rbs rename to sig/scalar_api_ruby/file_part.rbs diff --git a/sig/scalar-api-ruby/internal.rbs b/sig/scalar_api_ruby/internal.rbs similarity index 100% rename from sig/scalar-api-ruby/internal.rbs rename to sig/scalar_api_ruby/internal.rbs diff --git a/sig/scalar-api-ruby/internal/transport/base_client.rbs b/sig/scalar_api_ruby/internal/transport/base_client.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/transport/base_client.rbs rename to sig/scalar_api_ruby/internal/transport/base_client.rbs diff --git a/sig/scalar-api-ruby/internal/transport/pooled_net_requester.rbs b/sig/scalar_api_ruby/internal/transport/pooled_net_requester.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/transport/pooled_net_requester.rbs rename to sig/scalar_api_ruby/internal/transport/pooled_net_requester.rbs diff --git a/sig/scalar-api-ruby/internal/type/array_of.rbs b/sig/scalar_api_ruby/internal/type/array_of.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/array_of.rbs rename to sig/scalar_api_ruby/internal/type/array_of.rbs diff --git a/sig/scalar-api-ruby/internal/type/base_model.rbs b/sig/scalar_api_ruby/internal/type/base_model.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/base_model.rbs rename to sig/scalar_api_ruby/internal/type/base_model.rbs diff --git a/sig/scalar-api-ruby/internal/type/base_page.rbs b/sig/scalar_api_ruby/internal/type/base_page.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/base_page.rbs rename to sig/scalar_api_ruby/internal/type/base_page.rbs diff --git a/sig/scalar-api-ruby/internal/type/boolean.rbs b/sig/scalar_api_ruby/internal/type/boolean.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/boolean.rbs rename to sig/scalar_api_ruby/internal/type/boolean.rbs diff --git a/sig/scalar-api-ruby/internal/type/converter.rbs b/sig/scalar_api_ruby/internal/type/converter.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/converter.rbs rename to sig/scalar_api_ruby/internal/type/converter.rbs diff --git a/sig/scalar-api-ruby/internal/type/enum.rbs b/sig/scalar_api_ruby/internal/type/enum.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/enum.rbs rename to sig/scalar_api_ruby/internal/type/enum.rbs diff --git a/sig/scalar-api-ruby/internal/type/file_input.rbs b/sig/scalar_api_ruby/internal/type/file_input.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/file_input.rbs rename to sig/scalar_api_ruby/internal/type/file_input.rbs diff --git a/sig/scalar-api-ruby/internal/type/hash_of.rbs b/sig/scalar_api_ruby/internal/type/hash_of.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/hash_of.rbs rename to sig/scalar_api_ruby/internal/type/hash_of.rbs diff --git a/sig/scalar-api-ruby/internal/type/request_parameters.rbs b/sig/scalar_api_ruby/internal/type/request_parameters.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/request_parameters.rbs rename to sig/scalar_api_ruby/internal/type/request_parameters.rbs diff --git a/sig/scalar-api-ruby/internal/type/union.rbs b/sig/scalar_api_ruby/internal/type/union.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/union.rbs rename to sig/scalar_api_ruby/internal/type/union.rbs diff --git a/sig/scalar-api-ruby/internal/type/unknown.rbs b/sig/scalar_api_ruby/internal/type/unknown.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/type/unknown.rbs rename to sig/scalar_api_ruby/internal/type/unknown.rbs diff --git a/sig/scalar-api-ruby/internal/util.rbs b/sig/scalar_api_ruby/internal/util.rbs similarity index 100% rename from sig/scalar-api-ruby/internal/util.rbs rename to sig/scalar_api_ruby/internal/util.rbs diff --git a/sig/scalar-api-ruby/models.rbs b/sig/scalar_api_ruby/models.rbs similarity index 100% rename from sig/scalar-api-ruby/models.rbs rename to sig/scalar_api_ruby/models.rbs diff --git a/sig/scalar-api-ruby/models/400.rbs b/sig/scalar_api_ruby/models/400.rbs similarity index 100% rename from sig/scalar-api-ruby/models/400.rbs rename to sig/scalar_api_ruby/models/400.rbs diff --git a/sig/scalar-api-ruby/models/401.rbs b/sig/scalar_api_ruby/models/401.rbs similarity index 100% rename from sig/scalar-api-ruby/models/401.rbs rename to sig/scalar_api_ruby/models/401.rbs diff --git a/sig/scalar-api-ruby/models/403.rbs b/sig/scalar_api_ruby/models/403.rbs similarity index 100% rename from sig/scalar-api-ruby/models/403.rbs rename to sig/scalar_api_ruby/models/403.rbs diff --git a/sig/scalar-api-ruby/models/404.rbs b/sig/scalar_api_ruby/models/404.rbs similarity index 100% rename from sig/scalar-api-ruby/models/404.rbs rename to sig/scalar_api_ruby/models/404.rbs diff --git a/sig/scalar-api-ruby/models/422.rbs b/sig/scalar_api_ruby/models/422.rbs similarity index 100% rename from sig/scalar-api-ruby/models/422.rbs rename to sig/scalar_api_ruby/models/422.rbs diff --git a/sig/scalar-api-ruby/models/500.rbs b/sig/scalar_api_ruby/models/500.rbs similarity index 100% rename from sig/scalar-api-ruby/models/500.rbs rename to sig/scalar_api_ruby/models/500.rbs diff --git a/sig/scalar-api-ruby/models/access_group.rbs b/sig/scalar_api_ruby/models/access_group.rbs similarity index 100% rename from sig/scalar-api-ruby/models/access_group.rbs rename to sig/scalar_api_ruby/models/access_group.rbs diff --git a/sig/scalar-api-ruby/models/authentication_exchange_personal_token_params.rbs b/sig/scalar_api_ruby/models/authentication_exchange_personal_token_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/authentication_exchange_personal_token_params.rbs rename to sig/scalar_api_ruby/models/authentication_exchange_personal_token_params.rbs diff --git a/sig/scalar-api-ruby/models/authentication_exchange_personal_token_response.rbs b/sig/scalar_api_ruby/models/authentication_exchange_personal_token_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/authentication_exchange_personal_token_response.rbs rename to sig/scalar_api_ruby/models/authentication_exchange_personal_token_response.rbs diff --git a/sig/scalar-api-ruby/models/authentication_list_current_user_params.rbs b/sig/scalar_api_ruby/models/authentication_list_current_user_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/authentication_list_current_user_params.rbs rename to sig/scalar_api_ruby/models/authentication_list_current_user_params.rbs diff --git a/sig/scalar-api-ruby/models/authentication_list_current_user_response.rbs b/sig/scalar_api_ruby/models/authentication_list_current_user_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/authentication_list_current_user_response.rbs rename to sig/scalar_api_ruby/models/authentication_list_current_user_response.rbs diff --git a/sig/scalar-api-ruby/models/login_portal_create_params.rbs b/sig/scalar_api_ruby/models/login_portal_create_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/login_portal_create_params.rbs rename to sig/scalar_api_ruby/models/login_portal_create_params.rbs diff --git a/sig/scalar-api-ruby/models/login_portal_delete_params.rbs b/sig/scalar_api_ruby/models/login_portal_delete_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/login_portal_delete_params.rbs rename to sig/scalar_api_ruby/models/login_portal_delete_params.rbs diff --git a/sig/scalar-api-ruby/models/login_portal_email.rbs b/sig/scalar_api_ruby/models/login_portal_email.rbs similarity index 100% rename from sig/scalar-api-ruby/models/login_portal_email.rbs rename to sig/scalar_api_ruby/models/login_portal_email.rbs diff --git a/sig/scalar-api-ruby/models/login_portal_list_params.rbs b/sig/scalar_api_ruby/models/login_portal_list_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/login_portal_list_params.rbs rename to sig/scalar_api_ruby/models/login_portal_list_params.rbs diff --git a/sig/scalar-api-ruby/models/login_portal_list_response.rbs b/sig/scalar_api_ruby/models/login_portal_list_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/login_portal_list_response.rbs rename to sig/scalar_api_ruby/models/login_portal_list_response.rbs diff --git a/sig/scalar-api-ruby/models/login_portal_page.rbs b/sig/scalar_api_ruby/models/login_portal_page.rbs similarity index 100% rename from sig/scalar-api-ruby/models/login_portal_page.rbs rename to sig/scalar_api_ruby/models/login_portal_page.rbs diff --git a/sig/scalar-api-ruby/models/login_portal_retrieve_params.rbs b/sig/scalar_api_ruby/models/login_portal_retrieve_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/login_portal_retrieve_params.rbs rename to sig/scalar_api_ruby/models/login_portal_retrieve_params.rbs diff --git a/sig/scalar-api-ruby/models/login_portal_retrieve_response.rbs b/sig/scalar_api_ruby/models/login_portal_retrieve_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/login_portal_retrieve_response.rbs rename to sig/scalar_api_ruby/models/login_portal_retrieve_response.rbs diff --git a/sig/scalar-api-ruby/models/login_portal_update_params.rbs b/sig/scalar_api_ruby/models/login_portal_update_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/login_portal_update_params.rbs rename to sig/scalar_api_ruby/models/login_portal_update_params.rbs diff --git a/sig/scalar-api-ruby/models/managed_doc_version.rbs b/sig/scalar_api_ruby/models/managed_doc_version.rbs similarity index 91% rename from sig/scalar-api-ruby/models/managed_doc_version.rbs rename to sig/scalar_api_ruby/models/managed_doc_version.rbs index bfd21bd..f4bd017 100644 --- a/sig/scalar-api-ruby/models/managed_doc_version.rbs +++ b/sig/scalar_api_ruby/models/managed_doc_version.rbs @@ -4,13 +4,13 @@ module Scalar { created_at: Float, embed_status: Scalar::Models::ManagedDocVersion::embed_status?, + endpoint_count: Integer?, tags: ::Array[String], uid: String, upgraded: bool, version: String, json_sha: String, tools: ::Array[Scalar::ManagedDocVersion::Tool], - version_sha: String, yaml_sha: String } @@ -19,6 +19,8 @@ module Scalar attr_accessor embed_status: Scalar::Models::ManagedDocVersion::embed_status? + attr_accessor endpoint_count: Integer? + attr_accessor tags: ::Array[String] attr_accessor uid: String @@ -37,10 +39,6 @@ module Scalar ::Array[Scalar::ManagedDocVersion::Tool] ) -> ::Array[Scalar::ManagedDocVersion::Tool] - attr_reader version_sha: String? - - def version_sha=: (String) -> String - attr_reader yaml_sha: String? def yaml_sha=: (String) -> String @@ -48,26 +46,26 @@ module Scalar def initialize: ( created_at: Float, embed_status: Scalar::Models::ManagedDocVersion::embed_status?, + endpoint_count: Integer?, tags: ::Array[String], uid: String, upgraded: bool, version: String, ?json_sha: String, ?tools: ::Array[Scalar::ManagedDocVersion::Tool], - ?version_sha: String, ?yaml_sha: String ) -> void def to_hash: -> { created_at: Float, embed_status: Scalar::Models::ManagedDocVersion::embed_status?, + endpoint_count: Integer?, tags: ::Array[String], uid: String, upgraded: bool, version: String, json_sha: String, tools: ::Array[Scalar::ManagedDocVersion::Tool], - version_sha: String, yaml_sha: String } @@ -120,7 +118,15 @@ module Scalar end type method_ = - :delete | :get | :head | :options | :patch | :post | :put | :trace + :delete + | :get + | :head + | :options + | :patch + | :post + | :put + | :query + | :trace module Method extend Scalar::Internal::Type::Enum @@ -132,6 +138,7 @@ module Scalar PATCH: :patch POST: :post PUT: :put + QUERY: :query TRACE: :trace def self?.values: -> ::Array[Scalar::Models::ManagedDocVersion::Tool::method_] diff --git a/sig/scalar-api-ruby/models/namespace.rbs b/sig/scalar_api_ruby/models/namespace.rbs similarity index 100% rename from sig/scalar-api-ruby/models/namespace.rbs rename to sig/scalar_api_ruby/models/namespace.rbs diff --git a/sig/scalar-api-ruby/models/namespace_list_params.rbs b/sig/scalar_api_ruby/models/namespace_list_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/namespace_list_params.rbs rename to sig/scalar_api_ruby/models/namespace_list_params.rbs diff --git a/sig/scalar-api-ruby/models/namespace_list_response.rbs b/sig/scalar_api_ruby/models/namespace_list_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/namespace_list_response.rbs rename to sig/scalar_api_ruby/models/namespace_list_response.rbs diff --git a/sig/scalar-api-ruby/models/nanoid.rbs b/sig/scalar_api_ruby/models/nanoid.rbs similarity index 100% rename from sig/scalar-api-ruby/models/nanoid.rbs rename to sig/scalar_api_ruby/models/nanoid.rbs diff --git a/sig/scalar-api-ruby/models/registry_create_api_document_access_group_params.rbs b/sig/scalar_api_ruby/models/registry_create_api_document_access_group_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_create_api_document_access_group_params.rbs rename to sig/scalar_api_ruby/models/registry_create_api_document_access_group_params.rbs diff --git a/sig/scalar-api-ruby/models/registry_create_api_document_params.rbs b/sig/scalar_api_ruby/models/registry_create_api_document_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_create_api_document_params.rbs rename to sig/scalar_api_ruby/models/registry_create_api_document_params.rbs diff --git a/sig/scalar-api-ruby/models/registry_create_api_document_response.rbs b/sig/scalar_api_ruby/models/registry_create_api_document_response.rbs similarity index 86% rename from sig/scalar-api-ruby/models/registry_create_api_document_response.rbs rename to sig/scalar_api_ruby/models/registry_create_api_document_response.rbs index 5ba1273..9fc41a5 100644 --- a/sig/scalar-api-ruby/models/registry_create_api_document_response.rbs +++ b/sig/scalar_api_ruby/models/registry_create_api_document_response.rbs @@ -5,7 +5,6 @@ module Scalar json_sha: String, title: String, uid: String, - version_sha: String, version_uid: String, yaml_sha: String } @@ -17,8 +16,6 @@ module Scalar attr_accessor uid: String - attr_accessor version_sha: String - attr_accessor version_uid: String attr_accessor yaml_sha: String @@ -27,7 +24,6 @@ module Scalar json_sha: String, title: String, uid: String, - version_sha: String, version_uid: String, yaml_sha: String ) -> void @@ -36,7 +32,6 @@ module Scalar json_sha: String, title: String, uid: String, - version_sha: String, version_uid: String, yaml_sha: String } diff --git a/sig/scalar-api-ruby/models/registry_create_api_document_version_params.rbs b/sig/scalar_api_ruby/models/registry_create_api_document_version_params.rbs similarity index 81% rename from sig/scalar-api-ruby/models/registry_create_api_document_version_params.rbs rename to sig/scalar_api_ruby/models/registry_create_api_document_version_params.rbs index ff10156..75c4843 100644 --- a/sig/scalar-api-ruby/models/registry_create_api_document_version_params.rbs +++ b/sig/scalar_api_ruby/models/registry_create_api_document_version_params.rbs @@ -6,8 +6,7 @@ module Scalar slug: String, document: String, version: String, - force: bool, - last_known_version_sha: String + force: bool } & Scalar::Internal::Type::request_parameters @@ -27,17 +26,12 @@ module Scalar def force=: (bool) -> bool - attr_reader last_known_version_sha: String? - - def last_known_version_sha=: (String) -> String - def initialize: ( namespace: String, slug: String, document: String, version: String, ?force: bool, - ?last_known_version_sha: String, ?request_options: Scalar::request_opts ) -> void @@ -47,7 +41,6 @@ module Scalar document: String, version: String, force: bool, - last_known_version_sha: String, request_options: Scalar::RequestOptions } end diff --git a/sig/scalar-api-ruby/models/registry_delete_api_document_access_group_params.rbs b/sig/scalar_api_ruby/models/registry_delete_api_document_access_group_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_delete_api_document_access_group_params.rbs rename to sig/scalar_api_ruby/models/registry_delete_api_document_access_group_params.rbs diff --git a/sig/scalar-api-ruby/models/registry_delete_api_document_params.rbs b/sig/scalar_api_ruby/models/registry_delete_api_document_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_delete_api_document_params.rbs rename to sig/scalar_api_ruby/models/registry_delete_api_document_params.rbs diff --git a/sig/scalar-api-ruby/models/registry_delete_api_document_version_params.rbs b/sig/scalar_api_ruby/models/registry_delete_api_document_version_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_delete_api_document_version_params.rbs rename to sig/scalar_api_ruby/models/registry_delete_api_document_version_params.rbs diff --git a/sig/scalar-api-ruby/models/registry_list_all_api_documents_params.rbs b/sig/scalar_api_ruby/models/registry_list_all_api_documents_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_list_all_api_documents_params.rbs rename to sig/scalar_api_ruby/models/registry_list_all_api_documents_params.rbs diff --git a/sig/scalar-api-ruby/models/registry_list_all_api_documents_response.rbs b/sig/scalar_api_ruby/models/registry_list_all_api_documents_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_list_all_api_documents_response.rbs rename to sig/scalar_api_ruby/models/registry_list_all_api_documents_response.rbs diff --git a/sig/scalar-api-ruby/models/registry_list_api_document_version_metadata_params.rbs b/sig/scalar_api_ruby/models/registry_list_api_document_version_metadata_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_list_api_document_version_metadata_params.rbs rename to sig/scalar_api_ruby/models/registry_list_api_document_version_metadata_params.rbs diff --git a/sig/scalar-api-ruby/models/registry_list_api_documents_params.rbs b/sig/scalar_api_ruby/models/registry_list_api_documents_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_list_api_documents_params.rbs rename to sig/scalar_api_ruby/models/registry_list_api_documents_params.rbs diff --git a/sig/scalar-api-ruby/models/registry_list_api_documents_response.rbs b/sig/scalar_api_ruby/models/registry_list_api_documents_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_list_api_documents_response.rbs rename to sig/scalar_api_ruby/models/registry_list_api_documents_response.rbs diff --git a/sig/scalar-api-ruby/models/registry_retrieve_api_document_version_params.rbs b/sig/scalar_api_ruby/models/registry_retrieve_api_document_version_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_retrieve_api_document_version_params.rbs rename to sig/scalar_api_ruby/models/registry_retrieve_api_document_version_params.rbs diff --git a/sig/scalar-api-ruby/models/registry_retrieve_api_document_version_response.rbs b/sig/scalar_api_ruby/models/registry_retrieve_api_document_version_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_retrieve_api_document_version_response.rbs rename to sig/scalar_api_ruby/models/registry_retrieve_api_document_version_response.rbs diff --git a/sig/scalar-api-ruby/models/registry_update_api_document_params.rbs b/sig/scalar_api_ruby/models/registry_update_api_document_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/registry_update_api_document_params.rbs rename to sig/scalar_api_ruby/models/registry_update_api_document_params.rbs diff --git a/sig/scalar-api-ruby/models/registry_update_api_document_version_params.rbs b/sig/scalar_api_ruby/models/registry_update_api_document_version_params.rbs similarity index 71% rename from sig/scalar-api-ruby/models/registry_update_api_document_version_params.rbs rename to sig/scalar_api_ruby/models/registry_update_api_document_version_params.rbs index 7999e6d..5cd9761 100644 --- a/sig/scalar-api-ruby/models/registry_update_api_document_version_params.rbs +++ b/sig/scalar_api_ruby/models/registry_update_api_document_version_params.rbs @@ -1,13 +1,7 @@ module Scalar module Models type registry_update_api_document_version_params = - { - namespace: String, - slug: String, - semver: String, - document: String, - last_known_version_sha: String - } + { namespace: String, slug: String, semver: String, document: String } & Scalar::Internal::Type::request_parameters class RegistryUpdateAPIDocumentVersionParams < Scalar::Internal::Type::BaseModel @@ -22,16 +16,11 @@ module Scalar attr_accessor document: String - attr_reader last_known_version_sha: String? - - def last_known_version_sha=: (String) -> String - def initialize: ( namespace: String, slug: String, semver: String, document: String, - ?last_known_version_sha: String, ?request_options: Scalar::request_opts ) -> void @@ -40,7 +29,6 @@ module Scalar slug: String, semver: String, document: String, - last_known_version_sha: String, request_options: Scalar::RequestOptions } end diff --git a/sig/scalar_api_ruby/models/registry_update_api_document_version_response.rbs b/sig/scalar_api_ruby/models/registry_update_api_document_version_response.rbs new file mode 100644 index 0000000..0e0f30c --- /dev/null +++ b/sig/scalar_api_ruby/models/registry_update_api_document_version_response.rbs @@ -0,0 +1,16 @@ +module Scalar + module Models + type registry_update_api_document_version_response = + { json_sha: String, yaml_sha: String } + + class RegistryUpdateAPIDocumentVersionResponse < Scalar::Internal::Type::BaseModel + attr_accessor json_sha: String + + attr_accessor yaml_sha: String + + def initialize: (json_sha: String, yaml_sha: String) -> void + + def to_hash: -> { json_sha: String, yaml_sha: String } + end + end +end diff --git a/sig/scalar-api-ruby/models/rule_create_ruleset_access_group_params.rbs b/sig/scalar_api_ruby/models/rule_create_ruleset_access_group_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/rule_create_ruleset_access_group_params.rbs rename to sig/scalar_api_ruby/models/rule_create_ruleset_access_group_params.rbs diff --git a/sig/scalar-api-ruby/models/rule_create_ruleset_params.rbs b/sig/scalar_api_ruby/models/rule_create_ruleset_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/rule_create_ruleset_params.rbs rename to sig/scalar_api_ruby/models/rule_create_ruleset_params.rbs diff --git a/sig/scalar-api-ruby/models/rule_delete_ruleset_access_group_params.rbs b/sig/scalar_api_ruby/models/rule_delete_ruleset_access_group_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/rule_delete_ruleset_access_group_params.rbs rename to sig/scalar_api_ruby/models/rule_delete_ruleset_access_group_params.rbs diff --git a/sig/scalar-api-ruby/models/rule_delete_ruleset_params.rbs b/sig/scalar_api_ruby/models/rule_delete_ruleset_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/rule_delete_ruleset_params.rbs rename to sig/scalar_api_ruby/models/rule_delete_ruleset_params.rbs diff --git a/sig/scalar-api-ruby/models/rule_list_rulesets_params.rbs b/sig/scalar_api_ruby/models/rule_list_rulesets_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/rule_list_rulesets_params.rbs rename to sig/scalar_api_ruby/models/rule_list_rulesets_params.rbs diff --git a/sig/scalar-api-ruby/models/rule_list_rulesets_response.rbs b/sig/scalar_api_ruby/models/rule_list_rulesets_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/rule_list_rulesets_response.rbs rename to sig/scalar_api_ruby/models/rule_list_rulesets_response.rbs diff --git a/sig/scalar-api-ruby/models/rule_retrieve_ruleset_document_params.rbs b/sig/scalar_api_ruby/models/rule_retrieve_ruleset_document_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/rule_retrieve_ruleset_document_params.rbs rename to sig/scalar_api_ruby/models/rule_retrieve_ruleset_document_params.rbs diff --git a/sig/scalar-api-ruby/models/rule_retrieve_ruleset_document_response.rbs b/sig/scalar_api_ruby/models/rule_retrieve_ruleset_document_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/rule_retrieve_ruleset_document_response.rbs rename to sig/scalar_api_ruby/models/rule_retrieve_ruleset_document_response.rbs diff --git a/sig/scalar-api-ruby/models/rule_update_ruleset_params.rbs b/sig/scalar_api_ruby/models/rule_update_ruleset_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/rule_update_ruleset_params.rbs rename to sig/scalar_api_ruby/models/rule_update_ruleset_params.rbs diff --git a/sig/scalar-api-ruby/models/scalar_doc_create_guide_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_create_guide_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/scalar_doc_create_guide_params.rbs rename to sig/scalar_api_ruby/models/scalar_doc_create_guide_params.rbs diff --git a/sig/scalar-api-ruby/models/scalar_doc_create_guide_response.rbs b/sig/scalar_api_ruby/models/scalar_doc_create_guide_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/scalar_doc_create_guide_response.rbs rename to sig/scalar_api_ruby/models/scalar_doc_create_guide_response.rbs diff --git a/sig/scalar-api-ruby/models/scalar_doc_list_guides_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_guides_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/scalar_doc_list_guides_params.rbs rename to sig/scalar_api_ruby/models/scalar_doc_list_guides_params.rbs diff --git a/sig/scalar-api-ruby/models/scalar_doc_list_guides_response.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_guides_response.rbs similarity index 94% rename from sig/scalar-api-ruby/models/scalar_doc_list_guides_response.rbs rename to sig/scalar_api_ruby/models/scalar_doc_list_guides_response.rbs index 3549edb..1bf376d 100644 --- a/sig/scalar-api-ruby/models/scalar_doc_list_guides_response.rbs +++ b/sig/scalar_api_ruby/models/scalar_doc_list_guides_response.rbs @@ -6,6 +6,7 @@ module Scalar active_deployment: Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment?, active_theme_id: String, agent_enabled: bool, + analytics_enabled: bool, created_at: Integer, is_private: bool, last_published: Integer?, @@ -17,6 +18,7 @@ module Scalar slug: String, uid: String, updated_at: Integer, + user_info_hook_url: String, repository: Scalar::Models::ScalarDocListGuidesResponseItem::Repository?, typesense_id: Float } @@ -30,6 +32,8 @@ module Scalar attr_accessor agent_enabled: bool + attr_accessor analytics_enabled: bool + attr_accessor created_at: Integer attr_accessor is_private: bool @@ -52,6 +56,8 @@ module Scalar attr_accessor updated_at: Integer + attr_accessor user_info_hook_url: String + attr_accessor repository: Scalar::Models::ScalarDocListGuidesResponseItem::Repository? attr_reader typesense_id: Float? @@ -63,6 +69,7 @@ module Scalar active_deployment: Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment?, active_theme_id: String, agent_enabled: bool, + analytics_enabled: bool, created_at: Integer, is_private: bool, last_published: Integer?, @@ -74,6 +81,7 @@ module Scalar slug: String, uid: String, updated_at: Integer, + user_info_hook_url: String, ?repository: Scalar::Models::ScalarDocListGuidesResponseItem::Repository?, ?typesense_id: Float ) -> void @@ -83,6 +91,7 @@ module Scalar active_deployment: Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment?, active_theme_id: String, agent_enabled: bool, + analytics_enabled: bool, created_at: Integer, is_private: bool, last_published: Integer?, @@ -94,6 +103,7 @@ module Scalar slug: String, uid: String, updated_at: Integer, + user_info_hook_url: String, repository: Scalar::Models::ScalarDocListGuidesResponseItem::Repository?, typesense_id: Float } diff --git a/sig/scalar-api-ruby/models/scalar_doc_publish_guide_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_publish_guide_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/scalar_doc_publish_guide_params.rbs rename to sig/scalar_api_ruby/models/scalar_doc_publish_guide_params.rbs diff --git a/sig/scalar-api-ruby/models/scalar_doc_publish_guide_response.rbs b/sig/scalar_api_ruby/models/scalar_doc_publish_guide_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/scalar_doc_publish_guide_response.rbs rename to sig/scalar_api_ruby/models/scalar_doc_publish_guide_response.rbs diff --git a/sig/scalar-api-ruby/models/schema_create_params.rbs b/sig/scalar_api_ruby/models/schema_create_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/schema_create_params.rbs rename to sig/scalar_api_ruby/models/schema_create_params.rbs diff --git a/sig/scalar-api-ruby/models/schema_delete_params.rbs b/sig/scalar_api_ruby/models/schema_delete_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/schema_delete_params.rbs rename to sig/scalar_api_ruby/models/schema_delete_params.rbs diff --git a/sig/scalar-api-ruby/models/schema_list_params.rbs b/sig/scalar_api_ruby/models/schema_list_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/schema_list_params.rbs rename to sig/scalar_api_ruby/models/schema_list_params.rbs diff --git a/sig/scalar-api-ruby/models/schema_list_response.rbs b/sig/scalar_api_ruby/models/schema_list_response.rbs similarity index 82% rename from sig/scalar-api-ruby/models/schema_list_response.rbs rename to sig/scalar_api_ruby/models/schema_list_response.rbs index fff9e26..fc0c926 100644 --- a/sig/scalar-api-ruby/models/schema_list_response.rbs +++ b/sig/scalar_api_ruby/models/schema_list_response.rbs @@ -51,7 +51,9 @@ module Scalar created_at: Integer, uid: String, updated_at: Integer, - version: String + version: String, + json_sha: String, + yaml_sha: String } class Version < Scalar::Internal::Type::BaseModel @@ -63,18 +65,30 @@ module Scalar attr_accessor version: String + attr_reader json_sha: String? + + def json_sha=: (String) -> String + + attr_reader yaml_sha: String? + + def yaml_sha=: (String) -> String + def initialize: ( created_at: Integer, uid: String, updated_at: Integer, - version: String + version: String, + ?json_sha: String, + ?yaml_sha: String ) -> void def to_hash: -> { created_at: Integer, uid: String, updated_at: Integer, - version: String + version: String, + json_sha: String, + yaml_sha: String } end end diff --git a/sig/scalar-api-ruby/models/schema_update_params.rbs b/sig/scalar_api_ruby/models/schema_update_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/schema_update_params.rbs rename to sig/scalar_api_ruby/models/schema_update_params.rbs diff --git a/sig/scalar-api-ruby/models/schemas/access_group_create_params.rbs b/sig/scalar_api_ruby/models/schemas/access_group_create_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/schemas/access_group_create_params.rbs rename to sig/scalar_api_ruby/models/schemas/access_group_create_params.rbs diff --git a/sig/scalar-api-ruby/models/schemas/access_group_delete_params.rbs b/sig/scalar_api_ruby/models/schemas/access_group_delete_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/schemas/access_group_delete_params.rbs rename to sig/scalar_api_ruby/models/schemas/access_group_delete_params.rbs diff --git a/sig/scalar-api-ruby/models/schemas/version_create_params.rbs b/sig/scalar_api_ruby/models/schemas/version_create_params.rbs similarity index 77% rename from sig/scalar-api-ruby/models/schemas/version_create_params.rbs rename to sig/scalar_api_ruby/models/schemas/version_create_params.rbs index fa9f9e8..2116adc 100644 --- a/sig/scalar-api-ruby/models/schemas/version_create_params.rbs +++ b/sig/scalar_api_ruby/models/schemas/version_create_params.rbs @@ -2,7 +2,13 @@ module Scalar module Models module Schemas type version_create_params = - { namespace: String, slug: String, document: String, version: String } + { + namespace: String, + slug: String, + document: String, + version: String, + force: bool + } & Scalar::Internal::Type::request_parameters class VersionCreateParams < Scalar::Internal::Type::BaseModel @@ -17,11 +23,16 @@ module Scalar attr_accessor version: String + attr_reader force: bool? + + def force=: (bool) -> bool + def initialize: ( namespace: String, slug: String, document: String, version: String, + ?force: bool, ?request_options: Scalar::request_opts ) -> void @@ -30,6 +41,7 @@ module Scalar slug: String, document: String, version: String, + force: bool, request_options: Scalar::RequestOptions } end diff --git a/sig/scalar_api_ruby/models/schemas/version_create_response.rbs b/sig/scalar_api_ruby/models/schemas/version_create_response.rbs new file mode 100644 index 0000000..eca61f8 --- /dev/null +++ b/sig/scalar_api_ruby/models/schemas/version_create_response.rbs @@ -0,0 +1,15 @@ +module Scalar + module Models + module Schemas + type version_create_response = { uid: String } + + class VersionCreateResponse < Scalar::Internal::Type::BaseModel + attr_accessor uid: String + + def initialize: (uid: String) -> void + + def to_hash: -> { uid: String } + end + end + end +end diff --git a/sig/scalar-api-ruby/models/schemas/version_delete_params.rbs b/sig/scalar_api_ruby/models/schemas/version_delete_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/schemas/version_delete_params.rbs rename to sig/scalar_api_ruby/models/schemas/version_delete_params.rbs diff --git a/sig/scalar-api-ruby/models/schemas/version_retrieve_params.rbs b/sig/scalar_api_ruby/models/schemas/version_retrieve_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/schemas/version_retrieve_params.rbs rename to sig/scalar_api_ruby/models/schemas/version_retrieve_params.rbs diff --git a/sig/scalar-api-ruby/models/schemas/version_retrieve_response.rbs b/sig/scalar_api_ruby/models/schemas/version_retrieve_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/schemas/version_retrieve_response.rbs rename to sig/scalar_api_ruby/models/schemas/version_retrieve_response.rbs diff --git a/sig/scalar-api-ruby/models/slug.rbs b/sig/scalar_api_ruby/models/slug.rbs similarity index 100% rename from sig/scalar-api-ruby/models/slug.rbs rename to sig/scalar_api_ruby/models/slug.rbs diff --git a/sig/scalar-api-ruby/models/team_list_params.rbs b/sig/scalar_api_ruby/models/team_list_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/team_list_params.rbs rename to sig/scalar_api_ruby/models/team_list_params.rbs diff --git a/sig/scalar-api-ruby/models/team_list_response.rbs b/sig/scalar_api_ruby/models/team_list_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/team_list_response.rbs rename to sig/scalar_api_ruby/models/team_list_response.rbs diff --git a/sig/scalar-api-ruby/models/theme_create_params.rbs b/sig/scalar_api_ruby/models/theme_create_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/theme_create_params.rbs rename to sig/scalar_api_ruby/models/theme_create_params.rbs diff --git a/sig/scalar-api-ruby/models/theme_delete_params.rbs b/sig/scalar_api_ruby/models/theme_delete_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/theme_delete_params.rbs rename to sig/scalar_api_ruby/models/theme_delete_params.rbs diff --git a/sig/scalar-api-ruby/models/theme_list_params.rbs b/sig/scalar_api_ruby/models/theme_list_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/theme_list_params.rbs rename to sig/scalar_api_ruby/models/theme_list_params.rbs diff --git a/sig/scalar-api-ruby/models/theme_list_response.rbs b/sig/scalar_api_ruby/models/theme_list_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/theme_list_response.rbs rename to sig/scalar_api_ruby/models/theme_list_response.rbs diff --git a/sig/scalar-api-ruby/models/theme_replace_document_params.rbs b/sig/scalar_api_ruby/models/theme_replace_document_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/theme_replace_document_params.rbs rename to sig/scalar_api_ruby/models/theme_replace_document_params.rbs diff --git a/sig/scalar-api-ruby/models/theme_retrieve_params.rbs b/sig/scalar_api_ruby/models/theme_retrieve_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/theme_retrieve_params.rbs rename to sig/scalar_api_ruby/models/theme_retrieve_params.rbs diff --git a/sig/scalar-api-ruby/models/theme_retrieve_response.rbs b/sig/scalar_api_ruby/models/theme_retrieve_response.rbs similarity index 100% rename from sig/scalar-api-ruby/models/theme_retrieve_response.rbs rename to sig/scalar_api_ruby/models/theme_retrieve_response.rbs diff --git a/sig/scalar-api-ruby/models/theme_update_params.rbs b/sig/scalar_api_ruby/models/theme_update_params.rbs similarity index 100% rename from sig/scalar-api-ruby/models/theme_update_params.rbs rename to sig/scalar_api_ruby/models/theme_update_params.rbs diff --git a/sig/scalar-api-ruby/models/timestamp.rbs b/sig/scalar_api_ruby/models/timestamp.rbs similarity index 100% rename from sig/scalar-api-ruby/models/timestamp.rbs rename to sig/scalar_api_ruby/models/timestamp.rbs diff --git a/sig/scalar-api-ruby/models/uid.rbs b/sig/scalar_api_ruby/models/uid.rbs similarity index 100% rename from sig/scalar-api-ruby/models/uid.rbs rename to sig/scalar_api_ruby/models/uid.rbs diff --git a/sig/scalar-api-ruby/models/version.rbs b/sig/scalar_api_ruby/models/version.rbs similarity index 100% rename from sig/scalar-api-ruby/models/version.rbs rename to sig/scalar_api_ruby/models/version.rbs diff --git a/sig/scalar-api-ruby/request_options.rbs b/sig/scalar_api_ruby/request_options.rbs similarity index 100% rename from sig/scalar-api-ruby/request_options.rbs rename to sig/scalar_api_ruby/request_options.rbs diff --git a/sig/scalar-api-ruby/resources/authentication.rbs b/sig/scalar_api_ruby/resources/authentication.rbs similarity index 100% rename from sig/scalar-api-ruby/resources/authentication.rbs rename to sig/scalar_api_ruby/resources/authentication.rbs diff --git a/sig/scalar-api-ruby/resources/login_portals.rbs b/sig/scalar_api_ruby/resources/login_portals.rbs similarity index 100% rename from sig/scalar-api-ruby/resources/login_portals.rbs rename to sig/scalar_api_ruby/resources/login_portals.rbs diff --git a/sig/scalar-api-ruby/resources/namespaces.rbs b/sig/scalar_api_ruby/resources/namespaces.rbs similarity index 100% rename from sig/scalar-api-ruby/resources/namespaces.rbs rename to sig/scalar_api_ruby/resources/namespaces.rbs diff --git a/sig/scalar-api-ruby/resources/registry.rbs b/sig/scalar_api_ruby/resources/registry.rbs similarity index 97% rename from sig/scalar-api-ruby/resources/registry.rbs rename to sig/scalar_api_ruby/resources/registry.rbs index 038f041..06e1363 100644 --- a/sig/scalar-api-ruby/resources/registry.rbs +++ b/sig/scalar_api_ruby/resources/registry.rbs @@ -26,7 +26,6 @@ module Scalar document: String, version: String, ?force: bool, - ?last_known_version_sha: String, ?request_options: Scalar::request_opts ) -> Scalar::ManagedDocVersion @@ -88,7 +87,6 @@ module Scalar namespace: String, slug: String, document: String, - ?last_known_version_sha: String, ?request_options: Scalar::request_opts ) -> Scalar::Models::RegistryUpdateAPIDocumentVersionResponse diff --git a/sig/scalar-api-ruby/resources/rules.rbs b/sig/scalar_api_ruby/resources/rules.rbs similarity index 100% rename from sig/scalar-api-ruby/resources/rules.rbs rename to sig/scalar_api_ruby/resources/rules.rbs diff --git a/sig/scalar-api-ruby/resources/scalar_docs.rbs b/sig/scalar_api_ruby/resources/scalar_docs.rbs similarity index 100% rename from sig/scalar-api-ruby/resources/scalar_docs.rbs rename to sig/scalar_api_ruby/resources/scalar_docs.rbs diff --git a/sig/scalar-api-ruby/resources/schemas.rbs b/sig/scalar_api_ruby/resources/schemas.rbs similarity index 100% rename from sig/scalar-api-ruby/resources/schemas.rbs rename to sig/scalar_api_ruby/resources/schemas.rbs diff --git a/sig/scalar-api-ruby/resources/schemas/access_group.rbs b/sig/scalar_api_ruby/resources/schemas/access_group.rbs similarity index 100% rename from sig/scalar-api-ruby/resources/schemas/access_group.rbs rename to sig/scalar_api_ruby/resources/schemas/access_group.rbs diff --git a/sig/scalar-api-ruby/resources/schemas/version.rbs b/sig/scalar_api_ruby/resources/schemas/version.rbs similarity index 88% rename from sig/scalar-api-ruby/resources/schemas/version.rbs rename to sig/scalar_api_ruby/resources/schemas/version.rbs index 817fbac..53a6566 100644 --- a/sig/scalar-api-ruby/resources/schemas/version.rbs +++ b/sig/scalar_api_ruby/resources/schemas/version.rbs @@ -7,8 +7,9 @@ module Scalar namespace: String, document: String, version: String, + ?force: bool, ?request_options: Scalar::request_opts - ) -> Scalar::UID + ) -> Scalar::Models::Schemas::VersionCreateResponse def retrieve: ( String semver, diff --git a/sig/scalar-api-ruby/resources/teams.rbs b/sig/scalar_api_ruby/resources/teams.rbs similarity index 100% rename from sig/scalar-api-ruby/resources/teams.rbs rename to sig/scalar_api_ruby/resources/teams.rbs diff --git a/sig/scalar-api-ruby/resources/themes.rbs b/sig/scalar_api_ruby/resources/themes.rbs similarity index 100% rename from sig/scalar-api-ruby/resources/themes.rbs rename to sig/scalar_api_ruby/resources/themes.rbs diff --git a/sig/scalar-api-ruby/version.rbs b/sig/scalar_api_ruby/version.rbs similarity index 100% rename from sig/scalar-api-ruby/version.rbs rename to sig/scalar_api_ruby/version.rbs diff --git a/tests/smoke-test.rb b/tests/smoke-test.rb index 5b3e774..366252a 100644 --- a/tests/smoke-test.rb +++ b/tests/smoke-test.rb @@ -6,14 +6,14 @@ require "time" root = - File.exist?(File.join(__dir__, "lib", "scalar-api-ruby.rb")) ? __dir__ : File.expand_path("..", __dir__) + File.exist?(File.join(__dir__, "lib", "scalar_api_ruby.rb")) ? __dir__ : File.expand_path("..", __dir__) $LOAD_PATH.unshift(File.join(root, "lib")) -require "scalar-api-ruby" +require "scalar_api_ruby" # Smoke test: calls every generated operation once to confirm the SDK can reach each endpoint. # Run it from this repo with `ruby tests/smoke-test.rb`. The generator also runs this file # against a mock server and reads the JSON report produced via SCALAR_SMOKE_REPORT. -client = Scalar::Client.new(max_retries: 2, timeout: 30) +client = Scalar::Client.new(max_retries: 2, timeout: 10) cases = [ { @@ -44,7 +44,7 @@ run: -> do client.registry.create_api_document_access_group( "slug", - {access_group_slug: "xxx", namespace: "namespace"} + {access_group_slug: "x", namespace: "namespace"} ) end }, @@ -68,7 +68,7 @@ run: -> do client.registry.create_api_document_version( "slug", - {namespace: "namespace", document: "", version: "x", force: false, last_known_version_sha: ""} + {namespace: "namespace", document: "", version: "x", force: false} ) end }, @@ -85,7 +85,7 @@ run: -> do client.registry.delete_api_document_access_group( "slug", - {access_group_slug: "xxx", namespace: "namespace"} + {access_group_slug: "x", namespace: "namespace"} ) end }, @@ -148,7 +148,6 @@ operation: "updateApiDocumentVersion", method: "PATCH", path: "/v1/apis/{namespace}/{slug}/version/{semver}", - label: "required params", run: -> do client.registry.update_api_document_version( "semver", @@ -156,18 +155,6 @@ ) end }, - { - operation: "updateApiDocumentVersion", - method: "PATCH", - path: "/v1/apis/{namespace}/{slug}/version/{semver}", - label: "all params", - run: -> do - client.registry.update_api_document_version( - "semver", - {namespace: "namespace", slug: "slug", document: "", last_known_version_sha: ""} - ) - end - }, { operation: "create", method: "POST", @@ -219,8 +206,21 @@ operation: "create", method: "POST", path: "/v1/schemas/{namespace}/{slug}/version", + label: "required params", run: -> { client.schemas.version.create("slug", {namespace: "namespace", document: "", version: "x"}) } }, + { + operation: "create", + method: "POST", + path: "/v1/schemas/{namespace}/{slug}/version", + label: "all params", + run: -> do + client.schemas.version.create( + "slug", + {namespace: "namespace", document: "", version: "x", force: false} + ) + end + }, { operation: "retrieve", method: "GET", @@ -237,17 +237,13 @@ operation: "create", method: "POST", path: "/v1/schemas/{namespace}/{slug}/access-group", - run: -> do - client.schemas.access_group.create("slug", {access_group_slug: "xxx", namespace: "namespace"}) - end + run: -> { client.schemas.access_group.create("slug", {access_group_slug: "x", namespace: "namespace"}) } }, { operation: "delete", method: "DELETE", path: "/v1/schemas/{namespace}/{slug}/access-group", - run: -> do - client.schemas.access_group.delete("slug", {access_group_slug: "xxx", namespace: "namespace"}) - end + run: -> { client.schemas.access_group.delete("slug", {access_group_slug: "x", namespace: "namespace"}) } }, { operation: "create", @@ -264,7 +260,7 @@ "title" => "Private Docs", "mainColor" => "\#2a2f45", "mainBackground" => "\#f6f6f6", - "cardColor" => "2a2f45", + "cardColor" => "\#2a2f45", "cardBackground" => "\#fff", "buttonColor" => "\#fff", "buttonBackground" => "\#0f0f0f" @@ -342,7 +338,7 @@ method: "POST", path: "/v1/rulesets/{namespace}/{slug}/access-group", run: -> do - client.rules.create_ruleset_access_group("slug", {access_group_slug: "xxx", namespace: "namespace"}) + client.rules.create_ruleset_access_group("slug", {access_group_slug: "x", namespace: "namespace"}) end }, { @@ -356,7 +352,7 @@ method: "DELETE", path: "/v1/rulesets/{namespace}/{slug}/access-group", run: -> do - client.rules.delete_ruleset_access_group("slug", {access_group_slug: "xxx", namespace: "namespace"}) + client.rules.delete_ruleset_access_group("slug", {access_group_slug: "x", namespace: "namespace"}) end }, { @@ -461,7 +457,7 @@ label: "all params", run: -> do client.scalar_docs.create_guide( - {allowed_domains: [], allowed_users: [], is_private: false, name: "", slug: "xxx"} + {allowed_domains: [], allowed_users: [], is_private: false, name: "", slug: "x"} ) end }, From 68081934feaa706b74cfd4902e57ae856d8c0f45 Mon Sep 17 00:00:00 2001 From: scalarbot Date: Fri, 2 Oct 2026 00:39:50 +0000 Subject: [PATCH 2/7] feat(api): add operation accessGroups.create (+66 more changes) - Added operation `accessGroups.create` (`POST /v1/access-groups`). - Added operation `accessGroups.retrieve` (`GET /v1/access-groups/{slug}`). - Added operation `accessGroups.update` (`PATCH /v1/access-groups/{slug}`). - Added operation `accessGroups.delete` (`DELETE /v1/access-groups/{slug}`). - Added operation `accessGroups.domains.create` (`POST /v1/access-groups/{slug}/domains`). - Added operation `accessGroups.domains.delete` (`DELETE /v1/access-groups/{slug}/domains`). - Added operation `teams.members.list` (`GET /v1/teams/members`). - Added operation `teams.members.update` (`PATCH /v1/teams/members/{uid}`). - Added operation `teams.members.delete` (`DELETE /v1/teams/members/{uid}`). - Added operation `teams.invites.member` (`POST /v1/teams/invites`). - Added operation `teams.invites.resend` (`PATCH /v1/teams/invites/{uid}`). - Added operation `teams.invites.cancel` (`DELETE /v1/teams/invites/{uid}`). - Added operation `scalarDocs.listProjects` (`GET /v1/docs`). - Added operation `scalarDocs.createProject` (`POST /v1/docs`). - Added operation `scalarDocs.retrieveProject` (`GET /v1/docs/{slug}`). - Added operation `scalarDocs.updateProject` (`PATCH /v1/docs/{slug}`). - Added operation `scalarDocs.deleteProject` (`DELETE /v1/docs/{slug}`). - Added operation `scalarDocs.publishProject` (`POST /v1/docs/{slug}/publish`). - Added operation `scalarDocs.listProjectConfig` (`GET /v1/docs/{slug}/config`). - Added operation `scalarDocs.updateProjectConfig` (`PUT /v1/docs/{slug}/config`). - Added operation `scalarDocs.listProjectDomain` (`GET /v1/docs/{slug}/domain`). - Added operation `scalarDocs.listProjectDomainStatus` (`GET /v1/docs/{slug}/domain/status`). - Added operation `sdks.list` (`GET /v1/sdks`). - Added operation `sdks.create` (`POST /v1/sdks`). - Added operation `sdks.retrieve` (`GET /v1/sdks/{uid}`). - Added operation `sdks.update` (`PATCH /v1/sdks/{uid}`). - Added operation `sdks.delete` (`DELETE /v1/sdks/{uid}`). - Added operation `sdks.build` (`POST /v1/sdks/{uid}/build`). - Added operation `sdks.versions.create` (`POST /v1/sdks/{uid}/versions`). - Added operation `sdks.versions.delete` (`DELETE /v1/sdks/{uid}/versions/{version}`). - Added operation `sdks.repositories.link` (`POST /v1/sdks/{uid}/repositories`). - Added operation `sdks.repositories.unlink` (`DELETE /v1/sdks/{uid}/repositories/{language}`). - Added operation `sdks.repositories.updatePublishing` (`POST /v1/sdks/{uid}/repositories/{language}/publishing`). - Added operation `mcp.servers.list` (`GET /v1/mcp/servers`). - Added operation `mcp.servers.create` (`POST /v1/mcp/servers`). - Added operation `mcp.servers.retrieve` (`GET /v1/mcp/servers/{id}`). - Added operation `mcp.servers.update` (`PATCH /v1/mcp/servers/{id}`). - Added operation `mcp.servers.delete` (`DELETE /v1/mcp/servers/{id}`). - Added operation `mcp.servers.installations.list` (`GET /v1/mcp/servers/{id}/installations`). - Added operation `mcp.servers.installations.create` (`POST /v1/mcp/servers/{id}/installations`). - Added operation `mcp.servers.installations.retrieve` (`GET /v1/mcp/servers/{id}/installations/{installationId}`). - Added operation `mcp.servers.installations.update` (`PATCH /v1/mcp/servers/{id}/installations/{installationId}`). - Added operation `mcp.servers.installations.delete` (`DELETE /v1/mcp/servers/{id}/installations/{installationId}`). - Added operation `mcp.servers.installations.createAccessGroup` (`POST /v1/mcp/servers/{id}/installations/{installationId}/access-group`). - Added operation `mcp.servers.installations.deleteAccessGroup` (`DELETE /v1/mcp/servers/{id}/installations/{installationId}/access-group`). - Added operation `oAuth.oauthAuthorize` (`GET /v1/oauth/authorize`). - Added operation `oAuth.oauthToken` (`POST /v1/oauth/token`). - Added operation `oAuth.oauthRevoke` (`POST /v1/oauth/revoke`). - Added operation `oAuth.oauthAuthorizationServerMetadata` (`GET /.well-known/oauth-authorization-server`). - Added schema `access_group_name`. - Added schema `email_domain`. - Added schema `team_member`. - Added schema `role`. - Added schema `team_invite`. - Added schema `sdk`. - Added schema `sdk_target_summary`. - Added schema `sdk_version`. - Added schema `docs_project`. - Added schema `mcp_server`. - Added schema `mcp_installation`. - Added schema `mcp_installation_list_item`. - Added schema `oauth_token`. - Added schema `oauth_scope`. - Added schema `oauth_error`. - Added schema `oauth_token_request`. - Added schema `oauth_revoke_request`. - Added schema `oauth_authorization_server_metadata`. Build: fp8dFvEDjyiCAhKbA7qeF --- api.md | 833 +- lib/scalar_api_ruby.rb | 109 +- lib/scalar_api_ruby/client.rb | 19 + lib/scalar_api_ruby/models.rb | 104 + .../models/access_group_create_params.rb | 32 + .../models/access_group_create_response.rb | 40 + .../models/access_group_delete_params.rb | 20 + .../models/access_group_name.rb | 7 + .../models/access_group_retrieve_params.rb | 20 + .../models/access_group_retrieve_response.rb | 40 + .../models/access_group_update_params.rb | 32 + .../access_groups/domain_create_params.rb | 28 + .../access_groups/domain_delete_params.rb | 28 + .../models/access_groups/email_domain.rb | 9 + .../models/active_deployment.rb | 27 + lib/scalar_api_ruby/models/api_document.rb | 63 + lib/scalar_api_ruby/models/docs_project.rb | 76 + lib/scalar_api_ruby/models/github_project.rb | 123 + .../models/github_project_repository.rb | 63 + lib/scalar_api_ruby/models/login_portal.rb | 27 + .../models/login_portal_list_response.rb | 25 +- .../models/managed_doc_version.rb | 24 +- .../models/managed_schema_version.rb | 45 + .../models/mcp/mcp_installation.rb | 75 + lib/scalar_api_ruby/models/mcp/mcp_server.rb | 50 + .../models/mcp/server_create_params.rb | 40 + .../models/mcp/server_create_response.rb | 24 + .../models/mcp/server_delete_params.rb | 22 + .../models/mcp/server_list_params.rb | 16 + .../models/mcp/server_list_response.rb | 10 + .../models/mcp/server_retrieve_params.rb | 22 + .../models/mcp/server_update_params.rb | 52 + ...installation_create_access_group_params.rb | 36 + .../mcp/servers/installation_create_params.rb | 44 + ...installation_delete_access_group_params.rb | 36 + .../mcp/servers/installation_delete_params.rb | 30 + .../mcp/servers/installation_list_params.rb | 24 + .../mcp/servers/installation_list_response.rb | 13 + .../servers/installation_retrieve_params.rb | 30 + .../mcp/servers/installation_update_params.rb | 68 + .../mcp/servers/mcp_installation_list_item.rb | 43 + lib/scalar_api_ruby/models/method.rb | 22 + ...th_authorization_server_metadata_params.rb | 14 + .../models/o_auth_oauth_authorize_params.rb | 14 + .../models/o_auth_oauth_revoke_params.rb | 38 + .../models/o_auth_oauth_token_params.rb | 62 + .../models/o_auth_oauth_token_response.rb | 17 + .../oauth_authorization_server_metadata.rb | 70 + lib/scalar_api_ruby/models/oauth_error.rb | 22 + lib/scalar_api_ruby/models/oauth_scope.rb | 16 + lib/scalar_api_ruby/models/oauth_token.rb | 39 + ...egistry_list_all_api_documents_response.rb | 61 +- .../registry_list_api_documents_response.rb | 61 +- lib/scalar_api_ruby/models/rule.rb | 45 + .../models/rule_list_rulesets_response.rb | 43 +- .../scalar_doc_create_project_params.rb | 103 + .../scalar_doc_delete_project_params.rb | 20 + .../models/scalar_doc_list_guides_response.rb | 206 +- .../scalar_doc_list_project_config_params.rb | 26 + ...scalar_doc_list_project_config_response.rb | 34 + .../scalar_doc_list_project_domain_params.rb | 20 + ...scalar_doc_list_project_domain_response.rb | 22 + ...r_doc_list_project_domain_status_params.rb | 20 + ...doc_list_project_domain_status_response.rb | 65 + .../models/scalar_doc_list_projects_params.rb | 20 + .../scalar_doc_list_projects_response.rb | 22 + .../scalar_doc_publish_project_params.rb | 38 + .../scalar_doc_publish_project_response.rb | 16 + .../scalar_doc_retrieve_project_params.rb | 20 + ...scalar_doc_update_project_config_params.rb | 50 + ...alar_doc_update_project_config_response.rb | 28 + .../scalar_doc_update_project_params.rb | 75 + lib/scalar_api_ruby/models/schema.rb | 51 + .../models/schema_list_response.rb | 89 +- lib/scalar_api_ruby/models/sdk.rb | 76 + .../models/sdk_build_params.rb | 53 + .../models/sdk_build_response.rb | 16 + .../models/sdk_create_params.rb | 71 + .../models/sdk_delete_params.rb | 20 + lib/scalar_api_ruby/models/sdk_list_params.rb | 20 + .../models/sdk_list_response.rb | 22 + .../models/sdk_retrieve_params.rb | 20 + .../models/sdk_target_summary.rb | 43 + .../models/sdk_update_params.rb | 56 + lib/scalar_api_ruby/models/sdk_version.rb | 77 + .../models/sdks/repository_link_params.rb | 67 + .../models/sdks/repository_link_response.rb | 24 + .../models/sdks/repository_unlink_params.rb | 49 + .../repository_update_publishing_params.rb | 95 + .../models/sdks/version_create_params.rb | 34 + .../models/sdks/version_delete_params.rb | 28 + lib/scalar_api_ruby/models/team.rb | 39 + lib/scalar_api_ruby/models/team_image.rb | 7 + .../models/team_list_response.rb | 36 +- lib/scalar_api_ruby/models/team_name.rb | 7 + lib/scalar_api_ruby/models/team_summary.rb | 27 + lib/scalar_api_ruby/models/teams/email.rb | 9 + .../models/teams/invite_cancel_params.rb | 22 + .../models/teams/invite_member_params.rb | 28 + .../models/teams/invite_resend_params.rb | 22 + .../models/teams/member_delete_params.rb | 22 + .../models/teams/member_list_params.rb | 16 + .../models/teams/member_list_response.rb | 26 + .../models/teams/member_update_params.rb | 28 + lib/scalar_api_ruby/models/teams/role.rb | 19 + .../models/teams/team_invite.rb | 37 + .../models/teams/team_member.rb | 37 + lib/scalar_api_ruby/models/theme.rb | 33 + .../models/theme_list_response.rb | 30 +- ..._list_current_user_response.rb => user.rb} | 33 +- .../resources/access_groups.rb | 108 + .../resources/access_groups/domains.rb | 63 + .../resources/authentication.rb | 4 +- .../resources/login_portals.rb | 4 +- lib/scalar_api_ruby/resources/mcp.rb | 19 + lib/scalar_api_ruby/resources/mcp/servers.rb | 129 + .../resources/mcp/servers/installations.rb | 200 + lib/scalar_api_ruby/resources/o_auth.rb | 113 + lib/scalar_api_ruby/resources/registry.rb | 8 +- lib/scalar_api_ruby/resources/rules.rb | 4 +- lib/scalar_api_ruby/resources/scalar_docs.rb | 239 +- lib/scalar_api_ruby/resources/schemas.rb | 4 +- lib/scalar_api_ruby/resources/sdks.rb | 156 + .../resources/sdks/repositories.rb | 97 + .../resources/sdks/versions.rb | 62 + lib/scalar_api_ruby/resources/teams.rb | 14 +- .../resources/teams/invites.rb | 77 + .../resources/teams/members.rb | 76 + lib/scalar_api_ruby/resources/themes.rb | 4 +- rbi/scalar_api_ruby/client.rbi | 15 + rbi/scalar_api_ruby/models.rbi | 111 + .../models/access_group_create_params.rbi | 62 + .../models/access_group_create_response.rbi | 56 + .../models/access_group_delete_params.rbi | 35 + .../models/access_group_name.rbi | 7 + .../models/access_group_retrieve_params.rbi | 35 + .../models/access_group_retrieve_response.rbi | 56 + .../models/access_group_update_params.rbi | 54 + .../access_groups/domain_create_params.rbi | 48 + .../access_groups/domain_delete_params.rbi | 48 + .../models/access_groups/email_domain.rbi | 9 + .../models/active_deployment.rbi | 35 + rbi/scalar_api_ruby/models/api_document.rbi | 81 + ...hentication_list_current_user_response.rbi | 129 - rbi/scalar_api_ruby/models/docs_project.rbi | 93 + rbi/scalar_api_ruby/models/github_project.rbi | 158 + .../models/github_project_repository.rbi | 83 + rbi/scalar_api_ruby/models/login_portal.rbi | 31 + .../models/login_portal_list_response.rbi | 35 +- .../models/managed_doc_version.rbi | 49 +- .../models/managed_schema_version.rbi | 71 + .../models/mcp/mcp_installation.rbi | 93 + rbi/scalar_api_ruby/models/mcp/mcp_server.rbi | 69 + .../models/mcp/server_create_params.rbi | 70 + .../models/mcp/server_create_response.rbi | 49 + .../models/mcp/server_delete_params.rbi | 37 + .../models/mcp/server_list_params.rbi | 29 + .../models/mcp/server_list_response.rbi | 13 + .../models/mcp/server_retrieve_params.rbi | 37 + .../models/mcp/server_update_params.rbi | 88 + ...nstallation_create_access_group_params.rbi | 60 + .../servers/installation_create_params.rbi | 69 + ...nstallation_delete_access_group_params.rbi | 60 + .../servers/installation_delete_params.rbi | 50 + .../mcp/servers/installation_list_params.rbi | 42 + .../servers/installation_list_response.rbi | 17 + .../servers/installation_retrieve_params.rbi | 50 + .../servers/installation_update_params.rbi | 102 + .../servers/mcp_installation_list_item.rbi | 60 + rbi/scalar_api_ruby/models/method.rbi | 26 + ...h_authorization_server_metadata_params.rbi | 30 + .../models/o_auth_oauth_authorize_params.rbi | 27 + .../models/o_auth_oauth_revoke_params.rbi | 68 + .../models/o_auth_oauth_token_params.rbi | 104 + .../models/o_auth_oauth_token_response.rbi | 19 + .../oauth_authorization_server_metadata.rbi | 92 + rbi/scalar_api_ruby/models/oauth_error.rbi | 31 + rbi/scalar_api_ruby/models/oauth_scope.rbi | 20 + rbi/scalar_api_ruby/models/oauth_token.rbi | 57 + ...gistry_list_all_api_documents_response.rbi | 85 +- .../registry_list_api_documents_response.rbi | 85 +- rbi/scalar_api_ruby/models/rule.rbi | 55 + .../models/rule_list_rulesets_response.rbi | 60 +- .../scalar_doc_create_project_params.rbi | 206 + .../scalar_doc_delete_project_params.rbi | 35 + .../scalar_doc_list_guides_response.rbi | 306 +- .../scalar_doc_list_project_config_params.rbi | 45 + ...calar_doc_list_project_config_response.rbi | 46 + .../scalar_doc_list_project_domain_params.rbi | 38 + ...calar_doc_list_project_domain_response.rbi | 38 + ..._doc_list_project_domain_status_params.rbi | 38 + ...oc_list_project_domain_status_response.rbi | 142 + .../scalar_doc_list_projects_params.rbi | 38 + .../scalar_doc_list_projects_response.rbi | 38 + .../scalar_doc_publish_project_params.rbi | 71 + .../scalar_doc_publish_project_response.rbi | 26 + .../scalar_doc_retrieve_project_params.rbi | 38 + ...calar_doc_update_project_config_params.rbi | 86 + ...lar_doc_update_project_config_response.rbi | 42 + .../scalar_doc_update_project_params.rbi | 126 + rbi/scalar_api_ruby/models/schema.rbi | 68 + .../models/schema_list_response.rbi | 141 +- rbi/scalar_api_ruby/models/sdk.rbi | 92 + .../models/sdk_build_params.rbi | 91 + .../models/sdk_build_response.rbi | 23 + .../models/sdk_create_params.rbi | 114 + .../models/sdk_delete_params.rbi | 35 + .../models/sdk_list_params.rbi | 36 + .../models/sdk_list_response.rbi | 33 + .../models/sdk_retrieve_params.rbi | 35 + .../models/sdk_target_summary.rbi | 72 + .../models/sdk_update_params.rbi | 89 + rbi/scalar_api_ruby/models/sdk_version.rbi | 115 + .../models/sdks/repository_link_params.rbi | 156 + .../models/sdks/repository_link_response.rbi | 31 + .../models/sdks/repository_unlink_params.rbi | 137 + .../repository_update_publishing_params.rbi | 274 + .../models/sdks/version_create_params.rbi | 50 + .../models/sdks/version_delete_params.rbi | 45 + rbi/scalar_api_ruby/models/team.rbi | 53 + rbi/scalar_api_ruby/models/team_image.rbi | 7 + .../models/team_list_response.rbi | 53 +- rbi/scalar_api_ruby/models/team_name.rbi | 7 + rbi/scalar_api_ruby/models/team_summary.rbi | 34 + rbi/scalar_api_ruby/models/teams/email.rbi | 9 + .../models/teams/invite_cancel_params.rbi | 37 + .../models/teams/invite_member_params.rbi | 45 + .../models/teams/invite_resend_params.rbi | 37 + .../models/teams/member_delete_params.rbi | 37 + .../models/teams/member_list_params.rbi | 29 + .../models/teams/member_list_response.rbi | 43 + .../models/teams/member_update_params.rbi | 45 + rbi/scalar_api_ruby/models/teams/role.rbi | 23 + .../models/teams/team_invite.rbi | 55 + .../models/teams/team_member.rbi | 55 + rbi/scalar_api_ruby/models/theme.rbi | 40 + .../models/theme_list_response.rbi | 43 +- rbi/scalar_api_ruby/models/user.rbi | 77 + .../resources/access_groups.rbi | 70 + .../resources/access_groups/domains.rbi | 39 + .../resources/authentication.rbi | 2 +- .../resources/login_portals.rbi | 2 +- rbi/scalar_api_ruby/resources/mcp.rbi | 16 + rbi/scalar_api_ruby/resources/mcp/servers.rbi | 91 + .../resources/mcp/servers/installations.rbi | 140 + rbi/scalar_api_ruby/resources/o_auth.rbi | 87 + rbi/scalar_api_ruby/resources/registry.rbi | 6 +- rbi/scalar_api_ruby/resources/rules.rbi | 2 +- rbi/scalar_api_ruby/resources/scalar_docs.rbi | 169 +- rbi/scalar_api_ruby/resources/schemas.rbi | 2 +- rbi/scalar_api_ruby/resources/sdks.rbi | 112 + .../resources/sdks/repositories.rbi | 79 + .../resources/sdks/versions.rbi | 38 + rbi/scalar_api_ruby/resources/teams.rbi | 10 +- .../resources/teams/invites.rbi | 46 + .../resources/teams/members.rbi | 45 + rbi/scalar_api_ruby/resources/themes.rbi | 2 +- reference.md | 49 + scalar-sdk.manifest.json | 12671 ++++++++++++++-- sig/scalar_api_ruby/client.rbs | 8 + sig/scalar_api_ruby/models.rbs | 104 + .../models/access_group_create_params.rbs | 38 + .../models/access_group_create_response.rbs | 40 + .../models/access_group_delete_params.rbs | 20 + .../models/access_group_name.rbs | 5 + .../models/access_group_retrieve_params.rbs | 20 + .../models/access_group_retrieve_response.rbs | 40 + .../models/access_group_update_params.rbs | 36 + .../access_groups/domain_create_params.rbs | 30 + .../access_groups/domain_delete_params.rbs | 30 + .../models/access_groups/email_domain.rbs | 7 + .../models/active_deployment.rbs | 22 + sig/scalar_api_ruby/models/api_document.rbs | 60 + sig/scalar_api_ruby/models/docs_project.rbs | 70 + sig/scalar_api_ruby/models/github_project.rbs | 112 + .../models/github_project_repository.rbs | 60 + sig/scalar_api_ruby/models/login_portal.rbs | 17 + .../models/login_portal_list_response.rbs | 18 +- .../models/managed_doc_version.rbs | 35 +- .../models/managed_schema_version.rbs | 49 + .../models/mcp/mcp_installation.rbs | 69 + sig/scalar_api_ruby/models/mcp/mcp_server.rbs | 49 + .../models/mcp/server_create_params.rbs | 49 + .../models/mcp/server_create_response.rbs | 27 + .../models/mcp/server_delete_params.rbs | 22 + .../models/mcp/server_list_params.rbs | 17 + .../models/mcp/server_list_response.rbs | 9 + .../models/mcp/server_retrieve_params.rbs | 22 + .../models/mcp/server_update_params.rbs | 63 + ...nstallation_create_access_group_params.rbs | 36 + .../servers/installation_create_params.rbs | 47 + ...nstallation_delete_access_group_params.rbs | 36 + .../servers/installation_delete_params.rbs | 32 + .../mcp/servers/installation_list_params.rbs | 27 + .../servers/installation_list_response.rbs | 12 + .../servers/installation_retrieve_params.rbs | 32 + .../servers/installation_update_params.rbs | 73 + .../servers/mcp_installation_list_item.rbs | 44 + sig/scalar_api_ruby/models/method.rbs | 30 + ...h_authorization_server_metadata_params.rbs | 15 + .../models/o_auth_oauth_authorize_params.rbs | 15 + .../models/o_auth_oauth_revoke_params.rbs | 47 + .../models/o_auth_oauth_token_params.rbs | 75 + .../models/o_auth_oauth_token_response.rbs | 11 + .../oauth_authorization_server_metadata.rbs | 65 + sig/scalar_api_ruby/models/oauth_error.rbs | 17 + sig/scalar_api_ruby/models/oauth_scope.rbs | 15 + sig/scalar_api_ruby/models/oauth_token.rbs | 40 + ...gistry_list_all_api_documents_response.rbs | 60 +- .../registry_list_api_documents_response.rbs | 60 +- sig/scalar_api_ruby/models/rule.rbs | 45 + .../models/rule_list_rulesets_response.rbs | 45 +- .../scalar_doc_create_project_params.rbs | 106 + .../scalar_doc_delete_project_params.rbs | 20 + .../scalar_doc_list_guides_response.rbs | 188 +- .../scalar_doc_list_project_config_params.rbs | 29 + ...calar_doc_list_project_config_response.rbs | 30 + .../scalar_doc_list_project_domain_params.rbs | 20 + ...calar_doc_list_project_domain_response.rbs | 16 + ..._doc_list_project_domain_status_params.rbs | 20 + ...oc_list_project_domain_status_response.rbs | 59 + .../scalar_doc_list_projects_params.rbs | 25 + .../scalar_doc_list_projects_response.rbs | 19 + .../scalar_doc_publish_project_params.rbs | 42 + .../scalar_doc_publish_project_response.rbs | 13 + .../scalar_doc_retrieve_project_params.rbs | 20 + ...calar_doc_update_project_config_params.rbs | 59 + ...lar_doc_update_project_config_response.rbs | 22 + .../scalar_doc_update_project_params.rbs | 85 + sig/scalar_api_ruby/models/schema.rbs | 50 + .../models/schema_list_response.rbs | 95 +- sig/scalar_api_ruby/models/sdk.rbs | 70 + .../models/sdk_build_params.rbs | 77 + .../models/sdk_build_response.rbs | 13 + .../models/sdk_create_params.rbs | 94 + .../models/sdk_delete_params.rbs | 20 + .../models/sdk_list_params.rbs | 25 + .../models/sdk_list_response.rbs | 15 + .../models/sdk_retrieve_params.rbs | 20 + .../models/sdk_target_summary.rbs | 57 + .../models/sdk_update_params.rbs | 64 + sig/scalar_api_ruby/models/sdk_version.rbs | 95 + .../models/sdks/repository_link_params.rbs | 85 + .../models/sdks/repository_link_response.rbs | 17 + .../models/sdks/repository_unlink_params.rbs | 68 + .../repository_update_publishing_params.rbs | 120 + .../models/sdks/version_create_params.rbs | 34 + .../models/sdks/version_delete_params.rbs | 30 + sig/scalar_api_ruby/models/team.rbs | 42 + sig/scalar_api_ruby/models/team_image.rbs | 5 + .../models/team_list_response.rbs | 41 +- sig/scalar_api_ruby/models/team_name.rbs | 5 + sig/scalar_api_ruby/models/team_summary.rbs | 19 + sig/scalar_api_ruby/models/teams/email.rbs | 7 + .../models/teams/invite_cancel_params.rbs | 22 + .../models/teams/invite_member_params.rbs | 30 + .../models/teams/invite_resend_params.rbs | 22 + .../models/teams/member_delete_params.rbs | 22 + .../models/teams/member_list_params.rbs | 17 + .../models/teams/member_list_response.rbs | 27 + .../models/teams/member_update_params.rbs | 30 + sig/scalar_api_ruby/models/teams/role.rbs | 18 + .../models/teams/team_invite.rbs | 41 + .../models/teams/team_member.rbs | 41 + sig/scalar_api_ruby/models/theme.rbs | 30 + .../models/theme_list_response.rbs | 29 +- ...ist_current_user_response.rbs => user.rbs} | 28 +- .../resources/access_groups.rbs | 30 + .../resources/access_groups/domains.rbs | 21 + .../resources/authentication.rbs | 2 +- .../resources/login_portals.rbs | 2 +- sig/scalar_api_ruby/resources/mcp.rbs | 9 + sig/scalar_api_ruby/resources/mcp/servers.rbs | 40 + .../resources/mcp/servers/installations.rbs | 62 + sig/scalar_api_ruby/resources/o_auth.rbs | 33 + sig/scalar_api_ruby/resources/registry.rbs | 4 +- sig/scalar_api_ruby/resources/rules.rbs | 2 +- sig/scalar_api_ruby/resources/scalar_docs.rbs | 74 +- sig/scalar_api_ruby/resources/schemas.rbs | 2 +- sig/scalar_api_ruby/resources/sdks.rbs | 51 + .../resources/sdks/repositories.rbs | 34 + .../resources/sdks/versions.rbs | 22 + sig/scalar_api_ruby/resources/teams.rbs | 6 +- .../resources/teams/invites.rbs | 19 + .../resources/teams/members.rbs | 21 + sig/scalar_api_ruby/resources/themes.rbs | 2 +- tests/smoke-test.rb | 538 + 387 files changed, 28636 insertions(+), 3629 deletions(-) create mode 100644 lib/scalar_api_ruby/models/access_group_create_params.rb create mode 100644 lib/scalar_api_ruby/models/access_group_create_response.rb create mode 100644 lib/scalar_api_ruby/models/access_group_delete_params.rb create mode 100644 lib/scalar_api_ruby/models/access_group_name.rb create mode 100644 lib/scalar_api_ruby/models/access_group_retrieve_params.rb create mode 100644 lib/scalar_api_ruby/models/access_group_retrieve_response.rb create mode 100644 lib/scalar_api_ruby/models/access_group_update_params.rb create mode 100644 lib/scalar_api_ruby/models/access_groups/domain_create_params.rb create mode 100644 lib/scalar_api_ruby/models/access_groups/domain_delete_params.rb create mode 100644 lib/scalar_api_ruby/models/access_groups/email_domain.rb create mode 100644 lib/scalar_api_ruby/models/active_deployment.rb create mode 100644 lib/scalar_api_ruby/models/api_document.rb create mode 100644 lib/scalar_api_ruby/models/docs_project.rb create mode 100644 lib/scalar_api_ruby/models/github_project.rb create mode 100644 lib/scalar_api_ruby/models/github_project_repository.rb create mode 100644 lib/scalar_api_ruby/models/login_portal.rb create mode 100644 lib/scalar_api_ruby/models/managed_schema_version.rb create mode 100644 lib/scalar_api_ruby/models/mcp/mcp_installation.rb create mode 100644 lib/scalar_api_ruby/models/mcp/mcp_server.rb create mode 100644 lib/scalar_api_ruby/models/mcp/server_create_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/server_create_response.rb create mode 100644 lib/scalar_api_ruby/models/mcp/server_delete_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/server_list_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/server_list_response.rb create mode 100644 lib/scalar_api_ruby/models/mcp/server_retrieve_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/server_update_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/servers/installation_create_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/servers/installation_delete_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/servers/installation_list_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/servers/installation_list_response.rb create mode 100644 lib/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/servers/installation_update_params.rb create mode 100644 lib/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rb create mode 100644 lib/scalar_api_ruby/models/method.rb create mode 100644 lib/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rb create mode 100644 lib/scalar_api_ruby/models/o_auth_oauth_authorize_params.rb create mode 100644 lib/scalar_api_ruby/models/o_auth_oauth_revoke_params.rb create mode 100644 lib/scalar_api_ruby/models/o_auth_oauth_token_params.rb create mode 100644 lib/scalar_api_ruby/models/o_auth_oauth_token_response.rb create mode 100644 lib/scalar_api_ruby/models/oauth_authorization_server_metadata.rb create mode 100644 lib/scalar_api_ruby/models/oauth_error.rb create mode 100644 lib/scalar_api_ruby/models/oauth_scope.rb create mode 100644 lib/scalar_api_ruby/models/oauth_token.rb create mode 100644 lib/scalar_api_ruby/models/rule.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_create_project_params.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_delete_project_params.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_list_project_config_params.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_list_project_config_response.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_list_projects_params.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_list_projects_response.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_publish_project_params.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_publish_project_response.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_update_project_config_params.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_update_project_config_response.rb create mode 100644 lib/scalar_api_ruby/models/scalar_doc_update_project_params.rb create mode 100644 lib/scalar_api_ruby/models/schema.rb create mode 100644 lib/scalar_api_ruby/models/sdk.rb create mode 100644 lib/scalar_api_ruby/models/sdk_build_params.rb create mode 100644 lib/scalar_api_ruby/models/sdk_build_response.rb create mode 100644 lib/scalar_api_ruby/models/sdk_create_params.rb create mode 100644 lib/scalar_api_ruby/models/sdk_delete_params.rb create mode 100644 lib/scalar_api_ruby/models/sdk_list_params.rb create mode 100644 lib/scalar_api_ruby/models/sdk_list_response.rb create mode 100644 lib/scalar_api_ruby/models/sdk_retrieve_params.rb create mode 100644 lib/scalar_api_ruby/models/sdk_target_summary.rb create mode 100644 lib/scalar_api_ruby/models/sdk_update_params.rb create mode 100644 lib/scalar_api_ruby/models/sdk_version.rb create mode 100644 lib/scalar_api_ruby/models/sdks/repository_link_params.rb create mode 100644 lib/scalar_api_ruby/models/sdks/repository_link_response.rb create mode 100644 lib/scalar_api_ruby/models/sdks/repository_unlink_params.rb create mode 100644 lib/scalar_api_ruby/models/sdks/repository_update_publishing_params.rb create mode 100644 lib/scalar_api_ruby/models/sdks/version_create_params.rb create mode 100644 lib/scalar_api_ruby/models/sdks/version_delete_params.rb create mode 100644 lib/scalar_api_ruby/models/team.rb create mode 100644 lib/scalar_api_ruby/models/team_image.rb create mode 100644 lib/scalar_api_ruby/models/team_name.rb create mode 100644 lib/scalar_api_ruby/models/team_summary.rb create mode 100644 lib/scalar_api_ruby/models/teams/email.rb create mode 100644 lib/scalar_api_ruby/models/teams/invite_cancel_params.rb create mode 100644 lib/scalar_api_ruby/models/teams/invite_member_params.rb create mode 100644 lib/scalar_api_ruby/models/teams/invite_resend_params.rb create mode 100644 lib/scalar_api_ruby/models/teams/member_delete_params.rb create mode 100644 lib/scalar_api_ruby/models/teams/member_list_params.rb create mode 100644 lib/scalar_api_ruby/models/teams/member_list_response.rb create mode 100644 lib/scalar_api_ruby/models/teams/member_update_params.rb create mode 100644 lib/scalar_api_ruby/models/teams/role.rb create mode 100644 lib/scalar_api_ruby/models/teams/team_invite.rb create mode 100644 lib/scalar_api_ruby/models/teams/team_member.rb create mode 100644 lib/scalar_api_ruby/models/theme.rb rename lib/scalar_api_ruby/models/{authentication_list_current_user_response.rb => user.rb} (58%) create mode 100644 lib/scalar_api_ruby/resources/access_groups.rb create mode 100644 lib/scalar_api_ruby/resources/access_groups/domains.rb create mode 100644 lib/scalar_api_ruby/resources/mcp.rb create mode 100644 lib/scalar_api_ruby/resources/mcp/servers.rb create mode 100644 lib/scalar_api_ruby/resources/mcp/servers/installations.rb create mode 100644 lib/scalar_api_ruby/resources/o_auth.rb create mode 100644 lib/scalar_api_ruby/resources/sdks.rb create mode 100644 lib/scalar_api_ruby/resources/sdks/repositories.rb create mode 100644 lib/scalar_api_ruby/resources/sdks/versions.rb create mode 100644 lib/scalar_api_ruby/resources/teams/invites.rb create mode 100644 lib/scalar_api_ruby/resources/teams/members.rb create mode 100644 rbi/scalar_api_ruby/models/access_group_create_params.rbi create mode 100644 rbi/scalar_api_ruby/models/access_group_create_response.rbi create mode 100644 rbi/scalar_api_ruby/models/access_group_delete_params.rbi create mode 100644 rbi/scalar_api_ruby/models/access_group_name.rbi create mode 100644 rbi/scalar_api_ruby/models/access_group_retrieve_params.rbi create mode 100644 rbi/scalar_api_ruby/models/access_group_retrieve_response.rbi create mode 100644 rbi/scalar_api_ruby/models/access_group_update_params.rbi create mode 100644 rbi/scalar_api_ruby/models/access_groups/domain_create_params.rbi create mode 100644 rbi/scalar_api_ruby/models/access_groups/domain_delete_params.rbi create mode 100644 rbi/scalar_api_ruby/models/access_groups/email_domain.rbi create mode 100644 rbi/scalar_api_ruby/models/active_deployment.rbi create mode 100644 rbi/scalar_api_ruby/models/api_document.rbi delete mode 100644 rbi/scalar_api_ruby/models/authentication_list_current_user_response.rbi create mode 100644 rbi/scalar_api_ruby/models/docs_project.rbi create mode 100644 rbi/scalar_api_ruby/models/github_project.rbi create mode 100644 rbi/scalar_api_ruby/models/github_project_repository.rbi create mode 100644 rbi/scalar_api_ruby/models/login_portal.rbi create mode 100644 rbi/scalar_api_ruby/models/managed_schema_version.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/mcp_installation.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/mcp_server.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/server_create_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/server_create_response.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/server_delete_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/server_list_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/server_list_response.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/server_retrieve_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/server_update_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/servers/installation_create_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/servers/installation_delete_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/servers/installation_list_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/servers/installation_list_response.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/servers/installation_update_params.rbi create mode 100644 rbi/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rbi create mode 100644 rbi/scalar_api_ruby/models/method.rbi create mode 100644 rbi/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbi create mode 100644 rbi/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbi create mode 100644 rbi/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbi create mode 100644 rbi/scalar_api_ruby/models/o_auth_oauth_token_params.rbi create mode 100644 rbi/scalar_api_ruby/models/o_auth_oauth_token_response.rbi create mode 100644 rbi/scalar_api_ruby/models/oauth_authorization_server_metadata.rbi create mode 100644 rbi/scalar_api_ruby/models/oauth_error.rbi create mode 100644 rbi/scalar_api_ruby/models/oauth_scope.rbi create mode 100644 rbi/scalar_api_ruby/models/oauth_token.rbi create mode 100644 rbi/scalar_api_ruby/models/rule.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_create_project_params.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_delete_project_params.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_list_project_config_params.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_list_project_config_response.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_list_projects_params.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_list_projects_response.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_publish_project_params.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_publish_project_response.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_update_project_config_params.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_update_project_config_response.rbi create mode 100644 rbi/scalar_api_ruby/models/scalar_doc_update_project_params.rbi create mode 100644 rbi/scalar_api_ruby/models/schema.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk_build_params.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk_build_response.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk_create_params.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk_delete_params.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk_list_params.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk_list_response.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk_retrieve_params.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk_target_summary.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk_update_params.rbi create mode 100644 rbi/scalar_api_ruby/models/sdk_version.rbi create mode 100644 rbi/scalar_api_ruby/models/sdks/repository_link_params.rbi create mode 100644 rbi/scalar_api_ruby/models/sdks/repository_link_response.rbi create mode 100644 rbi/scalar_api_ruby/models/sdks/repository_unlink_params.rbi create mode 100644 rbi/scalar_api_ruby/models/sdks/repository_update_publishing_params.rbi create mode 100644 rbi/scalar_api_ruby/models/sdks/version_create_params.rbi create mode 100644 rbi/scalar_api_ruby/models/sdks/version_delete_params.rbi create mode 100644 rbi/scalar_api_ruby/models/team.rbi create mode 100644 rbi/scalar_api_ruby/models/team_image.rbi create mode 100644 rbi/scalar_api_ruby/models/team_name.rbi create mode 100644 rbi/scalar_api_ruby/models/team_summary.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/email.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/invite_cancel_params.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/invite_member_params.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/invite_resend_params.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/member_delete_params.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/member_list_params.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/member_list_response.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/member_update_params.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/role.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/team_invite.rbi create mode 100644 rbi/scalar_api_ruby/models/teams/team_member.rbi create mode 100644 rbi/scalar_api_ruby/models/theme.rbi create mode 100644 rbi/scalar_api_ruby/models/user.rbi create mode 100644 rbi/scalar_api_ruby/resources/access_groups.rbi create mode 100644 rbi/scalar_api_ruby/resources/access_groups/domains.rbi create mode 100644 rbi/scalar_api_ruby/resources/mcp.rbi create mode 100644 rbi/scalar_api_ruby/resources/mcp/servers.rbi create mode 100644 rbi/scalar_api_ruby/resources/mcp/servers/installations.rbi create mode 100644 rbi/scalar_api_ruby/resources/o_auth.rbi create mode 100644 rbi/scalar_api_ruby/resources/sdks.rbi create mode 100644 rbi/scalar_api_ruby/resources/sdks/repositories.rbi create mode 100644 rbi/scalar_api_ruby/resources/sdks/versions.rbi create mode 100644 rbi/scalar_api_ruby/resources/teams/invites.rbi create mode 100644 rbi/scalar_api_ruby/resources/teams/members.rbi create mode 100644 sig/scalar_api_ruby/models/access_group_create_params.rbs create mode 100644 sig/scalar_api_ruby/models/access_group_create_response.rbs create mode 100644 sig/scalar_api_ruby/models/access_group_delete_params.rbs create mode 100644 sig/scalar_api_ruby/models/access_group_name.rbs create mode 100644 sig/scalar_api_ruby/models/access_group_retrieve_params.rbs create mode 100644 sig/scalar_api_ruby/models/access_group_retrieve_response.rbs create mode 100644 sig/scalar_api_ruby/models/access_group_update_params.rbs create mode 100644 sig/scalar_api_ruby/models/access_groups/domain_create_params.rbs create mode 100644 sig/scalar_api_ruby/models/access_groups/domain_delete_params.rbs create mode 100644 sig/scalar_api_ruby/models/access_groups/email_domain.rbs create mode 100644 sig/scalar_api_ruby/models/active_deployment.rbs create mode 100644 sig/scalar_api_ruby/models/api_document.rbs create mode 100644 sig/scalar_api_ruby/models/docs_project.rbs create mode 100644 sig/scalar_api_ruby/models/github_project.rbs create mode 100644 sig/scalar_api_ruby/models/github_project_repository.rbs create mode 100644 sig/scalar_api_ruby/models/login_portal.rbs create mode 100644 sig/scalar_api_ruby/models/managed_schema_version.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/mcp_installation.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/mcp_server.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/server_create_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/server_create_response.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/server_delete_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/server_list_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/server_list_response.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/server_retrieve_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/server_update_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/servers/installation_create_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/servers/installation_delete_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/servers/installation_list_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/servers/installation_list_response.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/servers/installation_update_params.rbs create mode 100644 sig/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rbs create mode 100644 sig/scalar_api_ruby/models/method.rbs create mode 100644 sig/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbs create mode 100644 sig/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbs create mode 100644 sig/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbs create mode 100644 sig/scalar_api_ruby/models/o_auth_oauth_token_params.rbs create mode 100644 sig/scalar_api_ruby/models/o_auth_oauth_token_response.rbs create mode 100644 sig/scalar_api_ruby/models/oauth_authorization_server_metadata.rbs create mode 100644 sig/scalar_api_ruby/models/oauth_error.rbs create mode 100644 sig/scalar_api_ruby/models/oauth_scope.rbs create mode 100644 sig/scalar_api_ruby/models/oauth_token.rbs create mode 100644 sig/scalar_api_ruby/models/rule.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_create_project_params.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_delete_project_params.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_list_project_config_params.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_list_project_config_response.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_list_projects_params.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_list_projects_response.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_publish_project_params.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_publish_project_response.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_update_project_config_params.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_update_project_config_response.rbs create mode 100644 sig/scalar_api_ruby/models/scalar_doc_update_project_params.rbs create mode 100644 sig/scalar_api_ruby/models/schema.rbs create mode 100644 sig/scalar_api_ruby/models/sdk.rbs create mode 100644 sig/scalar_api_ruby/models/sdk_build_params.rbs create mode 100644 sig/scalar_api_ruby/models/sdk_build_response.rbs create mode 100644 sig/scalar_api_ruby/models/sdk_create_params.rbs create mode 100644 sig/scalar_api_ruby/models/sdk_delete_params.rbs create mode 100644 sig/scalar_api_ruby/models/sdk_list_params.rbs create mode 100644 sig/scalar_api_ruby/models/sdk_list_response.rbs create mode 100644 sig/scalar_api_ruby/models/sdk_retrieve_params.rbs create mode 100644 sig/scalar_api_ruby/models/sdk_target_summary.rbs create mode 100644 sig/scalar_api_ruby/models/sdk_update_params.rbs create mode 100644 sig/scalar_api_ruby/models/sdk_version.rbs create mode 100644 sig/scalar_api_ruby/models/sdks/repository_link_params.rbs create mode 100644 sig/scalar_api_ruby/models/sdks/repository_link_response.rbs create mode 100644 sig/scalar_api_ruby/models/sdks/repository_unlink_params.rbs create mode 100644 sig/scalar_api_ruby/models/sdks/repository_update_publishing_params.rbs create mode 100644 sig/scalar_api_ruby/models/sdks/version_create_params.rbs create mode 100644 sig/scalar_api_ruby/models/sdks/version_delete_params.rbs create mode 100644 sig/scalar_api_ruby/models/team.rbs create mode 100644 sig/scalar_api_ruby/models/team_image.rbs create mode 100644 sig/scalar_api_ruby/models/team_name.rbs create mode 100644 sig/scalar_api_ruby/models/team_summary.rbs create mode 100644 sig/scalar_api_ruby/models/teams/email.rbs create mode 100644 sig/scalar_api_ruby/models/teams/invite_cancel_params.rbs create mode 100644 sig/scalar_api_ruby/models/teams/invite_member_params.rbs create mode 100644 sig/scalar_api_ruby/models/teams/invite_resend_params.rbs create mode 100644 sig/scalar_api_ruby/models/teams/member_delete_params.rbs create mode 100644 sig/scalar_api_ruby/models/teams/member_list_params.rbs create mode 100644 sig/scalar_api_ruby/models/teams/member_list_response.rbs create mode 100644 sig/scalar_api_ruby/models/teams/member_update_params.rbs create mode 100644 sig/scalar_api_ruby/models/teams/role.rbs create mode 100644 sig/scalar_api_ruby/models/teams/team_invite.rbs create mode 100644 sig/scalar_api_ruby/models/teams/team_member.rbs create mode 100644 sig/scalar_api_ruby/models/theme.rbs rename sig/scalar_api_ruby/models/{authentication_list_current_user_response.rbs => user.rbs} (51%) create mode 100644 sig/scalar_api_ruby/resources/access_groups.rbs create mode 100644 sig/scalar_api_ruby/resources/access_groups/domains.rbs create mode 100644 sig/scalar_api_ruby/resources/mcp.rbs create mode 100644 sig/scalar_api_ruby/resources/mcp/servers.rbs create mode 100644 sig/scalar_api_ruby/resources/mcp/servers/installations.rbs create mode 100644 sig/scalar_api_ruby/resources/o_auth.rbs create mode 100644 sig/scalar_api_ruby/resources/sdks.rbs create mode 100644 sig/scalar_api_ruby/resources/sdks/repositories.rbs create mode 100644 sig/scalar_api_ruby/resources/sdks/versions.rbs create mode 100644 sig/scalar_api_ruby/resources/teams/invites.rbs create mode 100644 sig/scalar_api_ruby/resources/teams/members.rbs diff --git a/api.md b/api.md index f3e12a1..fa1a939 100644 --- a/api.md +++ b/api.md @@ -35,6 +35,14 @@ Complete reference of every operation, grouped by resource. See [the README](./R - [Delete a login portal](#delete-a-login-portal) - [Create a portal](#create-a-portal) - [List all portals](#list-all-portals) +- [`AccessGroups`](#accessgroups) + - [Create an access group](#create-an-access-group) + - [Get an access group](#get-an-access-group) + - [Update an access group](#update-an-access-group) + - [Delete an access group](#delete-an-access-group) + - [`AccessGroups Domains`](#accessgroups-domains) + - [Add an allowed email domain](#add-an-allowed-email-domain) + - [Remove an allowed email domain](#remove-an-allowed-email-domain) - [`Rules`](#rules) - [List all rules](#list-all-rules) - [Create a rule](#create-a-rule) @@ -52,15 +60,67 @@ Complete reference of every operation, grouped by resource. See [the README](./R - [Get a theme](#get-a-theme) - [`Teams`](#teams) - [List teams](#list-teams) + - [`Teams Members`](#teams-members) + - [List team members](#list-team-members) + - [Change a member role](#change-a-member-role) + - [Remove a member](#remove-a-member) + - [`Teams Invites`](#teams-invites) + - [Invite a member](#invite-a-member) + - [Resend an invite](#resend-an-invite) + - [Cancel an invite](#cancel-an-invite) - [`ScalarDocs`](#scalardocs) - [List all projects](#list-all-projects) - [Create a project](#create-a-project) - [Publish a project](#publish-a-project) + - [List all docs projects](#list-all-docs-projects) + - [Create a docs project](#create-a-docs-project) + - [Get a docs project](#get-a-docs-project) + - [Update a docs project](#update-a-docs-project) + - [Delete a docs project](#delete-a-docs-project) + - [Publish a docs project](#publish-a-docs-project) + - [Read the site config](#read-the-site-config) + - [Write the site config](#write-the-site-config) + - [Get the site domains](#get-the-site-domains) + - [Check domain DNS](#check-domain-dns) - [`Namespaces`](#namespaces) - [List namespaces](#list-namespaces) - [`Authentication`](#authentication) - [Exchange token](#exchange-token) - [Get current user](#get-current-user) +- [`Sdks`](#sdks) + - [List all SDKs](#list-all-sdks) + - [Create an SDK](#create-an-sdk) + - [Get an SDK](#get-an-sdk) + - [Update an SDK](#update-an-sdk) + - [Delete an SDK](#delete-an-sdk) + - [Build an SDK](#build-an-sdk) + - [`Sdks Versions`](#sdks-versions) + - [Create an SDK version](#create-an-sdk-version) + - [Delete an SDK version](#delete-an-sdk-version) + - [`Sdks Repositories`](#sdks-repositories) + - [Link a repository](#link-a-repository) + - [Unlink a repository](#unlink-a-repository) + - [Update publishing settings](#update-publishing-settings) +- [`Mcp`](#mcp) + - [`Mcp Servers`](#mcp-servers) + - [List all MCP servers](#list-all-mcp-servers) + - [Create an MCP server](#create-an-mcp-server) + - [Get an MCP server](#get-an-mcp-server) + - [Update an MCP server](#update-an-mcp-server) + - [Delete an MCP server](#delete-an-mcp-server) + - [`Mcp Servers Installations`](#mcp-servers-installations) + - [List installations](#list-installations) + - [Create an installation](#create-an-installation) + - [Get an installation](#get-an-installation) + - [Update an installation](#update-an-installation) + - [Delete an installation](#delete-an-installation) + - [Add an access group](#add-an-access-group) + - [Remove an access group](#remove-an-access-group) +- [`OAuth`](#oauth) + - [Start an OAuth authorization](#start-an-oauth-authorization) + - [Exchange a code or refresh token](#exchange-a-code-or-refresh-token) + - [Revoke a refresh token](#revoke-a-refresh-token) + - [Authorization server metadata](#authorization-server-metadata) ## Setup @@ -83,7 +143,7 @@ List all API documents across every namespace the caller can access. | Direction | Type | | --- | --- | | Request | [`RegistryListAllAPIDocumentsParams`](././lib/scalar_api_ruby/models/registry_list_all_api_documents_params.rb) | -| Response | [`RegistryListAllAPIDocumentsResponseItem`](././lib/scalar_api_ruby/models/registry_list_all_api_documents_response.rb) | +| Response | [`APIDocument`](././lib/scalar_api_ruby/models/api_document.rb) | ```ruby response = client.registry.list_all_api_documents @@ -98,7 +158,7 @@ List API documents in a namespace. | Direction | Type | | --- | --- | | Request | [`RegistryListAPIDocumentsParams`](././lib/scalar_api_ruby/models/registry_list_api_documents_params.rb) | -| Response | [`RegistryListAPIDocumentsResponseItem`](././lib/scalar_api_ruby/models/registry_list_api_documents_response.rb) | +| Response | [`APIDocument`](././lib/scalar_api_ruby/models/api_document.rb) | ```ruby response = client.registry.list_api_documents("namespace") @@ -261,7 +321,7 @@ List schemas in a namespace. | Direction | Type | | --- | --- | | Request | [`SchemaListParams`](././lib/scalar_api_ruby/models/schema_list_params.rb) | -| Response | [`SchemaListResponseItem`](././lib/scalar_api_ruby/models/schema_list_response.rb) | +| Response | [`Schema`](././lib/scalar_api_ruby/models/schema.rb) | ```ruby response = client.schemas.list("namespace") @@ -460,7 +520,7 @@ List all login portals for the current team. | Direction | Type | | --- | --- | | Request | [`LoginPortalListParams`](././lib/scalar_api_ruby/models/login_portal_list_params.rb) | -| Response | [`LoginPortalListResponseItem`](././lib/scalar_api_ruby/models/login_portal_list_response.rb) | +| Response | [`LoginPortal`](././lib/scalar_api_ruby/models/login_portal.rb) | ```ruby response = client.login_portals.list @@ -468,6 +528,100 @@ response = client.login_portals.list puts response.inspect ``` +## `AccessGroups` + +Access Groups + +### Create an access group + +Create a group for the current team. Requires docs edit permission and the access groups billing feature. Domains are exact email domains, without wildcards or implicit subdomain matching. + +| Direction | Type | +| --- | --- | +| Request | [`AccessGroupCreateParams`](././lib/scalar_api_ruby/models/access_group_create_params.rb) | +| Response | [`AccessGroupCreateResponse`](././lib/scalar_api_ruby/models/access_group_create_response.rb) | + +```ruby +response = client.access_groups.create({ allowed_domains: { }, name: "", slug: "x" }) + +puts response.inspect +``` + +### Get an access group + +Get a group and its email and domain allowlists by slug. + +| Direction | Type | +| --- | --- | +| Request | [`AccessGroupRetrieveParams`](././lib/scalar_api_ruby/models/access_group_retrieve_params.rb) | +| Response | [`AccessGroupRetrieveResponse`](././lib/scalar_api_ruby/models/access_group_retrieve_response.rb) | + +```ruby +response = client.access_groups.retrieve("slug") + +puts response.inspect +``` + +### Update an access group + +Update group metadata. Requires docs edit permission. After changing the slug, use the new slug in subsequent requests. + +| Direction | Type | +| --- | --- | +| Request | [`AccessGroupUpdateParams`](././lib/scalar_api_ruby/models/access_group_update_params.rb) | + +```ruby +response = client.access_groups.update("path_slug", { name: "", body_slug: "x" }) + +puts response.inspect +``` + +### Delete an access group + +Delete a group and remove its project assignments. Requires docs edit permission. + +| Direction | Type | +| --- | --- | +| Request | [`AccessGroupDeleteParams`](././lib/scalar_api_ruby/models/access_group_delete_params.rb) | + +```ruby +response = client.access_groups.delete("slug") + +puts response.inspect +``` + +### `AccessGroups Domains` + +Access Groups + +#### Add an allowed email domain + +Allow an exact email domain in a group. Requires docs edit permission. A group supports up to 1000 domains. + +| Direction | Type | +| --- | --- | +| Request | [`DomainCreateParams`](././lib/scalar_api_ruby/models/access_groups/domain_create_params.rb) | + +```ruby +response = client.access_groups.domains.create("slug", { domain: "" }) + +puts response.inspect +``` + +#### Remove an allowed email domain + +Remove an exact email domain from a group. Requires docs edit permission. Other allowed domains and emails are preserved. + +| Direction | Type | +| --- | --- | +| Request | [`DomainDeleteParams`](././lib/scalar_api_ruby/models/access_groups/domain_delete_params.rb) | + +```ruby +response = client.access_groups.domains.delete("slug", { domain: "" }) + +puts response.inspect +``` + ## `Rules` Rules @@ -479,7 +633,7 @@ List all rulesets in a namespace. | Direction | Type | | --- | --- | | Request | [`RuleListRulesetsParams`](././lib/scalar_api_ruby/models/rule_list_rulesets_params.rb) | -| Response | [`RuleListRulesetsResponseItem`](././lib/scalar_api_ruby/models/rule_list_rulesets_response.rb) | +| Response | [`Rule`](././lib/scalar_api_ruby/models/rule.rb) | ```ruby response = client.rules.list_rulesets("namespace") @@ -583,7 +737,7 @@ List all team themes. | Direction | Type | | --- | --- | | Request | [`ThemeListParams`](././lib/scalar_api_ruby/models/theme_list_params.rb) | -| Response | [`ThemeListResponseItem`](././lib/scalar_api_ruby/models/theme_list_response.rb) | +| Response | [`Theme`](././lib/scalar_api_ruby/models/theme.rb) | ```ruby response = client.themes.list @@ -673,7 +827,7 @@ List all available teams | Direction | Type | | --- | --- | | Request | [`TeamListParams`](././lib/scalar_api_ruby/models/team_list_params.rb) | -| Response | [`TeamListResponseItem`](././lib/scalar_api_ruby/models/team_list_response.rb) | +| Response | [`Team`](././lib/scalar_api_ruby/models/team.rb) | ```ruby response = client.teams.list @@ -681,6 +835,99 @@ response = client.teams.list puts response.inspect ``` +### `Teams Members` + +Teams + +#### List team members + +List the members of the current team, along with the invites still outstanding. + +| Direction | Type | +| --- | --- | +| Request | [`MemberListParams`](././lib/scalar_api_ruby/models/teams/member_list_params.rb) | +| Response | [`Teams::MemberListResponse`](././lib/scalar_api_ruby/models/teams/member_list_response.rb) | + +```ruby +response = client.teams.members.list + +puts response.inspect +``` + +#### Change a member role + +Change what a member of the current team is allowed to do. + +| Direction | Type | +| --- | --- | +| Request | [`MemberUpdateParams`](././lib/scalar_api_ruby/models/teams/member_update_params.rb) | + +```ruby +response = client.teams.members.update("uidxx", { role: "owner" }) + +puts response.inspect +``` + +#### Remove a member + +Remove someone from the current team. + +| Direction | Type | +| --- | --- | +| Request | [`MemberDeleteParams`](././lib/scalar_api_ruby/models/teams/member_delete_params.rb) | + +```ruby +response = client.teams.members.delete("uidxx") + +puts response.inspect +``` + +### `Teams Invites` + +Teams + +#### Invite a member + +Invite someone to the current team by email. + +| Direction | Type | +| --- | --- | +| Request | [`InviteMemberParams`](././lib/scalar_api_ruby/models/teams/invite_member_params.rb) | + +```ruby +response = client.teams.invites.member({ email: "user@example.com", role: "owner" }) + +puts response.inspect +``` + +#### Resend an invite + +Send the invite email again. + +| Direction | Type | +| --- | --- | +| Request | [`InviteResendParams`](././lib/scalar_api_ruby/models/teams/invite_resend_params.rb) | + +```ruby +response = client.teams.invites.resend("uidxx") + +puts response.inspect +``` + +#### Cancel an invite + +Withdraw an invite that has not been accepted. + +| Direction | Type | +| --- | --- | +| Request | [`InviteCancelParams`](././lib/scalar_api_ruby/models/teams/invite_cancel_params.rb) | + +```ruby +response = client.teams.invites.cancel("uidxx") + +puts response.inspect +``` + ## `ScalarDocs` Scalar Docs @@ -692,7 +939,7 @@ List all guide projects. | Direction | Type | | --- | --- | | Request | [`ScalarDocListGuidesParams`](././lib/scalar_api_ruby/models/scalar_doc_list_guides_params.rb) | -| Response | [`ScalarDocListGuidesResponseItem`](././lib/scalar_api_ruby/models/scalar_doc_list_guides_response.rb) | +| Response | [`GithubProject`](././lib/scalar_api_ruby/models/github_project.rb) | ```ruby response = client.scalar_docs.list_guides @@ -730,6 +977,154 @@ response = client.scalar_docs.publish_guide("slug") puts response.inspect ``` +### List all docs projects + +List every docs project on the team. + +| Direction | Type | +| --- | --- | +| Request | [`ScalarDocListProjectsParams`](././lib/scalar_api_ruby/models/scalar_doc_list_projects_params.rb) | +| Response | [`ScalarDocListProjectsResponse`](././lib/scalar_api_ruby/models/scalar_doc_list_projects_response.rb) | + +```ruby +response = client.scalar_docs.list_projects + +puts response.inspect +``` + +### Create a docs project + +Create a docs project. Omit `provider` to have Scalar host the repository. + +| Direction | Type | +| --- | --- | +| Request | [`ScalarDocCreateProjectParams`](././lib/scalar_api_ruby/models/scalar_doc_create_project_params.rb) | +| Response | [`DocsProject`](././lib/scalar_api_ruby/models/docs_project.rb) | + +```ruby +response = client.scalar_docs.create_project({ name: "", provider: "forgejo", bitbucket_repository: { "workspaceUuid" => "", "repoUuid" => "" }, blank: false, github_repository: { "installationId" => 0, "repoId" => 0 }, is_private: false, slug: "x" }) + +puts response.inspect +``` + +### Get a docs project + +Get a single docs project by its slug. + +| Direction | Type | +| --- | --- | +| Request | [`ScalarDocRetrieveProjectParams`](././lib/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rb) | +| Response | [`DocsProject`](././lib/scalar_api_ruby/models/docs_project.rb) | + +```ruby +response = client.scalar_docs.retrieve_project("slug") + +puts response.inspect +``` + +### Update a docs project + +Update project settings. Set `isPrivate` with `accessGroups` to put the site behind a login. + +| Direction | Type | +| --- | --- | +| Request | [`ScalarDocUpdateProjectParams`](././lib/scalar_api_ruby/models/scalar_doc_update_project_params.rb) | + +```ruby +response = client.scalar_docs.update_project("slug", { access_groups: ["xxxxx"], active_theme_id: "xxxxx", agent_enabled: false, analytics_enabled: false, is_private: false, login_portal_uid: "xxxxx", name: "" }) + +puts response.inspect +``` + +### Delete a docs project + +Delete a docs project, its deploys, its publish records and its cached builds. + +| Direction | Type | +| --- | --- | +| Request | [`ScalarDocDeleteProjectParams`](././lib/scalar_api_ruby/models/scalar_doc_delete_project_params.rb) | + +```ruby +response = client.scalar_docs.delete_project("slug") + +puts response.inspect +``` + +### Publish a docs project + +Start a build and deploy. The returned `publishUid` identifies the publish record. + +| Direction | Type | +| --- | --- | +| Request | [`ScalarDocPublishProjectParams`](././lib/scalar_api_ruby/models/scalar_doc_publish_project_params.rb) | +| Response | [`ScalarDocPublishProjectResponse`](././lib/scalar_api_ruby/models/scalar_doc_publish_project_response.rb) | + +```ruby +response = client.scalar_docs.publish_project("slug", { commit_sha: "", config_path: "", preview: false }) + +puts response.inspect +``` + +### Read the site config + +Read `scalar.config.json` straight from the project repository, without cloning it. `baseToken` is the compare-and-swap handle for a later write. + +| Direction | Type | +| --- | --- | +| Request | [`ScalarDocListProjectConfigParams`](././lib/scalar_api_ruby/models/scalar_doc_list_project_config_params.rb) | +| Response | [`ScalarDocListProjectConfigResponse`](././lib/scalar_api_ruby/models/scalar_doc_list_project_config_response.rb) | + +```ruby +response = client.scalar_docs.list_project_config("slug") + +puts response.inspect +``` + +### Write the site config + +Commit `scalar.config.json` straight to the project repository. Pass the `baseToken` from the read this edit was based on; a conflict means the file moved underneath it. + +| Direction | Type | +| --- | --- | +| Request | [`ScalarDocUpdateProjectConfigParams`](././lib/scalar_api_ruby/models/scalar_doc_update_project_config_params.rb) | +| Response | [`ScalarDocUpdateProjectConfigResponse`](././lib/scalar_api_ruby/models/scalar_doc_update_project_config_response.rb) | + +```ruby +response = client.scalar_docs.update_project_config("slug", { content: "", base_token: "", message: "", path: "", ref: "" }) + +puts response.inspect +``` + +### Get the site domains + +The domains the project serves on — the Scalar-hosted one and the custom one, when set. + +| Direction | Type | +| --- | --- | +| Request | [`ScalarDocListProjectDomainParams`](././lib/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rb) | +| Response | [`ScalarDocListProjectDomainResponse`](././lib/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rb) | + +```ruby +response = client.scalar_docs.list_project_domain("slug") + +puts response.inspect +``` + +### Check domain DNS + +Whether the project custom domain points at Scalar yet. `expected` is the CNAME record to create; `found` is what resolves today. A project with no custom domain reports `verified` with no expected record, because Scalar serves its own subdomain directly. + +| Direction | Type | +| --- | --- | +| Request | [`ScalarDocListProjectDomainStatusParams`](././lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rb) | +| Response | [`ScalarDocListProjectDomainStatusResponse`](././lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rb) | + +```ruby +response = client.scalar_docs.list_project_domain_status("slug") + +puts response.inspect +``` + ## `Namespaces` Namespaces @@ -774,10 +1169,430 @@ Get the authenticated user, including their available teams and theme. | Direction | Type | | --- | --- | | Request | [`AuthenticationListCurrentUserParams`](././lib/scalar_api_ruby/models/authentication_list_current_user_params.rb) | -| Response | [`AuthenticationListCurrentUserResponse`](././lib/scalar_api_ruby/models/authentication_list_current_user_response.rb) | +| Response | [`User`](././lib/scalar_api_ruby/models/user.rb) | ```ruby response = client.authentication.list_current_user puts response.inspect ``` + +## `Sdks` + +SDKs + +### List all SDKs + +List every SDK on the team. + +| Direction | Type | +| --- | --- | +| Request | [`SdkListParams`](././lib/scalar_api_ruby/models/sdk_list_params.rb) | +| Response | [`SdkListResponse`](././lib/scalar_api_ruby/models/sdk_list_response.rb) | + +```ruby +response = client.sdks.list + +puts response.inspect +``` + +### Create an SDK + +Create an SDK from an API document, targeting one or more languages. + +| Direction | Type | +| --- | --- | +| Request | [`SdkCreateParams`](././lib/scalar_api_ruby/models/sdk_create_params.rb) | +| Response | [`UID`](././lib/scalar_api_ruby/models/uid.rb) | + +```ruby +response = client.sdks.create({ api_uid: "xxxxx", languages: ["typescript"], class_name: "", config: "", slug: "x", title: "" }) + +puts response.inspect +``` + +### Get an SDK + +Get a single SDK by its uid. + +| Direction | Type | +| --- | --- | +| Request | [`SdkRetrieveParams`](././lib/scalar_api_ruby/models/sdk_retrieve_params.rb) | +| Response | [`Sdk`](././lib/scalar_api_ruby/models/sdk.rb) | + +```ruby +response = client.sdks.retrieve("uidxx") + +puts response.inspect +``` + +### Update an SDK + +Update SDK metadata, its linked API, or its config. + +| Direction | Type | +| --- | --- | +| Request | [`SdkUpdateParams`](././lib/scalar_api_ruby/models/sdk_update_params.rb) | + +```ruby +response = client.sdks.update("uidxx", { api_uid: "xxxxx", api_version: "", config: "", is_private: false, slug: "x", title: "" }) + +puts response.inspect +``` + +### Delete an SDK + +Delete an SDK and every version it holds. + +| Direction | Type | +| --- | --- | +| Request | [`SdkDeleteParams`](././lib/scalar_api_ruby/models/sdk_delete_params.rb) | + +```ruby +response = client.sdks.delete("uidxx") + +puts response.inspect +``` + +### Build an SDK + +Start a build. Omit `version` to build the current work — the open draft, else the latest version — and the resolved version comes back in the response. + +| Direction | Type | +| --- | --- | +| Request | [`SdkBuildParams`](././lib/scalar_api_ruby/models/sdk_build_params.rb) | +| Response | [`SdkBuildResponse`](././lib/scalar_api_ruby/models/sdk_build_response.rb) | + +```ruby +response = client.sdks.build("uidxx", { languages: ["typescript"], version: "" }) + +puts response.inspect +``` + +### `Sdks Versions` + +SDKs + +#### Create an SDK version + +Create a new SDK version against a specific API version. + +| Direction | Type | +| --- | --- | +| Request | [`VersionCreateParams`](././lib/scalar_api_ruby/models/sdks/version_create_params.rb) | + +```ruby +response = client.sdks.versions.create("uidxx", { api_version: "", version: "" }) + +puts response.inspect +``` + +#### Delete an SDK version + +Permanently delete one version of an SDK. + +| Direction | Type | +| --- | --- | +| Request | [`VersionDeleteParams`](././lib/scalar_api_ruby/models/sdks/version_delete_params.rb) | + +```ruby +response = client.sdks.versions.delete("version", { uid: "uidxx" }) + +puts response.inspect +``` + +### `Sdks Repositories` + +SDKs + +#### Link a repository + +Link one language target to a GitHub repository, so builds sync there. + +| Direction | Type | +| --- | --- | +| Request | [`RepositoryLinkParams`](././lib/scalar_api_ruby/models/sdks/repository_link_params.rb) | +| Response | [`Sdks::RepositoryLinkResponse`](././lib/scalar_api_ruby/models/sdks/repository_link_response.rb) | + +```ruby +response = client.sdks.repositories.link("uidxx", { base_branch: "", language: "typescript", repository_id: 0, prerelease_type: "" }) + +puts response.inspect +``` + +#### Unlink a repository + +Unlink one language target from its repository. + +| Direction | Type | +| --- | --- | +| Request | [`RepositoryUnlinkParams`](././lib/scalar_api_ruby/models/sdks/repository_unlink_params.rb) | + +```ruby +response = client.sdks.repositories.unlink("typescript", { uid: "uidxx" }) + +puts response.inspect +``` + +#### Update publishing settings + +Toggle publish-on-merge and the release settings for a linked target. + +| Direction | Type | +| --- | --- | +| Request | [`RepositoryUpdatePublishingParams`](././lib/scalar_api_ruby/models/sdks/repository_update_publishing_params.rb) | + +```ruby +response = client.sdks.repositories.update_publishing("typescript", { uid: "uidxx", publish_on_merge: false, access: "public", auth_method: "oidc", tag: "" }) + +puts response.inspect +``` + +## `Mcp` + +### `Mcp Servers` + +MCP + +#### List all MCP servers + +List every MCP server on the team. + +| Direction | Type | +| --- | --- | +| Request | [`ServerListParams`](././lib/scalar_api_ruby/models/mcp/server_list_params.rb) | +| Response | [`Mcp::McpServer`](././lib/scalar_api_ruby/models/mcp/mcp_server.rb) | + +```ruby +response = client.mcp.servers.list + +puts response.inspect +``` + +#### Create an MCP server + +Create an MCP server over one or more API document versions. The response carries the server and its first installation. + +| Direction | Type | +| --- | --- | +| Request | [`ServerCreateParams`](././lib/scalar_api_ruby/models/mcp/server_create_params.rb) | +| Response | [`Mcp::ServerCreateResponse`](././lib/scalar_api_ruby/models/mcp/server_create_response.rb) | + +```ruby +response = client.mcp.servers.create({ name: "x", project_uids: [""], slug: "x", version_uids: [""] }) + +puts response.inspect +``` + +#### Get an MCP server + +Get a single MCP server by its id. + +| Direction | Type | +| --- | --- | +| Request | [`ServerRetrieveParams`](././lib/scalar_api_ruby/models/mcp/server_retrieve_params.rb) | +| Response | [`Mcp::McpServer`](././lib/scalar_api_ruby/models/mcp/mcp_server.rb) | + +```ruby +response = client.mcp.servers.retrieve("id") + +puts response.inspect +``` + +#### Update an MCP server + +Update MCP server metadata and which tools it exposes. + +| Direction | Type | +| --- | --- | +| Request | [`ServerUpdateParams`](././lib/scalar_api_ruby/models/mcp/server_update_params.rb) | +| Response | [`Mcp::McpServer`](././lib/scalar_api_ruby/models/mcp/mcp_server.rb) | + +```ruby +response = client.mcp.servers.update("id", { auto_add_operations: false, docs_pages: [""], name: "x", operations: [""], slug: "x" }) + +puts response.inspect +``` + +#### Delete an MCP server + +Delete an MCP server and every installation it serves. + +| Direction | Type | +| --- | --- | +| Request | [`ServerDeleteParams`](././lib/scalar_api_ruby/models/mcp/server_delete_params.rb) | + +```ruby +response = client.mcp.servers.delete("id") + +puts response.inspect +``` + +#### `Mcp Servers Installations` + +MCP + +##### List installations + +List the installations of an MCP server. An installation is what an MCP client connects to. + +| Direction | Type | +| --- | --- | +| Request | [`InstallationListParams`](././lib/scalar_api_ruby/models/mcp/servers/installation_list_params.rb) | +| Response | [`Mcp::Servers::McpInstallationListItem`](././lib/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rb) | + +```ruby +response = client.mcp.servers.installations.list("id") + +puts response.inspect +``` + +##### Create an installation + +Create an installation of an MCP server. `documentAuth` holds the credentials the server presents to the upstream API and is never returned. + +| Direction | Type | +| --- | --- | +| Request | [`InstallationCreateParams`](././lib/scalar_api_ruby/models/mcp/servers/installation_create_params.rb) | +| Response | [`Mcp::McpInstallation`](././lib/scalar_api_ruby/models/mcp/mcp_installation.rb) | + +```ruby +response = client.mcp.servers.installations.create("id", { document_auth: { }, name: "x", slug: "x" }) + +puts response.inspect +``` + +##### Get an installation + +Get a single installation of an MCP server. + +| Direction | Type | +| --- | --- | +| Request | [`InstallationRetrieveParams`](././lib/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rb) | +| Response | [`Mcp::McpInstallation`](././lib/scalar_api_ruby/models/mcp/mcp_installation.rb) | + +```ruby +response = client.mcp.servers.installations.retrieve("installation_id", { id: "id" }) + +puts response.inspect +``` + +##### Update an installation + +Update an installation. Set `isPrivate` and add access groups to put it behind a login. + +| Direction | Type | +| --- | --- | +| Request | [`InstallationUpdateParams`](././lib/scalar_api_ruby/models/mcp/servers/installation_update_params.rb) | +| Response | [`Mcp::McpInstallation`](././lib/scalar_api_ruby/models/mcp/mcp_installation.rb) | + +```ruby +response = client.mcp.servers.installations.update("installation_id", { id: "id", document_auth: { }, is_private: false, login_portal_uid: "", mcp_version: "", name: "x", slug: "x" }) + +puts response.inspect +``` + +##### Delete an installation + +Delete an installation of an MCP server. + +| Direction | Type | +| --- | --- | +| Request | [`InstallationDeleteParams`](././lib/scalar_api_ruby/models/mcp/servers/installation_delete_params.rb) | + +```ruby +response = client.mcp.servers.installations.delete("installation_id", { id: "id" }) + +puts response.inspect +``` + +##### Add an access group + +Let an access group reach a private installation. + +| Direction | Type | +| --- | --- | +| Request | [`InstallationCreateAccessGroupParams`](././lib/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rb) | + +```ruby +response = client.mcp.servers.installations.create_access_group("installation_id", { id: "id", access_group_uid: "xxxxx" }) + +puts response.inspect +``` + +##### Remove an access group + +Stop an access group reaching a private installation. + +| Direction | Type | +| --- | --- | +| Request | [`InstallationDeleteAccessGroupParams`](././lib/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rb) | + +```ruby +response = client.mcp.servers.installations.delete_access_group("installation_id", { id: "id", access_group_uid: "xxxxx" }) + +puts response.inspect +``` + +## `OAuth` + +OAuth + +### Start an OAuth authorization + +Authorization endpoint (RFC 6749 §4.1.1 with PKCE, RFC 7636). Validates the request and sends the user to the Scalar dashboard to approve it; the user returns to `redirect_uri` with a `code` to exchange at the token endpoint. Only `response_type=code` with `code_challenge_method=S256` is supported. + +| Direction | Type | +| --- | --- | +| Request | [`OAuthOauthAuthorizeParams`](././lib/scalar_api_ruby/models/o_auth_oauth_authorize_params.rb) | + +```ruby +response = client.o_auth.oauth_authorize + +puts response.inspect +``` + +### Exchange a code or refresh token + +Token endpoint (RFC 6749 §4.1.3 and §6). Accepts `application/x-www-form-urlencoded`. Confidential clients authenticate with HTTP Basic or `client_secret` in the body; public clients send `client_id` alone. The `authorization_code` grant needs `code`, `redirect_uri` and `code_verifier`; the `refresh_token` grant needs `refresh_token` and may narrow `scope`. + +| Direction | Type | +| --- | --- | +| Request | [`OAuthOauthTokenParams`](././lib/scalar_api_ruby/models/o_auth_oauth_token_params.rb) | +| Response | [`OAuthOauthTokenResponse`](././lib/scalar_api_ruby/models/o_auth_oauth_token_response.rb) | + +```ruby +response = client.o_auth.oauth_token({ grant_type: "", client_id: "", client_secret: "", code: "", code_verifier: "", redirect_uri: "", refresh_token: "", scope: "" }) + +puts response.inspect +``` + +### Revoke a refresh token + +Revocation endpoint (RFC 7009). Revokes the refresh token and every token issued alongside it. The client authenticates as it does at the token endpoint. Responds 200 whether or not the token was live, as the RFC requires. + +| Direction | Type | +| --- | --- | +| Request | [`OAuthOauthRevokeParams`](././lib/scalar_api_ruby/models/o_auth_oauth_revoke_params.rb) | +| Response | [`OauthError`](././lib/scalar_api_ruby/models/oauth_error.rb) | + +```ruby +response = client.o_auth.oauth_revoke({ token: "", client_id: "", client_secret: "", token_type_hint: "" }) + +puts response.inspect +``` + +### Authorization server metadata + +Discovery document for OAuth clients (RFC 8414): where the endpoints are and what they support. + +| Direction | Type | +| --- | --- | +| Request | [`OAuthOauthAuthorizationServerMetadataParams`](././lib/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rb) | +| Response | [`OauthAuthorizationServerMetadata`](././lib/scalar_api_ruby/models/oauth_authorization_server_metadata.rb) | + +```ruby +response = client.o_auth.oauth_authorization_server_metadata + +puts response.inspect +``` diff --git a/lib/scalar_api_ruby.rb b/lib/scalar_api_ruby.rb index ff61cbe..36de95a 100644 --- a/lib/scalar_api_ruby.rb +++ b/lib/scalar_api_ruby.rb @@ -57,10 +57,25 @@ require_relative "scalar_api_ruby/models/404" require_relative "scalar_api_ruby/models/422" require_relative "scalar_api_ruby/models/500" +require_relative "scalar_api_ruby/models/access_group_create_params" +require_relative "scalar_api_ruby/models/access_group_create_response" +require_relative "scalar_api_ruby/models/access_group_delete_params" +require_relative "scalar_api_ruby/models/access_group_name" +require_relative "scalar_api_ruby/models/access_group_retrieve_params" +require_relative "scalar_api_ruby/models/access_group_retrieve_response" +require_relative "scalar_api_ruby/models/access_groups/domain_create_params" +require_relative "scalar_api_ruby/models/access_groups/domain_delete_params" +require_relative "scalar_api_ruby/models/access_groups/email_domain" +require_relative "scalar_api_ruby/models/access_group_update_params" +require_relative "scalar_api_ruby/models/active_deployment" +require_relative "scalar_api_ruby/models/api_document" require_relative "scalar_api_ruby/models/authentication_exchange_personal_token_params" require_relative "scalar_api_ruby/models/authentication_exchange_personal_token_response" require_relative "scalar_api_ruby/models/authentication_list_current_user_params" -require_relative "scalar_api_ruby/models/authentication_list_current_user_response" +require_relative "scalar_api_ruby/models/docs_project" +require_relative "scalar_api_ruby/models/github_project" +require_relative "scalar_api_ruby/models/github_project_repository" +require_relative "scalar_api_ruby/models/login_portal" require_relative "scalar_api_ruby/models/login_portal_create_params" require_relative "scalar_api_ruby/models/login_portal_delete_params" require_relative "scalar_api_ruby/models/login_portal_email" @@ -71,10 +86,39 @@ require_relative "scalar_api_ruby/models/login_portal_retrieve_response" require_relative "scalar_api_ruby/models/login_portal_update_params" require_relative "scalar_api_ruby/models/managed_doc_version" +require_relative "scalar_api_ruby/models/managed_schema_version" +require_relative "scalar_api_ruby/models/mcp/mcp_installation" +require_relative "scalar_api_ruby/models/mcp/mcp_server" +require_relative "scalar_api_ruby/models/mcp/server_create_params" +require_relative "scalar_api_ruby/models/mcp/server_create_response" +require_relative "scalar_api_ruby/models/mcp/server_delete_params" +require_relative "scalar_api_ruby/models/mcp/server_list_params" +require_relative "scalar_api_ruby/models/mcp/server_list_response" +require_relative "scalar_api_ruby/models/mcp/server_retrieve_params" +require_relative "scalar_api_ruby/models/mcp/servers/installation_create_access_group_params" +require_relative "scalar_api_ruby/models/mcp/servers/installation_create_params" +require_relative "scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params" +require_relative "scalar_api_ruby/models/mcp/servers/installation_delete_params" +require_relative "scalar_api_ruby/models/mcp/servers/installation_list_params" +require_relative "scalar_api_ruby/models/mcp/servers/installation_list_response" +require_relative "scalar_api_ruby/models/mcp/servers/installation_retrieve_params" +require_relative "scalar_api_ruby/models/mcp/servers/installation_update_params" +require_relative "scalar_api_ruby/models/mcp/servers/mcp_installation_list_item" +require_relative "scalar_api_ruby/models/mcp/server_update_params" +require_relative "scalar_api_ruby/models/method" require_relative "scalar_api_ruby/models/namespace" require_relative "scalar_api_ruby/models/namespace_list_params" require_relative "scalar_api_ruby/models/namespace_list_response" require_relative "scalar_api_ruby/models/nanoid" +require_relative "scalar_api_ruby/models/oauth_authorization_server_metadata" +require_relative "scalar_api_ruby/models/oauth_error" +require_relative "scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params" +require_relative "scalar_api_ruby/models/o_auth_oauth_authorize_params" +require_relative "scalar_api_ruby/models/o_auth_oauth_revoke_params" +require_relative "scalar_api_ruby/models/o_auth_oauth_token_params" +require_relative "scalar_api_ruby/models/o_auth_oauth_token_response" +require_relative "scalar_api_ruby/models/oauth_scope" +require_relative "scalar_api_ruby/models/oauth_token" require_relative "scalar_api_ruby/models/registry_create_api_document_access_group_params" require_relative "scalar_api_ruby/models/registry_create_api_document_params" require_relative "scalar_api_ruby/models/registry_create_api_document_response" @@ -92,6 +136,7 @@ require_relative "scalar_api_ruby/models/registry_update_api_document_params" require_relative "scalar_api_ruby/models/registry_update_api_document_version_params" require_relative "scalar_api_ruby/models/registry_update_api_document_version_response" +require_relative "scalar_api_ruby/models/rule" require_relative "scalar_api_ruby/models/rule_create_ruleset_access_group_params" require_relative "scalar_api_ruby/models/rule_create_ruleset_params" require_relative "scalar_api_ruby/models/rule_delete_ruleset_access_group_params" @@ -103,10 +148,27 @@ require_relative "scalar_api_ruby/models/rule_update_ruleset_params" require_relative "scalar_api_ruby/models/scalar_doc_create_guide_params" require_relative "scalar_api_ruby/models/scalar_doc_create_guide_response" +require_relative "scalar_api_ruby/models/scalar_doc_create_project_params" +require_relative "scalar_api_ruby/models/scalar_doc_delete_project_params" require_relative "scalar_api_ruby/models/scalar_doc_list_guides_params" require_relative "scalar_api_ruby/models/scalar_doc_list_guides_response" +require_relative "scalar_api_ruby/models/scalar_doc_list_project_config_params" +require_relative "scalar_api_ruby/models/scalar_doc_list_project_config_response" +require_relative "scalar_api_ruby/models/scalar_doc_list_project_domain_params" +require_relative "scalar_api_ruby/models/scalar_doc_list_project_domain_response" +require_relative "scalar_api_ruby/models/scalar_doc_list_project_domain_status_params" +require_relative "scalar_api_ruby/models/scalar_doc_list_project_domain_status_response" +require_relative "scalar_api_ruby/models/scalar_doc_list_projects_params" +require_relative "scalar_api_ruby/models/scalar_doc_list_projects_response" require_relative "scalar_api_ruby/models/scalar_doc_publish_guide_params" require_relative "scalar_api_ruby/models/scalar_doc_publish_guide_response" +require_relative "scalar_api_ruby/models/scalar_doc_publish_project_params" +require_relative "scalar_api_ruby/models/scalar_doc_publish_project_response" +require_relative "scalar_api_ruby/models/scalar_doc_retrieve_project_params" +require_relative "scalar_api_ruby/models/scalar_doc_update_project_config_params" +require_relative "scalar_api_ruby/models/scalar_doc_update_project_config_response" +require_relative "scalar_api_ruby/models/scalar_doc_update_project_params" +require_relative "scalar_api_ruby/models/schema" require_relative "scalar_api_ruby/models/schema_create_params" require_relative "scalar_api_ruby/models/schema_delete_params" require_relative "scalar_api_ruby/models/schema_list_params" @@ -119,9 +181,42 @@ require_relative "scalar_api_ruby/models/schemas/version_retrieve_params" require_relative "scalar_api_ruby/models/schemas/version_retrieve_response" require_relative "scalar_api_ruby/models/schema_update_params" +require_relative "scalar_api_ruby/models/sdk" +require_relative "scalar_api_ruby/models/sdk_build_params" +require_relative "scalar_api_ruby/models/sdk_build_response" +require_relative "scalar_api_ruby/models/sdk_create_params" +require_relative "scalar_api_ruby/models/sdk_delete_params" +require_relative "scalar_api_ruby/models/sdk_list_params" +require_relative "scalar_api_ruby/models/sdk_list_response" +require_relative "scalar_api_ruby/models/sdk_retrieve_params" +require_relative "scalar_api_ruby/models/sdks/repository_link_params" +require_relative "scalar_api_ruby/models/sdks/repository_link_response" +require_relative "scalar_api_ruby/models/sdks/repository_unlink_params" +require_relative "scalar_api_ruby/models/sdks/repository_update_publishing_params" +require_relative "scalar_api_ruby/models/sdks/version_create_params" +require_relative "scalar_api_ruby/models/sdks/version_delete_params" +require_relative "scalar_api_ruby/models/sdk_target_summary" +require_relative "scalar_api_ruby/models/sdk_update_params" +require_relative "scalar_api_ruby/models/sdk_version" require_relative "scalar_api_ruby/models/slug" +require_relative "scalar_api_ruby/models/team" +require_relative "scalar_api_ruby/models/team_image" require_relative "scalar_api_ruby/models/team_list_params" require_relative "scalar_api_ruby/models/team_list_response" +require_relative "scalar_api_ruby/models/team_name" +require_relative "scalar_api_ruby/models/teams/email" +require_relative "scalar_api_ruby/models/teams/invite_cancel_params" +require_relative "scalar_api_ruby/models/teams/invite_member_params" +require_relative "scalar_api_ruby/models/teams/invite_resend_params" +require_relative "scalar_api_ruby/models/teams/member_delete_params" +require_relative "scalar_api_ruby/models/teams/member_list_params" +require_relative "scalar_api_ruby/models/teams/member_list_response" +require_relative "scalar_api_ruby/models/teams/member_update_params" +require_relative "scalar_api_ruby/models/teams/role" +require_relative "scalar_api_ruby/models/teams/team_invite" +require_relative "scalar_api_ruby/models/teams/team_member" +require_relative "scalar_api_ruby/models/team_summary" +require_relative "scalar_api_ruby/models/theme" require_relative "scalar_api_ruby/models/theme_create_params" require_relative "scalar_api_ruby/models/theme_delete_params" require_relative "scalar_api_ruby/models/theme_list_params" @@ -132,6 +227,7 @@ require_relative "scalar_api_ruby/models/theme_update_params" require_relative "scalar_api_ruby/models/timestamp" require_relative "scalar_api_ruby/models/uid" +require_relative "scalar_api_ruby/models/user" require_relative "scalar_api_ruby/models/version" require_relative "scalar_api_ruby/models" require_relative "scalar_api_ruby/resources/registry" @@ -139,9 +235,20 @@ require_relative "scalar_api_ruby/resources/schemas/version" require_relative "scalar_api_ruby/resources/schemas/access_group" require_relative "scalar_api_ruby/resources/login_portals" +require_relative "scalar_api_ruby/resources/access_groups" +require_relative "scalar_api_ruby/resources/access_groups/domains" require_relative "scalar_api_ruby/resources/rules" require_relative "scalar_api_ruby/resources/themes" require_relative "scalar_api_ruby/resources/teams" +require_relative "scalar_api_ruby/resources/teams/members" +require_relative "scalar_api_ruby/resources/teams/invites" require_relative "scalar_api_ruby/resources/scalar_docs" require_relative "scalar_api_ruby/resources/namespaces" require_relative "scalar_api_ruby/resources/authentication" +require_relative "scalar_api_ruby/resources/sdks" +require_relative "scalar_api_ruby/resources/sdks/versions" +require_relative "scalar_api_ruby/resources/sdks/repositories" +require_relative "scalar_api_ruby/resources/mcp" +require_relative "scalar_api_ruby/resources/mcp/servers" +require_relative "scalar_api_ruby/resources/mcp/servers/installations" +require_relative "scalar_api_ruby/resources/o_auth" diff --git a/lib/scalar_api_ruby/client.rb b/lib/scalar_api_ruby/client.rb index 739f3f4..3fc9364 100644 --- a/lib/scalar_api_ruby/client.rb +++ b/lib/scalar_api_ruby/client.rb @@ -35,6 +35,10 @@ class Client < Scalar::Internal::Transport::BaseClient # @return [Scalar::Resources::LoginPortals] attr_reader :login_portals + # Access Groups + # @return [Scalar::Resources::AccessGroups] + attr_reader :access_groups + # Rules # @return [Scalar::Resources::Rules] attr_reader :rules @@ -59,6 +63,17 @@ class Client < Scalar::Internal::Transport::BaseClient # @return [Scalar::Resources::Authentication] attr_reader :authentication + # SDKs + # @return [Scalar::Resources::Sdks] + attr_reader :sdks + + # @return [Scalar::Resources::Mcp] + attr_reader :mcp + + # OAuth + # @return [Scalar::Resources::OAuth] + attr_reader :o_auth + # @api private # # @return [Hash{String=>String}] @@ -136,12 +151,16 @@ def initialize( @registry = Scalar::Resources::Registry.new(client: self) @schemas = Scalar::Resources::Schemas.new(client: self) @login_portals = Scalar::Resources::LoginPortals.new(client: self) + @access_groups = Scalar::Resources::AccessGroups.new(client: self) @rules = Scalar::Resources::Rules.new(client: self) @themes = Scalar::Resources::Themes.new(client: self) @teams = Scalar::Resources::Teams.new(client: self) @scalar_docs = Scalar::Resources::ScalarDocs.new(client: self) @namespaces = Scalar::Resources::Namespaces.new(client: self) @authentication = Scalar::Resources::Authentication.new(client: self) + @sdks = Scalar::Resources::Sdks.new(client: self) + @mcp = Scalar::Resources::Mcp.new(client: self) + @o_auth = Scalar::Resources::OAuth.new(client: self) end end end diff --git a/lib/scalar_api_ruby/models.rb b/lib/scalar_api_ruby/models.rb index 1c214fb..6b74ea1 100644 --- a/lib/scalar_api_ruby/models.rb +++ b/lib/scalar_api_ruby/models.rb @@ -44,10 +44,34 @@ module Scalar AccessGroup = Scalar::Models::AccessGroup + AccessGroupCreateParams = Scalar::Models::AccessGroupCreateParams + + AccessGroupDeleteParams = Scalar::Models::AccessGroupDeleteParams + + AccessGroupName = Scalar::Models::AccessGroupName + + AccessGroupRetrieveParams = Scalar::Models::AccessGroupRetrieveParams + + AccessGroups = Scalar::Models::AccessGroups + + AccessGroupUpdateParams = Scalar::Models::AccessGroupUpdateParams + + ActiveDeployment = Scalar::Models::ActiveDeployment + + APIDocument = Scalar::Models::APIDocument + AuthenticationExchangePersonalTokenParams = Scalar::Models::AuthenticationExchangePersonalTokenParams AuthenticationListCurrentUserParams = Scalar::Models::AuthenticationListCurrentUserParams + DocsProject = Scalar::Models::DocsProject + + GithubProject = Scalar::Models::GithubProject + + GithubProjectRepository = Scalar::Models::GithubProjectRepository + + LoginPortal = Scalar::Models::LoginPortal + LoginPortalCreateParams = Scalar::Models::LoginPortalCreateParams LoginPortalDeleteParams = Scalar::Models::LoginPortalDeleteParams @@ -64,12 +88,34 @@ module Scalar ManagedDocVersion = Scalar::Models::ManagedDocVersion + ManagedSchemaVersion = Scalar::Models::ManagedSchemaVersion + + Mcp = Scalar::Models::Mcp + + Method = Scalar::Models::Method + Namespace = Scalar::Models::Namespace NamespaceListParams = Scalar::Models::NamespaceListParams Nanoid = Scalar::Models::Nanoid + OauthAuthorizationServerMetadata = Scalar::Models::OauthAuthorizationServerMetadata + + OauthError = Scalar::Models::OauthError + + OAuthOauthAuthorizationServerMetadataParams = Scalar::Models::OAuthOauthAuthorizationServerMetadataParams + + OAuthOauthAuthorizeParams = Scalar::Models::OAuthOauthAuthorizeParams + + OAuthOauthRevokeParams = Scalar::Models::OAuthOauthRevokeParams + + OAuthOauthTokenParams = Scalar::Models::OAuthOauthTokenParams + + OauthScope = Scalar::Models::OauthScope + + OauthToken = Scalar::Models::OauthToken + RegistryCreateAPIDocumentAccessGroupParams = Scalar::Models::RegistryCreateAPIDocumentAccessGroupParams RegistryCreateAPIDocumentParams = Scalar::Models::RegistryCreateAPIDocumentParams @@ -94,6 +140,8 @@ module Scalar RegistryUpdateAPIDocumentVersionParams = Scalar::Models::RegistryUpdateAPIDocumentVersionParams + Rule = Scalar::Models::Rule + RuleCreateRulesetAccessGroupParams = Scalar::Models::RuleCreateRulesetAccessGroupParams RuleCreateRulesetParams = Scalar::Models::RuleCreateRulesetParams @@ -110,10 +158,32 @@ module Scalar ScalarDocCreateGuideParams = Scalar::Models::ScalarDocCreateGuideParams + ScalarDocCreateProjectParams = Scalar::Models::ScalarDocCreateProjectParams + + ScalarDocDeleteProjectParams = Scalar::Models::ScalarDocDeleteProjectParams + ScalarDocListGuidesParams = Scalar::Models::ScalarDocListGuidesParams + ScalarDocListProjectConfigParams = Scalar::Models::ScalarDocListProjectConfigParams + + ScalarDocListProjectDomainParams = Scalar::Models::ScalarDocListProjectDomainParams + + ScalarDocListProjectDomainStatusParams = Scalar::Models::ScalarDocListProjectDomainStatusParams + + ScalarDocListProjectsParams = Scalar::Models::ScalarDocListProjectsParams + ScalarDocPublishGuideParams = Scalar::Models::ScalarDocPublishGuideParams + ScalarDocPublishProjectParams = Scalar::Models::ScalarDocPublishProjectParams + + ScalarDocRetrieveProjectParams = Scalar::Models::ScalarDocRetrieveProjectParams + + ScalarDocUpdateProjectConfigParams = Scalar::Models::ScalarDocUpdateProjectConfigParams + + ScalarDocUpdateProjectParams = Scalar::Models::ScalarDocUpdateProjectParams + + Schema = Scalar::Models::Schema + SchemaCreateParams = Scalar::Models::SchemaCreateParams SchemaDeleteParams = Scalar::Models::SchemaDeleteParams @@ -124,10 +194,42 @@ module Scalar SchemaUpdateParams = Scalar::Models::SchemaUpdateParams + Sdk = Scalar::Models::Sdk + + SdkBuildParams = Scalar::Models::SdkBuildParams + + SdkCreateParams = Scalar::Models::SdkCreateParams + + SdkDeleteParams = Scalar::Models::SdkDeleteParams + + SdkListParams = Scalar::Models::SdkListParams + + SdkRetrieveParams = Scalar::Models::SdkRetrieveParams + + Sdks = Scalar::Models::Sdks + + SdkTargetSummary = Scalar::Models::SdkTargetSummary + + SdkUpdateParams = Scalar::Models::SdkUpdateParams + + SdkVersion = Scalar::Models::SdkVersion + Slug = Scalar::Models::Slug + Team = Scalar::Models::Team + + TeamImage = Scalar::Models::TeamImage + TeamListParams = Scalar::Models::TeamListParams + TeamName = Scalar::Models::TeamName + + Teams = Scalar::Models::Teams + + TeamSummary = Scalar::Models::TeamSummary + + Theme = Scalar::Models::Theme + ThemeCreateParams = Scalar::Models::ThemeCreateParams ThemeDeleteParams = Scalar::Models::ThemeDeleteParams @@ -144,6 +246,8 @@ module Scalar UID = Scalar::Models::UID + User = Scalar::Models::User + Value400 = Scalar::Models::Value400 Value401 = Scalar::Models::Value401 diff --git a/lib/scalar_api_ruby/models/access_group_create_params.rb b/lib/scalar_api_ruby/models/access_group_create_params.rb new file mode 100644 index 0000000..0f7dd22 --- /dev/null +++ b/lib/scalar_api_ruby/models/access_group_create_params.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::AccessGroups#create + class AccessGroupCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute allowed_domains + # + # @return [Object, nil] + optional :allowed_domains, Scalar::Internal::Type::Unknown, api_name: :allowedDomains + + # @!attribute name + # + # @return [String, nil] + optional :name, String + + # @!attribute slug + # + # @return [String, nil] + optional :slug, String + + # @!method initialize(allowed_domains: nil, name: nil, slug: nil, request_options: {}) + # @param allowed_domains [Object] + # @param name [String] + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/access_group_create_response.rb b/lib/scalar_api_ruby/models/access_group_create_response.rb new file mode 100644 index 0000000..ced125b --- /dev/null +++ b/lib/scalar_api_ruby/models/access_group_create_response.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::AccessGroups#create + class AccessGroupCreateResponse < Scalar::Internal::Type::BaseModel + # @!attribute allowed_domains + # + # @return [Object] + required :allowed_domains, Scalar::Internal::Type::Unknown, api_name: :allowedDomains + + # @!attribute allowed_emails + # + # @return [Object] + required :allowed_emails, Scalar::Internal::Type::Unknown, api_name: :allowedEmails + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(allowed_domains:, allowed_emails:, name:, slug:, uid:) + # @param allowed_domains [Object] + # @param allowed_emails [Object] + # @param name [String] + # @param slug [String] + # @param uid [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/access_group_delete_params.rb b/lib/scalar_api_ruby/models/access_group_delete_params.rb new file mode 100644 index 0000000..fc91061 --- /dev/null +++ b/lib/scalar_api_ruby/models/access_group_delete_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::AccessGroups#delete + class AccessGroupDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!method initialize(slug:, request_options: {}) + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/access_group_name.rb b/lib/scalar_api_ruby/models/access_group_name.rb new file mode 100644 index 0000000..88cac46 --- /dev/null +++ b/lib/scalar_api_ruby/models/access_group_name.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +module Scalar + module Models + AccessGroupName = String + end +end diff --git a/lib/scalar_api_ruby/models/access_group_retrieve_params.rb b/lib/scalar_api_ruby/models/access_group_retrieve_params.rb new file mode 100644 index 0000000..40ebb7d --- /dev/null +++ b/lib/scalar_api_ruby/models/access_group_retrieve_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::AccessGroups#retrieve + class AccessGroupRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!method initialize(slug:, request_options: {}) + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/access_group_retrieve_response.rb b/lib/scalar_api_ruby/models/access_group_retrieve_response.rb new file mode 100644 index 0000000..0a564a4 --- /dev/null +++ b/lib/scalar_api_ruby/models/access_group_retrieve_response.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::AccessGroups#retrieve + class AccessGroupRetrieveResponse < Scalar::Internal::Type::BaseModel + # @!attribute allowed_domains + # + # @return [Object] + required :allowed_domains, Scalar::Internal::Type::Unknown, api_name: :allowedDomains + + # @!attribute allowed_emails + # + # @return [Object] + required :allowed_emails, Scalar::Internal::Type::Unknown, api_name: :allowedEmails + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(allowed_domains:, allowed_emails:, name:, slug:, uid:) + # @param allowed_domains [Object] + # @param allowed_emails [Object] + # @param name [String] + # @param slug [String] + # @param uid [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/access_group_update_params.rb b/lib/scalar_api_ruby/models/access_group_update_params.rb new file mode 100644 index 0000000..a367fc4 --- /dev/null +++ b/lib/scalar_api_ruby/models/access_group_update_params.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::AccessGroups#update + class AccessGroupUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute path_slug + # + # @return [String] + required :path_slug, String + + # @!attribute name + # + # @return [String, nil] + optional :name, String + + # @!attribute body_slug + # + # @return [String, nil] + optional :body_slug, String, api_name: :slug + + # @!method initialize(path_slug:, name: nil, body_slug: nil, request_options: {}) + # @param path_slug [String] + # @param name [String] + # @param body_slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/access_groups/domain_create_params.rb b/lib/scalar_api_ruby/models/access_groups/domain_create_params.rb new file mode 100644 index 0000000..a7c916a --- /dev/null +++ b/lib/scalar_api_ruby/models/access_groups/domain_create_params.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +module Scalar + module Models + module AccessGroups + # @see Scalar::Resources::AccessGroups::Domains#create + class DomainCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute domain + # + # @return [String] + required :domain, String + + # @!method initialize(slug:, domain:, request_options: {}) + # @param slug [String] + # @param domain [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/access_groups/domain_delete_params.rb b/lib/scalar_api_ruby/models/access_groups/domain_delete_params.rb new file mode 100644 index 0000000..dd7a76d --- /dev/null +++ b/lib/scalar_api_ruby/models/access_groups/domain_delete_params.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +module Scalar + module Models + module AccessGroups + # @see Scalar::Resources::AccessGroups::Domains#delete + class DomainDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute domain + # + # @return [String] + required :domain, String + + # @!method initialize(slug:, domain:, request_options: {}) + # @param slug [String] + # @param domain [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/access_groups/email_domain.rb b/lib/scalar_api_ruby/models/access_groups/email_domain.rb new file mode 100644 index 0000000..245c7a8 --- /dev/null +++ b/lib/scalar_api_ruby/models/access_groups/email_domain.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module Scalar + module Models + module AccessGroups + EmailDomain = String + end + end +end diff --git a/lib/scalar_api_ruby/models/active_deployment.rb b/lib/scalar_api_ruby/models/active_deployment.rb new file mode 100644 index 0000000..4fc3669 --- /dev/null +++ b/lib/scalar_api_ruby/models/active_deployment.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +module Scalar + module Models + class ActiveDeployment < Scalar::Internal::Type::BaseModel + # @!attribute domain + # + # @return [String] + required :domain, String + + # @!attribute published_at + # + # @return [Integer] + required :published_at, Integer, api_name: :publishedAt + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(domain:, published_at:, uid:) + # @param domain [String] + # @param published_at [Integer] + # @param uid [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/api_document.rb b/lib/scalar_api_ruby/models/api_document.rb new file mode 100644 index 0000000..47f1525 --- /dev/null +++ b/lib/scalar_api_ruby/models/api_document.rb @@ -0,0 +1,63 @@ +# frozen_string_literal: true + +module Scalar + module Models + class APIDocument < Scalar::Internal::Type::BaseModel + # @!attribute description + # + # @return [String] + required :description, String + + # @!attribute is_private + # + # @return [Boolean] + required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute namespace + # + # @return [String] + required :namespace, String + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute tags + # + # @return [Object] + required :tags, Scalar::Internal::Type::Unknown + + # @!attribute title + # + # @return [String] + required :title, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute version + # + # @return [String] + required :version, String + + # @!attribute versions + # + # @return [Array] + required :versions, -> { Scalar::Internal::Type::ArrayOf[Scalar::ManagedDocVersion] } + + # @!method initialize(description:, is_private:, namespace:, slug:, tags:, title:, uid:, version:, versions:) + # @param description [String] + # @param is_private [Boolean] + # @param namespace [String] + # @param slug [String] + # @param tags [Object] + # @param title [String] + # @param uid [String] + # @param version [String] + # @param versions [Array] + end + end +end diff --git a/lib/scalar_api_ruby/models/docs_project.rb b/lib/scalar_api_ruby/models/docs_project.rb new file mode 100644 index 0000000..bbbfcda --- /dev/null +++ b/lib/scalar_api_ruby/models/docs_project.rb @@ -0,0 +1,76 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#create_project + class DocsProject < Scalar::Internal::Type::BaseModel + # @!attribute access_groups + # + # @return [Object] + required :access_groups, Scalar::Internal::Type::Unknown, api_name: :accessGroups + + # @!attribute active_theme_id + # + # @return [String] + required :active_theme_id, String, api_name: :activeThemeId + + # @!attribute agent_enabled + # + # @return [Boolean] + required :agent_enabled, Scalar::Internal::Type::Boolean, api_name: :agentEnabled + + # @!attribute analytics_enabled + # + # @return [Boolean] + required :analytics_enabled, Scalar::Internal::Type::Boolean, api_name: :analyticsEnabled + + # @!attribute is_private + # + # @return [Boolean] + required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute last_published + # + # @return [Integer, nil] + required :last_published, Integer, api_name: :lastPublished, nil?: true + + # @!attribute login_portal_uid + # + # @return [String] + required :login_portal_uid, String, api_name: :loginPortalUid + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute publish_status + # + # @return [String] + required :publish_status, String, api_name: :publishStatus + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(access_groups:, active_theme_id:, agent_enabled:, analytics_enabled:, is_private:, last_published:, login_portal_uid:, name:, publish_status:, slug:, uid:) + # @param access_groups [Object] + # @param active_theme_id [String] + # @param agent_enabled [Boolean] + # @param analytics_enabled [Boolean] + # @param is_private [Boolean] + # @param last_published [Integer, nil] + # @param login_portal_uid [String] + # @param name [String] + # @param publish_status [String] + # @param slug [String] + # @param uid [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/github_project.rb b/lib/scalar_api_ruby/models/github_project.rb new file mode 100644 index 0000000..933e157 --- /dev/null +++ b/lib/scalar_api_ruby/models/github_project.rb @@ -0,0 +1,123 @@ +# frozen_string_literal: true + +module Scalar + module Models + class GithubProject < Scalar::Internal::Type::BaseModel + # @!attribute access_groups + # + # @return [Object] + required :access_groups, Scalar::Internal::Type::Unknown, api_name: :accessGroups + + # @!attribute active_deployment + # + # @return [Scalar::Models::ActiveDeployment, nil] + required :active_deployment, -> { Scalar::ActiveDeployment }, api_name: :activeDeployment, nil?: true + + # @!attribute active_theme_id + # + # @return [String] + required :active_theme_id, String, api_name: :activeThemeId + + # @!attribute agent_enabled + # + # @return [Boolean] + required :agent_enabled, Scalar::Internal::Type::Boolean, api_name: :agentEnabled + + # @!attribute analytics_enabled + # + # @return [Boolean] + required :analytics_enabled, Scalar::Internal::Type::Boolean, api_name: :analyticsEnabled + + # @!attribute created_at + # + # @return [Integer] + required :created_at, Integer, api_name: :createdAt + + # @!attribute is_private + # + # @return [Boolean] + required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute last_published + # + # @return [Integer, nil] + required :last_published, Integer, api_name: :lastPublished, nil?: true + + # @!attribute last_published_uid + # + # @return [String, nil] + required :last_published_uid, String, api_name: :lastPublishedUid, nil?: true + + # @!attribute login_portal_uid + # + # @return [String] + required :login_portal_uid, String, api_name: :loginPortalUid + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute publish_message + # + # @return [String] + required :publish_message, String, api_name: :publishMessage + + # @!attribute publish_status + # + # @return [String] + required :publish_status, String, api_name: :publishStatus + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute updated_at + # + # @return [Integer] + required :updated_at, Integer, api_name: :updatedAt + + # @!attribute user_info_hook_url + # + # @return [String] + required :user_info_hook_url, String, api_name: :userInfoHookUrl + + # @!attribute repository + # + # @return [Scalar::Models::GithubProjectRepository, nil] + optional :repository, -> { Scalar::GithubProjectRepository }, nil?: true + + # @!attribute typesense_id + # + # @return [Float, nil] + optional :typesense_id, Float, api_name: :typesenseId + + # @!method initialize(access_groups:, active_deployment:, active_theme_id:, agent_enabled:, analytics_enabled:, created_at:, is_private:, last_published:, last_published_uid:, login_portal_uid:, name:, publish_message:, publish_status:, slug:, uid:, updated_at:, user_info_hook_url:, repository: nil, typesense_id: nil) + # @param access_groups [Object] + # @param active_deployment [Scalar::Models::ActiveDeployment, nil] + # @param active_theme_id [String] + # @param agent_enabled [Boolean] + # @param analytics_enabled [Boolean] + # @param created_at [Integer] + # @param is_private [Boolean] + # @param last_published [Integer, nil] + # @param last_published_uid [String, nil] + # @param login_portal_uid [String] + # @param name [String] + # @param publish_message [String] + # @param publish_status [String] + # @param slug [String] + # @param uid [String] + # @param updated_at [Integer] + # @param user_info_hook_url [String] + # @param repository [Scalar::Models::GithubProjectRepository, nil] + # @param typesense_id [Float] + end + end +end diff --git a/lib/scalar_api_ruby/models/github_project_repository.rb b/lib/scalar_api_ruby/models/github_project_repository.rb new file mode 100644 index 0000000..6a8dad9 --- /dev/null +++ b/lib/scalar_api_ruby/models/github_project_repository.rb @@ -0,0 +1,63 @@ +# frozen_string_literal: true + +module Scalar + module Models + class GithubProjectRepository < Scalar::Internal::Type::BaseModel + # @!attribute id + # + # @return [Float] + required :id, Float + + # @!attribute branch + # + # @return [String] + required :branch, String + + # @!attribute config_path + # + # @return [String] + required :config_path, String, api_name: :configPath + + # @!attribute expired + # + # @return [Boolean] + required :expired, Scalar::Internal::Type::Boolean + + # @!attribute linked_by + # + # @return [String] + required :linked_by, String, api_name: :linkedBy + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute pr_comments + # + # @return [Boolean] + required :pr_comments, Scalar::Internal::Type::Boolean, api_name: :prComments + + # @!attribute publish_on_merge + # + # @return [Boolean] + required :publish_on_merge, Scalar::Internal::Type::Boolean, api_name: :publishOnMerge + + # @!attribute publish_previews + # + # @return [Boolean] + required :publish_previews, Scalar::Internal::Type::Boolean, api_name: :publishPreviews + + # @!method initialize(id:, branch:, config_path:, expired:, linked_by:, name:, pr_comments:, publish_on_merge:, publish_previews:) + # @param id [Float] + # @param branch [String] + # @param config_path [String] + # @param expired [Boolean] + # @param linked_by [String] + # @param name [String] + # @param pr_comments [Boolean] + # @param publish_on_merge [Boolean] + # @param publish_previews [Boolean] + end + end +end diff --git a/lib/scalar_api_ruby/models/login_portal.rb b/lib/scalar_api_ruby/models/login_portal.rb new file mode 100644 index 0000000..ec90866 --- /dev/null +++ b/lib/scalar_api_ruby/models/login_portal.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +module Scalar + module Models + class LoginPortal < Scalar::Internal::Type::BaseModel + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute title + # + # @return [String] + required :title, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(slug:, title:, uid:) + # @param slug [String] + # @param title [String] + # @param uid [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/login_portal_list_response.rb b/lib/scalar_api_ruby/models/login_portal_list_response.rb index bf3fa54..83cc9e2 100644 --- a/lib/scalar_api_ruby/models/login_portal_list_response.rb +++ b/lib/scalar_api_ruby/models/login_portal_list_response.rb @@ -2,30 +2,7 @@ module Scalar module Models - class LoginPortalListResponseItem < Scalar::Internal::Type::BaseModel - # @!attribute slug - # - # @return [String] - required :slug, String - - # @!attribute title - # - # @return [String] - required :title, String - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!method initialize(slug:, title:, uid:) - # @param slug [String] - # @param title [String] - # @param uid [String] - end - # @type [Scalar::Internal::Type::Converter] - LoginPortalListResponse = - Scalar::Internal::Type::ArrayOf[-> { Scalar::Models::LoginPortalListResponseItem }] + LoginPortalListResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::LoginPortal }] end end diff --git a/lib/scalar_api_ruby/models/managed_doc_version.rb b/lib/scalar_api_ruby/models/managed_doc_version.rb index 39653ae..6b938bf 100644 --- a/lib/scalar_api_ruby/models/managed_doc_version.rb +++ b/lib/scalar_api_ruby/models/managed_doc_version.rb @@ -89,8 +89,8 @@ class Tool < Scalar::Internal::Type::BaseModel # @!attribute method_ # - # @return [Symbol, Scalar::Models::ManagedDocVersion::Tool::Method] - required :method_, enum: -> { Scalar::ManagedDocVersion::Tool::Method }, api_name: :method + # @return [Symbol, Scalar::Models::Method] + required :method_, enum: -> { Scalar::Method }, api_name: :method # @!attribute path # @@ -99,7 +99,7 @@ class Tool < Scalar::Internal::Type::BaseModel # @!method initialize(enabled_tools:, method_:, path:) # @param enabled_tools [Array] - # @param method_ [Symbol, Scalar::Models::ManagedDocVersion::Tool::Method] + # @param method_ [Symbol, Scalar::Models::Method] # @param path [String] module EnabledTool @@ -111,24 +111,6 @@ module EnabledTool # @!method self.values # @return [Array] end - - # @see Scalar::Models::ManagedDocVersion::Tool#method_ - module Method - extend Scalar::Internal::Type::Enum - - DELETE = :delete - GET = :get - HEAD = :head - OPTIONS = :options - PATCH = :patch - POST = :post - PUT = :put - QUERY = :query - TRACE = :trace - - # @!method self.values - # @return [Array] - end end end end diff --git a/lib/scalar_api_ruby/models/managed_schema_version.rb b/lib/scalar_api_ruby/models/managed_schema_version.rb new file mode 100644 index 0000000..78d32c1 --- /dev/null +++ b/lib/scalar_api_ruby/models/managed_schema_version.rb @@ -0,0 +1,45 @@ +# frozen_string_literal: true + +module Scalar + module Models + class ManagedSchemaVersion < Scalar::Internal::Type::BaseModel + # @!attribute created_at + # + # @return [Integer] + required :created_at, Integer, api_name: :createdAt + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute updated_at + # + # @return [Integer] + required :updated_at, Integer, api_name: :updatedAt + + # @!attribute version + # + # @return [String] + required :version, String + + # @!attribute json_sha + # + # @return [String, nil] + optional :json_sha, String, api_name: :jsonSha + + # @!attribute yaml_sha + # + # @return [String, nil] + optional :yaml_sha, String, api_name: :yamlSha + + # @!method initialize(created_at:, uid:, updated_at:, version:, json_sha: nil, yaml_sha: nil) + # @param created_at [Integer] + # @param uid [String] + # @param updated_at [Integer] + # @param version [String] + # @param json_sha [String] + # @param yaml_sha [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/mcp_installation.rb b/lib/scalar_api_ruby/models/mcp/mcp_installation.rb new file mode 100644 index 0000000..c69f51d --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/mcp_installation.rb @@ -0,0 +1,75 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + class McpInstallation < Scalar::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute access_groups + # + # @return [Array] + required :access_groups, Scalar::Internal::Type::ArrayOf[String], api_name: :accessGroups + + # @!attribute credential_redaction_enabled + # + # @return [Boolean] + required :credential_redaction_enabled, + Scalar::Internal::Type::Boolean, + api_name: :credentialRedactionEnabled + + # @!attribute is_private + # + # @return [Boolean] + required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute login_portal_uid + # + # @return [String, nil] + required :login_portal_uid, String, api_name: :loginPortalUid, nil?: true + + # @!attribute mcp_server_id + # + # @return [String] + required :mcp_server_id, String, api_name: :mcpServerId + + # @!attribute mcp_version + # + # @return [String, nil] + required :mcp_version, String, api_name: :mcpVersion, nil?: true + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute pii_redaction_enabled + # + # @return [Boolean] + required :pii_redaction_enabled, Scalar::Internal::Type::Boolean, api_name: :piiRedactionEnabled + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!method initialize(id:, access_groups:, credential_redaction_enabled:, is_private:, login_portal_uid:, mcp_server_id:, mcp_version:, name:, pii_redaction_enabled:, slug:) + # @param id [String] + # @param access_groups [Array] + # @param credential_redaction_enabled [Boolean] + # @param is_private [Boolean] + # @param login_portal_uid [String, nil] + # @param mcp_server_id [String] + # @param mcp_version [String, nil] + # @param name [String] + # @param pii_redaction_enabled [Boolean] + # @param slug [String] + end + end + + McpInstallation = Mcp::McpInstallation + end +end diff --git a/lib/scalar_api_ruby/models/mcp/mcp_server.rb b/lib/scalar_api_ruby/models/mcp/mcp_server.rb new file mode 100644 index 0000000..a58b993 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/mcp_server.rb @@ -0,0 +1,50 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + # @see Scalar::Resources::Mcp::Servers#retrieve + class McpServer < Scalar::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute auto_add_operations + # + # @return [Boolean] + required :auto_add_operations, Scalar::Internal::Type::Boolean, api_name: :autoAddOperations + + # @!attribute created_at + # + # @return [String] + required :created_at, String, api_name: :createdAt + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute updated_at + # + # @return [String] + required :updated_at, String, api_name: :updatedAt + + # @!method initialize(id:, auto_add_operations:, created_at:, name:, slug:, updated_at:) + # @param id [String] + # @param auto_add_operations [Boolean] + # @param created_at [String] + # @param name [String] + # @param slug [String] + # @param updated_at [String] + end + end + + McpServer = Mcp::McpServer + end +end diff --git a/lib/scalar_api_ruby/models/mcp/server_create_params.rb b/lib/scalar_api_ruby/models/mcp/server_create_params.rb new file mode 100644 index 0000000..9740fc1 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/server_create_params.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + # @see Scalar::Resources::Mcp::Servers#create + class ServerCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute project_uids + # + # @return [Array, nil] + optional :project_uids, Scalar::Internal::Type::ArrayOf[String], api_name: :projectUids + + # @!attribute slug + # + # @return [String, nil] + optional :slug, String + + # @!attribute version_uids + # + # @return [Array, nil] + optional :version_uids, Scalar::Internal::Type::ArrayOf[String], api_name: :versionUids + + # @!method initialize(name:, project_uids: nil, slug: nil, version_uids: nil, request_options: {}) + # @param name [String] + # @param project_uids [Array] + # @param slug [String] + # @param version_uids [Array] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/server_create_response.rb b/lib/scalar_api_ruby/models/mcp/server_create_response.rb new file mode 100644 index 0000000..c2b4a31 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/server_create_response.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + # @see Scalar::Resources::Mcp::Servers#create + class ServerCreateResponse < Scalar::Internal::Type::BaseModel + # @!attribute installation + # + # @return [Scalar::Models::Mcp::McpInstallation] + required :installation, -> { Scalar::Mcp::McpInstallation } + + # @!attribute server + # + # @return [Scalar::Models::Mcp::McpServer] + required :server, -> { Scalar::Mcp::McpServer } + + # @!method initialize(installation:, server:) + # @param installation [Scalar::Models::Mcp::McpInstallation] + # @param server [Scalar::Models::Mcp::McpServer] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/server_delete_params.rb b/lib/scalar_api_ruby/models/mcp/server_delete_params.rb new file mode 100644 index 0000000..f21bcac --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/server_delete_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + # @see Scalar::Resources::Mcp::Servers#delete + class ServerDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!method initialize(id:, request_options: {}) + # @param id [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/server_list_params.rb b/lib/scalar_api_ruby/models/mcp/server_list_params.rb new file mode 100644 index 0000000..ad952a5 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/server_list_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + # @see Scalar::Resources::Mcp::Servers#list + class ServerListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/server_list_response.rb b/lib/scalar_api_ruby/models/mcp/server_list_response.rb new file mode 100644 index 0000000..cf844a8 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/server_list_response.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + # @type [Scalar::Internal::Type::Converter] + ServerListResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::Mcp::McpServer }] + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/server_retrieve_params.rb b/lib/scalar_api_ruby/models/mcp/server_retrieve_params.rb new file mode 100644 index 0000000..7f6ef97 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/server_retrieve_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + # @see Scalar::Resources::Mcp::Servers#retrieve + class ServerRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!method initialize(id:, request_options: {}) + # @param id [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/server_update_params.rb b/lib/scalar_api_ruby/models/mcp/server_update_params.rb new file mode 100644 index 0000000..6737bb9 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/server_update_params.rb @@ -0,0 +1,52 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + # @see Scalar::Resources::Mcp::Servers#update + class ServerUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute auto_add_operations + # + # @return [Boolean, nil] + optional :auto_add_operations, Scalar::Internal::Type::Boolean, api_name: :autoAddOperations + + # @!attribute docs_pages + # + # @return [Array, nil] + optional :docs_pages, Scalar::Internal::Type::ArrayOf[String], api_name: :docsPages + + # @!attribute name + # + # @return [String, nil] + optional :name, String + + # @!attribute operations + # + # @return [Array, nil] + optional :operations, Scalar::Internal::Type::ArrayOf[String] + + # @!attribute slug + # + # @return [String, nil] + optional :slug, String + + # @!method initialize(id:, auto_add_operations: nil, docs_pages: nil, name: nil, operations: nil, slug: nil, request_options: {}) + # @param id [String] + # @param auto_add_operations [Boolean] + # @param docs_pages [Array] + # @param name [String] + # @param operations [Array] + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rb b/lib/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rb new file mode 100644 index 0000000..b95cea9 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + module Servers + # @see Scalar::Resources::Mcp::Servers::Installations#create_access_group + class InstallationCreateAccessGroupParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute installation_id + # + # @return [String] + required :installation_id, String + + # @!attribute access_group_uid + # + # @return [String] + required :access_group_uid, String, api_name: :accessGroupUid + + # @!method initialize(id:, installation_id:, access_group_uid:, request_options: {}) + # @param id [String] + # @param installation_id [String] + # @param access_group_uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/servers/installation_create_params.rb b/lib/scalar_api_ruby/models/mcp/servers/installation_create_params.rb new file mode 100644 index 0000000..0fb1eb8 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/servers/installation_create_params.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + module Servers + # @see Scalar::Resources::Mcp::Servers::Installations#create + class InstallationCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute document_auth + # + # @return [Hash{Symbol=>Object}] + required :document_auth, + Scalar::Internal::Type::HashOf[Scalar::Internal::Type::Unknown], + api_name: :documentAuth + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute slug + # + # @return [String, nil] + optional :slug, String + + # @!method initialize(id:, document_auth:, name:, slug: nil, request_options: {}) + # @param id [String] + # @param document_auth [Hash{Symbol=>Object}] + # @param name [String] + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rb b/lib/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rb new file mode 100644 index 0000000..31bed5e --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + module Servers + # @see Scalar::Resources::Mcp::Servers::Installations#delete_access_group + class InstallationDeleteAccessGroupParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute installation_id + # + # @return [String] + required :installation_id, String + + # @!attribute access_group_uid + # + # @return [String] + required :access_group_uid, String, api_name: :accessGroupUid + + # @!method initialize(id:, installation_id:, access_group_uid:, request_options: {}) + # @param id [String] + # @param installation_id [String] + # @param access_group_uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/servers/installation_delete_params.rb b/lib/scalar_api_ruby/models/mcp/servers/installation_delete_params.rb new file mode 100644 index 0000000..a2001de --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/servers/installation_delete_params.rb @@ -0,0 +1,30 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + module Servers + # @see Scalar::Resources::Mcp::Servers::Installations#delete + class InstallationDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute installation_id + # + # @return [String] + required :installation_id, String + + # @!method initialize(id:, installation_id:, request_options: {}) + # @param id [String] + # @param installation_id [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/servers/installation_list_params.rb b/lib/scalar_api_ruby/models/mcp/servers/installation_list_params.rb new file mode 100644 index 0000000..13ce587 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/servers/installation_list_params.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + module Servers + # @see Scalar::Resources::Mcp::Servers::Installations#list + class InstallationListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!method initialize(id:, request_options: {}) + # @param id [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/servers/installation_list_response.rb b/lib/scalar_api_ruby/models/mcp/servers/installation_list_response.rb new file mode 100644 index 0000000..98d36ad --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/servers/installation_list_response.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + module Servers + # @type [Scalar::Internal::Type::Converter] + InstallationListResponse = + Scalar::Internal::Type::ArrayOf[-> { Scalar::Mcp::Servers::McpInstallationListItem }] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rb b/lib/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rb new file mode 100644 index 0000000..878f0f7 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rb @@ -0,0 +1,30 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + module Servers + # @see Scalar::Resources::Mcp::Servers::Installations#retrieve + class InstallationRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute installation_id + # + # @return [String] + required :installation_id, String + + # @!method initialize(id:, installation_id:, request_options: {}) + # @param id [String] + # @param installation_id [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/servers/installation_update_params.rb b/lib/scalar_api_ruby/models/mcp/servers/installation_update_params.rb new file mode 100644 index 0000000..78ffcf4 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/servers/installation_update_params.rb @@ -0,0 +1,68 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + module Servers + # @see Scalar::Resources::Mcp::Servers::Installations#update + class InstallationUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute installation_id + # + # @return [String] + required :installation_id, String + + # @!attribute document_auth + # + # @return [Hash{Symbol=>Object}, nil] + optional :document_auth, + Scalar::Internal::Type::HashOf[Scalar::Internal::Type::Unknown], + api_name: :documentAuth + + # @!attribute is_private + # + # @return [Boolean, nil] + optional :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute login_portal_uid + # + # @return [String, nil] + optional :login_portal_uid, String, api_name: :loginPortalUid, nil?: true + + # @!attribute mcp_version + # + # @return [String, nil] + optional :mcp_version, String, api_name: :mcpVersion, nil?: true + + # @!attribute name + # + # @return [String, nil] + optional :name, String + + # @!attribute slug + # + # @return [String, nil] + optional :slug, String + + # @!method initialize(id:, installation_id:, document_auth: nil, is_private: nil, login_portal_uid: nil, mcp_version: nil, name: nil, slug: nil, request_options: {}) + # @param id [String] + # @param installation_id [String] + # @param document_auth [Hash{Symbol=>Object}] + # @param is_private [Boolean] + # @param login_portal_uid [String, nil] + # @param mcp_version [String, nil] + # @param name [String] + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rb b/lib/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rb new file mode 100644 index 0000000..b678809 --- /dev/null +++ b/lib/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Mcp + module Servers + class McpInstallationListItem < Scalar::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute is_private + # + # @return [Boolean] + required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute mcp_version + # + # @return [String, nil] + required :mcp_version, String, api_name: :mcpVersion, nil?: true + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!method initialize(id:, is_private:, mcp_version:, name:, slug:) + # @param id [String] + # @param is_private [Boolean] + # @param mcp_version [String, nil] + # @param name [String] + # @param slug [String] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/method.rb b/lib/scalar_api_ruby/models/method.rb new file mode 100644 index 0000000..43e3d69 --- /dev/null +++ b/lib/scalar_api_ruby/models/method.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Method + extend Scalar::Internal::Type::Enum + + DELETE = :delete + GET = :get + HEAD = :head + OPTIONS = :options + PATCH = :patch + POST = :post + PUT = :put + QUERY = :query + TRACE = :trace + + # @!method self.values + # @return [Array] + end + end +end diff --git a/lib/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rb b/lib/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rb new file mode 100644 index 0000000..9a30ee3 --- /dev/null +++ b/lib/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::OAuth#oauth_authorization_server_metadata + class OAuthOauthAuthorizationServerMetadataParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/o_auth_oauth_authorize_params.rb b/lib/scalar_api_ruby/models/o_auth_oauth_authorize_params.rb new file mode 100644 index 0000000..65eec9e --- /dev/null +++ b/lib/scalar_api_ruby/models/o_auth_oauth_authorize_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::OAuth#oauth_authorize + class OAuthOauthAuthorizeParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/o_auth_oauth_revoke_params.rb b/lib/scalar_api_ruby/models/o_auth_oauth_revoke_params.rb new file mode 100644 index 0000000..946235f --- /dev/null +++ b/lib/scalar_api_ruby/models/o_auth_oauth_revoke_params.rb @@ -0,0 +1,38 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::OAuth#oauth_revoke + class OAuthOauthRevokeParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute token + # + # @return [String] + required :token, String + + # @!attribute client_id + # + # @return [String, nil] + optional :client_id, String + + # @!attribute client_secret + # + # @return [String, nil] + optional :client_secret, String + + # @!attribute token_type_hint + # + # @return [String, nil] + optional :token_type_hint, String + + # @!method initialize(token:, client_id: nil, client_secret: nil, token_type_hint: nil, request_options: {}) + # @param token [String] + # @param client_id [String] + # @param client_secret [String] + # @param token_type_hint [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/o_auth_oauth_token_params.rb b/lib/scalar_api_ruby/models/o_auth_oauth_token_params.rb new file mode 100644 index 0000000..3ab505a --- /dev/null +++ b/lib/scalar_api_ruby/models/o_auth_oauth_token_params.rb @@ -0,0 +1,62 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::OAuth#oauth_token + class OAuthOauthTokenParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute grant_type + # + # @return [String] + required :grant_type, String + + # @!attribute client_id + # + # @return [String, nil] + optional :client_id, String + + # @!attribute client_secret + # + # @return [String, nil] + optional :client_secret, String + + # @!attribute code + # + # @return [String, nil] + optional :code, String + + # @!attribute code_verifier + # + # @return [String, nil] + optional :code_verifier, String + + # @!attribute redirect_uri + # + # @return [String, nil] + optional :redirect_uri, String + + # @!attribute refresh_token + # + # @return [String, nil] + optional :refresh_token, String + + # @!attribute scope + # + # @return [String, nil] + optional :scope, String + + # @!method initialize(grant_type:, client_id: nil, client_secret: nil, code: nil, code_verifier: nil, redirect_uri: nil, refresh_token: nil, scope: nil, request_options: {}) + # @param grant_type [String] + # @param client_id [String] + # @param client_secret [String] + # @param code [String] + # @param code_verifier [String] + # @param redirect_uri [String] + # @param refresh_token [String] + # @param scope [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/o_auth_oauth_token_response.rb b/lib/scalar_api_ruby/models/o_auth_oauth_token_response.rb new file mode 100644 index 0000000..cd2ce28 --- /dev/null +++ b/lib/scalar_api_ruby/models/o_auth_oauth_token_response.rb @@ -0,0 +1,17 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::OAuth#oauth_token + module OAuthOauthTokenResponse + extend Scalar::Internal::Type::Union + + variant -> { Scalar::OauthToken } + + variant -> { Scalar::OauthError } + + # @!method self.variants + # @return [Array(Scalar::Models::OauthToken, Scalar::Models::OauthError)] + end + end +end diff --git a/lib/scalar_api_ruby/models/oauth_authorization_server_metadata.rb b/lib/scalar_api_ruby/models/oauth_authorization_server_metadata.rb new file mode 100644 index 0000000..03b4c79 --- /dev/null +++ b/lib/scalar_api_ruby/models/oauth_authorization_server_metadata.rb @@ -0,0 +1,70 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::OAuth#oauth_authorization_server_metadata + class OauthAuthorizationServerMetadata < Scalar::Internal::Type::BaseModel + # @!attribute authorization_endpoint + # + # @return [String] + required :authorization_endpoint, String + + # @!attribute code_challenge_methods_supported + # + # @return [Array] + required :code_challenge_methods_supported, Scalar::Internal::Type::ArrayOf[String] + + # @!attribute grant_types_supported + # + # @return [Array] + required :grant_types_supported, Scalar::Internal::Type::ArrayOf[String] + + # @!attribute issuer + # + # @return [String] + required :issuer, String + + # @!attribute response_types_supported + # + # @return [Array] + required :response_types_supported, Scalar::Internal::Type::ArrayOf[String] + + # @!attribute revocation_endpoint + # + # @return [String] + required :revocation_endpoint, String + + # @!attribute revocation_endpoint_auth_methods_supported + # + # @return [Array] + required :revocation_endpoint_auth_methods_supported, Scalar::Internal::Type::ArrayOf[String] + + # @!attribute scopes_supported + # + # @return [Array] + required :scopes_supported, Scalar::Internal::Type::ArrayOf[String] + + # @!attribute token_endpoint + # + # @return [String] + required :token_endpoint, String + + # @!attribute token_endpoint_auth_methods_supported + # + # @return [Array] + required :token_endpoint_auth_methods_supported, Scalar::Internal::Type::ArrayOf[String] + + # @!method initialize(authorization_endpoint:, code_challenge_methods_supported:, grant_types_supported:, issuer:, response_types_supported:, revocation_endpoint:, revocation_endpoint_auth_methods_supported:, scopes_supported:, token_endpoint:, token_endpoint_auth_methods_supported:) + # @param authorization_endpoint [String] + # @param code_challenge_methods_supported [Array] + # @param grant_types_supported [Array] + # @param issuer [String] + # @param response_types_supported [Array] + # @param revocation_endpoint [String] + # @param revocation_endpoint_auth_methods_supported [Array] + # @param scopes_supported [Array] + # @param token_endpoint [String] + # @param token_endpoint_auth_methods_supported [Array] + end + end +end diff --git a/lib/scalar_api_ruby/models/oauth_error.rb b/lib/scalar_api_ruby/models/oauth_error.rb new file mode 100644 index 0000000..0bd2f48 --- /dev/null +++ b/lib/scalar_api_ruby/models/oauth_error.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::OAuth#oauth_revoke + class OauthError < Scalar::Internal::Type::BaseModel + # @!attribute error + # + # @return [String] + required :error, String + + # @!attribute error_description + # + # @return [String, nil] + optional :error_description, String + + # @!method initialize(error:, error_description: nil) + # @param error [String] + # @param error_description [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/oauth_scope.rb b/lib/scalar_api_ruby/models/oauth_scope.rb new file mode 100644 index 0000000..0b4bb62 --- /dev/null +++ b/lib/scalar_api_ruby/models/oauth_scope.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Scalar + module Models + module OauthScope + extend Scalar::Internal::Type::Enum + + READ = :read + WRITE = :write + ADMIN = :admin + + # @!method self.values + # @return [Array] + end + end +end diff --git a/lib/scalar_api_ruby/models/oauth_token.rb b/lib/scalar_api_ruby/models/oauth_token.rb new file mode 100644 index 0000000..b48c4a5 --- /dev/null +++ b/lib/scalar_api_ruby/models/oauth_token.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +module Scalar + module Models + class OauthToken < Scalar::Internal::Type::BaseModel + # @!attribute access_token + # + # @return [String] + required :access_token, String + + # @!attribute expires_in + # + # @return [Integer] + required :expires_in, Integer + + # @!attribute refresh_token + # + # @return [String] + required :refresh_token, String + + # @!attribute scope + # + # @return [Symbol, Scalar::Models::OauthScope] + required :scope, enum: -> { Scalar::OauthScope } + + # @!attribute token_type + # + # @return [Symbol, :Bearer] + required :token_type, const: :Bearer + + # @!method initialize(access_token:, expires_in:, refresh_token:, scope:, token_type: :Bearer) + # @param access_token [String] + # @param expires_in [Integer] + # @param refresh_token [String] + # @param scope [Symbol, Scalar::Models::OauthScope] + # @param token_type [Symbol, :Bearer] + end + end +end diff --git a/lib/scalar_api_ruby/models/registry_list_all_api_documents_response.rb b/lib/scalar_api_ruby/models/registry_list_all_api_documents_response.rb index 35a0bf9..e21f5eb 100644 --- a/lib/scalar_api_ruby/models/registry_list_all_api_documents_response.rb +++ b/lib/scalar_api_ruby/models/registry_list_all_api_documents_response.rb @@ -2,66 +2,7 @@ module Scalar module Models - class RegistryListAllAPIDocumentsResponseItem < Scalar::Internal::Type::BaseModel - # @!attribute description - # - # @return [String] - required :description, String - - # @!attribute is_private - # - # @return [Boolean] - required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate - - # @!attribute namespace - # - # @return [String] - required :namespace, String - - # @!attribute slug - # - # @return [String] - required :slug, String - - # @!attribute tags - # - # @return [Object] - required :tags, Scalar::Internal::Type::Unknown - - # @!attribute title - # - # @return [String] - required :title, String - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!attribute version - # - # @return [String] - required :version, String - - # @!attribute versions - # - # @return [Array] - required :versions, -> { Scalar::Internal::Type::ArrayOf[Scalar::ManagedDocVersion] } - - # @!method initialize(description:, is_private:, namespace:, slug:, tags:, title:, uid:, version:, versions:) - # @param description [String] - # @param is_private [Boolean] - # @param namespace [String] - # @param slug [String] - # @param tags [Object] - # @param title [String] - # @param uid [String] - # @param version [String] - # @param versions [Array] - end - # @type [Scalar::Internal::Type::Converter] - RegistryListAllAPIDocumentsResponse = - Scalar::Internal::Type::ArrayOf[-> { Scalar::Models::RegistryListAllAPIDocumentsResponseItem }] + RegistryListAllAPIDocumentsResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::APIDocument }] end end diff --git a/lib/scalar_api_ruby/models/registry_list_api_documents_response.rb b/lib/scalar_api_ruby/models/registry_list_api_documents_response.rb index 1338d5e..6081d65 100644 --- a/lib/scalar_api_ruby/models/registry_list_api_documents_response.rb +++ b/lib/scalar_api_ruby/models/registry_list_api_documents_response.rb @@ -2,66 +2,7 @@ module Scalar module Models - class RegistryListAPIDocumentsResponseItem < Scalar::Internal::Type::BaseModel - # @!attribute description - # - # @return [String] - required :description, String - - # @!attribute is_private - # - # @return [Boolean] - required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate - - # @!attribute namespace - # - # @return [String] - required :namespace, String - - # @!attribute slug - # - # @return [String] - required :slug, String - - # @!attribute tags - # - # @return [Object] - required :tags, Scalar::Internal::Type::Unknown - - # @!attribute title - # - # @return [String] - required :title, String - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!attribute version - # - # @return [String] - required :version, String - - # @!attribute versions - # - # @return [Array] - required :versions, -> { Scalar::Internal::Type::ArrayOf[Scalar::ManagedDocVersion] } - - # @!method initialize(description:, is_private:, namespace:, slug:, tags:, title:, uid:, version:, versions:) - # @param description [String] - # @param is_private [Boolean] - # @param namespace [String] - # @param slug [String] - # @param tags [Object] - # @param title [String] - # @param uid [String] - # @param version [String] - # @param versions [Array] - end - # @type [Scalar::Internal::Type::Converter] - RegistryListAPIDocumentsResponse = - Scalar::Internal::Type::ArrayOf[-> { Scalar::Models::RegistryListAPIDocumentsResponseItem }] + RegistryListAPIDocumentsResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::APIDocument }] end end diff --git a/lib/scalar_api_ruby/models/rule.rb b/lib/scalar_api_ruby/models/rule.rb new file mode 100644 index 0000000..8263c83 --- /dev/null +++ b/lib/scalar_api_ruby/models/rule.rb @@ -0,0 +1,45 @@ +# frozen_string_literal: true + +module Scalar + module Models + class Rule < Scalar::Internal::Type::BaseModel + # @!attribute description + # + # @return [String] + required :description, String + + # @!attribute is_private + # + # @return [Boolean] + required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute namespace + # + # @return [String] + required :namespace, String + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute title + # + # @return [String] + required :title, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(description:, is_private:, namespace:, slug:, title:, uid:) + # @param description [String] + # @param is_private [Boolean] + # @param namespace [String] + # @param slug [String] + # @param title [String] + # @param uid [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/rule_list_rulesets_response.rb b/lib/scalar_api_ruby/models/rule_list_rulesets_response.rb index 9db319a..f268bf9 100644 --- a/lib/scalar_api_ruby/models/rule_list_rulesets_response.rb +++ b/lib/scalar_api_ruby/models/rule_list_rulesets_response.rb @@ -2,48 +2,7 @@ module Scalar module Models - class RuleListRulesetsResponseItem < Scalar::Internal::Type::BaseModel - # @!attribute description - # - # @return [String] - required :description, String - - # @!attribute is_private - # - # @return [Boolean] - required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate - - # @!attribute namespace - # - # @return [String] - required :namespace, String - - # @!attribute slug - # - # @return [String] - required :slug, String - - # @!attribute title - # - # @return [String] - required :title, String - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!method initialize(description:, is_private:, namespace:, slug:, title:, uid:) - # @param description [String] - # @param is_private [Boolean] - # @param namespace [String] - # @param slug [String] - # @param title [String] - # @param uid [String] - end - # @type [Scalar::Internal::Type::Converter] - RuleListRulesetsResponse = - Scalar::Internal::Type::ArrayOf[-> { Scalar::Models::RuleListRulesetsResponseItem }] + RuleListRulesetsResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::Rule }] end end diff --git a/lib/scalar_api_ruby/models/scalar_doc_create_project_params.rb b/lib/scalar_api_ruby/models/scalar_doc_create_project_params.rb new file mode 100644 index 0000000..1cb5396 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_create_project_params.rb @@ -0,0 +1,103 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#create_project + class ScalarDocCreateProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute provider + # + # @return [Symbol, Scalar::Models::ScalarDocCreateProjectParams::Provider] + required :provider, enum: -> { Scalar::ScalarDocCreateProjectParams::Provider } + + # @!attribute bitbucket_repository + # + # @return [Scalar::Models::ScalarDocCreateProjectParams::BitbucketRepository, nil] + optional :bitbucket_repository, + -> { Scalar::ScalarDocCreateProjectParams::BitbucketRepository }, + api_name: :bitbucketRepository + + # @!attribute blank + # + # @return [Boolean, nil] + optional :blank, Scalar::Internal::Type::Boolean + + # @!attribute github_repository + # + # @return [Scalar::Models::ScalarDocCreateProjectParams::GithubRepository, nil] + optional :github_repository, + -> { Scalar::ScalarDocCreateProjectParams::GithubRepository }, + api_name: :githubRepository + + # @!attribute is_private + # + # @return [Boolean, nil] + optional :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute slug + # + # @return [String, nil] + optional :slug, String + + # @!method initialize(name:, provider:, bitbucket_repository: nil, blank: nil, github_repository: nil, is_private: nil, slug: nil, request_options: {}) + # @param name [String] + # @param provider [Symbol, Scalar::Models::ScalarDocCreateProjectParams::Provider] + # @param bitbucket_repository [Scalar::Models::ScalarDocCreateProjectParams::BitbucketRepository] + # @param blank [Boolean] + # @param github_repository [Scalar::Models::ScalarDocCreateProjectParams::GithubRepository] + # @param is_private [Boolean] + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + + module Provider + extend Scalar::Internal::Type::Enum + + FORGEJO = :forgejo + GITHUB = :github + BITBUCKET = :bitbucket + + # @!method self.values + # @return [Array] + end + + class BitbucketRepository < Scalar::Internal::Type::BaseModel + # @!attribute repo_uuid + # + # @return [String] + required :repo_uuid, String, api_name: :repoUuid + + # @!attribute workspace_uuid + # + # @return [String] + required :workspace_uuid, String, api_name: :workspaceUuid + + # @!method initialize(repo_uuid:, workspace_uuid:) + # @param repo_uuid [String] + # @param workspace_uuid [String] + end + + class GithubRepository < Scalar::Internal::Type::BaseModel + # @!attribute installation_id + # + # @return [Integer] + required :installation_id, Integer, api_name: :installationId + + # @!attribute repo_id + # + # @return [Integer] + required :repo_id, Integer, api_name: :repoId + + # @!method initialize(installation_id:, repo_id:) + # @param installation_id [Integer] + # @param repo_id [Integer] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_delete_project_params.rb b/lib/scalar_api_ruby/models/scalar_doc_delete_project_params.rb new file mode 100644 index 0000000..d212463 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_delete_project_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#delete_project + class ScalarDocDeleteProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!method initialize(slug:, request_options: {}) + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_list_guides_response.rb b/lib/scalar_api_ruby/models/scalar_doc_list_guides_response.rb index 474a3e7..f44807c 100644 --- a/lib/scalar_api_ruby/models/scalar_doc_list_guides_response.rb +++ b/lib/scalar_api_ruby/models/scalar_doc_list_guides_response.rb @@ -2,211 +2,7 @@ module Scalar module Models - class ScalarDocListGuidesResponseItem < Scalar::Internal::Type::BaseModel - # @!attribute access_groups - # - # @return [Object] - required :access_groups, Scalar::Internal::Type::Unknown, api_name: :accessGroups - - # @!attribute active_deployment - # - # @return [Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment, nil] - required :active_deployment, - -> { Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment }, - api_name: :activeDeployment, - nil?: true - - # @!attribute active_theme_id - # - # @return [String] - required :active_theme_id, String, api_name: :activeThemeId - - # @!attribute agent_enabled - # - # @return [Boolean] - required :agent_enabled, Scalar::Internal::Type::Boolean, api_name: :agentEnabled - - # @!attribute analytics_enabled - # - # @return [Boolean] - required :analytics_enabled, Scalar::Internal::Type::Boolean, api_name: :analyticsEnabled - - # @!attribute created_at - # - # @return [Integer] - required :created_at, Integer, api_name: :createdAt - - # @!attribute is_private - # - # @return [Boolean] - required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate - - # @!attribute last_published - # - # @return [Integer, nil] - required :last_published, Integer, api_name: :lastPublished, nil?: true - - # @!attribute last_published_uid - # - # @return [String, nil] - required :last_published_uid, String, api_name: :lastPublishedUid, nil?: true - - # @!attribute login_portal_uid - # - # @return [String] - required :login_portal_uid, String, api_name: :loginPortalUid - - # @!attribute name - # - # @return [String] - required :name, String - - # @!attribute publish_message - # - # @return [String] - required :publish_message, String, api_name: :publishMessage - - # @!attribute publish_status - # - # @return [String] - required :publish_status, String, api_name: :publishStatus - - # @!attribute slug - # - # @return [String] - required :slug, String - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!attribute updated_at - # - # @return [Integer] - required :updated_at, Integer, api_name: :updatedAt - - # @!attribute user_info_hook_url - # - # @return [String] - required :user_info_hook_url, String, api_name: :userInfoHookUrl - - # @!attribute repository - # - # @return [Scalar::Models::ScalarDocListGuidesResponseItem::Repository, nil] - optional :repository, -> { Scalar::Models::ScalarDocListGuidesResponseItem::Repository }, nil?: true - - # @!attribute typesense_id - # - # @return [Float, nil] - optional :typesense_id, Float, api_name: :typesenseId - - # @!method initialize(access_groups:, active_deployment:, active_theme_id:, agent_enabled:, analytics_enabled:, created_at:, is_private:, last_published:, last_published_uid:, login_portal_uid:, name:, publish_message:, publish_status:, slug:, uid:, updated_at:, user_info_hook_url:, repository: nil, typesense_id: nil) - # @param access_groups [Object] - # @param active_deployment [Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment, nil] - # @param active_theme_id [String] - # @param agent_enabled [Boolean] - # @param analytics_enabled [Boolean] - # @param created_at [Integer] - # @param is_private [Boolean] - # @param last_published [Integer, nil] - # @param last_published_uid [String, nil] - # @param login_portal_uid [String] - # @param name [String] - # @param publish_message [String] - # @param publish_status [String] - # @param slug [String] - # @param uid [String] - # @param updated_at [Integer] - # @param user_info_hook_url [String] - # @param repository [Scalar::Models::ScalarDocListGuidesResponseItem::Repository, nil] - # @param typesense_id [Float] - - # @see Scalar::Models::ScalarDocListGuidesResponseItem#active_deployment - class ActiveDeployment < Scalar::Internal::Type::BaseModel - # @!attribute domain - # - # @return [String] - required :domain, String - - # @!attribute published_at - # - # @return [Integer] - required :published_at, Integer, api_name: :publishedAt - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!method initialize(domain:, published_at:, uid:) - # @param domain [String] - # @param published_at [Integer] - # @param uid [String] - end - - # @see Scalar::Models::ScalarDocListGuidesResponseItem#repository - class Repository < Scalar::Internal::Type::BaseModel - # @!attribute id - # - # @return [Float] - required :id, Float - - # @!attribute branch - # - # @return [String] - required :branch, String - - # @!attribute config_path - # - # @return [String] - required :config_path, String, api_name: :configPath - - # @!attribute expired - # - # @return [Boolean] - required :expired, Scalar::Internal::Type::Boolean - - # @!attribute linked_by - # - # @return [String] - required :linked_by, String, api_name: :linkedBy - - # @!attribute name - # - # @return [String] - required :name, String - - # @!attribute pr_comments - # - # @return [Boolean] - required :pr_comments, Scalar::Internal::Type::Boolean, api_name: :prComments - - # @!attribute publish_on_merge - # - # @return [Boolean] - required :publish_on_merge, Scalar::Internal::Type::Boolean, api_name: :publishOnMerge - - # @!attribute publish_previews - # - # @return [Boolean] - required :publish_previews, Scalar::Internal::Type::Boolean, api_name: :publishPreviews - - # @!method initialize(id:, branch:, config_path:, expired:, linked_by:, name:, pr_comments:, publish_on_merge:, publish_previews:) - # @param id [Float] - # @param branch [String] - # @param config_path [String] - # @param expired [Boolean] - # @param linked_by [String] - # @param name [String] - # @param pr_comments [Boolean] - # @param publish_on_merge [Boolean] - # @param publish_previews [Boolean] - end - end - # @type [Scalar::Internal::Type::Converter] - ScalarDocListGuidesResponse = - Scalar::Internal::Type::ArrayOf[-> { Scalar::Models::ScalarDocListGuidesResponseItem }] + ScalarDocListGuidesResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::GithubProject }] end end diff --git a/lib/scalar_api_ruby/models/scalar_doc_list_project_config_params.rb b/lib/scalar_api_ruby/models/scalar_doc_list_project_config_params.rb new file mode 100644 index 0000000..f22a4a8 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_list_project_config_params.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#list_project_config + class ScalarDocListProjectConfigParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute ref + # + # @return [String, nil] + optional :ref, String + + # @!method initialize(slug:, ref: nil, request_options: {}) + # @param slug [String] + # @param ref [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_list_project_config_response.rb b/lib/scalar_api_ruby/models/scalar_doc_list_project_config_response.rb new file mode 100644 index 0000000..af18e57 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_list_project_config_response.rb @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#list_project_config + class ScalarDocListProjectConfigResponse < Scalar::Internal::Type::BaseModel + # @!attribute base_token + # + # @return [String] + required :base_token, String, api_name: :baseToken + + # @!attribute content + # + # @return [String] + required :content, String + + # @!attribute path + # + # @return [String] + required :path, String + + # @!attribute ref + # + # @return [String] + required :ref, String + + # @!method initialize(base_token:, content:, path:, ref:) + # @param base_token [String] + # @param content [String] + # @param path [String] + # @param ref [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rb b/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rb new file mode 100644 index 0000000..8001857 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#list_project_domain + class ScalarDocListProjectDomainParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!method initialize(slug:, request_options: {}) + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rb b/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rb new file mode 100644 index 0000000..9d576a1 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#list_project_domain + class ScalarDocListProjectDomainResponse < Scalar::Internal::Type::BaseModel + # @!attribute custom_domain + # + # @return [String, nil] + required :custom_domain, String, api_name: :customDomain, nil?: true + + # @!attribute scalar_domain + # + # @return [String, nil] + required :scalar_domain, String, api_name: :scalarDomain, nil?: true + + # @!method initialize(custom_domain:, scalar_domain:) + # @param custom_domain [String, nil] + # @param scalar_domain [String, nil] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rb b/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rb new file mode 100644 index 0000000..e769ae0 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#list_project_domain_status + class ScalarDocListProjectDomainStatusParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!method initialize(slug:, request_options: {}) + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rb b/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rb new file mode 100644 index 0000000..a573a89 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rb @@ -0,0 +1,65 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#list_project_domain_status + class ScalarDocListProjectDomainStatusResponse < Scalar::Internal::Type::BaseModel + # @!attribute domain + # + # @return [String, nil] + required :domain, String, nil?: true + + # @!attribute expected + # + # @return [Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected, nil] + required :expected, + -> { Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected }, + nil?: true + + # @!attribute found + # + # @return [Array] + required :found, Scalar::Internal::Type::ArrayOf[String] + + # @!attribute status + # + # @return [Symbol, Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status] + required :status, enum: -> { Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status } + + # @!method initialize(domain:, expected:, found:, status:) + # @param domain [String, nil] + # @param expected [Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected, nil] + # @param found [Array] + # @param status [Symbol, Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status] + + # @see Scalar::Models::ScalarDocListProjectDomainStatusResponse#expected + class Expected < Scalar::Internal::Type::BaseModel + # @!attribute target + # + # @return [String] + required :target, String + + # @!attribute type + # + # @return [Symbol, :CNAME] + required :type, const: :CNAME + + # @!method initialize(target:, type: :CNAME) + # @param target [String] + # @param type [Symbol, :CNAME] + end + + # @see Scalar::Models::ScalarDocListProjectDomainStatusResponse#status + module Status + extend Scalar::Internal::Type::Enum + + VERIFIED = :verified + PENDING = :pending + MISCONFIGURED = :misconfigured + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_list_projects_params.rb b/lib/scalar_api_ruby/models/scalar_doc_list_projects_params.rb new file mode 100644 index 0000000..5b7f154 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_list_projects_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#list_projects + class ScalarDocListProjectsParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute limit + # + # @return [Integer, nil] + optional :limit, Integer + + # @!method initialize(limit: nil, request_options: {}) + # @param limit [Integer] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_list_projects_response.rb b/lib/scalar_api_ruby/models/scalar_doc_list_projects_response.rb new file mode 100644 index 0000000..618b392 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_list_projects_response.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#list_projects + class ScalarDocListProjectsResponse < Scalar::Internal::Type::BaseModel + # @!attribute data + # + # @return [Array] + required :data, -> { Scalar::Internal::Type::ArrayOf[Scalar::DocsProject] } + + # @!attribute has_more + # + # @return [Boolean] + required :has_more, Scalar::Internal::Type::Boolean, api_name: :hasMore + + # @!method initialize(data:, has_more:) + # @param data [Array] + # @param has_more [Boolean] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_publish_project_params.rb b/lib/scalar_api_ruby/models/scalar_doc_publish_project_params.rb new file mode 100644 index 0000000..c08c1fa --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_publish_project_params.rb @@ -0,0 +1,38 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#publish_project + class ScalarDocPublishProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute commit_sha + # + # @return [String, nil] + optional :commit_sha, String, api_name: :commitSha + + # @!attribute config_path + # + # @return [String, nil] + optional :config_path, String, api_name: :configPath + + # @!attribute preview + # + # @return [Boolean, nil] + optional :preview, Scalar::Internal::Type::Boolean + + # @!method initialize(slug:, commit_sha: nil, config_path: nil, preview: nil, request_options: {}) + # @param slug [String] + # @param commit_sha [String] + # @param config_path [String] + # @param preview [Boolean] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_publish_project_response.rb b/lib/scalar_api_ruby/models/scalar_doc_publish_project_response.rb new file mode 100644 index 0000000..4e96553 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_publish_project_response.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#publish_project + class ScalarDocPublishProjectResponse < Scalar::Internal::Type::BaseModel + # @!attribute publish_uid + # + # @return [String] + required :publish_uid, String, api_name: :publishUid + + # @!method initialize(publish_uid:) + # @param publish_uid [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rb b/lib/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rb new file mode 100644 index 0000000..4d9cc3e --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#retrieve_project + class ScalarDocRetrieveProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!method initialize(slug:, request_options: {}) + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_update_project_config_params.rb b/lib/scalar_api_ruby/models/scalar_doc_update_project_config_params.rb new file mode 100644 index 0000000..7245562 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_update_project_config_params.rb @@ -0,0 +1,50 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#update_project_config + class ScalarDocUpdateProjectConfigParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute content + # + # @return [String] + required :content, String + + # @!attribute base_token + # + # @return [String, nil] + optional :base_token, String, api_name: :baseToken + + # @!attribute message + # + # @return [String, nil] + optional :message, String + + # @!attribute path + # + # @return [String, nil] + optional :path, String + + # @!attribute ref + # + # @return [String, nil] + optional :ref, String + + # @!method initialize(slug:, content:, base_token: nil, message: nil, path: nil, ref: nil, request_options: {}) + # @param slug [String] + # @param content [String] + # @param base_token [String] + # @param message [String] + # @param path [String] + # @param ref [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_update_project_config_response.rb b/lib/scalar_api_ruby/models/scalar_doc_update_project_config_response.rb new file mode 100644 index 0000000..7f52c25 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_update_project_config_response.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#update_project_config + class ScalarDocUpdateProjectConfigResponse < Scalar::Internal::Type::BaseModel + # @!attribute base_token + # + # @return [String] + required :base_token, String, api_name: :baseToken + + # @!attribute commit_sha + # + # @return [String, nil] + required :commit_sha, String, api_name: :commitSha, nil?: true + + # @!attribute ref + # + # @return [String] + required :ref, String + + # @!method initialize(base_token:, commit_sha:, ref:) + # @param base_token [String] + # @param commit_sha [String, nil] + # @param ref [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/scalar_doc_update_project_params.rb b/lib/scalar_api_ruby/models/scalar_doc_update_project_params.rb new file mode 100644 index 0000000..143d889 --- /dev/null +++ b/lib/scalar_api_ruby/models/scalar_doc_update_project_params.rb @@ -0,0 +1,75 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::ScalarDocs#update_project + class ScalarDocUpdateProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute access_groups + # + # @return [Array, nil] + optional :access_groups, Scalar::Internal::Type::ArrayOf[String], api_name: :accessGroups + + # @!attribute active_theme_id + # + # @return [String, nil] + optional :active_theme_id, String, api_name: :activeThemeId + + # @!attribute agent_enabled + # + # @return [Boolean, nil] + optional :agent_enabled, Scalar::Internal::Type::Boolean, api_name: :agentEnabled + + # @!attribute analytics_enabled + # + # @return [Boolean, nil] + optional :analytics_enabled, Scalar::Internal::Type::Boolean, api_name: :analyticsEnabled + + # @!attribute is_private + # + # @return [Boolean, nil] + optional :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute login_portal_uid + # + # @return [String, Symbol, nil] + optional :login_portal_uid, + union: -> { Scalar::ScalarDocUpdateProjectParams::LoginPortalUID }, + api_name: :loginPortalUid + + # @!attribute name + # + # @return [String, nil] + optional :name, String + + # @!method initialize(slug:, access_groups: nil, active_theme_id: nil, agent_enabled: nil, analytics_enabled: nil, is_private: nil, login_portal_uid: nil, name: nil, request_options: {}) + # @param slug [String] + # @param access_groups [Array] + # @param active_theme_id [String] + # @param agent_enabled [Boolean] + # @param analytics_enabled [Boolean] + # @param is_private [Boolean] + # @param login_portal_uid [String, Symbol] + # @param name [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + + module LoginPortalUID + extend Scalar::Internal::Type::Union + + variant String + + variant const: :"" + + # @!method self.variants + # @return [Array(String, Symbol)] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/schema.rb b/lib/scalar_api_ruby/models/schema.rb new file mode 100644 index 0000000..3de5b32 --- /dev/null +++ b/lib/scalar_api_ruby/models/schema.rb @@ -0,0 +1,51 @@ +# frozen_string_literal: true + +module Scalar + module Models + class Schema < Scalar::Internal::Type::BaseModel + # @!attribute description + # + # @return [String] + required :description, String + + # @!attribute is_private + # + # @return [Boolean] + required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute namespace + # + # @return [String] + required :namespace, String + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute title + # + # @return [String] + required :title, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute versions + # + # @return [Array] + required :versions, -> { Scalar::Internal::Type::ArrayOf[Scalar::ManagedSchemaVersion] } + + # @!method initialize(description:, is_private:, namespace:, slug:, title:, uid:, versions:) + # @param description [String] + # @param is_private [Boolean] + # @param namespace [String] + # @param slug [String] + # @param title [String] + # @param uid [String] + # @param versions [Array] + end + end +end diff --git a/lib/scalar_api_ruby/models/schema_list_response.rb b/lib/scalar_api_ruby/models/schema_list_response.rb index 5507566..d9b010b 100644 --- a/lib/scalar_api_ruby/models/schema_list_response.rb +++ b/lib/scalar_api_ruby/models/schema_list_response.rb @@ -2,94 +2,7 @@ module Scalar module Models - class SchemaListResponseItem < Scalar::Internal::Type::BaseModel - # @!attribute description - # - # @return [String] - required :description, String - - # @!attribute is_private - # - # @return [Boolean] - required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate - - # @!attribute namespace - # - # @return [String] - required :namespace, String - - # @!attribute slug - # - # @return [String] - required :slug, String - - # @!attribute title - # - # @return [String] - required :title, String - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!attribute versions - # - # @return [Array] - required :versions, - -> { Scalar::Internal::Type::ArrayOf[Scalar::Models::SchemaListResponseItem::Version] } - - # @!method initialize(description:, is_private:, namespace:, slug:, title:, uid:, versions:) - # @param description [String] - # @param is_private [Boolean] - # @param namespace [String] - # @param slug [String] - # @param title [String] - # @param uid [String] - # @param versions [Array] - - class Version < Scalar::Internal::Type::BaseModel - # @!attribute created_at - # - # @return [Integer] - required :created_at, Integer, api_name: :createdAt - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!attribute updated_at - # - # @return [Integer] - required :updated_at, Integer, api_name: :updatedAt - - # @!attribute version - # - # @return [String] - required :version, String - - # @!attribute json_sha - # - # @return [String, nil] - optional :json_sha, String, api_name: :jsonSha - - # @!attribute yaml_sha - # - # @return [String, nil] - optional :yaml_sha, String, api_name: :yamlSha - - # @!method initialize(created_at:, uid:, updated_at:, version:, json_sha: nil, yaml_sha: nil) - # @param created_at [Integer] - # @param uid [String] - # @param updated_at [Integer] - # @param version [String] - # @param json_sha [String] - # @param yaml_sha [String] - end - end - # @type [Scalar::Internal::Type::Converter] - SchemaListResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::Models::SchemaListResponseItem }] + SchemaListResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::Schema }] end end diff --git a/lib/scalar_api_ruby/models/sdk.rb b/lib/scalar_api_ruby/models/sdk.rb new file mode 100644 index 0000000..0bb45f2 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk.rb @@ -0,0 +1,76 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::Sdks#retrieve + class Sdk < Scalar::Internal::Type::BaseModel + # @!attribute api_uid + # + # @return [String, nil] + required :api_uid, String, api_name: :apiUid, nil?: true + + # @!attribute current_version + # + # @return [String] + required :current_version, String, api_name: :currentVersion + + # @!attribute description + # + # @return [String] + required :description, String + + # @!attribute is_private + # + # @return [Boolean] + required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute namespace + # + # @return [String] + required :namespace, String + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute targets + # + # @return [Array] + required :targets, -> { Scalar::Internal::Type::ArrayOf[Scalar::SdkTargetSummary] } + + # @!attribute title + # + # @return [String] + required :title, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute versions + # + # @return [Array] + required :versions, -> { Scalar::Internal::Type::ArrayOf[Scalar::SdkVersion] } + + # @!attribute api_version + # + # @return [String, nil] + optional :api_version, String, api_name: :apiVersion, nil?: true + + # @!method initialize(api_uid:, current_version:, description:, is_private:, namespace:, slug:, targets:, title:, uid:, versions:, api_version: nil) + # @param api_uid [String, nil] + # @param current_version [String] + # @param description [String] + # @param is_private [Boolean] + # @param namespace [String] + # @param slug [String] + # @param targets [Array] + # @param title [String] + # @param uid [String] + # @param versions [Array] + # @param api_version [String, nil] + end + end +end diff --git a/lib/scalar_api_ruby/models/sdk_build_params.rb b/lib/scalar_api_ruby/models/sdk_build_params.rb new file mode 100644 index 0000000..75c32d8 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk_build_params.rb @@ -0,0 +1,53 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::Sdks#build + class SdkBuildParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute languages + # + # @return [Array, nil] + optional :languages, -> { Scalar::Internal::Type::ArrayOf[enum: Scalar::SdkBuildParams::Language] } + + # @!attribute version + # + # @return [String, nil] + optional :version, String + + # @!method initialize(uid:, languages: nil, version: nil, request_options: {}) + # @param uid [String] + # @param languages [Array] + # @param version [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT = :typescript + PYTHON = :python + CLI = :cli + CSHARP = :csharp + JAVA = :java + RUBY = :ruby + PHP = :php + GO = :go + RUST = :rust + KOTLIN = :kotlin + SWIFT = :swift + CPP = :cpp + DART = :dart + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/sdk_build_response.rb b/lib/scalar_api_ruby/models/sdk_build_response.rb new file mode 100644 index 0000000..8cebb70 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk_build_response.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::Sdks#build + class SdkBuildResponse < Scalar::Internal::Type::BaseModel + # @!attribute version + # + # @return [String] + required :version, String + + # @!method initialize(version:) + # @param version [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/sdk_create_params.rb b/lib/scalar_api_ruby/models/sdk_create_params.rb new file mode 100644 index 0000000..9716bc8 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk_create_params.rb @@ -0,0 +1,71 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::Sdks#create + class SdkCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute api_uid + # + # @return [String] + required :api_uid, String, api_name: :apiUid + + # @!attribute languages + # + # @return [Array] + required :languages, -> { Scalar::Internal::Type::ArrayOf[enum: Scalar::SdkCreateParams::Language] } + + # @!attribute class_name + # + # @return [String, nil] + optional :class_name, String, api_name: :className + + # @!attribute config + # + # @return [String, nil] + optional :config, String + + # @!attribute slug + # + # @return [String, nil] + optional :slug, String + + # @!attribute title + # + # @return [String, nil] + optional :title, String + + # @!method initialize(api_uid:, languages:, class_name: nil, config: nil, slug: nil, title: nil, request_options: {}) + # @param api_uid [String] + # @param languages [Array] + # @param class_name [String] + # @param config [String] + # @param slug [String] + # @param title [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT = :typescript + PYTHON = :python + CLI = :cli + CSHARP = :csharp + JAVA = :java + RUBY = :ruby + PHP = :php + GO = :go + RUST = :rust + KOTLIN = :kotlin + SWIFT = :swift + CPP = :cpp + DART = :dart + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/sdk_delete_params.rb b/lib/scalar_api_ruby/models/sdk_delete_params.rb new file mode 100644 index 0000000..337a68c --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk_delete_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::Sdks#delete + class SdkDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(uid:, request_options: {}) + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/sdk_list_params.rb b/lib/scalar_api_ruby/models/sdk_list_params.rb new file mode 100644 index 0000000..cd00698 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk_list_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::Sdks#list + class SdkListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute limit + # + # @return [Integer, nil] + optional :limit, Integer + + # @!method initialize(limit: nil, request_options: {}) + # @param limit [Integer] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/sdk_list_response.rb b/lib/scalar_api_ruby/models/sdk_list_response.rb new file mode 100644 index 0000000..70da49c --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk_list_response.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::Sdks#list + class SdkListResponse < Scalar::Internal::Type::BaseModel + # @!attribute data + # + # @return [Array] + required :data, -> { Scalar::Internal::Type::ArrayOf[Scalar::Sdk] } + + # @!attribute has_more + # + # @return [Boolean] + required :has_more, Scalar::Internal::Type::Boolean, api_name: :hasMore + + # @!method initialize(data:, has_more:) + # @param data [Array] + # @param has_more [Boolean] + end + end +end diff --git a/lib/scalar_api_ruby/models/sdk_retrieve_params.rb b/lib/scalar_api_ruby/models/sdk_retrieve_params.rb new file mode 100644 index 0000000..29faa11 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk_retrieve_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::Sdks#retrieve + class SdkRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(uid:, request_options: {}) + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/sdk_target_summary.rb b/lib/scalar_api_ruby/models/sdk_target_summary.rb new file mode 100644 index 0000000..3298f29 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk_target_summary.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +module Scalar + module Models + class SdkTargetSummary < Scalar::Internal::Type::BaseModel + # @!attribute language + # + # @return [Symbol, Scalar::Models::SdkTargetSummary::Language] + required :language, enum: -> { Scalar::SdkTargetSummary::Language } + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!method initialize(language:, slug:) + # @param language [Symbol, Scalar::Models::SdkTargetSummary::Language] + # @param slug [String] + + # @see Scalar::Models::SdkTargetSummary#language + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT = :typescript + PYTHON = :python + CLI = :cli + CSHARP = :csharp + JAVA = :java + RUBY = :ruby + PHP = :php + GO = :go + RUST = :rust + KOTLIN = :kotlin + SWIFT = :swift + CPP = :cpp + DART = :dart + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/sdk_update_params.rb b/lib/scalar_api_ruby/models/sdk_update_params.rb new file mode 100644 index 0000000..46365d6 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk_update_params.rb @@ -0,0 +1,56 @@ +# frozen_string_literal: true + +module Scalar + module Models + # @see Scalar::Resources::Sdks#update + class SdkUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute api_uid + # + # @return [String, nil] + optional :api_uid, String, api_name: :apiUid, nil?: true + + # @!attribute api_version + # + # @return [String, nil] + optional :api_version, String, api_name: :apiVersion, nil?: true + + # @!attribute config + # + # @return [String, nil] + optional :config, String + + # @!attribute is_private + # + # @return [Boolean, nil] + optional :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate + + # @!attribute slug + # + # @return [String, nil] + optional :slug, String + + # @!attribute title + # + # @return [String, nil] + optional :title, String + + # @!method initialize(uid:, api_uid: nil, api_version: nil, config: nil, is_private: nil, slug: nil, title: nil, request_options: {}) + # @param uid [String] + # @param api_uid [String, nil] + # @param api_version [String, nil] + # @param config [String] + # @param is_private [Boolean] + # @param slug [String] + # @param title [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/scalar_api_ruby/models/sdk_version.rb b/lib/scalar_api_ruby/models/sdk_version.rb new file mode 100644 index 0000000..6e26650 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdk_version.rb @@ -0,0 +1,77 @@ +# frozen_string_literal: true + +module Scalar + module Models + class SdkVersion < Scalar::Internal::Type::BaseModel + # @!attribute api_version + # + # @return [String] + required :api_version, String, api_name: :apiVersion + + # @!attribute languages + # + # @return [Array] + required :languages, -> { Scalar::Internal::Type::ArrayOf[enum: Scalar::SdkVersion::Language] } + + # @!attribute status + # + # @return [Symbol, Scalar::Models::SdkVersion::Status] + required :status, enum: -> { Scalar::SdkVersion::Status } + + # @!attribute version + # + # @return [String] + required :version, String + + # @!attribute created_at + # + # @return [Integer, nil] + optional :created_at, Integer, api_name: :createdAt + + # @!attribute published_at + # + # @return [Integer, nil] + optional :published_at, Integer, api_name: :publishedAt + + # @!method initialize(api_version:, languages:, status:, version:, created_at: nil, published_at: nil) + # @param api_version [String] + # @param languages [Array] + # @param status [Symbol, Scalar::Models::SdkVersion::Status] + # @param version [String] + # @param created_at [Integer] + # @param published_at [Integer] + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT = :typescript + PYTHON = :python + CLI = :cli + CSHARP = :csharp + JAVA = :java + RUBY = :ruby + PHP = :php + GO = :go + RUST = :rust + KOTLIN = :kotlin + SWIFT = :swift + CPP = :cpp + DART = :dart + + # @!method self.values + # @return [Array] + end + + # @see Scalar::Models::SdkVersion#status + module Status + extend Scalar::Internal::Type::Enum + + DRAFT = :draft + PUBLISHED = :published + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/sdks/repository_link_params.rb b/lib/scalar_api_ruby/models/sdks/repository_link_params.rb new file mode 100644 index 0000000..1e4706e --- /dev/null +++ b/lib/scalar_api_ruby/models/sdks/repository_link_params.rb @@ -0,0 +1,67 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Sdks + # @see Scalar::Resources::Sdks::Repositories#link + class RepositoryLinkParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute base_branch + # + # @return [String] + required :base_branch, String, api_name: :baseBranch + + # @!attribute language + # + # @return [Symbol, Scalar::Models::Sdks::RepositoryLinkParams::Language] + required :language, enum: -> { Scalar::Sdks::RepositoryLinkParams::Language } + + # @!attribute repository_id + # + # @return [Integer] + required :repository_id, Integer, api_name: :repositoryId + + # @!attribute prerelease_type + # + # @return [String, nil] + optional :prerelease_type, String, api_name: :prereleaseType + + # @!method initialize(uid:, base_branch:, language:, repository_id:, prerelease_type: nil, request_options: {}) + # @param uid [String] + # @param base_branch [String] + # @param language [Symbol, Scalar::Models::Sdks::RepositoryLinkParams::Language] + # @param repository_id [Integer] + # @param prerelease_type [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT = :typescript + PYTHON = :python + CLI = :cli + CSHARP = :csharp + JAVA = :java + RUBY = :ruby + PHP = :php + GO = :go + RUST = :rust + KOTLIN = :kotlin + SWIFT = :swift + CPP = :cpp + DART = :dart + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/sdks/repository_link_response.rb b/lib/scalar_api_ruby/models/sdks/repository_link_response.rb new file mode 100644 index 0000000..4aff2fe --- /dev/null +++ b/lib/scalar_api_ruby/models/sdks/repository_link_response.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Sdks + # @see Scalar::Resources::Sdks::Repositories#link + class RepositoryLinkResponse < Scalar::Internal::Type::BaseModel + # @!attribute branch + # + # @return [String] + required :branch, String + + # @!attribute repo + # + # @return [String] + required :repo, String + + # @!method initialize(branch:, repo:) + # @param branch [String] + # @param repo [String] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/sdks/repository_unlink_params.rb b/lib/scalar_api_ruby/models/sdks/repository_unlink_params.rb new file mode 100644 index 0000000..5e5d379 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdks/repository_unlink_params.rb @@ -0,0 +1,49 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Sdks + # @see Scalar::Resources::Sdks::Repositories#unlink + class RepositoryUnlinkParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute language + # + # @return [Symbol, Scalar::Models::Sdks::RepositoryUnlinkParams::Language] + required :language, enum: -> { Scalar::Sdks::RepositoryUnlinkParams::Language } + + # @!method initialize(uid:, language:, request_options: {}) + # @param uid [String] + # @param language [Symbol, Scalar::Models::Sdks::RepositoryUnlinkParams::Language] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT = :typescript + PYTHON = :python + CLI = :cli + CSHARP = :csharp + JAVA = :java + RUBY = :ruby + PHP = :php + GO = :go + RUST = :rust + KOTLIN = :kotlin + SWIFT = :swift + CPP = :cpp + DART = :dart + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/sdks/repository_update_publishing_params.rb b/lib/scalar_api_ruby/models/sdks/repository_update_publishing_params.rb new file mode 100644 index 0000000..76233e5 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdks/repository_update_publishing_params.rb @@ -0,0 +1,95 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Sdks + # @see Scalar::Resources::Sdks::Repositories#update_publishing + class RepositoryUpdatePublishingParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute language + # + # @return [Symbol, Scalar::Models::Sdks::RepositoryUpdatePublishingParams::Language] + required :language, enum: -> { Scalar::Sdks::RepositoryUpdatePublishingParams::Language } + + # @!attribute publish_on_merge + # + # @return [Boolean] + required :publish_on_merge, Scalar::Internal::Type::Boolean, api_name: :publishOnMerge + + # @!attribute access + # + # @return [Symbol, Scalar::Models::Sdks::RepositoryUpdatePublishingParams::Access, nil] + optional :access, enum: -> { Scalar::Sdks::RepositoryUpdatePublishingParams::Access } + + # @!attribute auth_method + # + # @return [Symbol, Scalar::Models::Sdks::RepositoryUpdatePublishingParams::AuthMethod, nil] + optional :auth_method, + enum: -> { Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod }, + api_name: :authMethod + + # @!attribute tag + # + # @return [String, nil] + optional :tag, String + + # @!method initialize(uid:, language:, publish_on_merge:, access: nil, auth_method: nil, tag: nil, request_options: {}) + # @param uid [String] + # @param language [Symbol, Scalar::Models::Sdks::RepositoryUpdatePublishingParams::Language] + # @param publish_on_merge [Boolean] + # @param access [Symbol, Scalar::Models::Sdks::RepositoryUpdatePublishingParams::Access] + # @param auth_method [Symbol, Scalar::Models::Sdks::RepositoryUpdatePublishingParams::AuthMethod] + # @param tag [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT = :typescript + PYTHON = :python + CLI = :cli + CSHARP = :csharp + JAVA = :java + RUBY = :ruby + PHP = :php + GO = :go + RUST = :rust + KOTLIN = :kotlin + SWIFT = :swift + CPP = :cpp + DART = :dart + + # @!method self.values + # @return [Array] + end + + module Access + extend Scalar::Internal::Type::Enum + + PUBLIC = :public + RESTRICTED = :restricted + + # @!method self.values + # @return [Array] + end + + module AuthMethod + extend Scalar::Internal::Type::Enum + + OIDC = :oidc + ACCESS_TOKEN = :"access-token" + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/scalar_api_ruby/models/sdks/version_create_params.rb b/lib/scalar_api_ruby/models/sdks/version_create_params.rb new file mode 100644 index 0000000..4b13959 --- /dev/null +++ b/lib/scalar_api_ruby/models/sdks/version_create_params.rb @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Sdks + # @see Scalar::Resources::Sdks::Versions#create + class VersionCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute api_version + # + # @return [String] + required :api_version, String, api_name: :apiVersion + + # @!attribute version + # + # @return [String] + required :version, String + + # @!method initialize(uid:, api_version:, version:, request_options: {}) + # @param uid [String] + # @param api_version [String] + # @param version [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/sdks/version_delete_params.rb b/lib/scalar_api_ruby/models/sdks/version_delete_params.rb new file mode 100644 index 0000000..99ecf7d --- /dev/null +++ b/lib/scalar_api_ruby/models/sdks/version_delete_params.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Sdks + # @see Scalar::Resources::Sdks::Versions#delete + class VersionDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute version + # + # @return [String] + required :version, String + + # @!method initialize(uid:, version:, request_options: {}) + # @param uid [String] + # @param version [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/team.rb b/lib/scalar_api_ruby/models/team.rb new file mode 100644 index 0000000..bb498f8 --- /dev/null +++ b/lib/scalar_api_ruby/models/team.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +module Scalar + module Models + class Team < Scalar::Internal::Type::BaseModel + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute theme + # + # @return [String] + required :theme, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute image_uri + # + # @return [String, nil] + optional :image_uri, String, api_name: :imageUri + + # @!method initialize(name:, slug:, theme:, uid:, image_uri: nil) + # @param name [String] + # @param slug [String] + # @param theme [String] + # @param uid [String] + # @param image_uri [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/team_image.rb b/lib/scalar_api_ruby/models/team_image.rb new file mode 100644 index 0000000..af1f564 --- /dev/null +++ b/lib/scalar_api_ruby/models/team_image.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +module Scalar + module Models + TeamImage = String + end +end diff --git a/lib/scalar_api_ruby/models/team_list_response.rb b/lib/scalar_api_ruby/models/team_list_response.rb index dc4f248..3e8ea64 100644 --- a/lib/scalar_api_ruby/models/team_list_response.rb +++ b/lib/scalar_api_ruby/models/team_list_response.rb @@ -2,41 +2,7 @@ module Scalar module Models - class TeamListResponseItem < Scalar::Internal::Type::BaseModel - # @!attribute name - # - # @return [String] - required :name, String - - # @!attribute slug - # - # @return [String] - required :slug, String - - # @!attribute theme - # - # @return [String] - required :theme, String - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!attribute image_uri - # - # @return [String, nil] - optional :image_uri, String, api_name: :imageUri - - # @!method initialize(name:, slug:, theme:, uid:, image_uri: nil) - # @param name [String] - # @param slug [String] - # @param theme [String] - # @param uid [String] - # @param image_uri [String] - end - # @type [Scalar::Internal::Type::Converter] - TeamListResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::Models::TeamListResponseItem }] + TeamListResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::Team }] end end diff --git a/lib/scalar_api_ruby/models/team_name.rb b/lib/scalar_api_ruby/models/team_name.rb new file mode 100644 index 0000000..22c944e --- /dev/null +++ b/lib/scalar_api_ruby/models/team_name.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +module Scalar + module Models + TeamName = String + end +end diff --git a/lib/scalar_api_ruby/models/team_summary.rb b/lib/scalar_api_ruby/models/team_summary.rb new file mode 100644 index 0000000..64fd9f7 --- /dev/null +++ b/lib/scalar_api_ruby/models/team_summary.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +module Scalar + module Models + class TeamSummary < Scalar::Internal::Type::BaseModel + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute image_uri + # + # @return [String, nil] + optional :image_uri, String, api_name: :imageUri + + # @!method initialize(name:, uid:, image_uri: nil) + # @param name [String] + # @param uid [String] + # @param image_uri [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/teams/email.rb b/lib/scalar_api_ruby/models/teams/email.rb new file mode 100644 index 0000000..afe627e --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/email.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + Email = String + end + end +end diff --git a/lib/scalar_api_ruby/models/teams/invite_cancel_params.rb b/lib/scalar_api_ruby/models/teams/invite_cancel_params.rb new file mode 100644 index 0000000..04ed78c --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/invite_cancel_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + # @see Scalar::Resources::Teams::Invites#cancel + class InviteCancelParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(uid:, request_options: {}) + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/teams/invite_member_params.rb b/lib/scalar_api_ruby/models/teams/invite_member_params.rb new file mode 100644 index 0000000..9415618 --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/invite_member_params.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + # @see Scalar::Resources::Teams::Invites#member + class InviteMemberParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute email + # + # @return [String] + required :email, String + + # @!attribute role + # + # @return [Symbol, Scalar::Models::Teams::Role] + required :role, enum: -> { Scalar::Teams::Role } + + # @!method initialize(email:, role:, request_options: {}) + # @param email [String] + # @param role [Symbol, Scalar::Models::Teams::Role] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/teams/invite_resend_params.rb b/lib/scalar_api_ruby/models/teams/invite_resend_params.rb new file mode 100644 index 0000000..f431600 --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/invite_resend_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + # @see Scalar::Resources::Teams::Invites#resend + class InviteResendParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(uid:, request_options: {}) + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/teams/member_delete_params.rb b/lib/scalar_api_ruby/models/teams/member_delete_params.rb new file mode 100644 index 0000000..a181630 --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/member_delete_params.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + # @see Scalar::Resources::Teams::Members#delete + class MemberDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(uid:, request_options: {}) + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/teams/member_list_params.rb b/lib/scalar_api_ruby/models/teams/member_list_params.rb new file mode 100644 index 0000000..5495ef1 --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/member_list_params.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + # @see Scalar::Resources::Teams::Members#list + class MemberListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/teams/member_list_response.rb b/lib/scalar_api_ruby/models/teams/member_list_response.rb new file mode 100644 index 0000000..cecca5d --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/member_list_response.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + # @see Scalar::Resources::Teams::Members#list + class MemberListResponse < Scalar::Internal::Type::BaseModel + # @!attribute members + # + # @return [Array] + required :members, -> { Scalar::Internal::Type::ArrayOf[Scalar::Teams::TeamMember] } + + # @!attribute pending_invites + # + # @return [Array] + required :pending_invites, + -> { Scalar::Internal::Type::ArrayOf[Scalar::Teams::TeamInvite] }, + api_name: :pendingInvites + + # @!method initialize(members:, pending_invites:) + # @param members [Array] + # @param pending_invites [Array] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/teams/member_update_params.rb b/lib/scalar_api_ruby/models/teams/member_update_params.rb new file mode 100644 index 0000000..c89076c --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/member_update_params.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + # @see Scalar::Resources::Teams::Members#update + class MemberUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute role + # + # @return [Symbol, Scalar::Models::Teams::Role] + required :role, enum: -> { Scalar::Teams::Role } + + # @!method initialize(uid:, role:, request_options: {}) + # @param uid [String] + # @param role [Symbol, Scalar::Models::Teams::Role] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/teams/role.rb b/lib/scalar_api_ruby/models/teams/role.rb new file mode 100644 index 0000000..efd1f5f --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/role.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + module Role + extend Scalar::Internal::Type::Enum + + OWNER = :owner + ADMIN = :admin + EDITOR = :editor + VIEWER = :viewer + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/scalar_api_ruby/models/teams/team_invite.rb b/lib/scalar_api_ruby/models/teams/team_invite.rb new file mode 100644 index 0000000..d541188 --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/team_invite.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + class TeamInvite < Scalar::Internal::Type::BaseModel + # @!attribute email + # + # @return [String] + required :email, String + + # @!attribute role + # + # @return [Symbol, Scalar::Models::Teams::Role] + required :role, enum: -> { Scalar::Teams::Role } + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute expires + # + # @return [Float, nil] + optional :expires, Float + + # @!method initialize(email:, role:, uid:, expires: nil) + # @param email [String] + # @param role [Symbol, Scalar::Models::Teams::Role] + # @param uid [String] + # @param expires [Float] + end + end + + TeamInvite = Teams::TeamInvite + end +end diff --git a/lib/scalar_api_ruby/models/teams/team_member.rb b/lib/scalar_api_ruby/models/teams/team_member.rb new file mode 100644 index 0000000..d0ce545 --- /dev/null +++ b/lib/scalar_api_ruby/models/teams/team_member.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +module Scalar + module Models + module Teams + class TeamMember < Scalar::Internal::Type::BaseModel + # @!attribute display_name + # + # @return [String] + required :display_name, String, api_name: :displayName + + # @!attribute role + # + # @return [Symbol, Scalar::Models::Teams::Role] + required :role, enum: -> { Scalar::Teams::Role } + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!attribute image_uri + # + # @return [String, nil] + optional :image_uri, String, api_name: :imageUri + + # @!method initialize(display_name:, role:, uid:, image_uri: nil) + # @param display_name [String] + # @param role [Symbol, Scalar::Models::Teams::Role] + # @param uid [String] + # @param image_uri [String] + end + end + + TeamMember = Teams::TeamMember + end +end diff --git a/lib/scalar_api_ruby/models/theme.rb b/lib/scalar_api_ruby/models/theme.rb new file mode 100644 index 0000000..acd6a9b --- /dev/null +++ b/lib/scalar_api_ruby/models/theme.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +module Scalar + module Models + class Theme < Scalar::Internal::Type::BaseModel + # @!attribute description + # + # @return [String] + required :description, String + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute slug + # + # @return [String] + required :slug, String + + # @!attribute uid + # + # @return [String] + required :uid, String + + # @!method initialize(description:, name:, slug:, uid:) + # @param description [String] + # @param name [String] + # @param slug [String] + # @param uid [String] + end + end +end diff --git a/lib/scalar_api_ruby/models/theme_list_response.rb b/lib/scalar_api_ruby/models/theme_list_response.rb index 7010530..cca1f31 100644 --- a/lib/scalar_api_ruby/models/theme_list_response.rb +++ b/lib/scalar_api_ruby/models/theme_list_response.rb @@ -2,35 +2,7 @@ module Scalar module Models - class ThemeListResponseItem < Scalar::Internal::Type::BaseModel - # @!attribute description - # - # @return [String] - required :description, String - - # @!attribute name - # - # @return [String] - required :name, String - - # @!attribute slug - # - # @return [String] - required :slug, String - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!method initialize(description:, name:, slug:, uid:) - # @param description [String] - # @param name [String] - # @param slug [String] - # @param uid [String] - end - # @type [Scalar::Internal::Type::Converter] - ThemeListResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::Models::ThemeListResponseItem }] + ThemeListResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::Theme }] end end diff --git a/lib/scalar_api_ruby/models/authentication_list_current_user_response.rb b/lib/scalar_api_ruby/models/user.rb similarity index 58% rename from lib/scalar_api_ruby/models/authentication_list_current_user_response.rb rename to lib/scalar_api_ruby/models/user.rb index 82568ff..0db7400 100644 --- a/lib/scalar_api_ruby/models/authentication_list_current_user_response.rb +++ b/lib/scalar_api_ruby/models/user.rb @@ -3,7 +3,7 @@ module Scalar module Models # @see Scalar::Resources::Authentication#list_current_user - class AuthenticationListCurrentUserResponse < Scalar::Internal::Type::BaseModel + class User < Scalar::Internal::Type::BaseModel # @!attribute active_team_id # # @return [String, nil] @@ -26,11 +26,8 @@ class AuthenticationListCurrentUserResponse < Scalar::Internal::Type::BaseModel # @!attribute teams # - # @return [Array] - required :teams, - -> do - Scalar::Internal::Type::ArrayOf[Scalar::Models::AuthenticationListCurrentUserResponse::Team] - end + # @return [Array] + required :teams, -> { Scalar::Internal::Type::ArrayOf[Scalar::TeamSummary] } # @!attribute uid # @@ -52,32 +49,10 @@ class AuthenticationListCurrentUserResponse < Scalar::Internal::Type::BaseModel # @param created_at [Integer] # @param email [String] # @param has_github [Boolean] - # @param teams [Array] + # @param teams [Array] # @param uid [String] # @param updated_at [Integer] # @param theme [String] - - class Team < Scalar::Internal::Type::BaseModel - # @!attribute name - # - # @return [String] - required :name, String - - # @!attribute uid - # - # @return [String] - required :uid, String - - # @!attribute image_uri - # - # @return [String, nil] - optional :image_uri, String, api_name: :imageUri - - # @!method initialize(name:, uid:, image_uri: nil) - # @param name [String] - # @param uid [String] - # @param image_uri [String] - end end end end diff --git a/lib/scalar_api_ruby/resources/access_groups.rb b/lib/scalar_api_ruby/resources/access_groups.rb new file mode 100644 index 0000000..b7980c5 --- /dev/null +++ b/lib/scalar_api_ruby/resources/access_groups.rb @@ -0,0 +1,108 @@ +# frozen_string_literal: true + +module Scalar + module Resources + # Access Groups + class AccessGroups + # Access Groups + # @return [Scalar::Resources::AccessGroups::Domains] + attr_reader :domains + + # Create a group for the current team. Requires docs edit permission and the + # access groups billing feature. Domains are exact email domains, without + # wildcards or implicit subdomain matching. + # + # @overload create(allowed_domains: nil, name: nil, slug: nil, request_options: {}) + # + # @param allowed_domains [Object] + # @param name [String] + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::AccessGroupCreateResponse] + # + # @see Scalar::Models::AccessGroupCreateParams + def create(params = {}) + parsed, options = Scalar::AccessGroupCreateParams.dump_request(params) + @client.request( + method: :post, + path: "v1/access-groups", + body: parsed, + model: Scalar::Models::AccessGroupCreateResponse, + options: options + ) + end + + # Get a group and its email and domain allowlists by slug. + # + # @overload retrieve(slug, request_options: {}) + # + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::AccessGroupRetrieveResponse] + # + # @see Scalar::Models::AccessGroupRetrieveParams + def retrieve(slug, params = {}) + @client.request( + method: :get, + path: ["v1/access-groups/%1$s", slug], + model: Scalar::Models::AccessGroupRetrieveResponse, + options: params[:request_options] + ) + end + + # Update group metadata. Requires docs edit permission. After changing the slug, + # use the new slug in subsequent requests. + # + # @overload update(path_slug, name: nil, body_slug: nil, request_options: {}) + # + # @param path_slug [String] + # @param name [String] + # @param body_slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::AccessGroupUpdateParams + def update(path_slug, params = {}) + parsed, options = Scalar::AccessGroupUpdateParams.dump_request(params) + @client.request( + method: :patch, + path: ["v1/access-groups/%1$s", path_slug], + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # Delete a group and remove its project assignments. Requires docs edit + # permission. + # + # @overload delete(slug, request_options: {}) + # + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::AccessGroupDeleteParams + def delete(slug, params = {}) + @client.request( + method: :delete, + path: ["v1/access-groups/%1$s", slug], + model: Scalar::Internal::Type::Unknown, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + @domains = Scalar::Resources::AccessGroups::Domains.new(client: client) + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/access_groups/domains.rb b/lib/scalar_api_ruby/resources/access_groups/domains.rb new file mode 100644 index 0000000..7a36bf4 --- /dev/null +++ b/lib/scalar_api_ruby/resources/access_groups/domains.rb @@ -0,0 +1,63 @@ +# frozen_string_literal: true + +module Scalar + module Resources + class AccessGroups + # Access Groups + class Domains + # Allow an exact email domain in a group. Requires docs edit permission. A group + # supports up to 1000 domains. + # + # @overload create(slug, domain:, request_options: {}) + # + # @param slug [String] + # @param domain [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::AccessGroups::DomainCreateParams + def create(slug, params) + parsed, options = Scalar::AccessGroups::DomainCreateParams.dump_request(params) + @client.request( + method: :post, + path: ["v1/access-groups/%1$s/domains", slug], + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # Remove an exact email domain from a group. Requires docs edit permission. Other + # allowed domains and emails are preserved. + # + # @overload delete(slug, domain:, request_options: {}) + # + # @param slug [String] + # @param domain [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::AccessGroups::DomainDeleteParams + def delete(slug, params) + parsed, options = Scalar::AccessGroups::DomainDeleteParams.dump_request(params) + @client.request( + method: :delete, + path: ["v1/access-groups/%1$s/domains", slug], + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/authentication.rb b/lib/scalar_api_ruby/resources/authentication.rb index f2c8887..d21d9ae 100644 --- a/lib/scalar_api_ruby/resources/authentication.rb +++ b/lib/scalar_api_ruby/resources/authentication.rb @@ -31,14 +31,14 @@ def exchange_personal_token(params) # # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Scalar::Models::AuthenticationListCurrentUserResponse] + # @return [Scalar::Models::User] # # @see Scalar::Models::AuthenticationListCurrentUserParams def list_current_user(params = {}) @client.request( method: :get, path: "v1/auth/me", - model: Scalar::Models::AuthenticationListCurrentUserResponse, + model: Scalar::User, options: params[:request_options] ) end diff --git a/lib/scalar_api_ruby/resources/login_portals.rb b/lib/scalar_api_ruby/resources/login_portals.rb index 600a71f..f6327f7 100644 --- a/lib/scalar_api_ruby/resources/login_portals.rb +++ b/lib/scalar_api_ruby/resources/login_portals.rb @@ -75,14 +75,14 @@ def update(slug, params = {}) # # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Scalar::Models::LoginPortalListParams def list(params = {}) @client.request( method: :get, path: "v1/login-portals", - model: Scalar::Internal::Type::ArrayOf[Scalar::Models::LoginPortalListResponseItem], + model: Scalar::Internal::Type::ArrayOf[Scalar::LoginPortal], options: params[:request_options] ) end diff --git a/lib/scalar_api_ruby/resources/mcp.rb b/lib/scalar_api_ruby/resources/mcp.rb new file mode 100644 index 0000000..3e3a7bb --- /dev/null +++ b/lib/scalar_api_ruby/resources/mcp.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +module Scalar + module Resources + class Mcp + # MCP + # @return [Scalar::Resources::Mcp::Servers] + attr_reader :servers + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + @servers = Scalar::Resources::Mcp::Servers.new(client: client) + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/mcp/servers.rb b/lib/scalar_api_ruby/resources/mcp/servers.rb new file mode 100644 index 0000000..27fa3c7 --- /dev/null +++ b/lib/scalar_api_ruby/resources/mcp/servers.rb @@ -0,0 +1,129 @@ +# frozen_string_literal: true + +module Scalar + module Resources + class Mcp + # MCP + class Servers + # MCP + # @return [Scalar::Resources::Mcp::Servers::Installations] + attr_reader :installations + + # Create an MCP server over one or more API document versions. The response + # carries the server and its first installation. + # + # @overload create(name:, project_uids: nil, slug: nil, version_uids: nil, request_options: {}) + # + # @param name [String] + # @param project_uids [Array] + # @param slug [String] + # @param version_uids [Array] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::Mcp::ServerCreateResponse] + # + # @see Scalar::Models::Mcp::ServerCreateParams + def create(params) + parsed, options = Scalar::Mcp::ServerCreateParams.dump_request(params) + @client.request( + method: :post, + path: "v1/mcp/servers", + body: parsed, + model: Scalar::Models::Mcp::ServerCreateResponse, + options: options + ) + end + + # Get a single MCP server by its id. + # + # @overload retrieve(id, request_options: {}) + # + # @param id [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::Mcp::McpServer] + # + # @see Scalar::Models::Mcp::ServerRetrieveParams + def retrieve(id, params = {}) + @client.request( + method: :get, + path: ["v1/mcp/servers/%1$s", id], + model: Scalar::Mcp::McpServer, + options: params[:request_options] + ) + end + + # Update MCP server metadata and which tools it exposes. + # + # @overload update(id, auto_add_operations: nil, docs_pages: nil, name: nil, operations: nil, slug: nil, request_options: {}) + # + # @param id [String] + # @param auto_add_operations [Boolean] + # @param docs_pages [Array] + # @param name [String] + # @param operations [Array] + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::Mcp::McpServer] + # + # @see Scalar::Models::Mcp::ServerUpdateParams + def update(id, params = {}) + parsed, options = Scalar::Mcp::ServerUpdateParams.dump_request(params) + @client.request( + method: :patch, + path: ["v1/mcp/servers/%1$s", id], + body: parsed, + model: Scalar::Mcp::McpServer, + options: options + ) + end + + # List every MCP server on the team. + # + # @overload list(request_options: {}) + # + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Array] + # + # @see Scalar::Models::Mcp::ServerListParams + def list(params = {}) + @client.request( + method: :get, + path: "v1/mcp/servers", + model: Scalar::Internal::Type::ArrayOf[Scalar::Mcp::McpServer], + options: params[:request_options] + ) + end + + # Delete an MCP server and every installation it serves. + # + # @overload delete(id, request_options: {}) + # + # @param id [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Mcp::ServerDeleteParams + def delete(id, params = {}) + @client.request( + method: :delete, + path: ["v1/mcp/servers/%1$s", id], + model: Scalar::Internal::Type::Unknown, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + @installations = Scalar::Resources::Mcp::Servers::Installations.new(client: client) + end + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/mcp/servers/installations.rb b/lib/scalar_api_ruby/resources/mcp/servers/installations.rb new file mode 100644 index 0000000..208eca9 --- /dev/null +++ b/lib/scalar_api_ruby/resources/mcp/servers/installations.rb @@ -0,0 +1,200 @@ +# frozen_string_literal: true + +module Scalar + module Resources + class Mcp + class Servers + # MCP + class Installations + # Create an installation of an MCP server. `documentAuth` holds the credentials + # the server presents to the upstream API and is never returned. + # + # @overload create(id, document_auth:, name:, slug: nil, request_options: {}) + # + # @param id [String] + # @param document_auth [Hash{Symbol=>Object}] + # @param name [String] + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::Mcp::McpInstallation] + # + # @see Scalar::Models::Mcp::Servers::InstallationCreateParams + def create(id, params) + parsed, options = Scalar::Mcp::Servers::InstallationCreateParams.dump_request(params) + @client.request( + method: :post, + path: ["v1/mcp/servers/%1$s/installations", id], + body: parsed, + model: Scalar::Mcp::McpInstallation, + options: options + ) + end + + # Get a single installation of an MCP server. + # + # @overload retrieve(installation_id, id:, request_options: {}) + # + # @param installation_id [String] + # @param id [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::Mcp::McpInstallation] + # + # @see Scalar::Models::Mcp::Servers::InstallationRetrieveParams + def retrieve(installation_id, params) + parsed, options = Scalar::Mcp::Servers::InstallationRetrieveParams.dump_request(params) + id = parsed.delete(:id) { raise ArgumentError.new("missing required path argument #{_1}") } + @client.request( + method: :get, + path: ["v1/mcp/servers/%1$s/installations/%2$s", id, installation_id], + model: Scalar::Mcp::McpInstallation, + options: options + ) + end + + # Update an installation. Set `isPrivate` and add access groups to put it behind a + # login. + # + # @overload update(installation_id, id:, document_auth: nil, is_private: nil, login_portal_uid: nil, mcp_version: nil, name: nil, slug: nil, request_options: {}) + # + # @param installation_id [String] Path param + # + # @param id [String] Path param + # + # @param document_auth [Hash{Symbol=>Object}] Body param + # + # @param is_private [Boolean] Body param + # + # @param login_portal_uid [String, nil] Body param + # + # @param mcp_version [String, nil] Body param + # + # @param name [String] Body param + # + # @param slug [String] Body param + # + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::Mcp::McpInstallation] + # + # @see Scalar::Models::Mcp::Servers::InstallationUpdateParams + def update(installation_id, params) + parsed, options = Scalar::Mcp::Servers::InstallationUpdateParams.dump_request(params) + id = parsed.delete(:id) { raise ArgumentError.new("missing required path argument #{_1}") } + @client.request( + method: :patch, + path: ["v1/mcp/servers/%1$s/installations/%2$s", id, installation_id], + body: parsed, + model: Scalar::Mcp::McpInstallation, + options: options + ) + end + + # List the installations of an MCP server. An installation is what an MCP client + # connects to. + # + # @overload list(id, request_options: {}) + # + # @param id [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Array] + # + # @see Scalar::Models::Mcp::Servers::InstallationListParams + def list(id, params = {}) + @client.request( + method: :get, + path: ["v1/mcp/servers/%1$s/installations", id], + model: Scalar::Internal::Type::ArrayOf[Scalar::Mcp::Servers::McpInstallationListItem], + options: params[:request_options] + ) + end + + # Delete an installation of an MCP server. + # + # @overload delete(installation_id, id:, request_options: {}) + # + # @param installation_id [String] + # @param id [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Mcp::Servers::InstallationDeleteParams + def delete(installation_id, params) + parsed, options = Scalar::Mcp::Servers::InstallationDeleteParams.dump_request(params) + id = parsed.delete(:id) { raise ArgumentError.new("missing required path argument #{_1}") } + @client.request( + method: :delete, + path: ["v1/mcp/servers/%1$s/installations/%2$s", id, installation_id], + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # Let an access group reach a private installation. + # + # @overload create_access_group(installation_id, id:, access_group_uid:, request_options: {}) + # + # @param installation_id [String] Path param + # + # @param id [String] Path param + # + # @param access_group_uid [String] Body param + # + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Mcp::Servers::InstallationCreateAccessGroupParams + def create_access_group(installation_id, params) + parsed, options = Scalar::Mcp::Servers::InstallationCreateAccessGroupParams.dump_request(params) + id = parsed.delete(:id) { raise ArgumentError.new("missing required path argument #{_1}") } + @client.request( + method: :post, + path: ["v1/mcp/servers/%1$s/installations/%2$s/access-group", id, installation_id], + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # Stop an access group reaching a private installation. + # + # @overload delete_access_group(installation_id, id:, access_group_uid:, request_options: {}) + # + # @param installation_id [String] Path param + # + # @param id [String] Path param + # + # @param access_group_uid [String] Body param + # + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Mcp::Servers::InstallationDeleteAccessGroupParams + def delete_access_group(installation_id, params) + parsed, options = Scalar::Mcp::Servers::InstallationDeleteAccessGroupParams.dump_request(params) + id = parsed.delete(:id) { raise ArgumentError.new("missing required path argument #{_1}") } + @client.request( + method: :delete, + path: ["v1/mcp/servers/%1$s/installations/%2$s/access-group", id, installation_id], + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + end + end + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/o_auth.rb b/lib/scalar_api_ruby/resources/o_auth.rb new file mode 100644 index 0000000..845adeb --- /dev/null +++ b/lib/scalar_api_ruby/resources/o_auth.rb @@ -0,0 +1,113 @@ +# frozen_string_literal: true + +module Scalar + module Resources + # OAuth + class OAuth + # Discovery document for OAuth clients (RFC 8414): where the endpoints are and + # what they support. + # + # @overload oauth_authorization_server_metadata(request_options: {}) + # + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::OauthAuthorizationServerMetadata] + # + # @see Scalar::Models::OAuthOauthAuthorizationServerMetadataParams + def oauth_authorization_server_metadata(params = {}) + @client.request( + method: :get, + path: ".well-known/oauth-authorization-server", + model: Scalar::OauthAuthorizationServerMetadata, + options: params[:request_options] + ) + end + + # Authorization endpoint (RFC 6749 §4.1.1 with PKCE, RFC 7636). Validates the + # request and sends the user to the Scalar dashboard to approve it; the user + # returns to `redirect_uri` with a `code` to exchange at the token endpoint. Only + # `response_type=code` with `code_challenge_method=S256` is supported. + # + # @overload oauth_authorize(request_options: {}) + # + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::OAuthOauthAuthorizeParams + def oauth_authorize(params = {}) + @client.request( + method: :get, + path: "v1/oauth/authorize", + model: Scalar::Internal::Type::Unknown, + options: params[:request_options] + ) + end + + # Revocation endpoint (RFC 7009). Revokes the refresh token and every token issued + # alongside it. The client authenticates as it does at the token endpoint. + # Responds 200 whether or not the token was live, as the RFC requires. + # + # @overload oauth_revoke(token:, client_id: nil, client_secret: nil, token_type_hint: nil, request_options: {}) + # + # @param token [String] + # @param client_id [String] + # @param client_secret [String] + # @param token_type_hint [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::OauthError] + # + # @see Scalar::Models::OAuthOauthRevokeParams + def oauth_revoke(params) + parsed, options = Scalar::OAuthOauthRevokeParams.dump_request(params) + @client.request( + method: :post, + path: "v1/oauth/revoke", + body: parsed, + model: Scalar::OauthError, + options: options + ) + end + + # Token endpoint (RFC 6749 §4.1.3 and §6). Accepts + # `application/x-www-form-urlencoded`. Confidential clients authenticate with HTTP + # Basic or `client_secret` in the body; public clients send `client_id` alone. The + # `authorization_code` grant needs `code`, `redirect_uri` and `code_verifier`; the + # `refresh_token` grant needs `refresh_token` and may narrow `scope`. + # + # @overload oauth_token(grant_type:, client_id: nil, client_secret: nil, code: nil, code_verifier: nil, redirect_uri: nil, refresh_token: nil, scope: nil, request_options: {}) + # + # @param grant_type [String] + # @param client_id [String] + # @param client_secret [String] + # @param code [String] + # @param code_verifier [String] + # @param redirect_uri [String] + # @param refresh_token [String] + # @param scope [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::OauthToken, Scalar::Models::OauthError] + # + # @see Scalar::Models::OAuthOauthTokenParams + def oauth_token(params) + parsed, options = Scalar::OAuthOauthTokenParams.dump_request(params) + @client.request( + method: :post, + path: "v1/oauth/token", + body: parsed, + model: Scalar::Models::OAuthOauthTokenResponse, + options: options + ) + end + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/registry.rb b/lib/scalar_api_ruby/resources/registry.rb index dd83e6b..a630530 100644 --- a/lib/scalar_api_ruby/resources/registry.rb +++ b/lib/scalar_api_ruby/resources/registry.rb @@ -174,14 +174,14 @@ def delete_api_document_version(semver, params) # # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Scalar::Models::RegistryListAllAPIDocumentsParams def list_all_api_documents(params = {}) @client.request( method: :get, path: "v1/apis", - model: Scalar::Internal::Type::ArrayOf[Scalar::Models::RegistryListAllAPIDocumentsResponseItem], + model: Scalar::Internal::Type::ArrayOf[Scalar::APIDocument], options: params[:request_options] ) end @@ -219,14 +219,14 @@ def list_api_document_version_metadata(semver, params) # @param namespace [String] # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Scalar::Models::RegistryListAPIDocumentsParams def list_api_documents(namespace, params = {}) @client.request( method: :get, path: ["v1/apis/%1$s", namespace], - model: Scalar::Internal::Type::ArrayOf[Scalar::Models::RegistryListAPIDocumentsResponseItem], + model: Scalar::Internal::Type::ArrayOf[Scalar::APIDocument], options: params[:request_options] ) end diff --git a/lib/scalar_api_ruby/resources/rules.rb b/lib/scalar_api_ruby/resources/rules.rb index 8efe193..6da660c 100644 --- a/lib/scalar_api_ruby/resources/rules.rb +++ b/lib/scalar_api_ruby/resources/rules.rb @@ -116,14 +116,14 @@ def delete_ruleset_access_group(slug, params) # @param namespace [String] # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Scalar::Models::RuleListRulesetsParams def list_rulesets(namespace, params = {}) @client.request( method: :get, path: ["v1/rulesets/%1$s", namespace], - model: Scalar::Internal::Type::ArrayOf[Scalar::Models::RuleListRulesetsResponseItem], + model: Scalar::Internal::Type::ArrayOf[Scalar::Rule], options: params[:request_options] ) end diff --git a/lib/scalar_api_ruby/resources/scalar_docs.rb b/lib/scalar_api_ruby/resources/scalar_docs.rb index da25d3e..bc18f6a 100644 --- a/lib/scalar_api_ruby/resources/scalar_docs.rb +++ b/lib/scalar_api_ruby/resources/scalar_docs.rb @@ -29,24 +29,158 @@ def create_guide(params) ) end + # Create a docs project. Omit `provider` to have Scalar host the repository. + # + # @overload create_project(name:, provider:, bitbucket_repository: nil, blank: nil, github_repository: nil, is_private: nil, slug: nil, request_options: {}) + # + # @param name [String] + # @param provider [Symbol, Scalar::Models::ScalarDocCreateProjectParams::Provider] + # @param bitbucket_repository [Scalar::Models::ScalarDocCreateProjectParams::BitbucketRepository] + # @param blank [Boolean] + # @param github_repository [Scalar::Models::ScalarDocCreateProjectParams::GithubRepository] + # @param is_private [Boolean] + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::DocsProject] + # + # @see Scalar::Models::ScalarDocCreateProjectParams + def create_project(params) + parsed, options = Scalar::ScalarDocCreateProjectParams.dump_request(params) + @client.request( + method: :post, + path: "v1/docs", + body: parsed, + model: Scalar::DocsProject, + options: options + ) + end + + # Delete a docs project, its deploys, its publish records and its cached builds. + # + # @overload delete_project(slug, request_options: {}) + # + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::ScalarDocDeleteProjectParams + def delete_project(slug, params = {}) + @client.request( + method: :delete, + path: ["v1/docs/%1$s", slug], + model: Scalar::Internal::Type::Unknown, + options: params[:request_options] + ) + end + # List all guide projects. # # @overload list_guides(request_options: {}) # # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Scalar::Models::ScalarDocListGuidesParams def list_guides(params = {}) @client.request( method: :get, path: "v1/guides", - model: Scalar::Internal::Type::ArrayOf[Scalar::Models::ScalarDocListGuidesResponseItem], + model: Scalar::Internal::Type::ArrayOf[Scalar::GithubProject], + options: params[:request_options] + ) + end + + # Read `scalar.config.json` straight from the project repository, without cloning + # it. `baseToken` is the compare-and-swap handle for a later write. + # + # @overload list_project_config(slug, ref: nil, request_options: {}) + # + # @param slug [String] + # @param ref [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::ScalarDocListProjectConfigResponse] + # + # @see Scalar::Models::ScalarDocListProjectConfigParams + def list_project_config(slug, params = {}) + parsed, options = Scalar::ScalarDocListProjectConfigParams.dump_request(params) + query = Scalar::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: ["v1/docs/%1$s/config", slug], + query: query, + model: Scalar::Models::ScalarDocListProjectConfigResponse, + options: options + ) + end + + # The domains the project serves on — the Scalar-hosted one and the custom one, + # when set. + # + # @overload list_project_domain(slug, request_options: {}) + # + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::ScalarDocListProjectDomainResponse] + # + # @see Scalar::Models::ScalarDocListProjectDomainParams + def list_project_domain(slug, params = {}) + @client.request( + method: :get, + path: ["v1/docs/%1$s/domain", slug], + model: Scalar::Models::ScalarDocListProjectDomainResponse, + options: params[:request_options] + ) + end + + # Whether the project custom domain points at Scalar yet. `expected` is the CNAME + # record to create; `found` is what resolves today. A project with no custom + # domain reports `verified` with no expected record, because Scalar serves its own + # subdomain directly. + # + # @overload list_project_domain_status(slug, request_options: {}) + # + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::ScalarDocListProjectDomainStatusResponse] + # + # @see Scalar::Models::ScalarDocListProjectDomainStatusParams + def list_project_domain_status(slug, params = {}) + @client.request( + method: :get, + path: ["v1/docs/%1$s/domain/status", slug], + model: Scalar::Models::ScalarDocListProjectDomainStatusResponse, options: params[:request_options] ) end + # List every docs project on the team. + # + # @overload list_projects(limit: nil, request_options: {}) + # + # @param limit [Integer] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::ScalarDocListProjectsResponse] + # + # @see Scalar::Models::ScalarDocListProjectsParams + def list_projects(params = {}) + parsed, options = Scalar::ScalarDocListProjectsParams.dump_request(params) + query = Scalar::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "v1/docs", + query: query, + model: Scalar::Models::ScalarDocListProjectsResponse, + options: options + ) + end + # Start a new publish process. # # @overload publish_guide(slug, request_options: {}) @@ -66,6 +200,107 @@ def publish_guide(slug, params = {}) ) end + # Start a build and deploy. The returned `publishUid` identifies the publish + # record. + # + # @overload publish_project(slug, commit_sha: nil, config_path: nil, preview: nil, request_options: {}) + # + # @param slug [String] + # @param commit_sha [String] + # @param config_path [String] + # @param preview [Boolean] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::ScalarDocPublishProjectResponse] + # + # @see Scalar::Models::ScalarDocPublishProjectParams + def publish_project(slug, params = {}) + parsed, options = Scalar::ScalarDocPublishProjectParams.dump_request(params) + @client.request( + method: :post, + path: ["v1/docs/%1$s/publish", slug], + body: parsed, + model: Scalar::Models::ScalarDocPublishProjectResponse, + options: options + ) + end + + # Get a single docs project by its slug. + # + # @overload retrieve_project(slug, request_options: {}) + # + # @param slug [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::DocsProject] + # + # @see Scalar::Models::ScalarDocRetrieveProjectParams + def retrieve_project(slug, params = {}) + @client.request( + method: :get, + path: ["v1/docs/%1$s", slug], + model: Scalar::DocsProject, + options: params[:request_options] + ) + end + + # Update project settings. Set `isPrivate` with `accessGroups` to put the site + # behind a login. + # + # @overload update_project(slug, access_groups: nil, active_theme_id: nil, agent_enabled: nil, analytics_enabled: nil, is_private: nil, login_portal_uid: nil, name: nil, request_options: {}) + # + # @param slug [String] + # @param access_groups [Array] + # @param active_theme_id [String] + # @param agent_enabled [Boolean] + # @param analytics_enabled [Boolean] + # @param is_private [Boolean] + # @param login_portal_uid [String, Symbol] + # @param name [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::ScalarDocUpdateProjectParams + def update_project(slug, params = {}) + parsed, options = Scalar::ScalarDocUpdateProjectParams.dump_request(params) + @client.request( + method: :patch, + path: ["v1/docs/%1$s", slug], + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # Commit `scalar.config.json` straight to the project repository. Pass the + # `baseToken` from the read this edit was based on; a conflict means the file + # moved underneath it. + # + # @overload update_project_config(slug, content:, base_token: nil, message: nil, path: nil, ref: nil, request_options: {}) + # + # @param slug [String] + # @param content [String] + # @param base_token [String] + # @param message [String] + # @param path [String] + # @param ref [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::ScalarDocUpdateProjectConfigResponse] + # + # @see Scalar::Models::ScalarDocUpdateProjectConfigParams + def update_project_config(slug, params) + parsed, options = Scalar::ScalarDocUpdateProjectConfigParams.dump_request(params) + @client.request( + method: :put, + path: ["v1/docs/%1$s/config", slug], + body: parsed, + model: Scalar::Models::ScalarDocUpdateProjectConfigResponse, + options: options + ) + end + # @api private # # @param client [Scalar::Client] diff --git a/lib/scalar_api_ruby/resources/schemas.rb b/lib/scalar_api_ruby/resources/schemas.rb index 934c99c..6c90ccd 100644 --- a/lib/scalar_api_ruby/resources/schemas.rb +++ b/lib/scalar_api_ruby/resources/schemas.rb @@ -78,14 +78,14 @@ def update(slug, params) # @param namespace [String] # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Scalar::Models::SchemaListParams def list(namespace, params = {}) @client.request( method: :get, path: ["v1/schemas/%1$s", namespace], - model: Scalar::Internal::Type::ArrayOf[Scalar::Models::SchemaListResponseItem], + model: Scalar::Internal::Type::ArrayOf[Scalar::Schema], options: params[:request_options] ) end diff --git a/lib/scalar_api_ruby/resources/sdks.rb b/lib/scalar_api_ruby/resources/sdks.rb new file mode 100644 index 0000000..250b6b7 --- /dev/null +++ b/lib/scalar_api_ruby/resources/sdks.rb @@ -0,0 +1,156 @@ +# frozen_string_literal: true + +module Scalar + module Resources + # SDKs + class Sdks + # SDKs + # @return [Scalar::Resources::Sdks::Versions] + attr_reader :versions + + # SDKs + # @return [Scalar::Resources::Sdks::Repositories] + attr_reader :repositories + + # Create an SDK from an API document, targeting one or more languages. + # + # @overload create(api_uid:, languages:, class_name: nil, config: nil, slug: nil, title: nil, request_options: {}) + # + # @param api_uid [String] + # @param languages [Array] + # @param class_name [String] + # @param config [String] + # @param slug [String] + # @param title [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::UID] + # + # @see Scalar::Models::SdkCreateParams + def create(params) + parsed, options = Scalar::SdkCreateParams.dump_request(params) + @client.request(method: :post, path: "v1/sdks", body: parsed, model: Scalar::UID, options: options) + end + + # Get a single SDK by its uid. + # + # @overload retrieve(uid, request_options: {}) + # + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::Sdk] + # + # @see Scalar::Models::SdkRetrieveParams + def retrieve(uid, params = {}) + @client.request( + method: :get, + path: ["v1/sdks/%1$s", uid], + model: Scalar::Sdk, + options: params[:request_options] + ) + end + + # Update SDK metadata, its linked API, or its config. + # + # @overload update(uid, api_uid: nil, api_version: nil, config: nil, is_private: nil, slug: nil, title: nil, request_options: {}) + # + # @param uid [String] + # @param api_uid [String, nil] + # @param api_version [String, nil] + # @param config [String] + # @param is_private [Boolean] + # @param slug [String] + # @param title [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::SdkUpdateParams + def update(uid, params = {}) + parsed, options = Scalar::SdkUpdateParams.dump_request(params) + @client.request( + method: :patch, + path: ["v1/sdks/%1$s", uid], + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # List every SDK on the team. + # + # @overload list(limit: nil, request_options: {}) + # + # @param limit [Integer] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::SdkListResponse] + # + # @see Scalar::Models::SdkListParams + def list(params = {}) + parsed, options = Scalar::SdkListParams.dump_request(params) + query = Scalar::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "v1/sdks", + query: query, + model: Scalar::Models::SdkListResponse, + options: options + ) + end + + # Delete an SDK and every version it holds. + # + # @overload delete(uid, request_options: {}) + # + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::SdkDeleteParams + def delete(uid, params = {}) + @client.request( + method: :delete, + path: ["v1/sdks/%1$s", uid], + model: Scalar::Internal::Type::Unknown, + options: params[:request_options] + ) + end + + # Start a build. Omit `version` to build the current work — the open draft, else + # the latest version — and the resolved version comes back in the response. + # + # @overload build(uid, languages: nil, version: nil, request_options: {}) + # + # @param uid [String] + # @param languages [Array] + # @param version [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::SdkBuildResponse] + # + # @see Scalar::Models::SdkBuildParams + def build(uid, params = {}) + parsed, options = Scalar::SdkBuildParams.dump_request(params) + @client.request( + method: :post, + path: ["v1/sdks/%1$s/build", uid], + body: parsed, + model: Scalar::Models::SdkBuildResponse, + options: options + ) + end + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + @versions = Scalar::Resources::Sdks::Versions.new(client: client) + @repositories = Scalar::Resources::Sdks::Repositories.new(client: client) + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/sdks/repositories.rb b/lib/scalar_api_ruby/resources/sdks/repositories.rb new file mode 100644 index 0000000..200a8f4 --- /dev/null +++ b/lib/scalar_api_ruby/resources/sdks/repositories.rb @@ -0,0 +1,97 @@ +# frozen_string_literal: true + +module Scalar + module Resources + class Sdks + # SDKs + class Repositories + # Link one language target to a GitHub repository, so builds sync there. + # + # @overload link(uid, base_branch:, language:, repository_id:, prerelease_type: nil, request_options: {}) + # + # @param uid [String] + # @param base_branch [String] + # @param language [Symbol, Scalar::Models::Sdks::RepositoryLinkParams::Language] + # @param repository_id [Integer] + # @param prerelease_type [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::Sdks::RepositoryLinkResponse] + # + # @see Scalar::Models::Sdks::RepositoryLinkParams + def link(uid, params) + parsed, options = Scalar::Sdks::RepositoryLinkParams.dump_request(params) + @client.request( + method: :post, + path: ["v1/sdks/%1$s/repositories", uid], + body: parsed, + model: Scalar::Models::Sdks::RepositoryLinkResponse, + options: options + ) + end + + # Unlink one language target from its repository. + # + # @overload unlink(language, uid:, request_options: {}) + # + # @param language [Symbol, Scalar::Models::Sdks::RepositoryUnlinkParams::Language] + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Sdks::RepositoryUnlinkParams + def unlink(language, params) + parsed, options = Scalar::Sdks::RepositoryUnlinkParams.dump_request(params) + uid = parsed.delete(:uid) { raise ArgumentError.new("missing required path argument #{_1}") } + @client.request( + method: :delete, + path: ["v1/sdks/%1$s/repositories/%2$s", uid, language], + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # Toggle publish-on-merge and the release settings for a linked target. + # + # @overload update_publishing(language, uid:, publish_on_merge:, access: nil, auth_method: nil, tag: nil, request_options: {}) + # + # @param language [Symbol, Scalar::Models::Sdks::RepositoryUpdatePublishingParams::Language] Path param + # + # @param uid [String] Path param + # + # @param publish_on_merge [Boolean] Body param + # + # @param access [Symbol, Scalar::Models::Sdks::RepositoryUpdatePublishingParams::Access] Body param + # + # @param auth_method [Symbol, Scalar::Models::Sdks::RepositoryUpdatePublishingParams::AuthMethod] Body param + # + # @param tag [String] Body param + # + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Sdks::RepositoryUpdatePublishingParams + def update_publishing(language, params) + parsed, options = Scalar::Sdks::RepositoryUpdatePublishingParams.dump_request(params) + uid = parsed.delete(:uid) { raise ArgumentError.new("missing required path argument #{_1}") } + @client.request( + method: :post, + path: ["v1/sdks/%1$s/repositories/%2$s/publishing", uid, language], + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/sdks/versions.rb b/lib/scalar_api_ruby/resources/sdks/versions.rb new file mode 100644 index 0000000..c6a26f2 --- /dev/null +++ b/lib/scalar_api_ruby/resources/sdks/versions.rb @@ -0,0 +1,62 @@ +# frozen_string_literal: true + +module Scalar + module Resources + class Sdks + # SDKs + class Versions + # Create a new SDK version against a specific API version. + # + # @overload create(uid, api_version:, version:, request_options: {}) + # + # @param uid [String] + # @param api_version [String] + # @param version [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Sdks::VersionCreateParams + def create(uid, params) + parsed, options = Scalar::Sdks::VersionCreateParams.dump_request(params) + @client.request( + method: :post, + path: ["v1/sdks/%1$s/versions", uid], + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # Permanently delete one version of an SDK. + # + # @overload delete(version, uid:, request_options: {}) + # + # @param version [String] + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Sdks::VersionDeleteParams + def delete(version, params) + parsed, options = Scalar::Sdks::VersionDeleteParams.dump_request(params) + uid = parsed.delete(:uid) { raise ArgumentError.new("missing required path argument #{_1}") } + @client.request( + method: :delete, + path: ["v1/sdks/%1$s/versions/%2$s", uid, version], + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/teams.rb b/lib/scalar_api_ruby/resources/teams.rb index e7e8b3c..683eb5b 100644 --- a/lib/scalar_api_ruby/resources/teams.rb +++ b/lib/scalar_api_ruby/resources/teams.rb @@ -4,20 +4,28 @@ module Scalar module Resources # Teams class Teams + # Teams + # @return [Scalar::Resources::Teams::Members] + attr_reader :members + + # Teams + # @return [Scalar::Resources::Teams::Invites] + attr_reader :invites + # List all available teams # # @overload list(request_options: {}) # # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Scalar::Models::TeamListParams def list(params = {}) @client.request( method: :get, path: "v1/teams", - model: Scalar::Internal::Type::ArrayOf[Scalar::Models::TeamListResponseItem], + model: Scalar::Internal::Type::ArrayOf[Scalar::Team], options: params[:request_options] ) end @@ -27,6 +35,8 @@ def list(params = {}) # @param client [Scalar::Client] def initialize(client:) @client = client + @members = Scalar::Resources::Teams::Members.new(client: client) + @invites = Scalar::Resources::Teams::Invites.new(client: client) end end end diff --git a/lib/scalar_api_ruby/resources/teams/invites.rb b/lib/scalar_api_ruby/resources/teams/invites.rb new file mode 100644 index 0000000..2c16746 --- /dev/null +++ b/lib/scalar_api_ruby/resources/teams/invites.rb @@ -0,0 +1,77 @@ +# frozen_string_literal: true + +module Scalar + module Resources + class Teams + # Teams + class Invites + # Withdraw an invite that has not been accepted. + # + # @overload cancel(uid, request_options: {}) + # + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Teams::InviteCancelParams + def cancel(uid, params = {}) + @client.request( + method: :delete, + path: ["v1/teams/invites/%1$s", uid], + model: Scalar::Internal::Type::Unknown, + options: params[:request_options] + ) + end + + # Invite someone to the current team by email. + # + # @overload member(email:, role:, request_options: {}) + # + # @param email [String] + # @param role [Symbol, Scalar::Models::Teams::Role] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Teams::InviteMemberParams + def member(params) + parsed, options = Scalar::Teams::InviteMemberParams.dump_request(params) + @client.request( + method: :post, + path: "v1/teams/invites", + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # Send the invite email again. + # + # @overload resend(uid, request_options: {}) + # + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Teams::InviteResendParams + def resend(uid, params = {}) + @client.request( + method: :patch, + path: ["v1/teams/invites/%1$s", uid], + model: Scalar::Internal::Type::Unknown, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/teams/members.rb b/lib/scalar_api_ruby/resources/teams/members.rb new file mode 100644 index 0000000..d1d7e7f --- /dev/null +++ b/lib/scalar_api_ruby/resources/teams/members.rb @@ -0,0 +1,76 @@ +# frozen_string_literal: true + +module Scalar + module Resources + class Teams + # Teams + class Members + # Change what a member of the current team is allowed to do. + # + # @overload update(uid, role:, request_options: {}) + # + # @param uid [String] + # @param role [Symbol, Scalar::Models::Teams::Role] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Teams::MemberUpdateParams + def update(uid, params) + parsed, options = Scalar::Teams::MemberUpdateParams.dump_request(params) + @client.request( + method: :patch, + path: ["v1/teams/members/%1$s", uid], + body: parsed, + model: Scalar::Internal::Type::Unknown, + options: options + ) + end + + # List the members of the current team, along with the invites still outstanding. + # + # @overload list(request_options: {}) + # + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Scalar::Models::Teams::MemberListResponse] + # + # @see Scalar::Models::Teams::MemberListParams + def list(params = {}) + @client.request( + method: :get, + path: "v1/teams/members", + model: Scalar::Models::Teams::MemberListResponse, + options: params[:request_options] + ) + end + + # Remove someone from the current team. + # + # @overload delete(uid, request_options: {}) + # + # @param uid [String] + # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Object] + # + # @see Scalar::Models::Teams::MemberDeleteParams + def delete(uid, params = {}) + @client.request( + method: :delete, + path: ["v1/teams/members/%1$s", uid], + model: Scalar::Internal::Type::Unknown, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Scalar::Client] + def initialize(client:) + @client = client + end + end + end + end +end diff --git a/lib/scalar_api_ruby/resources/themes.rb b/lib/scalar_api_ruby/resources/themes.rb index 2d1158b..45529ba 100644 --- a/lib/scalar_api_ruby/resources/themes.rb +++ b/lib/scalar_api_ruby/resources/themes.rb @@ -73,14 +73,14 @@ def update(slug, params = {}) # # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see Scalar::Models::ThemeListParams def list(params = {}) @client.request( method: :get, path: "v1/themes", - model: Scalar::Internal::Type::ArrayOf[Scalar::Models::ThemeListResponseItem], + model: Scalar::Internal::Type::ArrayOf[Scalar::Theme], options: params[:request_options] ) end diff --git a/rbi/scalar_api_ruby/client.rbi b/rbi/scalar_api_ruby/client.rbi index c6a5904..a108bd9 100644 --- a/rbi/scalar_api_ruby/client.rbi +++ b/rbi/scalar_api_ruby/client.rbi @@ -28,6 +28,10 @@ module Scalar sig { returns(Scalar::Resources::LoginPortals) } attr_reader :login_portals + # Access Groups + sig { returns(Scalar::Resources::AccessGroups) } + attr_reader :access_groups + # Rules sig { returns(Scalar::Resources::Rules) } attr_reader :rules @@ -52,6 +56,17 @@ module Scalar sig { returns(Scalar::Resources::Authentication) } attr_reader :authentication + # SDKs + sig { returns(Scalar::Resources::Sdks) } + attr_reader :sdks + + sig { returns(Scalar::Resources::Mcp) } + attr_reader :mcp + + # OAuth + sig { returns(Scalar::Resources::OAuth) } + attr_reader :o_auth + # @api private sig { override.returns(T::Hash[String, String]) } private def auth_headers diff --git a/rbi/scalar_api_ruby/models.rbi b/rbi/scalar_api_ruby/models.rbi index c36489c..ee11e27 100644 --- a/rbi/scalar_api_ruby/models.rbi +++ b/rbi/scalar_api_ruby/models.rbi @@ -3,12 +3,36 @@ module Scalar AccessGroup = Scalar::Models::AccessGroup + AccessGroupCreateParams = Scalar::Models::AccessGroupCreateParams + + AccessGroupDeleteParams = Scalar::Models::AccessGroupDeleteParams + + AccessGroupName = Scalar::Models::AccessGroupName + + AccessGroupRetrieveParams = Scalar::Models::AccessGroupRetrieveParams + + AccessGroups = Scalar::Models::AccessGroups + + AccessGroupUpdateParams = Scalar::Models::AccessGroupUpdateParams + + ActiveDeployment = Scalar::Models::ActiveDeployment + + APIDocument = Scalar::Models::APIDocument + AuthenticationExchangePersonalTokenParams = Scalar::Models::AuthenticationExchangePersonalTokenParams AuthenticationListCurrentUserParams = Scalar::Models::AuthenticationListCurrentUserParams + DocsProject = Scalar::Models::DocsProject + + GithubProject = Scalar::Models::GithubProject + + GithubProjectRepository = Scalar::Models::GithubProjectRepository + + LoginPortal = Scalar::Models::LoginPortal + LoginPortalCreateParams = Scalar::Models::LoginPortalCreateParams LoginPortalDeleteParams = Scalar::Models::LoginPortalDeleteParams @@ -25,12 +49,36 @@ module Scalar ManagedDocVersion = Scalar::Models::ManagedDocVersion + ManagedSchemaVersion = Scalar::Models::ManagedSchemaVersion + + Mcp = Scalar::Models::Mcp + + Method = Scalar::Models::Method + Namespace = Scalar::Models::Namespace NamespaceListParams = Scalar::Models::NamespaceListParams Nanoid = Scalar::Models::Nanoid + OauthAuthorizationServerMetadata = + Scalar::Models::OauthAuthorizationServerMetadata + + OauthError = Scalar::Models::OauthError + + OAuthOauthAuthorizationServerMetadataParams = + Scalar::Models::OAuthOauthAuthorizationServerMetadataParams + + OAuthOauthAuthorizeParams = Scalar::Models::OAuthOauthAuthorizeParams + + OAuthOauthRevokeParams = Scalar::Models::OAuthOauthRevokeParams + + OAuthOauthTokenParams = Scalar::Models::OAuthOauthTokenParams + + OauthScope = Scalar::Models::OauthScope + + OauthToken = Scalar::Models::OauthToken + RegistryCreateAPIDocumentAccessGroupParams = Scalar::Models::RegistryCreateAPIDocumentAccessGroupParams @@ -67,6 +115,8 @@ module Scalar RegistryUpdateAPIDocumentVersionParams = Scalar::Models::RegistryUpdateAPIDocumentVersionParams + Rule = Scalar::Models::Rule + RuleCreateRulesetAccessGroupParams = Scalar::Models::RuleCreateRulesetAccessGroupParams @@ -86,10 +136,37 @@ module Scalar ScalarDocCreateGuideParams = Scalar::Models::ScalarDocCreateGuideParams + ScalarDocCreateProjectParams = Scalar::Models::ScalarDocCreateProjectParams + + ScalarDocDeleteProjectParams = Scalar::Models::ScalarDocDeleteProjectParams + ScalarDocListGuidesParams = Scalar::Models::ScalarDocListGuidesParams + ScalarDocListProjectConfigParams = + Scalar::Models::ScalarDocListProjectConfigParams + + ScalarDocListProjectDomainParams = + Scalar::Models::ScalarDocListProjectDomainParams + + ScalarDocListProjectDomainStatusParams = + Scalar::Models::ScalarDocListProjectDomainStatusParams + + ScalarDocListProjectsParams = Scalar::Models::ScalarDocListProjectsParams + ScalarDocPublishGuideParams = Scalar::Models::ScalarDocPublishGuideParams + ScalarDocPublishProjectParams = Scalar::Models::ScalarDocPublishProjectParams + + ScalarDocRetrieveProjectParams = + Scalar::Models::ScalarDocRetrieveProjectParams + + ScalarDocUpdateProjectConfigParams = + Scalar::Models::ScalarDocUpdateProjectConfigParams + + ScalarDocUpdateProjectParams = Scalar::Models::ScalarDocUpdateProjectParams + + Schema = Scalar::Models::Schema + SchemaCreateParams = Scalar::Models::SchemaCreateParams SchemaDeleteParams = Scalar::Models::SchemaDeleteParams @@ -100,10 +177,42 @@ module Scalar SchemaUpdateParams = Scalar::Models::SchemaUpdateParams + Sdk = Scalar::Models::Sdk + + SdkBuildParams = Scalar::Models::SdkBuildParams + + SdkCreateParams = Scalar::Models::SdkCreateParams + + SdkDeleteParams = Scalar::Models::SdkDeleteParams + + SdkListParams = Scalar::Models::SdkListParams + + SdkRetrieveParams = Scalar::Models::SdkRetrieveParams + + Sdks = Scalar::Models::Sdks + + SdkTargetSummary = Scalar::Models::SdkTargetSummary + + SdkUpdateParams = Scalar::Models::SdkUpdateParams + + SdkVersion = Scalar::Models::SdkVersion + Slug = Scalar::Models::Slug + Team = Scalar::Models::Team + + TeamImage = Scalar::Models::TeamImage + TeamListParams = Scalar::Models::TeamListParams + TeamName = Scalar::Models::TeamName + + Teams = Scalar::Models::Teams + + TeamSummary = Scalar::Models::TeamSummary + + Theme = Scalar::Models::Theme + ThemeCreateParams = Scalar::Models::ThemeCreateParams ThemeDeleteParams = Scalar::Models::ThemeDeleteParams @@ -120,6 +229,8 @@ module Scalar UID = Scalar::Models::UID + User = Scalar::Models::User + Value400 = Scalar::Models::Value400 Value401 = Scalar::Models::Value401 diff --git a/rbi/scalar_api_ruby/models/access_group_create_params.rbi b/rbi/scalar_api_ruby/models/access_group_create_params.rbi new file mode 100644 index 0000000..1b7dd0b --- /dev/null +++ b/rbi/scalar_api_ruby/models/access_group_create_params.rbi @@ -0,0 +1,62 @@ +# typed: strong + +module Scalar + module Models + class AccessGroupCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::AccessGroupCreateParams, Scalar::Internal::AnyHash) + end + + sig { returns(T.nilable(T.anything)) } + attr_reader :allowed_domains + + sig { params(allowed_domains: T.anything).void } + attr_writer :allowed_domains + + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + sig { returns(T.nilable(String)) } + attr_reader :slug + + sig { params(slug: String).void } + attr_writer :slug + + sig do + params( + allowed_domains: T.anything, + name: String, + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + allowed_domains: nil, + name: nil, + slug: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + allowed_domains: T.anything, + name: String, + slug: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/access_group_create_response.rbi b/rbi/scalar_api_ruby/models/access_group_create_response.rbi new file mode 100644 index 0000000..46a3d5a --- /dev/null +++ b/rbi/scalar_api_ruby/models/access_group_create_response.rbi @@ -0,0 +1,56 @@ +# typed: strong + +module Scalar + module Models + class AccessGroupCreateResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::AccessGroupCreateResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(T.anything) } + attr_accessor :allowed_domains + + sig { returns(T.anything) } + attr_accessor :allowed_emails + + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :uid + + sig do + params( + allowed_domains: T.anything, + allowed_emails: T.anything, + name: String, + slug: String, + uid: String + ).returns(T.attached_class) + end + def self.new(allowed_domains:, allowed_emails:, name:, slug:, uid:) + end + + sig do + override.returns( + { + allowed_domains: T.anything, + allowed_emails: T.anything, + name: String, + slug: String, + uid: String + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/access_group_delete_params.rbi b/rbi/scalar_api_ruby/models/access_group_delete_params.rbi new file mode 100644 index 0000000..5eae5cd --- /dev/null +++ b/rbi/scalar_api_ruby/models/access_group_delete_params.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Scalar + module Models + class AccessGroupDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::AccessGroupDeleteParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :slug + + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(slug:, request_options: {}) + end + + sig do + override.returns( + { slug: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/access_group_name.rbi b/rbi/scalar_api_ruby/models/access_group_name.rbi new file mode 100644 index 0000000..f378a52 --- /dev/null +++ b/rbi/scalar_api_ruby/models/access_group_name.rbi @@ -0,0 +1,7 @@ +# typed: strong + +module Scalar + module Models + AccessGroupName = String + end +end diff --git a/rbi/scalar_api_ruby/models/access_group_retrieve_params.rbi b/rbi/scalar_api_ruby/models/access_group_retrieve_params.rbi new file mode 100644 index 0000000..3a58cac --- /dev/null +++ b/rbi/scalar_api_ruby/models/access_group_retrieve_params.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Scalar + module Models + class AccessGroupRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::AccessGroupRetrieveParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :slug + + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(slug:, request_options: {}) + end + + sig do + override.returns( + { slug: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/access_group_retrieve_response.rbi b/rbi/scalar_api_ruby/models/access_group_retrieve_response.rbi new file mode 100644 index 0000000..4acd2a3 --- /dev/null +++ b/rbi/scalar_api_ruby/models/access_group_retrieve_response.rbi @@ -0,0 +1,56 @@ +# typed: strong + +module Scalar + module Models + class AccessGroupRetrieveResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::AccessGroupRetrieveResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(T.anything) } + attr_accessor :allowed_domains + + sig { returns(T.anything) } + attr_accessor :allowed_emails + + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :uid + + sig do + params( + allowed_domains: T.anything, + allowed_emails: T.anything, + name: String, + slug: String, + uid: String + ).returns(T.attached_class) + end + def self.new(allowed_domains:, allowed_emails:, name:, slug:, uid:) + end + + sig do + override.returns( + { + allowed_domains: T.anything, + allowed_emails: T.anything, + name: String, + slug: String, + uid: String + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/access_group_update_params.rbi b/rbi/scalar_api_ruby/models/access_group_update_params.rbi new file mode 100644 index 0000000..92f5c5f --- /dev/null +++ b/rbi/scalar_api_ruby/models/access_group_update_params.rbi @@ -0,0 +1,54 @@ +# typed: strong + +module Scalar + module Models + class AccessGroupUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::AccessGroupUpdateParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :path_slug + + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + sig { returns(T.nilable(String)) } + attr_reader :body_slug + + sig { params(body_slug: String).void } + attr_writer :body_slug + + sig do + params( + path_slug: String, + name: String, + body_slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(path_slug:, name: nil, body_slug: nil, request_options: {}) + end + + sig do + override.returns( + { + path_slug: String, + name: String, + body_slug: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/access_groups/domain_create_params.rbi b/rbi/scalar_api_ruby/models/access_groups/domain_create_params.rbi new file mode 100644 index 0000000..50b708c --- /dev/null +++ b/rbi/scalar_api_ruby/models/access_groups/domain_create_params.rbi @@ -0,0 +1,48 @@ +# typed: strong + +module Scalar + module Models + module AccessGroups + class DomainCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::AccessGroups::DomainCreateParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :domain + + sig do + params( + slug: String, + domain: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(slug:, domain:, request_options: {}) + end + + sig do + override.returns( + { + slug: String, + domain: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/access_groups/domain_delete_params.rbi b/rbi/scalar_api_ruby/models/access_groups/domain_delete_params.rbi new file mode 100644 index 0000000..d4346e9 --- /dev/null +++ b/rbi/scalar_api_ruby/models/access_groups/domain_delete_params.rbi @@ -0,0 +1,48 @@ +# typed: strong + +module Scalar + module Models + module AccessGroups + class DomainDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::AccessGroups::DomainDeleteParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :domain + + sig do + params( + slug: String, + domain: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(slug:, domain:, request_options: {}) + end + + sig do + override.returns( + { + slug: String, + domain: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/access_groups/email_domain.rbi b/rbi/scalar_api_ruby/models/access_groups/email_domain.rbi new file mode 100644 index 0000000..b55fcd0 --- /dev/null +++ b/rbi/scalar_api_ruby/models/access_groups/email_domain.rbi @@ -0,0 +1,9 @@ +# typed: strong + +module Scalar + module Models + module AccessGroups + EmailDomain = String + end + end +end diff --git a/rbi/scalar_api_ruby/models/active_deployment.rbi b/rbi/scalar_api_ruby/models/active_deployment.rbi new file mode 100644 index 0000000..b528123 --- /dev/null +++ b/rbi/scalar_api_ruby/models/active_deployment.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Scalar + module Models + class ActiveDeployment < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Scalar::ActiveDeployment, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :domain + + sig { returns(Integer) } + attr_accessor :published_at + + sig { returns(String) } + attr_accessor :uid + + sig do + params(domain: String, published_at: Integer, uid: String).returns( + T.attached_class + ) + end + def self.new(domain:, published_at:, uid:) + end + + sig do + override.returns({ domain: String, published_at: Integer, uid: String }) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/api_document.rbi b/rbi/scalar_api_ruby/models/api_document.rbi new file mode 100644 index 0000000..08e4f81 --- /dev/null +++ b/rbi/scalar_api_ruby/models/api_document.rbi @@ -0,0 +1,81 @@ +# typed: strong + +module Scalar + module Models + class APIDocument < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Scalar::APIDocument, Scalar::Internal::AnyHash) } + + sig { returns(String) } + attr_accessor :description + + sig { returns(T::Boolean) } + attr_accessor :is_private + + sig { returns(String) } + attr_accessor :namespace + + sig { returns(String) } + attr_accessor :slug + + sig { returns(T.anything) } + attr_accessor :tags + + sig { returns(String) } + attr_accessor :title + + sig { returns(String) } + attr_accessor :uid + + sig { returns(String) } + attr_accessor :version + + sig { returns(T::Array[Scalar::ManagedDocVersion]) } + attr_accessor :versions + + sig do + params( + description: String, + is_private: T::Boolean, + namespace: String, + slug: String, + tags: T.anything, + title: String, + uid: String, + version: String, + versions: T::Array[Scalar::ManagedDocVersion::OrHash] + ).returns(T.attached_class) + end + def self.new( + description:, + is_private:, + namespace:, + slug:, + tags:, + title:, + uid:, + version:, + versions: + ) + end + + sig do + override.returns( + { + description: String, + is_private: T::Boolean, + namespace: String, + slug: String, + tags: T.anything, + title: String, + uid: String, + version: String, + versions: T::Array[Scalar::ManagedDocVersion] + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/authentication_list_current_user_response.rbi b/rbi/scalar_api_ruby/models/authentication_list_current_user_response.rbi deleted file mode 100644 index 43c46e6..0000000 --- a/rbi/scalar_api_ruby/models/authentication_list_current_user_response.rbi +++ /dev/null @@ -1,129 +0,0 @@ -# typed: strong - -module Scalar - module Models - class AuthenticationListCurrentUserResponse < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::AuthenticationListCurrentUserResponse, - Scalar::Internal::AnyHash - ) - end - - sig { returns(T.nilable(String)) } - attr_accessor :active_team_id - - sig { returns(Integer) } - attr_accessor :created_at - - sig { returns(String) } - attr_accessor :email - - sig { returns(T::Boolean) } - attr_accessor :has_github - - sig do - returns( - T::Array[Scalar::Models::AuthenticationListCurrentUserResponse::Team] - ) - end - attr_accessor :teams - - sig { returns(String) } - attr_accessor :uid - - sig { returns(Integer) } - attr_accessor :updated_at - - sig { returns(T.nilable(String)) } - attr_reader :theme - - sig { params(theme: String).void } - attr_writer :theme - - sig do - params( - active_team_id: T.nilable(String), - created_at: Integer, - email: String, - has_github: T::Boolean, - teams: - T::Array[ - Scalar::Models::AuthenticationListCurrentUserResponse::Team::OrHash - ], - uid: String, - updated_at: Integer, - theme: String - ).returns(T.attached_class) - end - def self.new( - active_team_id:, - created_at:, - email:, - has_github:, - teams:, - uid:, - updated_at:, - theme: nil - ) - end - - sig do - override.returns( - { - active_team_id: T.nilable(String), - created_at: Integer, - email: String, - has_github: T::Boolean, - teams: - T::Array[ - Scalar::Models::AuthenticationListCurrentUserResponse::Team - ], - uid: String, - updated_at: Integer, - theme: String - } - ) - end - def to_hash - end - - class Team < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::AuthenticationListCurrentUserResponse::Team, - Scalar::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :uid - - sig { returns(T.nilable(String)) } - attr_reader :image_uri - - sig { params(image_uri: String).void } - attr_writer :image_uri - - sig do - params(name: String, uid: String, image_uri: String).returns( - T.attached_class - ) - end - def self.new(name:, uid:, image_uri: nil) - end - - sig do - override.returns({ name: String, uid: String, image_uri: String }) - end - def to_hash - end - end - end - end -end diff --git a/rbi/scalar_api_ruby/models/docs_project.rbi b/rbi/scalar_api_ruby/models/docs_project.rbi new file mode 100644 index 0000000..13479cf --- /dev/null +++ b/rbi/scalar_api_ruby/models/docs_project.rbi @@ -0,0 +1,93 @@ +# typed: strong + +module Scalar + module Models + class DocsProject < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Scalar::DocsProject, Scalar::Internal::AnyHash) } + + sig { returns(T.anything) } + attr_accessor :access_groups + + sig { returns(String) } + attr_accessor :active_theme_id + + sig { returns(T::Boolean) } + attr_accessor :agent_enabled + + sig { returns(T::Boolean) } + attr_accessor :analytics_enabled + + sig { returns(T::Boolean) } + attr_accessor :is_private + + sig { returns(T.nilable(Integer)) } + attr_accessor :last_published + + sig { returns(String) } + attr_accessor :login_portal_uid + + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :publish_status + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :uid + + sig do + params( + access_groups: T.anything, + active_theme_id: String, + agent_enabled: T::Boolean, + analytics_enabled: T::Boolean, + is_private: T::Boolean, + last_published: T.nilable(Integer), + login_portal_uid: String, + name: String, + publish_status: String, + slug: String, + uid: String + ).returns(T.attached_class) + end + def self.new( + access_groups:, + active_theme_id:, + agent_enabled:, + analytics_enabled:, + is_private:, + last_published:, + login_portal_uid:, + name:, + publish_status:, + slug:, + uid: + ) + end + + sig do + override.returns( + { + access_groups: T.anything, + active_theme_id: String, + agent_enabled: T::Boolean, + analytics_enabled: T::Boolean, + is_private: T::Boolean, + last_published: T.nilable(Integer), + login_portal_uid: String, + name: String, + publish_status: String, + slug: String, + uid: String + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/github_project.rbi b/rbi/scalar_api_ruby/models/github_project.rbi new file mode 100644 index 0000000..505f9ae --- /dev/null +++ b/rbi/scalar_api_ruby/models/github_project.rbi @@ -0,0 +1,158 @@ +# typed: strong + +module Scalar + module Models + class GithubProject < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Scalar::GithubProject, Scalar::Internal::AnyHash) } + + sig { returns(T.anything) } + attr_accessor :access_groups + + sig { returns(T.nilable(Scalar::ActiveDeployment)) } + attr_reader :active_deployment + + sig do + params( + active_deployment: T.nilable(Scalar::ActiveDeployment::OrHash) + ).void + end + attr_writer :active_deployment + + sig { returns(String) } + attr_accessor :active_theme_id + + sig { returns(T::Boolean) } + attr_accessor :agent_enabled + + sig { returns(T::Boolean) } + attr_accessor :analytics_enabled + + sig { returns(Integer) } + attr_accessor :created_at + + sig { returns(T::Boolean) } + attr_accessor :is_private + + sig { returns(T.nilable(Integer)) } + attr_accessor :last_published + + sig { returns(T.nilable(String)) } + attr_accessor :last_published_uid + + sig { returns(String) } + attr_accessor :login_portal_uid + + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :publish_message + + sig { returns(String) } + attr_accessor :publish_status + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :uid + + sig { returns(Integer) } + attr_accessor :updated_at + + sig { returns(String) } + attr_accessor :user_info_hook_url + + sig { returns(T.nilable(Scalar::GithubProjectRepository)) } + attr_reader :repository + + sig do + params( + repository: T.nilable(Scalar::GithubProjectRepository::OrHash) + ).void + end + attr_writer :repository + + sig { returns(T.nilable(Float)) } + attr_reader :typesense_id + + sig { params(typesense_id: Float).void } + attr_writer :typesense_id + + sig do + params( + access_groups: T.anything, + active_deployment: T.nilable(Scalar::ActiveDeployment::OrHash), + active_theme_id: String, + agent_enabled: T::Boolean, + analytics_enabled: T::Boolean, + created_at: Integer, + is_private: T::Boolean, + last_published: T.nilable(Integer), + last_published_uid: T.nilable(String), + login_portal_uid: String, + name: String, + publish_message: String, + publish_status: String, + slug: String, + uid: String, + updated_at: Integer, + user_info_hook_url: String, + repository: T.nilable(Scalar::GithubProjectRepository::OrHash), + typesense_id: Float + ).returns(T.attached_class) + end + def self.new( + access_groups:, + active_deployment:, + active_theme_id:, + agent_enabled:, + analytics_enabled:, + created_at:, + is_private:, + last_published:, + last_published_uid:, + login_portal_uid:, + name:, + publish_message:, + publish_status:, + slug:, + uid:, + updated_at:, + user_info_hook_url:, + repository: nil, + typesense_id: nil + ) + end + + sig do + override.returns( + { + access_groups: T.anything, + active_deployment: T.nilable(Scalar::ActiveDeployment), + active_theme_id: String, + agent_enabled: T::Boolean, + analytics_enabled: T::Boolean, + created_at: Integer, + is_private: T::Boolean, + last_published: T.nilable(Integer), + last_published_uid: T.nilable(String), + login_portal_uid: String, + name: String, + publish_message: String, + publish_status: String, + slug: String, + uid: String, + updated_at: Integer, + user_info_hook_url: String, + repository: T.nilable(Scalar::GithubProjectRepository), + typesense_id: Float + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/github_project_repository.rbi b/rbi/scalar_api_ruby/models/github_project_repository.rbi new file mode 100644 index 0000000..d831007 --- /dev/null +++ b/rbi/scalar_api_ruby/models/github_project_repository.rbi @@ -0,0 +1,83 @@ +# typed: strong + +module Scalar + module Models + class GithubProjectRepository < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Scalar::GithubProjectRepository, Scalar::Internal::AnyHash) + end + + sig { returns(Float) } + attr_accessor :id + + sig { returns(String) } + attr_accessor :branch + + sig { returns(String) } + attr_accessor :config_path + + sig { returns(T::Boolean) } + attr_accessor :expired + + sig { returns(String) } + attr_accessor :linked_by + + sig { returns(String) } + attr_accessor :name + + sig { returns(T::Boolean) } + attr_accessor :pr_comments + + sig { returns(T::Boolean) } + attr_accessor :publish_on_merge + + sig { returns(T::Boolean) } + attr_accessor :publish_previews + + sig do + params( + id: Float, + branch: String, + config_path: String, + expired: T::Boolean, + linked_by: String, + name: String, + pr_comments: T::Boolean, + publish_on_merge: T::Boolean, + publish_previews: T::Boolean + ).returns(T.attached_class) + end + def self.new( + id:, + branch:, + config_path:, + expired:, + linked_by:, + name:, + pr_comments:, + publish_on_merge:, + publish_previews: + ) + end + + sig do + override.returns( + { + id: Float, + branch: String, + config_path: String, + expired: T::Boolean, + linked_by: String, + name: String, + pr_comments: T::Boolean, + publish_on_merge: T::Boolean, + publish_previews: T::Boolean + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/login_portal.rbi b/rbi/scalar_api_ruby/models/login_portal.rbi new file mode 100644 index 0000000..6c59ece --- /dev/null +++ b/rbi/scalar_api_ruby/models/login_portal.rbi @@ -0,0 +1,31 @@ +# typed: strong + +module Scalar + module Models + class LoginPortal < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Scalar::LoginPortal, Scalar::Internal::AnyHash) } + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :title + + sig { returns(String) } + attr_accessor :uid + + sig do + params(slug: String, title: String, uid: String).returns( + T.attached_class + ) + end + def self.new(slug:, title:, uid:) + end + + sig { override.returns({ slug: String, title: String, uid: String }) } + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/login_portal_list_response.rbi b/rbi/scalar_api_ruby/models/login_portal_list_response.rbi index e94edbc..a4928af 100644 --- a/rbi/scalar_api_ruby/models/login_portal_list_response.rbi +++ b/rbi/scalar_api_ruby/models/login_portal_list_response.rbi @@ -2,42 +2,9 @@ module Scalar module Models - class LoginPortalListResponseItem < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::LoginPortalListResponseItem, - Scalar::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :slug - - sig { returns(String) } - attr_accessor :title - - sig { returns(String) } - attr_accessor :uid - - sig do - params(slug: String, title: String, uid: String).returns( - T.attached_class - ) - end - def self.new(slug:, title:, uid:) - end - - sig { override.returns({ slug: String, title: String, uid: String }) } - def to_hash - end - end - LoginPortalListResponse = T.let( - Scalar::Internal::Type::ArrayOf[ - Scalar::Models::LoginPortalListResponseItem - ], + Scalar::Internal::Type::ArrayOf[Scalar::LoginPortal], Scalar::Internal::Type::Converter ) end diff --git a/rbi/scalar_api_ruby/models/managed_doc_version.rbi b/rbi/scalar_api_ruby/models/managed_doc_version.rbi index 316b3c2..81205f5 100644 --- a/rbi/scalar_api_ruby/models/managed_doc_version.rbi +++ b/rbi/scalar_api_ruby/models/managed_doc_version.rbi @@ -134,7 +134,7 @@ module Scalar end attr_accessor :enabled_tools - sig { returns(Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) } + sig { returns(Scalar::Method::TaggedSymbol) } attr_accessor :method_ sig { returns(String) } @@ -144,7 +144,7 @@ module Scalar params( enabled_tools: T::Array[Scalar::ManagedDocVersion::Tool::EnabledTool::OrSymbol], - method_: Scalar::ManagedDocVersion::Tool::Method::OrSymbol, + method_: Scalar::Method::OrSymbol, path: String ).returns(T.attached_class) end @@ -158,7 +158,7 @@ module Scalar T::Array[ Scalar::ManagedDocVersion::Tool::EnabledTool::TaggedSymbol ], - method_: Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol, + method_: Scalar::Method::TaggedSymbol, path: String } ) @@ -196,49 +196,6 @@ module Scalar def self.values end end - - module Method - extend Scalar::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Scalar::ManagedDocVersion::Tool::Method) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - DELETE = - T.let( - :delete, - Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol - ) - GET = - T.let(:get, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) - HEAD = - T.let(:head, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) - OPTIONS = - T.let( - :options, - Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol - ) - PATCH = - T.let(:patch, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) - POST = - T.let(:post, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) - PUT = - T.let(:put, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) - QUERY = - T.let(:query, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) - TRACE = - T.let(:trace, Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol) - - sig do - override.returns( - T::Array[Scalar::ManagedDocVersion::Tool::Method::TaggedSymbol] - ) - end - def self.values - end - end end end end diff --git a/rbi/scalar_api_ruby/models/managed_schema_version.rbi b/rbi/scalar_api_ruby/models/managed_schema_version.rbi new file mode 100644 index 0000000..3f8ba03 --- /dev/null +++ b/rbi/scalar_api_ruby/models/managed_schema_version.rbi @@ -0,0 +1,71 @@ +# typed: strong + +module Scalar + module Models + class ManagedSchemaVersion < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Scalar::ManagedSchemaVersion, Scalar::Internal::AnyHash) + end + + sig { returns(Integer) } + attr_accessor :created_at + + sig { returns(String) } + attr_accessor :uid + + sig { returns(Integer) } + attr_accessor :updated_at + + sig { returns(String) } + attr_accessor :version + + sig { returns(T.nilable(String)) } + attr_reader :json_sha + + sig { params(json_sha: String).void } + attr_writer :json_sha + + sig { returns(T.nilable(String)) } + attr_reader :yaml_sha + + sig { params(yaml_sha: String).void } + attr_writer :yaml_sha + + sig do + params( + created_at: Integer, + uid: String, + updated_at: Integer, + version: String, + json_sha: String, + yaml_sha: String + ).returns(T.attached_class) + end + def self.new( + created_at:, + uid:, + updated_at:, + version:, + json_sha: nil, + yaml_sha: nil + ) + end + + sig do + override.returns( + { + created_at: Integer, + uid: String, + updated_at: Integer, + version: String, + json_sha: String, + yaml_sha: String + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/mcp_installation.rbi b/rbi/scalar_api_ruby/models/mcp/mcp_installation.rbi new file mode 100644 index 0000000..bb97dd8 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/mcp_installation.rbi @@ -0,0 +1,93 @@ +# typed: strong + +module Scalar + module Models + McpInstallation = Mcp::McpInstallation + + module Mcp + class McpInstallation < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Scalar::Mcp::McpInstallation, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :id + + sig { returns(T::Array[String]) } + attr_accessor :access_groups + + sig { returns(T::Boolean) } + attr_accessor :credential_redaction_enabled + + sig { returns(T::Boolean) } + attr_accessor :is_private + + sig { returns(T.nilable(String)) } + attr_accessor :login_portal_uid + + sig { returns(String) } + attr_accessor :mcp_server_id + + sig { returns(T.nilable(String)) } + attr_accessor :mcp_version + + sig { returns(String) } + attr_accessor :name + + sig { returns(T::Boolean) } + attr_accessor :pii_redaction_enabled + + sig { returns(String) } + attr_accessor :slug + + sig do + params( + id: String, + access_groups: T::Array[String], + credential_redaction_enabled: T::Boolean, + is_private: T::Boolean, + login_portal_uid: T.nilable(String), + mcp_server_id: String, + mcp_version: T.nilable(String), + name: String, + pii_redaction_enabled: T::Boolean, + slug: String + ).returns(T.attached_class) + end + def self.new( + id:, + access_groups:, + credential_redaction_enabled:, + is_private:, + login_portal_uid:, + mcp_server_id:, + mcp_version:, + name:, + pii_redaction_enabled:, + slug: + ) + end + + sig do + override.returns( + { + id: String, + access_groups: T::Array[String], + credential_redaction_enabled: T::Boolean, + is_private: T::Boolean, + login_portal_uid: T.nilable(String), + mcp_server_id: String, + mcp_version: T.nilable(String), + name: String, + pii_redaction_enabled: T::Boolean, + slug: String + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/mcp_server.rbi b/rbi/scalar_api_ruby/models/mcp/mcp_server.rbi new file mode 100644 index 0000000..5116191 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/mcp_server.rbi @@ -0,0 +1,69 @@ +# typed: strong + +module Scalar + module Models + McpServer = Mcp::McpServer + + module Mcp + class McpServer < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Scalar::Mcp::McpServer, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :id + + sig { returns(T::Boolean) } + attr_accessor :auto_add_operations + + sig { returns(String) } + attr_accessor :created_at + + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :updated_at + + sig do + params( + id: String, + auto_add_operations: T::Boolean, + created_at: String, + name: String, + slug: String, + updated_at: String + ).returns(T.attached_class) + end + def self.new( + id:, + auto_add_operations:, + created_at:, + name:, + slug:, + updated_at: + ) + end + + sig do + override.returns( + { + id: String, + auto_add_operations: T::Boolean, + created_at: String, + name: String, + slug: String, + updated_at: String + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/server_create_params.rbi b/rbi/scalar_api_ruby/models/mcp/server_create_params.rbi new file mode 100644 index 0000000..05d70b5 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/server_create_params.rbi @@ -0,0 +1,70 @@ +# typed: strong + +module Scalar + module Models + module Mcp + class ServerCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Mcp::ServerCreateParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :project_uids + + sig { params(project_uids: T::Array[String]).void } + attr_writer :project_uids + + sig { returns(T.nilable(String)) } + attr_reader :slug + + sig { params(slug: String).void } + attr_writer :slug + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :version_uids + + sig { params(version_uids: T::Array[String]).void } + attr_writer :version_uids + + sig do + params( + name: String, + project_uids: T::Array[String], + slug: String, + version_uids: T::Array[String], + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + name:, + project_uids: nil, + slug: nil, + version_uids: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + name: String, + project_uids: T::Array[String], + slug: String, + version_uids: T::Array[String], + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/server_create_response.rbi b/rbi/scalar_api_ruby/models/mcp/server_create_response.rbi new file mode 100644 index 0000000..c490a24 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/server_create_response.rbi @@ -0,0 +1,49 @@ +# typed: strong + +module Scalar + module Models + module Mcp + class ServerCreateResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::Mcp::ServerCreateResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(Scalar::Mcp::McpInstallation) } + attr_reader :installation + + sig { params(installation: Scalar::Mcp::McpInstallation::OrHash).void } + attr_writer :installation + + sig { returns(Scalar::Mcp::McpServer) } + attr_reader :server + + sig { params(server: Scalar::Mcp::McpServer::OrHash).void } + attr_writer :server + + sig do + params( + installation: Scalar::Mcp::McpInstallation::OrHash, + server: Scalar::Mcp::McpServer::OrHash + ).returns(T.attached_class) + end + def self.new(installation:, server:) + end + + sig do + override.returns( + { + installation: Scalar::Mcp::McpInstallation, + server: Scalar::Mcp::McpServer + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/server_delete_params.rbi b/rbi/scalar_api_ruby/models/mcp/server_delete_params.rbi new file mode 100644 index 0000000..44c2cae --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/server_delete_params.rbi @@ -0,0 +1,37 @@ +# typed: strong + +module Scalar + module Models + module Mcp + class ServerDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Mcp::ServerDeleteParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(id:, request_options: {}) + end + + sig do + override.returns( + { id: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/server_list_params.rbi b/rbi/scalar_api_ruby/models/mcp/server_list_params.rbi new file mode 100644 index 0000000..457ef20 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/server_list_params.rbi @@ -0,0 +1,29 @@ +# typed: strong + +module Scalar + module Models + module Mcp + class ServerListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Mcp::ServerListParams, Scalar::Internal::AnyHash) + end + + sig do + params(request_options: Scalar::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Scalar::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/server_list_response.rbi b/rbi/scalar_api_ruby/models/mcp/server_list_response.rbi new file mode 100644 index 0000000..4f87fa6 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/server_list_response.rbi @@ -0,0 +1,13 @@ +# typed: strong + +module Scalar + module Models + module Mcp + ServerListResponse = + T.let( + Scalar::Internal::Type::ArrayOf[Scalar::Mcp::McpServer], + Scalar::Internal::Type::Converter + ) + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/server_retrieve_params.rbi b/rbi/scalar_api_ruby/models/mcp/server_retrieve_params.rbi new file mode 100644 index 0000000..6714648 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/server_retrieve_params.rbi @@ -0,0 +1,37 @@ +# typed: strong + +module Scalar + module Models + module Mcp + class ServerRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Mcp::ServerRetrieveParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(id:, request_options: {}) + end + + sig do + override.returns( + { id: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/server_update_params.rbi b/rbi/scalar_api_ruby/models/mcp/server_update_params.rbi new file mode 100644 index 0000000..5cc8881 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/server_update_params.rbi @@ -0,0 +1,88 @@ +# typed: strong + +module Scalar + module Models + module Mcp + class ServerUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Mcp::ServerUpdateParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :id + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :auto_add_operations + + sig { params(auto_add_operations: T::Boolean).void } + attr_writer :auto_add_operations + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :docs_pages + + sig { params(docs_pages: T::Array[String]).void } + attr_writer :docs_pages + + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :operations + + sig { params(operations: T::Array[String]).void } + attr_writer :operations + + sig { returns(T.nilable(String)) } + attr_reader :slug + + sig { params(slug: String).void } + attr_writer :slug + + sig do + params( + id: String, + auto_add_operations: T::Boolean, + docs_pages: T::Array[String], + name: String, + operations: T::Array[String], + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + id:, + auto_add_operations: nil, + docs_pages: nil, + name: nil, + operations: nil, + slug: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + id: String, + auto_add_operations: T::Boolean, + docs_pages: T::Array[String], + name: String, + operations: T::Array[String], + slug: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rbi b/rbi/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rbi new file mode 100644 index 0000000..585ce88 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rbi @@ -0,0 +1,60 @@ +# typed: strong + +module Scalar + module Models + module Mcp + module Servers + class InstallationCreateAccessGroupParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::Mcp::Servers::InstallationCreateAccessGroupParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :id + + sig { returns(String) } + attr_accessor :installation_id + + sig { returns(String) } + attr_accessor :access_group_uid + + sig do + params( + id: String, + installation_id: String, + access_group_uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + id:, + installation_id:, + access_group_uid:, + request_options: {} + ) + end + + sig do + override.returns( + { + id: String, + installation_id: String, + access_group_uid: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/servers/installation_create_params.rbi b/rbi/scalar_api_ruby/models/mcp/servers/installation_create_params.rbi new file mode 100644 index 0000000..1175dd1 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/servers/installation_create_params.rbi @@ -0,0 +1,69 @@ +# typed: strong + +module Scalar + module Models + module Mcp + module Servers + class InstallationCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::Mcp::Servers::InstallationCreateParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :id + + sig { returns(T::Hash[Symbol, T.anything]) } + attr_accessor :document_auth + + sig { returns(String) } + attr_accessor :name + + sig { returns(T.nilable(String)) } + attr_reader :slug + + sig { params(slug: String).void } + attr_writer :slug + + sig do + params( + id: String, + document_auth: T::Hash[Symbol, T.anything], + name: String, + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + id:, + document_auth:, + name:, + slug: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + id: String, + document_auth: T::Hash[Symbol, T.anything], + name: String, + slug: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rbi b/rbi/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rbi new file mode 100644 index 0000000..b5d359b --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rbi @@ -0,0 +1,60 @@ +# typed: strong + +module Scalar + module Models + module Mcp + module Servers + class InstallationDeleteAccessGroupParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::Mcp::Servers::InstallationDeleteAccessGroupParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :id + + sig { returns(String) } + attr_accessor :installation_id + + sig { returns(String) } + attr_accessor :access_group_uid + + sig do + params( + id: String, + installation_id: String, + access_group_uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + id:, + installation_id:, + access_group_uid:, + request_options: {} + ) + end + + sig do + override.returns( + { + id: String, + installation_id: String, + access_group_uid: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/servers/installation_delete_params.rbi b/rbi/scalar_api_ruby/models/mcp/servers/installation_delete_params.rbi new file mode 100644 index 0000000..c440c56 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/servers/installation_delete_params.rbi @@ -0,0 +1,50 @@ +# typed: strong + +module Scalar + module Models + module Mcp + module Servers + class InstallationDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::Mcp::Servers::InstallationDeleteParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :id + + sig { returns(String) } + attr_accessor :installation_id + + sig do + params( + id: String, + installation_id: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(id:, installation_id:, request_options: {}) + end + + sig do + override.returns( + { + id: String, + installation_id: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/servers/installation_list_params.rbi b/rbi/scalar_api_ruby/models/mcp/servers/installation_list_params.rbi new file mode 100644 index 0000000..7580c43 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/servers/installation_list_params.rbi @@ -0,0 +1,42 @@ +# typed: strong + +module Scalar + module Models + module Mcp + module Servers + class InstallationListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::Mcp::Servers::InstallationListParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(id:, request_options: {}) + end + + sig do + override.returns( + { id: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/servers/installation_list_response.rbi b/rbi/scalar_api_ruby/models/mcp/servers/installation_list_response.rbi new file mode 100644 index 0000000..cc5034b --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/servers/installation_list_response.rbi @@ -0,0 +1,17 @@ +# typed: strong + +module Scalar + module Models + module Mcp + module Servers + InstallationListResponse = + T.let( + Scalar::Internal::Type::ArrayOf[ + Scalar::Mcp::Servers::McpInstallationListItem + ], + Scalar::Internal::Type::Converter + ) + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rbi b/rbi/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rbi new file mode 100644 index 0000000..81226bc --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rbi @@ -0,0 +1,50 @@ +# typed: strong + +module Scalar + module Models + module Mcp + module Servers + class InstallationRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::Mcp::Servers::InstallationRetrieveParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :id + + sig { returns(String) } + attr_accessor :installation_id + + sig do + params( + id: String, + installation_id: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(id:, installation_id:, request_options: {}) + end + + sig do + override.returns( + { + id: String, + installation_id: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/servers/installation_update_params.rbi b/rbi/scalar_api_ruby/models/mcp/servers/installation_update_params.rbi new file mode 100644 index 0000000..d1dda97 --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/servers/installation_update_params.rbi @@ -0,0 +1,102 @@ +# typed: strong + +module Scalar + module Models + module Mcp + module Servers + class InstallationUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::Mcp::Servers::InstallationUpdateParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :id + + sig { returns(String) } + attr_accessor :installation_id + + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + attr_reader :document_auth + + sig { params(document_auth: T::Hash[Symbol, T.anything]).void } + attr_writer :document_auth + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private + + sig { params(is_private: T::Boolean).void } + attr_writer :is_private + + sig { returns(T.nilable(String)) } + attr_accessor :login_portal_uid + + sig { returns(T.nilable(String)) } + attr_accessor :mcp_version + + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + sig { returns(T.nilable(String)) } + attr_reader :slug + + sig { params(slug: String).void } + attr_writer :slug + + sig do + params( + id: String, + installation_id: String, + document_auth: T::Hash[Symbol, T.anything], + is_private: T::Boolean, + login_portal_uid: T.nilable(String), + mcp_version: T.nilable(String), + name: String, + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + id:, + installation_id:, + document_auth: nil, + is_private: nil, + login_portal_uid: nil, + mcp_version: nil, + name: nil, + slug: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + id: String, + installation_id: String, + document_auth: T::Hash[Symbol, T.anything], + is_private: T::Boolean, + login_portal_uid: T.nilable(String), + mcp_version: T.nilable(String), + name: String, + slug: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rbi b/rbi/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rbi new file mode 100644 index 0000000..d487dec --- /dev/null +++ b/rbi/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rbi @@ -0,0 +1,60 @@ +# typed: strong + +module Scalar + module Models + module Mcp + module Servers + class McpInstallationListItem < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Mcp::Servers::McpInstallationListItem, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :id + + sig { returns(T::Boolean) } + attr_accessor :is_private + + sig { returns(T.nilable(String)) } + attr_accessor :mcp_version + + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :slug + + sig do + params( + id: String, + is_private: T::Boolean, + mcp_version: T.nilable(String), + name: String, + slug: String + ).returns(T.attached_class) + end + def self.new(id:, is_private:, mcp_version:, name:, slug:) + end + + sig do + override.returns( + { + id: String, + is_private: T::Boolean, + mcp_version: T.nilable(String), + name: String, + slug: String + } + ) + end + def to_hash + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/method.rbi b/rbi/scalar_api_ruby/models/method.rbi new file mode 100644 index 0000000..f20000a --- /dev/null +++ b/rbi/scalar_api_ruby/models/method.rbi @@ -0,0 +1,26 @@ +# typed: strong + +module Scalar + module Models + module Method + extend Scalar::Internal::Type::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, Scalar::Method) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + DELETE = T.let(:delete, Scalar::Method::TaggedSymbol) + GET = T.let(:get, Scalar::Method::TaggedSymbol) + HEAD = T.let(:head, Scalar::Method::TaggedSymbol) + OPTIONS = T.let(:options, Scalar::Method::TaggedSymbol) + PATCH = T.let(:patch, Scalar::Method::TaggedSymbol) + POST = T.let(:post, Scalar::Method::TaggedSymbol) + PUT = T.let(:put, Scalar::Method::TaggedSymbol) + QUERY = T.let(:query, Scalar::Method::TaggedSymbol) + TRACE = T.let(:trace, Scalar::Method::TaggedSymbol) + + sig { override.returns(T::Array[Scalar::Method::TaggedSymbol]) } + def self.values + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbi b/rbi/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbi new file mode 100644 index 0000000..51fee2b --- /dev/null +++ b/rbi/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbi @@ -0,0 +1,30 @@ +# typed: strong + +module Scalar + module Models + class OAuthOauthAuthorizationServerMetadataParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::OAuthOauthAuthorizationServerMetadataParams, + Scalar::Internal::AnyHash + ) + end + + sig do + params(request_options: Scalar::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Scalar::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbi b/rbi/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbi new file mode 100644 index 0000000..326fdd0 --- /dev/null +++ b/rbi/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Scalar + module Models + class OAuthOauthAuthorizeParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::OAuthOauthAuthorizeParams, Scalar::Internal::AnyHash) + end + + sig do + params(request_options: Scalar::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Scalar::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbi b/rbi/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbi new file mode 100644 index 0000000..658d80a --- /dev/null +++ b/rbi/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbi @@ -0,0 +1,68 @@ +# typed: strong + +module Scalar + module Models + class OAuthOauthRevokeParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::OAuthOauthRevokeParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :token + + sig { returns(T.nilable(String)) } + attr_reader :client_id + + sig { params(client_id: String).void } + attr_writer :client_id + + sig { returns(T.nilable(String)) } + attr_reader :client_secret + + sig { params(client_secret: String).void } + attr_writer :client_secret + + sig { returns(T.nilable(String)) } + attr_reader :token_type_hint + + sig { params(token_type_hint: String).void } + attr_writer :token_type_hint + + sig do + params( + token: String, + client_id: String, + client_secret: String, + token_type_hint: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + token:, + client_id: nil, + client_secret: nil, + token_type_hint: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + token: String, + client_id: String, + client_secret: String, + token_type_hint: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/o_auth_oauth_token_params.rbi b/rbi/scalar_api_ruby/models/o_auth_oauth_token_params.rbi new file mode 100644 index 0000000..26f1e52 --- /dev/null +++ b/rbi/scalar_api_ruby/models/o_auth_oauth_token_params.rbi @@ -0,0 +1,104 @@ +# typed: strong + +module Scalar + module Models + class OAuthOauthTokenParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::OAuthOauthTokenParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :grant_type + + sig { returns(T.nilable(String)) } + attr_reader :client_id + + sig { params(client_id: String).void } + attr_writer :client_id + + sig { returns(T.nilable(String)) } + attr_reader :client_secret + + sig { params(client_secret: String).void } + attr_writer :client_secret + + sig { returns(T.nilable(String)) } + attr_reader :code + + sig { params(code: String).void } + attr_writer :code + + sig { returns(T.nilable(String)) } + attr_reader :code_verifier + + sig { params(code_verifier: String).void } + attr_writer :code_verifier + + sig { returns(T.nilable(String)) } + attr_reader :redirect_uri + + sig { params(redirect_uri: String).void } + attr_writer :redirect_uri + + sig { returns(T.nilable(String)) } + attr_reader :refresh_token + + sig { params(refresh_token: String).void } + attr_writer :refresh_token + + sig { returns(T.nilable(String)) } + attr_reader :scope + + sig { params(scope: String).void } + attr_writer :scope + + sig do + params( + grant_type: String, + client_id: String, + client_secret: String, + code: String, + code_verifier: String, + redirect_uri: String, + refresh_token: String, + scope: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + grant_type:, + client_id: nil, + client_secret: nil, + code: nil, + code_verifier: nil, + redirect_uri: nil, + refresh_token: nil, + scope: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + grant_type: String, + client_id: String, + client_secret: String, + code: String, + code_verifier: String, + redirect_uri: String, + refresh_token: String, + scope: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/o_auth_oauth_token_response.rbi b/rbi/scalar_api_ruby/models/o_auth_oauth_token_response.rbi new file mode 100644 index 0000000..f1ac7f0 --- /dev/null +++ b/rbi/scalar_api_ruby/models/o_auth_oauth_token_response.rbi @@ -0,0 +1,19 @@ +# typed: strong + +module Scalar + module Models + module OAuthOauthTokenResponse + extend Scalar::Internal::Type::Union + + Variants = T.type_alias { T.any(Scalar::OauthToken, Scalar::OauthError) } + + sig do + override.returns( + T::Array[Scalar::Models::OAuthOauthTokenResponse::Variants] + ) + end + def self.variants + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/oauth_authorization_server_metadata.rbi b/rbi/scalar_api_ruby/models/oauth_authorization_server_metadata.rbi new file mode 100644 index 0000000..da49b6c --- /dev/null +++ b/rbi/scalar_api_ruby/models/oauth_authorization_server_metadata.rbi @@ -0,0 +1,92 @@ +# typed: strong + +module Scalar + module Models + class OauthAuthorizationServerMetadata < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::OauthAuthorizationServerMetadata, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :authorization_endpoint + + sig { returns(T::Array[String]) } + attr_accessor :code_challenge_methods_supported + + sig { returns(T::Array[String]) } + attr_accessor :grant_types_supported + + sig { returns(String) } + attr_accessor :issuer + + sig { returns(T::Array[String]) } + attr_accessor :response_types_supported + + sig { returns(String) } + attr_accessor :revocation_endpoint + + sig { returns(T::Array[String]) } + attr_accessor :revocation_endpoint_auth_methods_supported + + sig { returns(T::Array[String]) } + attr_accessor :scopes_supported + + sig { returns(String) } + attr_accessor :token_endpoint + + sig { returns(T::Array[String]) } + attr_accessor :token_endpoint_auth_methods_supported + + sig do + params( + authorization_endpoint: String, + code_challenge_methods_supported: T::Array[String], + grant_types_supported: T::Array[String], + issuer: String, + response_types_supported: T::Array[String], + revocation_endpoint: String, + revocation_endpoint_auth_methods_supported: T::Array[String], + scopes_supported: T::Array[String], + token_endpoint: String, + token_endpoint_auth_methods_supported: T::Array[String] + ).returns(T.attached_class) + end + def self.new( + authorization_endpoint:, + code_challenge_methods_supported:, + grant_types_supported:, + issuer:, + response_types_supported:, + revocation_endpoint:, + revocation_endpoint_auth_methods_supported:, + scopes_supported:, + token_endpoint:, + token_endpoint_auth_methods_supported: + ) + end + + sig do + override.returns( + { + authorization_endpoint: String, + code_challenge_methods_supported: T::Array[String], + grant_types_supported: T::Array[String], + issuer: String, + response_types_supported: T::Array[String], + revocation_endpoint: String, + revocation_endpoint_auth_methods_supported: T::Array[String], + scopes_supported: T::Array[String], + token_endpoint: String, + token_endpoint_auth_methods_supported: T::Array[String] + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/oauth_error.rbi b/rbi/scalar_api_ruby/models/oauth_error.rbi new file mode 100644 index 0000000..3d32fec --- /dev/null +++ b/rbi/scalar_api_ruby/models/oauth_error.rbi @@ -0,0 +1,31 @@ +# typed: strong + +module Scalar + module Models + class OauthError < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Scalar::OauthError, Scalar::Internal::AnyHash) } + + sig { returns(String) } + attr_accessor :error + + sig { returns(T.nilable(String)) } + attr_reader :error_description + + sig { params(error_description: String).void } + attr_writer :error_description + + sig do + params(error: String, error_description: String).returns( + T.attached_class + ) + end + def self.new(error:, error_description: nil) + end + + sig { override.returns({ error: String, error_description: String }) } + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/oauth_scope.rbi b/rbi/scalar_api_ruby/models/oauth_scope.rbi new file mode 100644 index 0000000..355128e --- /dev/null +++ b/rbi/scalar_api_ruby/models/oauth_scope.rbi @@ -0,0 +1,20 @@ +# typed: strong + +module Scalar + module Models + module OauthScope + extend Scalar::Internal::Type::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, Scalar::OauthScope) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + READ = T.let(:read, Scalar::OauthScope::TaggedSymbol) + WRITE = T.let(:write, Scalar::OauthScope::TaggedSymbol) + ADMIN = T.let(:admin, Scalar::OauthScope::TaggedSymbol) + + sig { override.returns(T::Array[Scalar::OauthScope::TaggedSymbol]) } + def self.values + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/oauth_token.rbi b/rbi/scalar_api_ruby/models/oauth_token.rbi new file mode 100644 index 0000000..bf08871 --- /dev/null +++ b/rbi/scalar_api_ruby/models/oauth_token.rbi @@ -0,0 +1,57 @@ +# typed: strong + +module Scalar + module Models + class OauthToken < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Scalar::OauthToken, Scalar::Internal::AnyHash) } + + sig { returns(String) } + attr_accessor :access_token + + sig { returns(Integer) } + attr_accessor :expires_in + + sig { returns(String) } + attr_accessor :refresh_token + + sig { returns(Scalar::OauthScope::TaggedSymbol) } + attr_accessor :scope + + sig { returns(Symbol) } + attr_accessor :token_type + + sig do + params( + access_token: String, + expires_in: Integer, + refresh_token: String, + scope: Scalar::OauthScope::OrSymbol, + token_type: Symbol + ).returns(T.attached_class) + end + def self.new( + access_token:, + expires_in:, + refresh_token:, + scope:, + token_type: :Bearer + ) + end + + sig do + override.returns( + { + access_token: String, + expires_in: Integer, + refresh_token: String, + scope: Scalar::OauthScope::TaggedSymbol, + token_type: Symbol + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/registry_list_all_api_documents_response.rbi b/rbi/scalar_api_ruby/models/registry_list_all_api_documents_response.rbi index 7e740b2..41132c0 100644 --- a/rbi/scalar_api_ruby/models/registry_list_all_api_documents_response.rbi +++ b/rbi/scalar_api_ruby/models/registry_list_all_api_documents_response.rbi @@ -2,92 +2,9 @@ module Scalar module Models - class RegistryListAllAPIDocumentsResponseItem < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::RegistryListAllAPIDocumentsResponseItem, - Scalar::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :description - - sig { returns(T::Boolean) } - attr_accessor :is_private - - sig { returns(String) } - attr_accessor :namespace - - sig { returns(String) } - attr_accessor :slug - - sig { returns(T.anything) } - attr_accessor :tags - - sig { returns(String) } - attr_accessor :title - - sig { returns(String) } - attr_accessor :uid - - sig { returns(String) } - attr_accessor :version - - sig { returns(T::Array[Scalar::ManagedDocVersion]) } - attr_accessor :versions - - sig do - params( - description: String, - is_private: T::Boolean, - namespace: String, - slug: String, - tags: T.anything, - title: String, - uid: String, - version: String, - versions: T::Array[Scalar::ManagedDocVersion::OrHash] - ).returns(T.attached_class) - end - def self.new( - description:, - is_private:, - namespace:, - slug:, - tags:, - title:, - uid:, - version:, - versions: - ) - end - - sig do - override.returns( - { - description: String, - is_private: T::Boolean, - namespace: String, - slug: String, - tags: T.anything, - title: String, - uid: String, - version: String, - versions: T::Array[Scalar::ManagedDocVersion] - } - ) - end - def to_hash - end - end - RegistryListAllAPIDocumentsResponse = T.let( - Scalar::Internal::Type::ArrayOf[ - Scalar::Models::RegistryListAllAPIDocumentsResponseItem - ], + Scalar::Internal::Type::ArrayOf[Scalar::APIDocument], Scalar::Internal::Type::Converter ) end diff --git a/rbi/scalar_api_ruby/models/registry_list_api_documents_response.rbi b/rbi/scalar_api_ruby/models/registry_list_api_documents_response.rbi index 9bfc66b..c85e40b 100644 --- a/rbi/scalar_api_ruby/models/registry_list_api_documents_response.rbi +++ b/rbi/scalar_api_ruby/models/registry_list_api_documents_response.rbi @@ -2,92 +2,9 @@ module Scalar module Models - class RegistryListAPIDocumentsResponseItem < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::RegistryListAPIDocumentsResponseItem, - Scalar::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :description - - sig { returns(T::Boolean) } - attr_accessor :is_private - - sig { returns(String) } - attr_accessor :namespace - - sig { returns(String) } - attr_accessor :slug - - sig { returns(T.anything) } - attr_accessor :tags - - sig { returns(String) } - attr_accessor :title - - sig { returns(String) } - attr_accessor :uid - - sig { returns(String) } - attr_accessor :version - - sig { returns(T::Array[Scalar::ManagedDocVersion]) } - attr_accessor :versions - - sig do - params( - description: String, - is_private: T::Boolean, - namespace: String, - slug: String, - tags: T.anything, - title: String, - uid: String, - version: String, - versions: T::Array[Scalar::ManagedDocVersion::OrHash] - ).returns(T.attached_class) - end - def self.new( - description:, - is_private:, - namespace:, - slug:, - tags:, - title:, - uid:, - version:, - versions: - ) - end - - sig do - override.returns( - { - description: String, - is_private: T::Boolean, - namespace: String, - slug: String, - tags: T.anything, - title: String, - uid: String, - version: String, - versions: T::Array[Scalar::ManagedDocVersion] - } - ) - end - def to_hash - end - end - RegistryListAPIDocumentsResponse = T.let( - Scalar::Internal::Type::ArrayOf[ - Scalar::Models::RegistryListAPIDocumentsResponseItem - ], + Scalar::Internal::Type::ArrayOf[Scalar::APIDocument], Scalar::Internal::Type::Converter ) end diff --git a/rbi/scalar_api_ruby/models/rule.rbi b/rbi/scalar_api_ruby/models/rule.rbi new file mode 100644 index 0000000..059f007 --- /dev/null +++ b/rbi/scalar_api_ruby/models/rule.rbi @@ -0,0 +1,55 @@ +# typed: strong + +module Scalar + module Models + class Rule < Scalar::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(Scalar::Rule, Scalar::Internal::AnyHash) } + + sig { returns(String) } + attr_accessor :description + + sig { returns(T::Boolean) } + attr_accessor :is_private + + sig { returns(String) } + attr_accessor :namespace + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :title + + sig { returns(String) } + attr_accessor :uid + + sig do + params( + description: String, + is_private: T::Boolean, + namespace: String, + slug: String, + title: String, + uid: String + ).returns(T.attached_class) + end + def self.new(description:, is_private:, namespace:, slug:, title:, uid:) + end + + sig do + override.returns( + { + description: String, + is_private: T::Boolean, + namespace: String, + slug: String, + title: String, + uid: String + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/rule_list_rulesets_response.rbi b/rbi/scalar_api_ruby/models/rule_list_rulesets_response.rbi index 6debc40..6f3100b 100644 --- a/rbi/scalar_api_ruby/models/rule_list_rulesets_response.rbi +++ b/rbi/scalar_api_ruby/models/rule_list_rulesets_response.rbi @@ -2,67 +2,9 @@ module Scalar module Models - class RuleListRulesetsResponseItem < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::RuleListRulesetsResponseItem, - Scalar::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :description - - sig { returns(T::Boolean) } - attr_accessor :is_private - - sig { returns(String) } - attr_accessor :namespace - - sig { returns(String) } - attr_accessor :slug - - sig { returns(String) } - attr_accessor :title - - sig { returns(String) } - attr_accessor :uid - - sig do - params( - description: String, - is_private: T::Boolean, - namespace: String, - slug: String, - title: String, - uid: String - ).returns(T.attached_class) - end - def self.new(description:, is_private:, namespace:, slug:, title:, uid:) - end - - sig do - override.returns( - { - description: String, - is_private: T::Boolean, - namespace: String, - slug: String, - title: String, - uid: String - } - ) - end - def to_hash - end - end - RuleListRulesetsResponse = T.let( - Scalar::Internal::Type::ArrayOf[ - Scalar::Models::RuleListRulesetsResponseItem - ], + Scalar::Internal::Type::ArrayOf[Scalar::Rule], Scalar::Internal::Type::Converter ) end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_create_project_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_create_project_params.rbi new file mode 100644 index 0000000..95f5deb --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_create_project_params.rbi @@ -0,0 +1,206 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocCreateProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::ScalarDocCreateProjectParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :name + + sig { returns(Scalar::ScalarDocCreateProjectParams::Provider::OrSymbol) } + attr_accessor :provider + + sig do + returns( + T.nilable(Scalar::ScalarDocCreateProjectParams::BitbucketRepository) + ) + end + attr_reader :bitbucket_repository + + sig do + params( + bitbucket_repository: + Scalar::ScalarDocCreateProjectParams::BitbucketRepository::OrHash + ).void + end + attr_writer :bitbucket_repository + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :blank + + sig { params(blank: T::Boolean).void } + attr_writer :blank + + sig do + returns( + T.nilable(Scalar::ScalarDocCreateProjectParams::GithubRepository) + ) + end + attr_reader :github_repository + + sig do + params( + github_repository: + Scalar::ScalarDocCreateProjectParams::GithubRepository::OrHash + ).void + end + attr_writer :github_repository + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private + + sig { params(is_private: T::Boolean).void } + attr_writer :is_private + + sig { returns(T.nilable(String)) } + attr_reader :slug + + sig { params(slug: String).void } + attr_writer :slug + + sig do + params( + name: String, + provider: Scalar::ScalarDocCreateProjectParams::Provider::OrSymbol, + bitbucket_repository: + Scalar::ScalarDocCreateProjectParams::BitbucketRepository::OrHash, + blank: T::Boolean, + github_repository: + Scalar::ScalarDocCreateProjectParams::GithubRepository::OrHash, + is_private: T::Boolean, + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + name:, + provider:, + bitbucket_repository: nil, + blank: nil, + github_repository: nil, + is_private: nil, + slug: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + name: String, + provider: Scalar::ScalarDocCreateProjectParams::Provider::OrSymbol, + bitbucket_repository: + Scalar::ScalarDocCreateProjectParams::BitbucketRepository, + blank: T::Boolean, + github_repository: + Scalar::ScalarDocCreateProjectParams::GithubRepository, + is_private: T::Boolean, + slug: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + + module Provider + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Scalar::ScalarDocCreateProjectParams::Provider) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FORGEJO = + T.let( + :forgejo, + Scalar::ScalarDocCreateProjectParams::Provider::TaggedSymbol + ) + GITHUB = + T.let( + :github, + Scalar::ScalarDocCreateProjectParams::Provider::TaggedSymbol + ) + BITBUCKET = + T.let( + :bitbucket, + Scalar::ScalarDocCreateProjectParams::Provider::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Scalar::ScalarDocCreateProjectParams::Provider::TaggedSymbol + ] + ) + end + def self.values + end + end + + class BitbucketRepository < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::ScalarDocCreateProjectParams::BitbucketRepository, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :repo_uuid + + sig { returns(String) } + attr_accessor :workspace_uuid + + sig do + params(repo_uuid: String, workspace_uuid: String).returns( + T.attached_class + ) + end + def self.new(repo_uuid:, workspace_uuid:) + end + + sig { override.returns({ repo_uuid: String, workspace_uuid: String }) } + def to_hash + end + end + + class GithubRepository < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::ScalarDocCreateProjectParams::GithubRepository, + Scalar::Internal::AnyHash + ) + end + + sig { returns(Integer) } + attr_accessor :installation_id + + sig { returns(Integer) } + attr_accessor :repo_id + + sig do + params(installation_id: Integer, repo_id: Integer).returns( + T.attached_class + ) + end + def self.new(installation_id:, repo_id:) + end + + sig { override.returns({ installation_id: Integer, repo_id: Integer }) } + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_delete_project_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_delete_project_params.rbi new file mode 100644 index 0000000..8be45a8 --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_delete_project_params.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocDeleteProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::ScalarDocDeleteProjectParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :slug + + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(slug:, request_options: {}) + end + + sig do + override.returns( + { slug: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_list_guides_response.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_guides_response.rbi index be945d6..4452f2c 100644 --- a/rbi/scalar_api_ruby/models/scalar_doc_list_guides_response.rbi +++ b/rbi/scalar_api_ruby/models/scalar_doc_list_guides_response.rbi @@ -2,313 +2,9 @@ module Scalar module Models - class ScalarDocListGuidesResponseItem < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::ScalarDocListGuidesResponseItem, - Scalar::Internal::AnyHash - ) - end - - sig { returns(T.anything) } - attr_accessor :access_groups - - sig do - returns( - T.nilable( - Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment - ) - ) - end - attr_reader :active_deployment - - sig do - params( - active_deployment: - T.nilable( - Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment::OrHash - ) - ).void - end - attr_writer :active_deployment - - sig { returns(String) } - attr_accessor :active_theme_id - - sig { returns(T::Boolean) } - attr_accessor :agent_enabled - - sig { returns(T::Boolean) } - attr_accessor :analytics_enabled - - sig { returns(Integer) } - attr_accessor :created_at - - sig { returns(T::Boolean) } - attr_accessor :is_private - - sig { returns(T.nilable(Integer)) } - attr_accessor :last_published - - sig { returns(T.nilable(String)) } - attr_accessor :last_published_uid - - sig { returns(String) } - attr_accessor :login_portal_uid - - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :publish_message - - sig { returns(String) } - attr_accessor :publish_status - - sig { returns(String) } - attr_accessor :slug - - sig { returns(String) } - attr_accessor :uid - - sig { returns(Integer) } - attr_accessor :updated_at - - sig { returns(String) } - attr_accessor :user_info_hook_url - - sig do - returns( - T.nilable(Scalar::Models::ScalarDocListGuidesResponseItem::Repository) - ) - end - attr_reader :repository - - sig do - params( - repository: - T.nilable( - Scalar::Models::ScalarDocListGuidesResponseItem::Repository::OrHash - ) - ).void - end - attr_writer :repository - - sig { returns(T.nilable(Float)) } - attr_reader :typesense_id - - sig { params(typesense_id: Float).void } - attr_writer :typesense_id - - sig do - params( - access_groups: T.anything, - active_deployment: - T.nilable( - Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment::OrHash - ), - active_theme_id: String, - agent_enabled: T::Boolean, - analytics_enabled: T::Boolean, - created_at: Integer, - is_private: T::Boolean, - last_published: T.nilable(Integer), - last_published_uid: T.nilable(String), - login_portal_uid: String, - name: String, - publish_message: String, - publish_status: String, - slug: String, - uid: String, - updated_at: Integer, - user_info_hook_url: String, - repository: - T.nilable( - Scalar::Models::ScalarDocListGuidesResponseItem::Repository::OrHash - ), - typesense_id: Float - ).returns(T.attached_class) - end - def self.new( - access_groups:, - active_deployment:, - active_theme_id:, - agent_enabled:, - analytics_enabled:, - created_at:, - is_private:, - last_published:, - last_published_uid:, - login_portal_uid:, - name:, - publish_message:, - publish_status:, - slug:, - uid:, - updated_at:, - user_info_hook_url:, - repository: nil, - typesense_id: nil - ) - end - - sig do - override.returns( - { - access_groups: T.anything, - active_deployment: - T.nilable( - Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment - ), - active_theme_id: String, - agent_enabled: T::Boolean, - analytics_enabled: T::Boolean, - created_at: Integer, - is_private: T::Boolean, - last_published: T.nilable(Integer), - last_published_uid: T.nilable(String), - login_portal_uid: String, - name: String, - publish_message: String, - publish_status: String, - slug: String, - uid: String, - updated_at: Integer, - user_info_hook_url: String, - repository: - T.nilable( - Scalar::Models::ScalarDocListGuidesResponseItem::Repository - ), - typesense_id: Float - } - ) - end - def to_hash - end - - class ActiveDeployment < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment, - Scalar::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :domain - - sig { returns(Integer) } - attr_accessor :published_at - - sig { returns(String) } - attr_accessor :uid - - sig do - params(domain: String, published_at: Integer, uid: String).returns( - T.attached_class - ) - end - def self.new(domain:, published_at:, uid:) - end - - sig do - override.returns( - { domain: String, published_at: Integer, uid: String } - ) - end - def to_hash - end - end - - class Repository < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::ScalarDocListGuidesResponseItem::Repository, - Scalar::Internal::AnyHash - ) - end - - sig { returns(Float) } - attr_accessor :id - - sig { returns(String) } - attr_accessor :branch - - sig { returns(String) } - attr_accessor :config_path - - sig { returns(T::Boolean) } - attr_accessor :expired - - sig { returns(String) } - attr_accessor :linked_by - - sig { returns(String) } - attr_accessor :name - - sig { returns(T::Boolean) } - attr_accessor :pr_comments - - sig { returns(T::Boolean) } - attr_accessor :publish_on_merge - - sig { returns(T::Boolean) } - attr_accessor :publish_previews - - sig do - params( - id: Float, - branch: String, - config_path: String, - expired: T::Boolean, - linked_by: String, - name: String, - pr_comments: T::Boolean, - publish_on_merge: T::Boolean, - publish_previews: T::Boolean - ).returns(T.attached_class) - end - def self.new( - id:, - branch:, - config_path:, - expired:, - linked_by:, - name:, - pr_comments:, - publish_on_merge:, - publish_previews: - ) - end - - sig do - override.returns( - { - id: Float, - branch: String, - config_path: String, - expired: T::Boolean, - linked_by: String, - name: String, - pr_comments: T::Boolean, - publish_on_merge: T::Boolean, - publish_previews: T::Boolean - } - ) - end - def to_hash - end - end - end - ScalarDocListGuidesResponse = T.let( - Scalar::Internal::Type::ArrayOf[ - Scalar::Models::ScalarDocListGuidesResponseItem - ], + Scalar::Internal::Type::ArrayOf[Scalar::GithubProject], Scalar::Internal::Type::Converter ) end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_list_project_config_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_project_config_params.rbi new file mode 100644 index 0000000..1f68dc7 --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_list_project_config_params.rbi @@ -0,0 +1,45 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocListProjectConfigParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::ScalarDocListProjectConfigParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :slug + + sig { returns(T.nilable(String)) } + attr_reader :ref + + sig { params(ref: String).void } + attr_writer :ref + + sig do + params( + slug: String, + ref: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(slug:, ref: nil, request_options: {}) + end + + sig do + override.returns( + { slug: String, ref: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_list_project_config_response.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_project_config_response.rbi new file mode 100644 index 0000000..851f473 --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_list_project_config_response.rbi @@ -0,0 +1,46 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocListProjectConfigResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::ScalarDocListProjectConfigResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :base_token + + sig { returns(String) } + attr_accessor :content + + sig { returns(String) } + attr_accessor :path + + sig { returns(String) } + attr_accessor :ref + + sig do + params( + base_token: String, + content: String, + path: String, + ref: String + ).returns(T.attached_class) + end + def self.new(base_token:, content:, path:, ref:) + end + + sig do + override.returns( + { base_token: String, content: String, path: String, ref: String } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rbi new file mode 100644 index 0000000..3e65caf --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rbi @@ -0,0 +1,38 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocListProjectDomainParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::ScalarDocListProjectDomainParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :slug + + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(slug:, request_options: {}) + end + + sig do + override.returns( + { slug: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rbi new file mode 100644 index 0000000..d811ad2 --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rbi @@ -0,0 +1,38 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocListProjectDomainResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::ScalarDocListProjectDomainResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_accessor :custom_domain + + sig { returns(T.nilable(String)) } + attr_accessor :scalar_domain + + sig do + params( + custom_domain: T.nilable(String), + scalar_domain: T.nilable(String) + ).returns(T.attached_class) + end + def self.new(custom_domain:, scalar_domain:) + end + + sig do + override.returns( + { custom_domain: T.nilable(String), scalar_domain: T.nilable(String) } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rbi new file mode 100644 index 0000000..f6e3a56 --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rbi @@ -0,0 +1,38 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocListProjectDomainStatusParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::ScalarDocListProjectDomainStatusParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :slug + + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(slug:, request_options: {}) + end + + sig do + override.returns( + { slug: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rbi new file mode 100644 index 0000000..d2d2a25 --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rbi @@ -0,0 +1,142 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocListProjectDomainStatusResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::ScalarDocListProjectDomainStatusResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(T.nilable(String)) } + attr_accessor :domain + + sig do + returns( + T.nilable( + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected + ) + ) + end + attr_reader :expected + + sig do + params( + expected: + T.nilable( + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected::OrHash + ) + ).void + end + attr_writer :expected + + sig { returns(T::Array[String]) } + attr_accessor :found + + sig do + returns( + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status::TaggedSymbol + ) + end + attr_accessor :status + + sig do + params( + domain: T.nilable(String), + expected: + T.nilable( + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected::OrHash + ), + found: T::Array[String], + status: + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status::OrSymbol + ).returns(T.attached_class) + end + def self.new(domain:, expected:, found:, status:) + end + + sig do + override.returns( + { + domain: T.nilable(String), + expected: + T.nilable( + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected + ), + found: T::Array[String], + status: + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status::TaggedSymbol + } + ) + end + def to_hash + end + + class Expected < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :target + + sig { returns(Symbol) } + attr_accessor :type + + sig { params(target: String, type: Symbol).returns(T.attached_class) } + def self.new(target:, type: :CNAME) + end + + sig { override.returns({ target: String, type: Symbol }) } + def to_hash + end + end + + module Status + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + VERIFIED = + T.let( + :verified, + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status::TaggedSymbol + ) + PENDING = + T.let( + :pending, + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status::TaggedSymbol + ) + MISCONFIGURED = + T.let( + :misconfigured, + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Scalar::Models::ScalarDocListProjectDomainStatusResponse::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_list_projects_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_projects_params.rbi new file mode 100644 index 0000000..ef43bfd --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_list_projects_params.rbi @@ -0,0 +1,38 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocListProjectsParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::ScalarDocListProjectsParams, Scalar::Internal::AnyHash) + end + + sig { returns(T.nilable(Integer)) } + attr_reader :limit + + sig { params(limit: Integer).void } + attr_writer :limit + + sig do + params( + limit: Integer, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(limit: nil, request_options: {}) + end + + sig do + override.returns( + { limit: Integer, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_list_projects_response.rbi b/rbi/scalar_api_ruby/models/scalar_doc_list_projects_response.rbi new file mode 100644 index 0000000..2d72bfb --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_list_projects_response.rbi @@ -0,0 +1,38 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocListProjectsResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::ScalarDocListProjectsResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(T::Array[Scalar::DocsProject]) } + attr_accessor :data + + sig { returns(T::Boolean) } + attr_accessor :has_more + + sig do + params( + data: T::Array[Scalar::DocsProject::OrHash], + has_more: T::Boolean + ).returns(T.attached_class) + end + def self.new(data:, has_more:) + end + + sig do + override.returns( + { data: T::Array[Scalar::DocsProject], has_more: T::Boolean } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_publish_project_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_publish_project_params.rbi new file mode 100644 index 0000000..ce53adf --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_publish_project_params.rbi @@ -0,0 +1,71 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocPublishProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::ScalarDocPublishProjectParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :slug + + sig { returns(T.nilable(String)) } + attr_reader :commit_sha + + sig { params(commit_sha: String).void } + attr_writer :commit_sha + + sig { returns(T.nilable(String)) } + attr_reader :config_path + + sig { params(config_path: String).void } + attr_writer :config_path + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :preview + + sig { params(preview: T::Boolean).void } + attr_writer :preview + + sig do + params( + slug: String, + commit_sha: String, + config_path: String, + preview: T::Boolean, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + slug:, + commit_sha: nil, + config_path: nil, + preview: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + slug: String, + commit_sha: String, + config_path: String, + preview: T::Boolean, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_publish_project_response.rbi b/rbi/scalar_api_ruby/models/scalar_doc_publish_project_response.rbi new file mode 100644 index 0000000..0d543fa --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_publish_project_response.rbi @@ -0,0 +1,26 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocPublishProjectResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::ScalarDocPublishProjectResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :publish_uid + + sig { params(publish_uid: String).returns(T.attached_class) } + def self.new(publish_uid:) + end + + sig { override.returns({ publish_uid: String }) } + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rbi new file mode 100644 index 0000000..1559b66 --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rbi @@ -0,0 +1,38 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocRetrieveProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::ScalarDocRetrieveProjectParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :slug + + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(slug:, request_options: {}) + end + + sig do + override.returns( + { slug: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_update_project_config_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_update_project_config_params.rbi new file mode 100644 index 0000000..dfa6c40 --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_update_project_config_params.rbi @@ -0,0 +1,86 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocUpdateProjectConfigParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::ScalarDocUpdateProjectConfigParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :content + + sig { returns(T.nilable(String)) } + attr_reader :base_token + + sig { params(base_token: String).void } + attr_writer :base_token + + sig { returns(T.nilable(String)) } + attr_reader :message + + sig { params(message: String).void } + attr_writer :message + + sig { returns(T.nilable(String)) } + attr_reader :path + + sig { params(path: String).void } + attr_writer :path + + sig { returns(T.nilable(String)) } + attr_reader :ref + + sig { params(ref: String).void } + attr_writer :ref + + sig do + params( + slug: String, + content: String, + base_token: String, + message: String, + path: String, + ref: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + slug:, + content:, + base_token: nil, + message: nil, + path: nil, + ref: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + slug: String, + content: String, + base_token: String, + message: String, + path: String, + ref: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_update_project_config_response.rbi b/rbi/scalar_api_ruby/models/scalar_doc_update_project_config_response.rbi new file mode 100644 index 0000000..e0a9563 --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_update_project_config_response.rbi @@ -0,0 +1,42 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocUpdateProjectConfigResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::ScalarDocUpdateProjectConfigResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :base_token + + sig { returns(T.nilable(String)) } + attr_accessor :commit_sha + + sig { returns(String) } + attr_accessor :ref + + sig do + params( + base_token: String, + commit_sha: T.nilable(String), + ref: String + ).returns(T.attached_class) + end + def self.new(base_token:, commit_sha:, ref:) + end + + sig do + override.returns( + { base_token: String, commit_sha: T.nilable(String), ref: String } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/scalar_doc_update_project_params.rbi b/rbi/scalar_api_ruby/models/scalar_doc_update_project_params.rbi new file mode 100644 index 0000000..55db3c5 --- /dev/null +++ b/rbi/scalar_api_ruby/models/scalar_doc_update_project_params.rbi @@ -0,0 +1,126 @@ +# typed: strong + +module Scalar + module Models + class ScalarDocUpdateProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::ScalarDocUpdateProjectParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :slug + + sig { returns(T.nilable(T::Array[String])) } + attr_reader :access_groups + + sig { params(access_groups: T::Array[String]).void } + attr_writer :access_groups + + sig { returns(T.nilable(String)) } + attr_reader :active_theme_id + + sig { params(active_theme_id: String).void } + attr_writer :active_theme_id + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :agent_enabled + + sig { params(agent_enabled: T::Boolean).void } + attr_writer :agent_enabled + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :analytics_enabled + + sig { params(analytics_enabled: T::Boolean).void } + attr_writer :analytics_enabled + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private + + sig { params(is_private: T::Boolean).void } + attr_writer :is_private + + sig { returns(T.nilable(T.any(String, Symbol))) } + attr_reader :login_portal_uid + + sig do + params( + login_portal_uid: + Scalar::ScalarDocUpdateProjectParams::LoginPortalUID::Variants + ).void + end + attr_writer :login_portal_uid + + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + sig do + params( + slug: String, + access_groups: T::Array[String], + active_theme_id: String, + agent_enabled: T::Boolean, + analytics_enabled: T::Boolean, + is_private: T::Boolean, + login_portal_uid: + Scalar::ScalarDocUpdateProjectParams::LoginPortalUID::Variants, + name: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + slug:, + access_groups: nil, + active_theme_id: nil, + agent_enabled: nil, + analytics_enabled: nil, + is_private: nil, + login_portal_uid: nil, + name: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + slug: String, + access_groups: T::Array[String], + active_theme_id: String, + agent_enabled: T::Boolean, + analytics_enabled: T::Boolean, + is_private: T::Boolean, + login_portal_uid: T.any(String, Symbol), + name: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + + module LoginPortalUID + extend Scalar::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Symbol) } + + sig do + override.returns( + T::Array[ + Scalar::ScalarDocUpdateProjectParams::LoginPortalUID::Variants + ] + ) + end + def self.variants + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/schema.rbi b/rbi/scalar_api_ruby/models/schema.rbi new file mode 100644 index 0000000..c385482 --- /dev/null +++ b/rbi/scalar_api_ruby/models/schema.rbi @@ -0,0 +1,68 @@ +# typed: strong + +module Scalar + module Models + class Schema < Scalar::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(Scalar::Schema, Scalar::Internal::AnyHash) } + + sig { returns(String) } + attr_accessor :description + + sig { returns(T::Boolean) } + attr_accessor :is_private + + sig { returns(String) } + attr_accessor :namespace + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :title + + sig { returns(String) } + attr_accessor :uid + + sig { returns(T::Array[Scalar::ManagedSchemaVersion]) } + attr_accessor :versions + + sig do + params( + description: String, + is_private: T::Boolean, + namespace: String, + slug: String, + title: String, + uid: String, + versions: T::Array[Scalar::ManagedSchemaVersion::OrHash] + ).returns(T.attached_class) + end + def self.new( + description:, + is_private:, + namespace:, + slug:, + title:, + uid:, + versions: + ) + end + + sig do + override.returns( + { + description: String, + is_private: T::Boolean, + namespace: String, + slug: String, + title: String, + uid: String, + versions: T::Array[Scalar::ManagedSchemaVersion] + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/schema_list_response.rbi b/rbi/scalar_api_ruby/models/schema_list_response.rbi index 2c4a97b..1d473d0 100644 --- a/rbi/scalar_api_ruby/models/schema_list_response.rbi +++ b/rbi/scalar_api_ruby/models/schema_list_response.rbi @@ -2,148 +2,9 @@ module Scalar module Models - class SchemaListResponseItem < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::SchemaListResponseItem, - Scalar::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :description - - sig { returns(T::Boolean) } - attr_accessor :is_private - - sig { returns(String) } - attr_accessor :namespace - - sig { returns(String) } - attr_accessor :slug - - sig { returns(String) } - attr_accessor :title - - sig { returns(String) } - attr_accessor :uid - - sig { returns(T::Array[Scalar::Models::SchemaListResponseItem::Version]) } - attr_accessor :versions - - sig do - params( - description: String, - is_private: T::Boolean, - namespace: String, - slug: String, - title: String, - uid: String, - versions: - T::Array[Scalar::Models::SchemaListResponseItem::Version::OrHash] - ).returns(T.attached_class) - end - def self.new( - description:, - is_private:, - namespace:, - slug:, - title:, - uid:, - versions: - ) - end - - sig do - override.returns( - { - description: String, - is_private: T::Boolean, - namespace: String, - slug: String, - title: String, - uid: String, - versions: T::Array[Scalar::Models::SchemaListResponseItem::Version] - } - ) - end - def to_hash - end - - class Version < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::SchemaListResponseItem::Version, - Scalar::Internal::AnyHash - ) - end - - sig { returns(Integer) } - attr_accessor :created_at - - sig { returns(String) } - attr_accessor :uid - - sig { returns(Integer) } - attr_accessor :updated_at - - sig { returns(String) } - attr_accessor :version - - sig { returns(T.nilable(String)) } - attr_reader :json_sha - - sig { params(json_sha: String).void } - attr_writer :json_sha - - sig { returns(T.nilable(String)) } - attr_reader :yaml_sha - - sig { params(yaml_sha: String).void } - attr_writer :yaml_sha - - sig do - params( - created_at: Integer, - uid: String, - updated_at: Integer, - version: String, - json_sha: String, - yaml_sha: String - ).returns(T.attached_class) - end - def self.new( - created_at:, - uid:, - updated_at:, - version:, - json_sha: nil, - yaml_sha: nil - ) - end - - sig do - override.returns( - { - created_at: Integer, - uid: String, - updated_at: Integer, - version: String, - json_sha: String, - yaml_sha: String - } - ) - end - def to_hash - end - end - end - SchemaListResponse = T.let( - Scalar::Internal::Type::ArrayOf[Scalar::Models::SchemaListResponseItem], + Scalar::Internal::Type::ArrayOf[Scalar::Schema], Scalar::Internal::Type::Converter ) end diff --git a/rbi/scalar_api_ruby/models/sdk.rbi b/rbi/scalar_api_ruby/models/sdk.rbi new file mode 100644 index 0000000..cc8b757 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk.rbi @@ -0,0 +1,92 @@ +# typed: strong + +module Scalar + module Models + class Sdk < Scalar::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(Scalar::Sdk, Scalar::Internal::AnyHash) } + + sig { returns(T.nilable(String)) } + attr_accessor :api_uid + + sig { returns(String) } + attr_accessor :current_version + + sig { returns(String) } + attr_accessor :description + + sig { returns(T::Boolean) } + attr_accessor :is_private + + sig { returns(String) } + attr_accessor :namespace + + sig { returns(String) } + attr_accessor :slug + + sig { returns(T::Array[Scalar::SdkTargetSummary]) } + attr_accessor :targets + + sig { returns(String) } + attr_accessor :title + + sig { returns(String) } + attr_accessor :uid + + sig { returns(T::Array[Scalar::SdkVersion]) } + attr_accessor :versions + + sig { returns(T.nilable(String)) } + attr_accessor :api_version + + sig do + params( + api_uid: T.nilable(String), + current_version: String, + description: String, + is_private: T::Boolean, + namespace: String, + slug: String, + targets: T::Array[Scalar::SdkTargetSummary::OrHash], + title: String, + uid: String, + versions: T::Array[Scalar::SdkVersion::OrHash], + api_version: T.nilable(String) + ).returns(T.attached_class) + end + def self.new( + api_uid:, + current_version:, + description:, + is_private:, + namespace:, + slug:, + targets:, + title:, + uid:, + versions:, + api_version: nil + ) + end + + sig do + override.returns( + { + api_uid: T.nilable(String), + current_version: String, + description: String, + is_private: T::Boolean, + namespace: String, + slug: String, + targets: T::Array[Scalar::SdkTargetSummary], + title: String, + uid: String, + versions: T::Array[Scalar::SdkVersion], + api_version: T.nilable(String) + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdk_build_params.rbi b/rbi/scalar_api_ruby/models/sdk_build_params.rbi new file mode 100644 index 0000000..714baf6 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk_build_params.rbi @@ -0,0 +1,91 @@ +# typed: strong + +module Scalar + module Models + class SdkBuildParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::SdkBuildParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig do + returns(T.nilable(T::Array[Scalar::SdkBuildParams::Language::OrSymbol])) + end + attr_reader :languages + + sig do + params( + languages: T::Array[Scalar::SdkBuildParams::Language::OrSymbol] + ).void + end + attr_writer :languages + + sig { returns(T.nilable(String)) } + attr_reader :version + + sig { params(version: String).void } + attr_writer :version + + sig do + params( + uid: String, + languages: T::Array[Scalar::SdkBuildParams::Language::OrSymbol], + version: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(uid:, languages: nil, version: nil, request_options: {}) + end + + sig do + override.returns( + { + uid: String, + languages: T::Array[Scalar::SdkBuildParams::Language::OrSymbol], + version: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + + module Language + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Scalar::SdkBuildParams::Language) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TYPESCRIPT = + T.let(:typescript, Scalar::SdkBuildParams::Language::TaggedSymbol) + PYTHON = T.let(:python, Scalar::SdkBuildParams::Language::TaggedSymbol) + CLI = T.let(:cli, Scalar::SdkBuildParams::Language::TaggedSymbol) + CSHARP = T.let(:csharp, Scalar::SdkBuildParams::Language::TaggedSymbol) + JAVA = T.let(:java, Scalar::SdkBuildParams::Language::TaggedSymbol) + RUBY = T.let(:ruby, Scalar::SdkBuildParams::Language::TaggedSymbol) + PHP = T.let(:php, Scalar::SdkBuildParams::Language::TaggedSymbol) + GO = T.let(:go, Scalar::SdkBuildParams::Language::TaggedSymbol) + RUST = T.let(:rust, Scalar::SdkBuildParams::Language::TaggedSymbol) + KOTLIN = T.let(:kotlin, Scalar::SdkBuildParams::Language::TaggedSymbol) + SWIFT = T.let(:swift, Scalar::SdkBuildParams::Language::TaggedSymbol) + CPP = T.let(:cpp, Scalar::SdkBuildParams::Language::TaggedSymbol) + DART = T.let(:dart, Scalar::SdkBuildParams::Language::TaggedSymbol) + + sig do + override.returns( + T::Array[Scalar::SdkBuildParams::Language::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdk_build_response.rbi b/rbi/scalar_api_ruby/models/sdk_build_response.rbi new file mode 100644 index 0000000..1eead10 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk_build_response.rbi @@ -0,0 +1,23 @@ +# typed: strong + +module Scalar + module Models + class SdkBuildResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Scalar::Models::SdkBuildResponse, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :version + + sig { params(version: String).returns(T.attached_class) } + def self.new(version:) + end + + sig { override.returns({ version: String }) } + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdk_create_params.rbi b/rbi/scalar_api_ruby/models/sdk_create_params.rbi new file mode 100644 index 0000000..b88a27f --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk_create_params.rbi @@ -0,0 +1,114 @@ +# typed: strong + +module Scalar + module Models + class SdkCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::SdkCreateParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :api_uid + + sig { returns(T::Array[Scalar::SdkCreateParams::Language::OrSymbol]) } + attr_accessor :languages + + sig { returns(T.nilable(String)) } + attr_reader :class_name + + sig { params(class_name: String).void } + attr_writer :class_name + + sig { returns(T.nilable(String)) } + attr_reader :config + + sig { params(config: String).void } + attr_writer :config + + sig { returns(T.nilable(String)) } + attr_reader :slug + + sig { params(slug: String).void } + attr_writer :slug + + sig { returns(T.nilable(String)) } + attr_reader :title + + sig { params(title: String).void } + attr_writer :title + + sig do + params( + api_uid: String, + languages: T::Array[Scalar::SdkCreateParams::Language::OrSymbol], + class_name: String, + config: String, + slug: String, + title: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + api_uid:, + languages:, + class_name: nil, + config: nil, + slug: nil, + title: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + api_uid: String, + languages: T::Array[Scalar::SdkCreateParams::Language::OrSymbol], + class_name: String, + config: String, + slug: String, + title: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + + module Language + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Scalar::SdkCreateParams::Language) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TYPESCRIPT = + T.let(:typescript, Scalar::SdkCreateParams::Language::TaggedSymbol) + PYTHON = T.let(:python, Scalar::SdkCreateParams::Language::TaggedSymbol) + CLI = T.let(:cli, Scalar::SdkCreateParams::Language::TaggedSymbol) + CSHARP = T.let(:csharp, Scalar::SdkCreateParams::Language::TaggedSymbol) + JAVA = T.let(:java, Scalar::SdkCreateParams::Language::TaggedSymbol) + RUBY = T.let(:ruby, Scalar::SdkCreateParams::Language::TaggedSymbol) + PHP = T.let(:php, Scalar::SdkCreateParams::Language::TaggedSymbol) + GO = T.let(:go, Scalar::SdkCreateParams::Language::TaggedSymbol) + RUST = T.let(:rust, Scalar::SdkCreateParams::Language::TaggedSymbol) + KOTLIN = T.let(:kotlin, Scalar::SdkCreateParams::Language::TaggedSymbol) + SWIFT = T.let(:swift, Scalar::SdkCreateParams::Language::TaggedSymbol) + CPP = T.let(:cpp, Scalar::SdkCreateParams::Language::TaggedSymbol) + DART = T.let(:dart, Scalar::SdkCreateParams::Language::TaggedSymbol) + + sig do + override.returns( + T::Array[Scalar::SdkCreateParams::Language::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdk_delete_params.rbi b/rbi/scalar_api_ruby/models/sdk_delete_params.rbi new file mode 100644 index 0000000..ab4b073 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk_delete_params.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Scalar + module Models + class SdkDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::SdkDeleteParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig do + params( + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(uid:, request_options: {}) + end + + sig do + override.returns( + { uid: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdk_list_params.rbi b/rbi/scalar_api_ruby/models/sdk_list_params.rbi new file mode 100644 index 0000000..0099e99 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk_list_params.rbi @@ -0,0 +1,36 @@ +# typed: strong + +module Scalar + module Models + class SdkListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias { T.any(Scalar::SdkListParams, Scalar::Internal::AnyHash) } + + sig { returns(T.nilable(Integer)) } + attr_reader :limit + + sig { params(limit: Integer).void } + attr_writer :limit + + sig do + params( + limit: Integer, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(limit: nil, request_options: {}) + end + + sig do + override.returns( + { limit: Integer, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdk_list_response.rbi b/rbi/scalar_api_ruby/models/sdk_list_response.rbi new file mode 100644 index 0000000..44be97b --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk_list_response.rbi @@ -0,0 +1,33 @@ +# typed: strong + +module Scalar + module Models + class SdkListResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Scalar::Models::SdkListResponse, Scalar::Internal::AnyHash) + end + + sig { returns(T::Array[Scalar::Sdk]) } + attr_accessor :data + + sig { returns(T::Boolean) } + attr_accessor :has_more + + sig do + params( + data: T::Array[Scalar::Sdk::OrHash], + has_more: T::Boolean + ).returns(T.attached_class) + end + def self.new(data:, has_more:) + end + + sig do + override.returns({ data: T::Array[Scalar::Sdk], has_more: T::Boolean }) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdk_retrieve_params.rbi b/rbi/scalar_api_ruby/models/sdk_retrieve_params.rbi new file mode 100644 index 0000000..a102d0b --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk_retrieve_params.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module Scalar + module Models + class SdkRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::SdkRetrieveParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig do + params( + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(uid:, request_options: {}) + end + + sig do + override.returns( + { uid: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdk_target_summary.rbi b/rbi/scalar_api_ruby/models/sdk_target_summary.rbi new file mode 100644 index 0000000..2b3e2b7 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk_target_summary.rbi @@ -0,0 +1,72 @@ +# typed: strong + +module Scalar + module Models + class SdkTargetSummary < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Scalar::SdkTargetSummary, Scalar::Internal::AnyHash) + end + + sig { returns(Scalar::SdkTargetSummary::Language::TaggedSymbol) } + attr_accessor :language + + sig { returns(String) } + attr_accessor :slug + + sig do + params( + language: Scalar::SdkTargetSummary::Language::OrSymbol, + slug: String + ).returns(T.attached_class) + end + def self.new(language:, slug:) + end + + sig do + override.returns( + { + language: Scalar::SdkTargetSummary::Language::TaggedSymbol, + slug: String + } + ) + end + def to_hash + end + + module Language + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Scalar::SdkTargetSummary::Language) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TYPESCRIPT = + T.let(:typescript, Scalar::SdkTargetSummary::Language::TaggedSymbol) + PYTHON = + T.let(:python, Scalar::SdkTargetSummary::Language::TaggedSymbol) + CLI = T.let(:cli, Scalar::SdkTargetSummary::Language::TaggedSymbol) + CSHARP = + T.let(:csharp, Scalar::SdkTargetSummary::Language::TaggedSymbol) + JAVA = T.let(:java, Scalar::SdkTargetSummary::Language::TaggedSymbol) + RUBY = T.let(:ruby, Scalar::SdkTargetSummary::Language::TaggedSymbol) + PHP = T.let(:php, Scalar::SdkTargetSummary::Language::TaggedSymbol) + GO = T.let(:go, Scalar::SdkTargetSummary::Language::TaggedSymbol) + RUST = T.let(:rust, Scalar::SdkTargetSummary::Language::TaggedSymbol) + KOTLIN = + T.let(:kotlin, Scalar::SdkTargetSummary::Language::TaggedSymbol) + SWIFT = T.let(:swift, Scalar::SdkTargetSummary::Language::TaggedSymbol) + CPP = T.let(:cpp, Scalar::SdkTargetSummary::Language::TaggedSymbol) + DART = T.let(:dart, Scalar::SdkTargetSummary::Language::TaggedSymbol) + + sig do + override.returns( + T::Array[Scalar::SdkTargetSummary::Language::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdk_update_params.rbi b/rbi/scalar_api_ruby/models/sdk_update_params.rbi new file mode 100644 index 0000000..bef749a --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk_update_params.rbi @@ -0,0 +1,89 @@ +# typed: strong + +module Scalar + module Models + class SdkUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::SdkUpdateParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig { returns(T.nilable(String)) } + attr_accessor :api_uid + + sig { returns(T.nilable(String)) } + attr_accessor :api_version + + sig { returns(T.nilable(String)) } + attr_reader :config + + sig { params(config: String).void } + attr_writer :config + + sig { returns(T.nilable(T::Boolean)) } + attr_reader :is_private + + sig { params(is_private: T::Boolean).void } + attr_writer :is_private + + sig { returns(T.nilable(String)) } + attr_reader :slug + + sig { params(slug: String).void } + attr_writer :slug + + sig { returns(T.nilable(String)) } + attr_reader :title + + sig { params(title: String).void } + attr_writer :title + + sig do + params( + uid: String, + api_uid: T.nilable(String), + api_version: T.nilable(String), + config: String, + is_private: T::Boolean, + slug: String, + title: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + uid:, + api_uid: nil, + api_version: nil, + config: nil, + is_private: nil, + slug: nil, + title: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + uid: String, + api_uid: T.nilable(String), + api_version: T.nilable(String), + config: String, + is_private: T::Boolean, + slug: String, + title: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdk_version.rbi b/rbi/scalar_api_ruby/models/sdk_version.rbi new file mode 100644 index 0000000..ea0c544 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdk_version.rbi @@ -0,0 +1,115 @@ +# typed: strong + +module Scalar + module Models + class SdkVersion < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Scalar::SdkVersion, Scalar::Internal::AnyHash) } + + sig { returns(String) } + attr_accessor :api_version + + sig { returns(T::Array[Scalar::SdkVersion::Language::TaggedSymbol]) } + attr_accessor :languages + + sig { returns(Scalar::SdkVersion::Status::TaggedSymbol) } + attr_accessor :status + + sig { returns(String) } + attr_accessor :version + + sig { returns(T.nilable(Integer)) } + attr_reader :created_at + + sig { params(created_at: Integer).void } + attr_writer :created_at + + sig { returns(T.nilable(Integer)) } + attr_reader :published_at + + sig { params(published_at: Integer).void } + attr_writer :published_at + + sig do + params( + api_version: String, + languages: T::Array[Scalar::SdkVersion::Language::OrSymbol], + status: Scalar::SdkVersion::Status::OrSymbol, + version: String, + created_at: Integer, + published_at: Integer + ).returns(T.attached_class) + end + def self.new( + api_version:, + languages:, + status:, + version:, + created_at: nil, + published_at: nil + ) + end + + sig do + override.returns( + { + api_version: String, + languages: T::Array[Scalar::SdkVersion::Language::TaggedSymbol], + status: Scalar::SdkVersion::Status::TaggedSymbol, + version: String, + created_at: Integer, + published_at: Integer + } + ) + end + def to_hash + end + + module Language + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Scalar::SdkVersion::Language) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TYPESCRIPT = + T.let(:typescript, Scalar::SdkVersion::Language::TaggedSymbol) + PYTHON = T.let(:python, Scalar::SdkVersion::Language::TaggedSymbol) + CLI = T.let(:cli, Scalar::SdkVersion::Language::TaggedSymbol) + CSHARP = T.let(:csharp, Scalar::SdkVersion::Language::TaggedSymbol) + JAVA = T.let(:java, Scalar::SdkVersion::Language::TaggedSymbol) + RUBY = T.let(:ruby, Scalar::SdkVersion::Language::TaggedSymbol) + PHP = T.let(:php, Scalar::SdkVersion::Language::TaggedSymbol) + GO = T.let(:go, Scalar::SdkVersion::Language::TaggedSymbol) + RUST = T.let(:rust, Scalar::SdkVersion::Language::TaggedSymbol) + KOTLIN = T.let(:kotlin, Scalar::SdkVersion::Language::TaggedSymbol) + SWIFT = T.let(:swift, Scalar::SdkVersion::Language::TaggedSymbol) + CPP = T.let(:cpp, Scalar::SdkVersion::Language::TaggedSymbol) + DART = T.let(:dart, Scalar::SdkVersion::Language::TaggedSymbol) + + sig do + override.returns(T::Array[Scalar::SdkVersion::Language::TaggedSymbol]) + end + def self.values + end + end + + module Status + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Scalar::SdkVersion::Status) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + DRAFT = T.let(:draft, Scalar::SdkVersion::Status::TaggedSymbol) + PUBLISHED = T.let(:published, Scalar::SdkVersion::Status::TaggedSymbol) + + sig do + override.returns(T::Array[Scalar::SdkVersion::Status::TaggedSymbol]) + end + def self.values + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdks/repository_link_params.rbi b/rbi/scalar_api_ruby/models/sdks/repository_link_params.rbi new file mode 100644 index 0000000..2a54fb3 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdks/repository_link_params.rbi @@ -0,0 +1,156 @@ +# typed: strong + +module Scalar + module Models + module Sdks + class RepositoryLinkParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Sdks::RepositoryLinkParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig { returns(String) } + attr_accessor :base_branch + + sig { returns(Scalar::Sdks::RepositoryLinkParams::Language::OrSymbol) } + attr_accessor :language + + sig { returns(Integer) } + attr_accessor :repository_id + + sig { returns(T.nilable(String)) } + attr_reader :prerelease_type + + sig { params(prerelease_type: String).void } + attr_writer :prerelease_type + + sig do + params( + uid: String, + base_branch: String, + language: Scalar::Sdks::RepositoryLinkParams::Language::OrSymbol, + repository_id: Integer, + prerelease_type: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + uid:, + base_branch:, + language:, + repository_id:, + prerelease_type: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + uid: String, + base_branch: String, + language: Scalar::Sdks::RepositoryLinkParams::Language::OrSymbol, + repository_id: Integer, + prerelease_type: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + + module Language + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Scalar::Sdks::RepositoryLinkParams::Language) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TYPESCRIPT = + T.let( + :typescript, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + PYTHON = + T.let( + :python, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + CLI = + T.let( + :cli, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + CSHARP = + T.let( + :csharp, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + JAVA = + T.let( + :java, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + RUBY = + T.let( + :ruby, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + PHP = + T.let( + :php, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + GO = + T.let( + :go, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + RUST = + T.let( + :rust, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + KOTLIN = + T.let( + :kotlin, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + SWIFT = + T.let( + :swift, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + CPP = + T.let( + :cpp, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + DART = + T.let( + :dart, + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Scalar::Sdks::RepositoryLinkParams::Language::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdks/repository_link_response.rbi b/rbi/scalar_api_ruby/models/sdks/repository_link_response.rbi new file mode 100644 index 0000000..d347640 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdks/repository_link_response.rbi @@ -0,0 +1,31 @@ +# typed: strong + +module Scalar + module Models + module Sdks + class RepositoryLinkResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::Sdks::RepositoryLinkResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :branch + + sig { returns(String) } + attr_accessor :repo + + sig { params(branch: String, repo: String).returns(T.attached_class) } + def self.new(branch:, repo:) + end + + sig { override.returns({ branch: String, repo: String }) } + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdks/repository_unlink_params.rbi b/rbi/scalar_api_ruby/models/sdks/repository_unlink_params.rbi new file mode 100644 index 0000000..d224967 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdks/repository_unlink_params.rbi @@ -0,0 +1,137 @@ +# typed: strong + +module Scalar + module Models + module Sdks + class RepositoryUnlinkParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::Sdks::RepositoryUnlinkParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :uid + + sig do + returns(Scalar::Sdks::RepositoryUnlinkParams::Language::OrSymbol) + end + attr_accessor :language + + sig do + params( + uid: String, + language: Scalar::Sdks::RepositoryUnlinkParams::Language::OrSymbol, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(uid:, language:, request_options: {}) + end + + sig do + override.returns( + { + uid: String, + language: + Scalar::Sdks::RepositoryUnlinkParams::Language::OrSymbol, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + + module Language + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Scalar::Sdks::RepositoryUnlinkParams::Language) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TYPESCRIPT = + T.let( + :typescript, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + PYTHON = + T.let( + :python, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + CLI = + T.let( + :cli, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + CSHARP = + T.let( + :csharp, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + JAVA = + T.let( + :java, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + RUBY = + T.let( + :ruby, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + PHP = + T.let( + :php, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + GO = + T.let( + :go, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + RUST = + T.let( + :rust, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + KOTLIN = + T.let( + :kotlin, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + SWIFT = + T.let( + :swift, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + CPP = + T.let( + :cpp, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + DART = + T.let( + :dart, + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Scalar::Sdks::RepositoryUnlinkParams::Language::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdks/repository_update_publishing_params.rbi b/rbi/scalar_api_ruby/models/sdks/repository_update_publishing_params.rbi new file mode 100644 index 0000000..7e2c3c1 --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdks/repository_update_publishing_params.rbi @@ -0,0 +1,274 @@ +# typed: strong + +module Scalar + module Models + module Sdks + class RepositoryUpdatePublishingParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Scalar::Sdks::RepositoryUpdatePublishingParams, + Scalar::Internal::AnyHash + ) + end + + sig { returns(String) } + attr_accessor :uid + + sig do + returns( + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::OrSymbol + ) + end + attr_accessor :language + + sig { returns(T::Boolean) } + attr_accessor :publish_on_merge + + sig do + returns( + T.nilable( + Scalar::Sdks::RepositoryUpdatePublishingParams::Access::OrSymbol + ) + ) + end + attr_reader :access + + sig do + params( + access: + Scalar::Sdks::RepositoryUpdatePublishingParams::Access::OrSymbol + ).void + end + attr_writer :access + + sig do + returns( + T.nilable( + Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod::OrSymbol + ) + ) + end + attr_reader :auth_method + + sig do + params( + auth_method: + Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod::OrSymbol + ).void + end + attr_writer :auth_method + + sig { returns(T.nilable(String)) } + attr_reader :tag + + sig { params(tag: String).void } + attr_writer :tag + + sig do + params( + uid: String, + language: + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::OrSymbol, + publish_on_merge: T::Boolean, + access: + Scalar::Sdks::RepositoryUpdatePublishingParams::Access::OrSymbol, + auth_method: + Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod::OrSymbol, + tag: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + uid:, + language:, + publish_on_merge:, + access: nil, + auth_method: nil, + tag: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + uid: String, + language: + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::OrSymbol, + publish_on_merge: T::Boolean, + access: + Scalar::Sdks::RepositoryUpdatePublishingParams::Access::OrSymbol, + auth_method: + Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod::OrSymbol, + tag: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + + module Language + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TYPESCRIPT = + T.let( + :typescript, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + PYTHON = + T.let( + :python, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + CLI = + T.let( + :cli, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + CSHARP = + T.let( + :csharp, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + JAVA = + T.let( + :java, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + RUBY = + T.let( + :ruby, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + PHP = + T.let( + :php, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + GO = + T.let( + :go, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + RUST = + T.let( + :rust, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + KOTLIN = + T.let( + :kotlin, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + SWIFT = + T.let( + :swift, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + CPP = + T.let( + :cpp, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + DART = + T.let( + :dart, + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::TaggedSymbol + ] + ) + end + def self.values + end + end + + module Access + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Scalar::Sdks::RepositoryUpdatePublishingParams::Access + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PUBLIC = + T.let( + :public, + Scalar::Sdks::RepositoryUpdatePublishingParams::Access::TaggedSymbol + ) + RESTRICTED = + T.let( + :restricted, + Scalar::Sdks::RepositoryUpdatePublishingParams::Access::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Scalar::Sdks::RepositoryUpdatePublishingParams::Access::TaggedSymbol + ] + ) + end + def self.values + end + end + + module AuthMethod + extend Scalar::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + OIDC = + T.let( + :oidc, + Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod::TaggedSymbol + ) + ACCESS_TOKEN = + T.let( + :"access-token", + Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdks/version_create_params.rbi b/rbi/scalar_api_ruby/models/sdks/version_create_params.rbi new file mode 100644 index 0000000..7e5a8ca --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdks/version_create_params.rbi @@ -0,0 +1,50 @@ +# typed: strong + +module Scalar + module Models + module Sdks + class VersionCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Sdks::VersionCreateParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig { returns(String) } + attr_accessor :api_version + + sig { returns(String) } + attr_accessor :version + + sig do + params( + uid: String, + api_version: String, + version: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(uid:, api_version:, version:, request_options: {}) + end + + sig do + override.returns( + { + uid: String, + api_version: String, + version: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/sdks/version_delete_params.rbi b/rbi/scalar_api_ruby/models/sdks/version_delete_params.rbi new file mode 100644 index 0000000..2cba1be --- /dev/null +++ b/rbi/scalar_api_ruby/models/sdks/version_delete_params.rbi @@ -0,0 +1,45 @@ +# typed: strong + +module Scalar + module Models + module Sdks + class VersionDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Sdks::VersionDeleteParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig { returns(String) } + attr_accessor :version + + sig do + params( + uid: String, + version: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(uid:, version:, request_options: {}) + end + + sig do + override.returns( + { + uid: String, + version: String, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/team.rbi b/rbi/scalar_api_ruby/models/team.rbi new file mode 100644 index 0000000..97546ad --- /dev/null +++ b/rbi/scalar_api_ruby/models/team.rbi @@ -0,0 +1,53 @@ +# typed: strong + +module Scalar + module Models + class Team < Scalar::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(Scalar::Team, Scalar::Internal::AnyHash) } + + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :theme + + sig { returns(String) } + attr_accessor :uid + + sig { returns(T.nilable(String)) } + attr_reader :image_uri + + sig { params(image_uri: String).void } + attr_writer :image_uri + + sig do + params( + name: String, + slug: String, + theme: String, + uid: String, + image_uri: String + ).returns(T.attached_class) + end + def self.new(name:, slug:, theme:, uid:, image_uri: nil) + end + + sig do + override.returns( + { + name: String, + slug: String, + theme: String, + uid: String, + image_uri: String + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/team_image.rbi b/rbi/scalar_api_ruby/models/team_image.rbi new file mode 100644 index 0000000..17f2989 --- /dev/null +++ b/rbi/scalar_api_ruby/models/team_image.rbi @@ -0,0 +1,7 @@ +# typed: strong + +module Scalar + module Models + TeamImage = String + end +end diff --git a/rbi/scalar_api_ruby/models/team_list_response.rbi b/rbi/scalar_api_ruby/models/team_list_response.rbi index 79e7e36..12454cb 100644 --- a/rbi/scalar_api_ruby/models/team_list_response.rbi +++ b/rbi/scalar_api_ruby/models/team_list_response.rbi @@ -2,60 +2,9 @@ module Scalar module Models - class TeamListResponseItem < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Scalar::Models::TeamListResponseItem, Scalar::Internal::AnyHash) - end - - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :slug - - sig { returns(String) } - attr_accessor :theme - - sig { returns(String) } - attr_accessor :uid - - sig { returns(T.nilable(String)) } - attr_reader :image_uri - - sig { params(image_uri: String).void } - attr_writer :image_uri - - sig do - params( - name: String, - slug: String, - theme: String, - uid: String, - image_uri: String - ).returns(T.attached_class) - end - def self.new(name:, slug:, theme:, uid:, image_uri: nil) - end - - sig do - override.returns( - { - name: String, - slug: String, - theme: String, - uid: String, - image_uri: String - } - ) - end - def to_hash - end - end - TeamListResponse = T.let( - Scalar::Internal::Type::ArrayOf[Scalar::Models::TeamListResponseItem], + Scalar::Internal::Type::ArrayOf[Scalar::Team], Scalar::Internal::Type::Converter ) end diff --git a/rbi/scalar_api_ruby/models/team_name.rbi b/rbi/scalar_api_ruby/models/team_name.rbi new file mode 100644 index 0000000..b029ac7 --- /dev/null +++ b/rbi/scalar_api_ruby/models/team_name.rbi @@ -0,0 +1,7 @@ +# typed: strong + +module Scalar + module Models + TeamName = String + end +end diff --git a/rbi/scalar_api_ruby/models/team_summary.rbi b/rbi/scalar_api_ruby/models/team_summary.rbi new file mode 100644 index 0000000..10b2370 --- /dev/null +++ b/rbi/scalar_api_ruby/models/team_summary.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Scalar + module Models + class TeamSummary < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Scalar::TeamSummary, Scalar::Internal::AnyHash) } + + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :uid + + sig { returns(T.nilable(String)) } + attr_reader :image_uri + + sig { params(image_uri: String).void } + attr_writer :image_uri + + sig do + params(name: String, uid: String, image_uri: String).returns( + T.attached_class + ) + end + def self.new(name:, uid:, image_uri: nil) + end + + sig { override.returns({ name: String, uid: String, image_uri: String }) } + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/email.rbi b/rbi/scalar_api_ruby/models/teams/email.rbi new file mode 100644 index 0000000..c0617c7 --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/email.rbi @@ -0,0 +1,9 @@ +# typed: strong + +module Scalar + module Models + module Teams + Email = String + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/invite_cancel_params.rbi b/rbi/scalar_api_ruby/models/teams/invite_cancel_params.rbi new file mode 100644 index 0000000..740ddb8 --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/invite_cancel_params.rbi @@ -0,0 +1,37 @@ +# typed: strong + +module Scalar + module Models + module Teams + class InviteCancelParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Teams::InviteCancelParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig do + params( + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(uid:, request_options: {}) + end + + sig do + override.returns( + { uid: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/invite_member_params.rbi b/rbi/scalar_api_ruby/models/teams/invite_member_params.rbi new file mode 100644 index 0000000..16e3acc --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/invite_member_params.rbi @@ -0,0 +1,45 @@ +# typed: strong + +module Scalar + module Models + module Teams + class InviteMemberParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Teams::InviteMemberParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :email + + sig { returns(Scalar::Teams::Role::OrSymbol) } + attr_accessor :role + + sig do + params( + email: String, + role: Scalar::Teams::Role::OrSymbol, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(email:, role:, request_options: {}) + end + + sig do + override.returns( + { + email: String, + role: Scalar::Teams::Role::OrSymbol, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/invite_resend_params.rbi b/rbi/scalar_api_ruby/models/teams/invite_resend_params.rbi new file mode 100644 index 0000000..4fc9038 --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/invite_resend_params.rbi @@ -0,0 +1,37 @@ +# typed: strong + +module Scalar + module Models + module Teams + class InviteResendParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Teams::InviteResendParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig do + params( + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(uid:, request_options: {}) + end + + sig do + override.returns( + { uid: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/member_delete_params.rbi b/rbi/scalar_api_ruby/models/teams/member_delete_params.rbi new file mode 100644 index 0000000..d4c6e43 --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/member_delete_params.rbi @@ -0,0 +1,37 @@ +# typed: strong + +module Scalar + module Models + module Teams + class MemberDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Teams::MemberDeleteParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig do + params( + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(uid:, request_options: {}) + end + + sig do + override.returns( + { uid: String, request_options: Scalar::RequestOptions } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/member_list_params.rbi b/rbi/scalar_api_ruby/models/teams/member_list_params.rbi new file mode 100644 index 0000000..26b7575 --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/member_list_params.rbi @@ -0,0 +1,29 @@ +# typed: strong + +module Scalar + module Models + module Teams + class MemberListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Teams::MemberListParams, Scalar::Internal::AnyHash) + end + + sig do + params(request_options: Scalar::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Scalar::RequestOptions }) } + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/member_list_response.rbi b/rbi/scalar_api_ruby/models/teams/member_list_response.rbi new file mode 100644 index 0000000..ae1ec17 --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/member_list_response.rbi @@ -0,0 +1,43 @@ +# typed: strong + +module Scalar + module Models + module Teams + class MemberListResponse < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Scalar::Models::Teams::MemberListResponse, + Scalar::Internal::AnyHash + ) + end + + sig { returns(T::Array[Scalar::Teams::TeamMember]) } + attr_accessor :members + + sig { returns(T::Array[Scalar::Teams::TeamInvite]) } + attr_accessor :pending_invites + + sig do + params( + members: T::Array[Scalar::Teams::TeamMember::OrHash], + pending_invites: T::Array[Scalar::Teams::TeamInvite::OrHash] + ).returns(T.attached_class) + end + def self.new(members:, pending_invites:) + end + + sig do + override.returns( + { + members: T::Array[Scalar::Teams::TeamMember], + pending_invites: T::Array[Scalar::Teams::TeamInvite] + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/member_update_params.rbi b/rbi/scalar_api_ruby/models/teams/member_update_params.rbi new file mode 100644 index 0000000..a43f98b --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/member_update_params.rbi @@ -0,0 +1,45 @@ +# typed: strong + +module Scalar + module Models + module Teams + class MemberUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Scalar::Teams::MemberUpdateParams, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :uid + + sig { returns(Scalar::Teams::Role::OrSymbol) } + attr_accessor :role + + sig do + params( + uid: String, + role: Scalar::Teams::Role::OrSymbol, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(uid:, role:, request_options: {}) + end + + sig do + override.returns( + { + uid: String, + role: Scalar::Teams::Role::OrSymbol, + request_options: Scalar::RequestOptions + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/role.rbi b/rbi/scalar_api_ruby/models/teams/role.rbi new file mode 100644 index 0000000..2afcfa9 --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/role.rbi @@ -0,0 +1,23 @@ +# typed: strong + +module Scalar + module Models + module Teams + module Role + extend Scalar::Internal::Type::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, Scalar::Teams::Role) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + OWNER = T.let(:owner, Scalar::Teams::Role::TaggedSymbol) + ADMIN = T.let(:admin, Scalar::Teams::Role::TaggedSymbol) + EDITOR = T.let(:editor, Scalar::Teams::Role::TaggedSymbol) + VIEWER = T.let(:viewer, Scalar::Teams::Role::TaggedSymbol) + + sig { override.returns(T::Array[Scalar::Teams::Role::TaggedSymbol]) } + def self.values + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/team_invite.rbi b/rbi/scalar_api_ruby/models/teams/team_invite.rbi new file mode 100644 index 0000000..607d752 --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/team_invite.rbi @@ -0,0 +1,55 @@ +# typed: strong + +module Scalar + module Models + TeamInvite = Teams::TeamInvite + + module Teams + class TeamInvite < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Scalar::Teams::TeamInvite, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :email + + sig { returns(Scalar::Teams::Role::TaggedSymbol) } + attr_accessor :role + + sig { returns(String) } + attr_accessor :uid + + sig { returns(T.nilable(Float)) } + attr_reader :expires + + sig { params(expires: Float).void } + attr_writer :expires + + sig do + params( + email: String, + role: Scalar::Teams::Role::OrSymbol, + uid: String, + expires: Float + ).returns(T.attached_class) + end + def self.new(email:, role:, uid:, expires: nil) + end + + sig do + override.returns( + { + email: String, + role: Scalar::Teams::Role::TaggedSymbol, + uid: String, + expires: Float + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/teams/team_member.rbi b/rbi/scalar_api_ruby/models/teams/team_member.rbi new file mode 100644 index 0000000..b54ce46 --- /dev/null +++ b/rbi/scalar_api_ruby/models/teams/team_member.rbi @@ -0,0 +1,55 @@ +# typed: strong + +module Scalar + module Models + TeamMember = Teams::TeamMember + + module Teams + class TeamMember < Scalar::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Scalar::Teams::TeamMember, Scalar::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :display_name + + sig { returns(Scalar::Teams::Role::TaggedSymbol) } + attr_accessor :role + + sig { returns(String) } + attr_accessor :uid + + sig { returns(T.nilable(String)) } + attr_reader :image_uri + + sig { params(image_uri: String).void } + attr_writer :image_uri + + sig do + params( + display_name: String, + role: Scalar::Teams::Role::OrSymbol, + uid: String, + image_uri: String + ).returns(T.attached_class) + end + def self.new(display_name:, role:, uid:, image_uri: nil) + end + + sig do + override.returns( + { + display_name: String, + role: Scalar::Teams::Role::TaggedSymbol, + uid: String, + image_uri: String + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/theme.rbi b/rbi/scalar_api_ruby/models/theme.rbi new file mode 100644 index 0000000..28a36aa --- /dev/null +++ b/rbi/scalar_api_ruby/models/theme.rbi @@ -0,0 +1,40 @@ +# typed: strong + +module Scalar + module Models + class Theme < Scalar::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(Scalar::Theme, Scalar::Internal::AnyHash) } + + sig { returns(String) } + attr_accessor :description + + sig { returns(String) } + attr_accessor :name + + sig { returns(String) } + attr_accessor :slug + + sig { returns(String) } + attr_accessor :uid + + sig do + params( + description: String, + name: String, + slug: String, + uid: String + ).returns(T.attached_class) + end + def self.new(description:, name:, slug:, uid:) + end + + sig do + override.returns( + { description: String, name: String, slug: String, uid: String } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/models/theme_list_response.rbi b/rbi/scalar_api_ruby/models/theme_list_response.rbi index 225476a..2cb79d3 100644 --- a/rbi/scalar_api_ruby/models/theme_list_response.rbi +++ b/rbi/scalar_api_ruby/models/theme_list_response.rbi @@ -2,50 +2,9 @@ module Scalar module Models - class ThemeListResponseItem < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::Models::ThemeListResponseItem, - Scalar::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :description - - sig { returns(String) } - attr_accessor :name - - sig { returns(String) } - attr_accessor :slug - - sig { returns(String) } - attr_accessor :uid - - sig do - params( - description: String, - name: String, - slug: String, - uid: String - ).returns(T.attached_class) - end - def self.new(description:, name:, slug:, uid:) - end - - sig do - override.returns( - { description: String, name: String, slug: String, uid: String } - ) - end - def to_hash - end - end - ThemeListResponse = T.let( - Scalar::Internal::Type::ArrayOf[Scalar::Models::ThemeListResponseItem], + Scalar::Internal::Type::ArrayOf[Scalar::Theme], Scalar::Internal::Type::Converter ) end diff --git a/rbi/scalar_api_ruby/models/user.rbi b/rbi/scalar_api_ruby/models/user.rbi new file mode 100644 index 0000000..3455b86 --- /dev/null +++ b/rbi/scalar_api_ruby/models/user.rbi @@ -0,0 +1,77 @@ +# typed: strong + +module Scalar + module Models + class User < Scalar::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(Scalar::User, Scalar::Internal::AnyHash) } + + sig { returns(T.nilable(String)) } + attr_accessor :active_team_id + + sig { returns(Integer) } + attr_accessor :created_at + + sig { returns(String) } + attr_accessor :email + + sig { returns(T::Boolean) } + attr_accessor :has_github + + sig { returns(T::Array[Scalar::TeamSummary]) } + attr_accessor :teams + + sig { returns(String) } + attr_accessor :uid + + sig { returns(Integer) } + attr_accessor :updated_at + + sig { returns(T.nilable(String)) } + attr_reader :theme + + sig { params(theme: String).void } + attr_writer :theme + + sig do + params( + active_team_id: T.nilable(String), + created_at: Integer, + email: String, + has_github: T::Boolean, + teams: T::Array[Scalar::TeamSummary::OrHash], + uid: String, + updated_at: Integer, + theme: String + ).returns(T.attached_class) + end + def self.new( + active_team_id:, + created_at:, + email:, + has_github:, + teams:, + uid:, + updated_at:, + theme: nil + ) + end + + sig do + override.returns( + { + active_team_id: T.nilable(String), + created_at: Integer, + email: String, + has_github: T::Boolean, + teams: T::Array[Scalar::TeamSummary], + uid: String, + updated_at: Integer, + theme: String + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/access_groups.rbi b/rbi/scalar_api_ruby/resources/access_groups.rbi new file mode 100644 index 0000000..c01ef93 --- /dev/null +++ b/rbi/scalar_api_ruby/resources/access_groups.rbi @@ -0,0 +1,70 @@ +# typed: strong + +module Scalar + module Resources + # Access Groups + class AccessGroups + # Access Groups + sig { returns(Scalar::Resources::AccessGroups::Domains) } + attr_reader :domains + + # Create a group for the current team. Requires docs edit permission and the + # access groups billing feature. Domains are exact email domains, without + # wildcards or implicit subdomain matching. + sig do + params( + allowed_domains: T.anything, + name: String, + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::AccessGroupCreateResponse) + end + def create( + allowed_domains: nil, + name: nil, + slug: nil, + request_options: {} + ) + end + + # Get a group and its email and domain allowlists by slug. + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::AccessGroupRetrieveResponse) + end + def retrieve(slug, request_options: {}) + end + + # Update group metadata. Requires docs edit permission. After changing the slug, + # use the new slug in subsequent requests. + sig do + params( + path_slug: String, + name: String, + body_slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def update(path_slug, name: nil, body_slug: nil, request_options: {}) + end + + # Delete a group and remove its project assignments. Requires docs edit + # permission. + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def delete(slug, request_options: {}) + end + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/access_groups/domains.rbi b/rbi/scalar_api_ruby/resources/access_groups/domains.rbi new file mode 100644 index 0000000..72a1c73 --- /dev/null +++ b/rbi/scalar_api_ruby/resources/access_groups/domains.rbi @@ -0,0 +1,39 @@ +# typed: strong + +module Scalar + module Resources + class AccessGroups + # Access Groups + class Domains + # Allow an exact email domain in a group. Requires docs edit permission. A group + # supports up to 1000 domains. + sig do + params( + slug: String, + domain: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def create(slug, domain:, request_options: {}) + end + + # Remove an exact email domain from a group. Requires docs edit permission. Other + # allowed domains and emails are preserved. + sig do + params( + slug: String, + domain: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def delete(slug, domain:, request_options: {}) + end + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/authentication.rbi b/rbi/scalar_api_ruby/resources/authentication.rbi index d558b7b..3c0c545 100644 --- a/rbi/scalar_api_ruby/resources/authentication.rbi +++ b/rbi/scalar_api_ruby/resources/authentication.rbi @@ -17,7 +17,7 @@ module Scalar # Get the authenticated user, including their available teams and theme. sig do params(request_options: Scalar::RequestOptions::OrHash).returns( - Scalar::Models::AuthenticationListCurrentUserResponse + Scalar::User ) end def list_current_user(request_options: {}) diff --git a/rbi/scalar_api_ruby/resources/login_portals.rbi b/rbi/scalar_api_ruby/resources/login_portals.rbi index 3695d37..a44aa81 100644 --- a/rbi/scalar_api_ruby/resources/login_portals.rbi +++ b/rbi/scalar_api_ruby/resources/login_portals.rbi @@ -41,7 +41,7 @@ module Scalar # List all login portals for the current team. sig do params(request_options: Scalar::RequestOptions::OrHash).returns( - T::Array[Scalar::Models::LoginPortalListResponseItem] + T::Array[Scalar::LoginPortal] ) end def list(request_options: {}) diff --git a/rbi/scalar_api_ruby/resources/mcp.rbi b/rbi/scalar_api_ruby/resources/mcp.rbi new file mode 100644 index 0000000..1477409 --- /dev/null +++ b/rbi/scalar_api_ruby/resources/mcp.rbi @@ -0,0 +1,16 @@ +# typed: strong + +module Scalar + module Resources + class Mcp + # MCP + sig { returns(Scalar::Resources::Mcp::Servers) } + attr_reader :servers + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/mcp/servers.rbi b/rbi/scalar_api_ruby/resources/mcp/servers.rbi new file mode 100644 index 0000000..f41fdcb --- /dev/null +++ b/rbi/scalar_api_ruby/resources/mcp/servers.rbi @@ -0,0 +1,91 @@ +# typed: strong + +module Scalar + module Resources + class Mcp + # MCP + class Servers + # MCP + sig { returns(Scalar::Resources::Mcp::Servers::Installations) } + attr_reader :installations + + # Create an MCP server over one or more API document versions. The response + # carries the server and its first installation. + sig do + params( + name: String, + project_uids: T::Array[String], + slug: String, + version_uids: T::Array[String], + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::Mcp::ServerCreateResponse) + end + def create( + name:, + project_uids: nil, + slug: nil, + version_uids: nil, + request_options: {} + ) + end + + # Get a single MCP server by its id. + sig do + params( + id: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Mcp::McpServer) + end + def retrieve(id, request_options: {}) + end + + # Update MCP server metadata and which tools it exposes. + sig do + params( + id: String, + auto_add_operations: T::Boolean, + docs_pages: T::Array[String], + name: String, + operations: T::Array[String], + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Mcp::McpServer) + end + def update( + id, + auto_add_operations: nil, + docs_pages: nil, + name: nil, + operations: nil, + slug: nil, + request_options: {} + ) + end + + # List every MCP server on the team. + sig do + params(request_options: Scalar::RequestOptions::OrHash).returns( + T::Array[Scalar::Mcp::McpServer] + ) + end + def list(request_options: {}) + end + + # Delete an MCP server and every installation it serves. + sig do + params( + id: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def delete(id, request_options: {}) + end + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/mcp/servers/installations.rbi b/rbi/scalar_api_ruby/resources/mcp/servers/installations.rbi new file mode 100644 index 0000000..e0cb0bc --- /dev/null +++ b/rbi/scalar_api_ruby/resources/mcp/servers/installations.rbi @@ -0,0 +1,140 @@ +# typed: strong + +module Scalar + module Resources + class Mcp + class Servers + # MCP + class Installations + # Create an installation of an MCP server. `documentAuth` holds the credentials + # the server presents to the upstream API and is never returned. + sig do + params( + id: String, + document_auth: T::Hash[Symbol, T.anything], + name: String, + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Mcp::McpInstallation) + end + def create(id, document_auth:, name:, slug: nil, request_options: {}) + end + + # Get a single installation of an MCP server. + sig do + params( + installation_id: String, + id: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Mcp::McpInstallation) + end + def retrieve(installation_id, id:, request_options: {}) + end + + # Update an installation. Set `isPrivate` and add access groups to put it behind a + # login. + sig do + params( + installation_id: String, + id: String, + document_auth: T::Hash[Symbol, T.anything], + is_private: T::Boolean, + login_portal_uid: T.nilable(String), + mcp_version: T.nilable(String), + name: String, + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Mcp::McpInstallation) + end + def update( + # Path param + installation_id, + # Path param + id:, + # Body param + document_auth: nil, + # Body param + is_private: nil, + # Body param + login_portal_uid: nil, + # Body param + mcp_version: nil, + # Body param + name: nil, + # Body param + slug: nil, + request_options: {} + ) + end + + # List the installations of an MCP server. An installation is what an MCP client + # connects to. + sig do + params( + id: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T::Array[Scalar::Mcp::Servers::McpInstallationListItem]) + end + def list(id, request_options: {}) + end + + # Delete an installation of an MCP server. + sig do + params( + installation_id: String, + id: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def delete(installation_id, id:, request_options: {}) + end + + # Let an access group reach a private installation. + sig do + params( + installation_id: String, + id: String, + access_group_uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def create_access_group( + # Path param + installation_id, + # Path param + id:, + # Body param + access_group_uid:, + request_options: {} + ) + end + + # Stop an access group reaching a private installation. + sig do + params( + installation_id: String, + id: String, + access_group_uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def delete_access_group( + # Path param + installation_id, + # Path param + id:, + # Body param + access_group_uid:, + request_options: {} + ) + end + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/o_auth.rbi b/rbi/scalar_api_ruby/resources/o_auth.rbi new file mode 100644 index 0000000..4624d4d --- /dev/null +++ b/rbi/scalar_api_ruby/resources/o_auth.rbi @@ -0,0 +1,87 @@ +# typed: strong + +module Scalar + module Resources + # OAuth + class OAuth + # Discovery document for OAuth clients (RFC 8414): where the endpoints are and + # what they support. + sig do + params(request_options: Scalar::RequestOptions::OrHash).returns( + Scalar::OauthAuthorizationServerMetadata + ) + end + def oauth_authorization_server_metadata(request_options: {}) + end + + # Authorization endpoint (RFC 6749 §4.1.1 with PKCE, RFC 7636). Validates the + # request and sends the user to the Scalar dashboard to approve it; the user + # returns to `redirect_uri` with a `code` to exchange at the token endpoint. Only + # `response_type=code` with `code_challenge_method=S256` is supported. + sig do + params(request_options: Scalar::RequestOptions::OrHash).returns( + T.anything + ) + end + def oauth_authorize(request_options: {}) + end + + # Revocation endpoint (RFC 7009). Revokes the refresh token and every token issued + # alongside it. The client authenticates as it does at the token endpoint. + # Responds 200 whether or not the token was live, as the RFC requires. + sig do + params( + token: String, + client_id: String, + client_secret: String, + token_type_hint: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::OauthError) + end + def oauth_revoke( + token:, + client_id: nil, + client_secret: nil, + token_type_hint: nil, + request_options: {} + ) + end + + # Token endpoint (RFC 6749 §4.1.3 and §6). Accepts + # `application/x-www-form-urlencoded`. Confidential clients authenticate with HTTP + # Basic or `client_secret` in the body; public clients send `client_id` alone. The + # `authorization_code` grant needs `code`, `redirect_uri` and `code_verifier`; the + # `refresh_token` grant needs `refresh_token` and may narrow `scope`. + sig do + params( + grant_type: String, + client_id: String, + client_secret: String, + code: String, + code_verifier: String, + redirect_uri: String, + refresh_token: String, + scope: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::OAuthOauthTokenResponse::Variants) + end + def oauth_token( + grant_type:, + client_id: nil, + client_secret: nil, + code: nil, + code_verifier: nil, + redirect_uri: nil, + refresh_token: nil, + scope: nil, + request_options: {} + ) + end + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/registry.rbi b/rbi/scalar_api_ruby/resources/registry.rbi index eec1e76..4efbec4 100644 --- a/rbi/scalar_api_ruby/resources/registry.rbi +++ b/rbi/scalar_api_ruby/resources/registry.rbi @@ -128,7 +128,7 @@ module Scalar # List all API documents across every namespace the caller can access. sig do params(request_options: Scalar::RequestOptions::OrHash).returns( - T::Array[Scalar::Models::RegistryListAllAPIDocumentsResponseItem] + T::Array[Scalar::APIDocument] ) end def list_all_api_documents(request_options: {}) @@ -157,9 +157,7 @@ module Scalar params( namespace: String, request_options: Scalar::RequestOptions::OrHash - ).returns( - T::Array[Scalar::Models::RegistryListAPIDocumentsResponseItem] - ) + ).returns(T::Array[Scalar::APIDocument]) end def list_api_documents(namespace, request_options: {}) end diff --git a/rbi/scalar_api_ruby/resources/rules.rbi b/rbi/scalar_api_ruby/resources/rules.rbi index 7494f9d..cf45e95 100644 --- a/rbi/scalar_api_ruby/resources/rules.rbi +++ b/rbi/scalar_api_ruby/resources/rules.rbi @@ -83,7 +83,7 @@ module Scalar params( namespace: String, request_options: Scalar::RequestOptions::OrHash - ).returns(T::Array[Scalar::Models::RuleListRulesetsResponseItem]) + ).returns(T::Array[Scalar::Rule]) end def list_rulesets(namespace, request_options: {}) end diff --git a/rbi/scalar_api_ruby/resources/scalar_docs.rbi b/rbi/scalar_api_ruby/resources/scalar_docs.rbi index f99fe87..22b3ea2 100644 --- a/rbi/scalar_api_ruby/resources/scalar_docs.rbi +++ b/rbi/scalar_api_ruby/resources/scalar_docs.rbi @@ -25,15 +25,98 @@ module Scalar ) end + # Create a docs project. Omit `provider` to have Scalar host the repository. + sig do + params( + name: String, + provider: Scalar::ScalarDocCreateProjectParams::Provider::OrSymbol, + bitbucket_repository: + Scalar::ScalarDocCreateProjectParams::BitbucketRepository::OrHash, + blank: T::Boolean, + github_repository: + Scalar::ScalarDocCreateProjectParams::GithubRepository::OrHash, + is_private: T::Boolean, + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::DocsProject) + end + def create_project( + name:, + provider:, + bitbucket_repository: nil, + blank: nil, + github_repository: nil, + is_private: nil, + slug: nil, + request_options: {} + ) + end + + # Delete a docs project, its deploys, its publish records and its cached builds. + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def delete_project(slug, request_options: {}) + end + # List all guide projects. sig do params(request_options: Scalar::RequestOptions::OrHash).returns( - T::Array[Scalar::Models::ScalarDocListGuidesResponseItem] + T::Array[Scalar::GithubProject] ) end def list_guides(request_options: {}) end + # Read `scalar.config.json` straight from the project repository, without cloning + # it. `baseToken` is the compare-and-swap handle for a later write. + sig do + params( + slug: String, + ref: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::ScalarDocListProjectConfigResponse) + end + def list_project_config(slug, ref: nil, request_options: {}) + end + + # The domains the project serves on — the Scalar-hosted one and the custom one, + # when set. + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::ScalarDocListProjectDomainResponse) + end + def list_project_domain(slug, request_options: {}) + end + + # Whether the project custom domain points at Scalar yet. `expected` is the CNAME + # record to create; `found` is what resolves today. A project with no custom + # domain reports `verified` with no expected record, because Scalar serves its own + # subdomain directly. + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::ScalarDocListProjectDomainStatusResponse) + end + def list_project_domain_status(slug, request_options: {}) + end + + # List every docs project on the team. + sig do + params( + limit: Integer, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::ScalarDocListProjectsResponse) + end + def list_projects(limit: nil, request_options: {}) + end + # Start a new publish process. sig do params( @@ -44,6 +127,90 @@ module Scalar def publish_guide(slug, request_options: {}) end + # Start a build and deploy. The returned `publishUid` identifies the publish + # record. + sig do + params( + slug: String, + commit_sha: String, + config_path: String, + preview: T::Boolean, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::ScalarDocPublishProjectResponse) + end + def publish_project( + slug, + commit_sha: nil, + config_path: nil, + preview: nil, + request_options: {} + ) + end + + # Get a single docs project by its slug. + sig do + params( + slug: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::DocsProject) + end + def retrieve_project(slug, request_options: {}) + end + + # Update project settings. Set `isPrivate` with `accessGroups` to put the site + # behind a login. + sig do + params( + slug: String, + access_groups: T::Array[String], + active_theme_id: String, + agent_enabled: T::Boolean, + analytics_enabled: T::Boolean, + is_private: T::Boolean, + login_portal_uid: + Scalar::ScalarDocUpdateProjectParams::LoginPortalUID::Variants, + name: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def update_project( + slug, + access_groups: nil, + active_theme_id: nil, + agent_enabled: nil, + analytics_enabled: nil, + is_private: nil, + login_portal_uid: nil, + name: nil, + request_options: {} + ) + end + + # Commit `scalar.config.json` straight to the project repository. Pass the + # `baseToken` from the read this edit was based on; a conflict means the file + # moved underneath it. + sig do + params( + slug: String, + content: String, + base_token: String, + message: String, + path: String, + ref: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::ScalarDocUpdateProjectConfigResponse) + end + def update_project_config( + slug, + content:, + base_token: nil, + message: nil, + path: nil, + ref: nil, + request_options: {} + ) + end + # @api private sig { params(client: Scalar::Client).returns(T.attached_class) } def self.new(client:) diff --git a/rbi/scalar_api_ruby/resources/schemas.rbi b/rbi/scalar_api_ruby/resources/schemas.rbi index 09e5101..e4a2643 100644 --- a/rbi/scalar_api_ruby/resources/schemas.rbi +++ b/rbi/scalar_api_ruby/resources/schemas.rbi @@ -68,7 +68,7 @@ module Scalar params( namespace: String, request_options: Scalar::RequestOptions::OrHash - ).returns(T::Array[Scalar::Models::SchemaListResponseItem]) + ).returns(T::Array[Scalar::Schema]) end def list(namespace, request_options: {}) end diff --git a/rbi/scalar_api_ruby/resources/sdks.rbi b/rbi/scalar_api_ruby/resources/sdks.rbi new file mode 100644 index 0000000..25a3e18 --- /dev/null +++ b/rbi/scalar_api_ruby/resources/sdks.rbi @@ -0,0 +1,112 @@ +# typed: strong + +module Scalar + module Resources + # SDKs + class Sdks + # SDKs + sig { returns(Scalar::Resources::Sdks::Versions) } + attr_reader :versions + + # SDKs + sig { returns(Scalar::Resources::Sdks::Repositories) } + attr_reader :repositories + + # Create an SDK from an API document, targeting one or more languages. + sig do + params( + api_uid: String, + languages: T::Array[Scalar::SdkCreateParams::Language::OrSymbol], + class_name: String, + config: String, + slug: String, + title: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::UID) + end + def create( + api_uid:, + languages:, + class_name: nil, + config: nil, + slug: nil, + title: nil, + request_options: {} + ) + end + + # Get a single SDK by its uid. + sig do + params( + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Sdk) + end + def retrieve(uid, request_options: {}) + end + + # Update SDK metadata, its linked API, or its config. + sig do + params( + uid: String, + api_uid: T.nilable(String), + api_version: T.nilable(String), + config: String, + is_private: T::Boolean, + slug: String, + title: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def update( + uid, + api_uid: nil, + api_version: nil, + config: nil, + is_private: nil, + slug: nil, + title: nil, + request_options: {} + ) + end + + # List every SDK on the team. + sig do + params( + limit: Integer, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::SdkListResponse) + end + def list(limit: nil, request_options: {}) + end + + # Delete an SDK and every version it holds. + sig do + params( + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def delete(uid, request_options: {}) + end + + # Start a build. Omit `version` to build the current work — the open draft, else + # the latest version — and the resolved version comes back in the response. + sig do + params( + uid: String, + languages: T::Array[Scalar::SdkBuildParams::Language::OrSymbol], + version: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::SdkBuildResponse) + end + def build(uid, languages: nil, version: nil, request_options: {}) + end + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/sdks/repositories.rbi b/rbi/scalar_api_ruby/resources/sdks/repositories.rbi new file mode 100644 index 0000000..f38c45f --- /dev/null +++ b/rbi/scalar_api_ruby/resources/sdks/repositories.rbi @@ -0,0 +1,79 @@ +# typed: strong + +module Scalar + module Resources + class Sdks + # SDKs + class Repositories + # Link one language target to a GitHub repository, so builds sync there. + sig do + params( + uid: String, + base_branch: String, + language: Scalar::Sdks::RepositoryLinkParams::Language::OrSymbol, + repository_id: Integer, + prerelease_type: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(Scalar::Models::Sdks::RepositoryLinkResponse) + end + def link( + uid, + base_branch:, + language:, + repository_id:, + prerelease_type: nil, + request_options: {} + ) + end + + # Unlink one language target from its repository. + sig do + params( + language: Scalar::Sdks::RepositoryUnlinkParams::Language::OrSymbol, + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def unlink(language, uid:, request_options: {}) + end + + # Toggle publish-on-merge and the release settings for a linked target. + sig do + params( + language: + Scalar::Sdks::RepositoryUpdatePublishingParams::Language::OrSymbol, + uid: String, + publish_on_merge: T::Boolean, + access: + Scalar::Sdks::RepositoryUpdatePublishingParams::Access::OrSymbol, + auth_method: + Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod::OrSymbol, + tag: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def update_publishing( + # Path param + language, + # Path param + uid:, + # Body param + publish_on_merge:, + # Body param + access: nil, + # Body param + auth_method: nil, + # Body param + tag: nil, + request_options: {} + ) + end + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/sdks/versions.rbi b/rbi/scalar_api_ruby/resources/sdks/versions.rbi new file mode 100644 index 0000000..26b4e6e --- /dev/null +++ b/rbi/scalar_api_ruby/resources/sdks/versions.rbi @@ -0,0 +1,38 @@ +# typed: strong + +module Scalar + module Resources + class Sdks + # SDKs + class Versions + # Create a new SDK version against a specific API version. + sig do + params( + uid: String, + api_version: String, + version: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def create(uid, api_version:, version:, request_options: {}) + end + + # Permanently delete one version of an SDK. + sig do + params( + version: String, + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def delete(version, uid:, request_options: {}) + end + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/teams.rbi b/rbi/scalar_api_ruby/resources/teams.rbi index 9e36d7b..3ecb071 100644 --- a/rbi/scalar_api_ruby/resources/teams.rbi +++ b/rbi/scalar_api_ruby/resources/teams.rbi @@ -4,10 +4,18 @@ module Scalar module Resources # Teams class Teams + # Teams + sig { returns(Scalar::Resources::Teams::Members) } + attr_reader :members + + # Teams + sig { returns(Scalar::Resources::Teams::Invites) } + attr_reader :invites + # List all available teams sig do params(request_options: Scalar::RequestOptions::OrHash).returns( - T::Array[Scalar::Models::TeamListResponseItem] + T::Array[Scalar::Team] ) end def list(request_options: {}) diff --git a/rbi/scalar_api_ruby/resources/teams/invites.rbi b/rbi/scalar_api_ruby/resources/teams/invites.rbi new file mode 100644 index 0000000..956f70d --- /dev/null +++ b/rbi/scalar_api_ruby/resources/teams/invites.rbi @@ -0,0 +1,46 @@ +# typed: strong + +module Scalar + module Resources + class Teams + # Teams + class Invites + # Withdraw an invite that has not been accepted. + sig do + params( + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def cancel(uid, request_options: {}) + end + + # Invite someone to the current team by email. + sig do + params( + email: String, + role: Scalar::Teams::Role::OrSymbol, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def member(email:, role:, request_options: {}) + end + + # Send the invite email again. + sig do + params( + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def resend(uid, request_options: {}) + end + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/teams/members.rbi b/rbi/scalar_api_ruby/resources/teams/members.rbi new file mode 100644 index 0000000..bd9f981 --- /dev/null +++ b/rbi/scalar_api_ruby/resources/teams/members.rbi @@ -0,0 +1,45 @@ +# typed: strong + +module Scalar + module Resources + class Teams + # Teams + class Members + # Change what a member of the current team is allowed to do. + sig do + params( + uid: String, + role: Scalar::Teams::Role::OrSymbol, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def update(uid, role:, request_options: {}) + end + + # List the members of the current team, along with the invites still outstanding. + sig do + params(request_options: Scalar::RequestOptions::OrHash).returns( + Scalar::Models::Teams::MemberListResponse + ) + end + def list(request_options: {}) + end + + # Remove someone from the current team. + sig do + params( + uid: String, + request_options: Scalar::RequestOptions::OrHash + ).returns(T.anything) + end + def delete(uid, request_options: {}) + end + + # @api private + sig { params(client: Scalar::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end + end +end diff --git a/rbi/scalar_api_ruby/resources/themes.rbi b/rbi/scalar_api_ruby/resources/themes.rbi index dffcf67..8194433 100644 --- a/rbi/scalar_api_ruby/resources/themes.rbi +++ b/rbi/scalar_api_ruby/resources/themes.rbi @@ -42,7 +42,7 @@ module Scalar # List all team themes. sig do params(request_options: Scalar::RequestOptions::OrHash).returns( - T::Array[Scalar::Models::ThemeListResponseItem] + T::Array[Scalar::Theme] ) end def list(request_options: {}) diff --git a/reference.md b/reference.md index 1eca806..c7322fb 100644 --- a/reference.md +++ b/reference.md @@ -28,6 +28,12 @@ - `login_portals.update(...)` — `PATCH /v1/login-portals/{slug}` - `login_portals.list(...)` — `GET /v1/login-portals` - `login_portals.delete(...)` — `DELETE /v1/login-portals/{slug}` +- `access_groups.create(...)` — `POST /v1/access-groups` +- `access_groups.retrieve(...)` — `GET /v1/access-groups/{slug}` +- `access_groups.update(...)` — `PATCH /v1/access-groups/{slug}` +- `access_groups.delete(...)` — `DELETE /v1/access-groups/{slug}` +- `access_groups.domains.create(...)` — `POST /v1/access-groups/{slug}/domains` +- `access_groups.domains.delete(...)` — `DELETE /v1/access-groups/{slug}/domains` - `rules.create_ruleset(...)` — `POST /v1/rulesets/{namespace}` - `rules.create_ruleset_access_group(...)` — `POST /v1/rulesets/{namespace}/{slug}/access-group` - `rules.delete_ruleset(...)` — `DELETE /v1/rulesets/{namespace}/{slug}` @@ -42,9 +48,52 @@ - `themes.delete(...)` — `DELETE /v1/themes/{slug}` - `themes.replace_document(...)` — `PUT /v1/themes/{slug}` - `teams.list(...)` — `GET /v1/teams` +- `teams.members.update(...)` — `PATCH /v1/teams/members/{uid}` +- `teams.members.list(...)` — `GET /v1/teams/members` +- `teams.members.delete(...)` — `DELETE /v1/teams/members/{uid}` +- `teams.invites.cancel(...)` — `DELETE /v1/teams/invites/{uid}` +- `teams.invites.member(...)` — `POST /v1/teams/invites` +- `teams.invites.resend(...)` — `PATCH /v1/teams/invites/{uid}` - `scalar_docs.create_guide(...)` — `POST /v1/guides` +- `scalar_docs.create_project(...)` — `POST /v1/docs` +- `scalar_docs.delete_project(...)` — `DELETE /v1/docs/{slug}` - `scalar_docs.list_guides(...)` — `GET /v1/guides` +- `scalar_docs.list_project_config(...)` — `GET /v1/docs/{slug}/config` +- `scalar_docs.list_project_domain(...)` — `GET /v1/docs/{slug}/domain` +- `scalar_docs.list_project_domain_status(...)` — `GET /v1/docs/{slug}/domain/status` +- `scalar_docs.list_projects(...)` — `GET /v1/docs` - `scalar_docs.publish_guide(...)` — `POST /v1/guides/{slug}/publish` +- `scalar_docs.publish_project(...)` — `POST /v1/docs/{slug}/publish` +- `scalar_docs.retrieve_project(...)` — `GET /v1/docs/{slug}` +- `scalar_docs.update_project(...)` — `PATCH /v1/docs/{slug}` +- `scalar_docs.update_project_config(...)` — `PUT /v1/docs/{slug}/config` - `namespaces.list(...)` — `GET /v1/namespaces` - `authentication.exchange_personal_token(...)` — `POST /v1/auth/exchange` - `authentication.list_current_user(...)` — `GET /v1/auth/me` +- `sdks.create(...)` — `POST /v1/sdks` +- `sdks.retrieve(...)` — `GET /v1/sdks/{uid}` +- `sdks.update(...)` — `PATCH /v1/sdks/{uid}` +- `sdks.list(...)` — `GET /v1/sdks` +- `sdks.delete(...)` — `DELETE /v1/sdks/{uid}` +- `sdks.build(...)` — `POST /v1/sdks/{uid}/build` +- `sdks.versions.create(...)` — `POST /v1/sdks/{uid}/versions` +- `sdks.versions.delete(...)` — `DELETE /v1/sdks/{uid}/versions/{version}` +- `sdks.repositories.link(...)` — `POST /v1/sdks/{uid}/repositories` +- `sdks.repositories.unlink(...)` — `DELETE /v1/sdks/{uid}/repositories/{language}` +- `sdks.repositories.update_publishing(...)` — `POST /v1/sdks/{uid}/repositories/{language}/publishing` +- `mcp.servers.create(...)` — `POST /v1/mcp/servers` +- `mcp.servers.retrieve(...)` — `GET /v1/mcp/servers/{id}` +- `mcp.servers.update(...)` — `PATCH /v1/mcp/servers/{id}` +- `mcp.servers.list(...)` — `GET /v1/mcp/servers` +- `mcp.servers.delete(...)` — `DELETE /v1/mcp/servers/{id}` +- `mcp.servers.installations.create(...)` — `POST /v1/mcp/servers/{id}/installations` +- `mcp.servers.installations.retrieve(...)` — `GET /v1/mcp/servers/{id}/installations/{installationId}` +- `mcp.servers.installations.update(...)` — `PATCH /v1/mcp/servers/{id}/installations/{installationId}` +- `mcp.servers.installations.list(...)` — `GET /v1/mcp/servers/{id}/installations` +- `mcp.servers.installations.delete(...)` — `DELETE /v1/mcp/servers/{id}/installations/{installationId}` +- `mcp.servers.installations.create_access_group(...)` — `POST /v1/mcp/servers/{id}/installations/{installationId}/access-group` +- `mcp.servers.installations.delete_access_group(...)` — `DELETE /v1/mcp/servers/{id}/installations/{installationId}/access-group` +- `o_auth.oauth_authorization_server_metadata(...)` — `GET /.well-known/oauth-authorization-server` +- `o_auth.oauth_authorize(...)` — `GET /v1/oauth/authorize` +- `o_auth.oauth_revoke(...)` — `POST /v1/oauth/revoke` +- `o_auth.oauth_token(...)` — `POST /v1/oauth/token` diff --git a/scalar-sdk.manifest.json b/scalar-sdk.manifest.json index be91ffa..a3e3a29 100644 --- a/scalar-sdk.manifest.json +++ b/scalar-sdk.manifest.json @@ -1218,6 +1218,33 @@ "additionalProperties": false } }, + { + "name": "access_group_name", + "source": "access_group_name", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 40 + } + } + }, + { + "name": "email_domain", + "source": "email_domain", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "pattern": "^([A-Za-z0-9]+(-[A-Za-z0-9]+)*\\.)+[A-Za-z]{2,}$", + "maxLength": 253 + } + } + }, { "name": "rule", "source": "rule", @@ -1427,6 +1454,137 @@ "type": "string" } }, + { + "name": "team_member", + "source": "team_member", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "uid", + "publicName": "uid", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "nanoid" + } + }, + { + "name": "role", + "publicName": "role", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "role" + } + }, + { + "name": "displayName", + "publicName": "displayName", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "imageUri", + "publicName": "imageUri", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + } + ], + "additionalProperties": false + } + }, + { + "name": "role", + "source": "role", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "enum", + "values": [ + "owner", + "admin", + "editor", + "viewer" + ], + "names": [ + "Owner", + "Admin", + "Editor", + "Viewer" + ], + "deprecations": [ + false, + false, + false, + false + ] + } + }, + { + "name": "team_invite", + "source": "team_invite", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "uid", + "publicName": "uid", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "nanoid" + } + }, + { + "name": "email", + "publicName": "email", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "email" + } + }, + { + "name": "role", + "publicName": "role", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "role" + } + }, + { + "name": "expires", + "publicName": "expires", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "number" + } + } + ], + "additionalProperties": false + } + }, { "name": "email", "source": "email", @@ -1965,118 +2123,9648 @@ ], "additionalProperties": false } - } - ], - "resources": [ - "registry", - "schemas", - "schemas.version", - "schemas.accessGroup", - "loginPortals", - "rules", - "themes", - "teams", - "scalarDocs", - "namespaces", - "authentication" - ], - "publicResources": [ - "registry", - "schemas", - "schemas.version", - "schemas.accessGroup", - "loginPortals", - "rules", - "themes", - "teams", - "scalarDocs", - "namespaces", - "authentication" - ], - "operations": [ + }, { - "resource": "registry", - "publicResource": "registry", - "operation": "listAllApiDocuments", - "publicOperation": "listAllApiDocuments", + "name": "sdk", + "source": "sdk", + "publicAliases": [], "deprecated": false, - "method": "GET", - "path": "/v1/apis", - "pathParams": [], - "publicPathParams": [], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], - "queryParamDetails": [], - "headerParamDetails": [], - "cookieParams": [], - "publicCookieParams": [], - "cookieParamDetails": [], - "response": { - "status": "200", - "contentType": "application/json", - "encoding": "json", - "contents": [ + "type": { + "kind": "object", + "properties": [ { - "contentType": "application/json", - "encoding": "json" - } - ] - }, - "result": { - "successStatus": "200", - "errorStatuses": [ - "400", - "401", - "403", - "404", - "422", - "500" - ] - }, - "errorResponses": [ - { - "status": "400", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" + "name": "uid", + "publicName": "uid", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "nanoid" } - ], - "model": { - "name": "400", - "publicAliases": [] - } - }, - { - "status": "401", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" + }, + { + "name": "title", + "publicName": "title", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 100 + } } - ], - "model": { - "name": "401", - "publicAliases": [] - } - }, - { - "status": "403", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", + }, + { + "name": "slug", + "publicName": "slug", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "slug" + } + }, + { + "name": "namespace", + "publicName": "namespace", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "namespace" + } + }, + { + "name": "description", + "publicName": "description", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "isPrivate", + "publicName": "isPrivate", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "boolean" + } + }, + { + "name": "apiUid", + "publicName": "apiUid", + "required": true, + "deprecated": false, + "type": { + "kind": "union", + "variants": [ + { + "kind": "ref", + "name": "nanoid" + }, + { + "kind": "null" + } + ] + } + }, + { + "name": "apiVersion", + "publicName": "apiVersion", + "required": false, + "deprecated": false, + "type": { + "kind": "union", + "variants": [ + { + "kind": "ref", + "name": "version" + }, + { + "kind": "null" + } + ] + } + }, + { + "name": "currentVersion", + "publicName": "currentVersion", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "version" + } + }, + { + "name": "targets", + "publicName": "targets", + "required": true, + "deprecated": false, + "type": { + "kind": "array", + "items": { + "kind": "ref", + "name": "sdk_target_summary" + } + } + }, + { + "name": "versions", + "publicName": "versions", + "required": true, + "deprecated": false, + "type": { + "kind": "array", + "items": { + "kind": "ref", + "name": "sdk_version" + } + } + } + ], + "additionalProperties": false + } + }, + { + "name": "sdk_target_summary", + "source": "sdk_target_summary", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "language", + "publicName": "language", + "required": true, + "deprecated": false, + "type": { + "kind": "enum", + "values": [ + "typescript", + "python", + "cli", + "csharp", + "java", + "ruby", + "php", + "go", + "rust", + "kotlin", + "swift", + "cpp", + "dart" + ], + "names": [ + "Typescript", + "Python", + "Cli", + "Csharp", + "Java", + "Ruby", + "Php", + "Go", + "Rust", + "Kotlin", + "Swift", + "Cpp", + "Dart" + ], + "deprecations": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ] + } + }, + { + "name": "slug", + "publicName": "slug", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "slug" + } + } + ], + "additionalProperties": false + } + }, + { + "name": "sdk_version", + "source": "sdk_version", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "version", + "publicName": "version", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "version" + } + }, + { + "name": "apiVersion", + "publicName": "apiVersion", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "version" + } + }, + { + "name": "status", + "publicName": "status", + "required": true, + "deprecated": false, + "type": { + "kind": "enum", + "values": [ + "draft", + "published" + ], + "names": [ + "Draft", + "Published" + ], + "deprecations": [ + false, + false + ] + } + }, + { + "name": "languages", + "publicName": "languages", + "required": true, + "deprecated": false, + "type": { + "kind": "array", + "items": { + "kind": "enum", + "values": [ + "typescript", + "python", + "cli", + "csharp", + "java", + "ruby", + "php", + "go", + "rust", + "kotlin", + "swift", + "cpp", + "dart" + ], + "names": [ + "Typescript", + "Python", + "Cli", + "Csharp", + "Java", + "Ruby", + "Php", + "Go", + "Rust", + "Kotlin", + "Swift", + "Cpp", + "Dart" + ], + "deprecations": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ] + } + } + }, + { + "name": "publishedAt", + "publicName": "publishedAt", + "required": false, + "deprecated": false, + "type": { + "kind": "ref", + "name": "timestamp" + } + }, + { + "name": "createdAt", + "publicName": "createdAt", + "required": false, + "deprecated": false, + "type": { + "kind": "ref", + "name": "timestamp" + } + } + ], + "additionalProperties": false + } + }, + { + "name": "docs_project", + "source": "docs_project", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "uid", + "publicName": "uid", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "nanoid" + } + }, + { + "name": "name", + "publicName": "name", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "slug", + "publicName": "slug", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "slug" + } + }, + { + "name": "isPrivate", + "publicName": "isPrivate", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "boolean" + } + }, + { + "name": "accessGroups", + "publicName": "accessGroups", + "required": true, + "deprecated": false, + "type": { + "kind": "unknown" + } + }, + { + "name": "loginPortalUid", + "publicName": "loginPortalUid", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "activeThemeId", + "publicName": "activeThemeId", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "agentEnabled", + "publicName": "agentEnabled", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "boolean" + } + }, + { + "name": "analyticsEnabled", + "publicName": "analyticsEnabled", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "boolean" + } + }, + { + "name": "lastPublished", + "publicName": "lastPublished", + "required": true, + "deprecated": false, + "type": { + "kind": "union", + "variants": [ + { + "kind": "ref", + "name": "timestamp" + }, + { + "kind": "null" + } + ] + } + }, + { + "name": "publishStatus", + "publicName": "publishStatus", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + } + ], + "additionalProperties": false + } + }, + { + "name": "mcp_server", + "source": "mcp_server", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "id", + "publicName": "id", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "name", + "publicName": "name", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "slug", + "publicName": "slug", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "slug" + } + }, + { + "name": "autoAddOperations", + "publicName": "autoAddOperations", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "boolean" + } + }, + { + "name": "createdAt", + "publicName": "createdAt", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "updatedAt", + "publicName": "updatedAt", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + } + ], + "additionalProperties": false + } + }, + { + "name": "mcp_installation", + "source": "mcp_installation", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "id", + "publicName": "id", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "mcpServerId", + "publicName": "mcpServerId", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "name", + "publicName": "name", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "slug", + "publicName": "slug", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "slug" + } + }, + { + "name": "isPrivate", + "publicName": "isPrivate", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "boolean" + } + }, + { + "name": "accessGroups", + "publicName": "accessGroups", + "required": true, + "deprecated": false, + "type": { + "kind": "array", + "items": { + "kind": "primitive", + "type": "string" + } + } + }, + { + "name": "loginPortalUid", + "publicName": "loginPortalUid", + "required": true, + "deprecated": false, + "type": { + "kind": "union", + "variants": [ + { + "kind": "primitive", + "type": "string" + }, + { + "kind": "null" + } + ] + } + }, + { + "name": "mcpVersion", + "publicName": "mcpVersion", + "required": true, + "deprecated": false, + "type": { + "kind": "union", + "variants": [ + { + "kind": "primitive", + "type": "string" + }, + { + "kind": "null" + } + ] + } + }, + { + "name": "piiRedactionEnabled", + "publicName": "piiRedactionEnabled", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "boolean" + } + }, + { + "name": "credentialRedactionEnabled", + "publicName": "credentialRedactionEnabled", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "boolean" + } + } + ], + "additionalProperties": false + } + }, + { + "name": "mcp_installation_list_item", + "source": "mcp_installation_list_item", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "id", + "publicName": "id", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "name", + "publicName": "name", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "slug", + "publicName": "slug", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "slug" + } + }, + { + "name": "isPrivate", + "publicName": "isPrivate", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "boolean" + } + }, + { + "name": "mcpVersion", + "publicName": "mcpVersion", + "required": true, + "deprecated": false, + "type": { + "kind": "union", + "variants": [ + { + "kind": "primitive", + "type": "string" + }, + { + "kind": "null" + } + ] + } + } + ], + "additionalProperties": false + } + }, + { + "name": "oauth_token", + "source": "oauth_token", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "access_token", + "publicName": "access_token", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "token_type", + "publicName": "token_type", + "required": true, + "deprecated": false, + "type": { + "kind": "literal", + "value": "Bearer" + } + }, + { + "name": "expires_in", + "publicName": "expires_in", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "integer", + "validation": { + "minimum": -9007199254740991, + "maximum": 9007199254740991 + } + } + }, + { + "name": "refresh_token", + "publicName": "refresh_token", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "scope", + "publicName": "scope", + "required": true, + "deprecated": false, + "type": { + "kind": "ref", + "name": "oauth_scope" + } + } + ], + "additionalProperties": false + } + }, + { + "name": "oauth_scope", + "source": "oauth_scope", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "enum", + "values": [ + "read", + "write", + "admin" + ], + "names": [ + "Read", + "Write", + "Admin" + ], + "deprecations": [ + false, + false, + false + ] + } + }, + { + "name": "oauth_error", + "source": "oauth_error", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "error", + "publicName": "error", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "error_description", + "publicName": "error_description", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + } + ], + "additionalProperties": false + } + }, + { + "name": "oauth_token_request", + "source": "oauth_token_request", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "grant_type", + "publicName": "grant_type", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 64 + } + } + }, + { + "name": "client_id", + "publicName": "client_id", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 256 + } + } + }, + { + "name": "client_secret", + "publicName": "client_secret", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 256 + } + } + }, + { + "name": "code", + "publicName": "code", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 256 + } + } + }, + { + "name": "redirect_uri", + "publicName": "redirect_uri", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 2048 + } + } + }, + { + "name": "code_verifier", + "publicName": "code_verifier", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 256 + } + } + }, + { + "name": "refresh_token", + "publicName": "refresh_token", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 4096 + } + } + }, + { + "name": "scope", + "publicName": "scope", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 256 + } + } + } + ], + "additionalProperties": false + } + }, + { + "name": "oauth_revoke_request", + "source": "oauth_revoke_request", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "token", + "publicName": "token", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 4096 + } + } + }, + { + "name": "token_type_hint", + "publicName": "token_type_hint", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 64 + } + } + }, + { + "name": "client_id", + "publicName": "client_id", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 256 + } + } + }, + { + "name": "client_secret", + "publicName": "client_secret", + "required": false, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string", + "validation": { + "maxLength": 256 + } + } + } + ], + "additionalProperties": false + } + }, + { + "name": "oauth_authorization_server_metadata", + "source": "oauth_authorization_server_metadata", + "publicAliases": [], + "deprecated": false, + "type": { + "kind": "object", + "properties": [ + { + "name": "issuer", + "publicName": "issuer", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "authorization_endpoint", + "publicName": "authorization_endpoint", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "token_endpoint", + "publicName": "token_endpoint", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "revocation_endpoint", + "publicName": "revocation_endpoint", + "required": true, + "deprecated": false, + "type": { + "kind": "primitive", + "type": "string" + } + }, + { + "name": "response_types_supported", + "publicName": "response_types_supported", + "required": true, + "deprecated": false, + "type": { + "kind": "array", + "items": { + "kind": "primitive", + "type": "string" + } + } + }, + { + "name": "grant_types_supported", + "publicName": "grant_types_supported", + "required": true, + "deprecated": false, + "type": { + "kind": "array", + "items": { + "kind": "primitive", + "type": "string" + } + } + }, + { + "name": "code_challenge_methods_supported", + "publicName": "code_challenge_methods_supported", + "required": true, + "deprecated": false, + "type": { + "kind": "array", + "items": { + "kind": "primitive", + "type": "string" + } + } + }, + { + "name": "token_endpoint_auth_methods_supported", + "publicName": "token_endpoint_auth_methods_supported", + "required": true, + "deprecated": false, + "type": { + "kind": "array", + "items": { + "kind": "primitive", + "type": "string" + } + } + }, + { + "name": "revocation_endpoint_auth_methods_supported", + "publicName": "revocation_endpoint_auth_methods_supported", + "required": true, + "deprecated": false, + "type": { + "kind": "array", + "items": { + "kind": "primitive", + "type": "string" + } + } + }, + { + "name": "scopes_supported", + "publicName": "scopes_supported", + "required": true, + "deprecated": false, + "type": { + "kind": "array", + "items": { + "kind": "primitive", + "type": "string" + } + } + } + ], + "additionalProperties": false + } + } + ], + "resources": [ + "registry", + "schemas", + "schemas.version", + "schemas.accessGroup", + "loginPortals", + "accessGroups", + "accessGroups.domains", + "rules", + "themes", + "teams", + "teams.members", + "teams.invites", + "scalarDocs", + "namespaces", + "authentication", + "sdks", + "sdks.versions", + "sdks.repositories", + "mcp", + "mcp.servers", + "mcp.servers.installations", + "oAuth" + ], + "publicResources": [ + "registry", + "schemas", + "schemas.version", + "schemas.accessGroup", + "loginPortals", + "accessGroups", + "accessGroups.domains", + "rules", + "themes", + "teams", + "teams.members", + "teams.invites", + "scalarDocs", + "namespaces", + "authentication", + "sdks", + "sdks.versions", + "sdks.repositories", + "mcp", + "mcp.servers", + "mcp.servers.installations", + "oAuth" + ], + "operations": [ + { + "resource": "registry", + "publicResource": "registry", + "operation": "listAllApiDocuments", + "publicOperation": "listAllApiDocuments", + "deprecated": false, + "method": "GET", + "path": "/v1/apis", + "pathParams": [], + "publicPathParams": [], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "listApiDocuments", + "publicOperation": "listApiDocuments", + "deprecated": false, + "method": "GET", + "path": "/v1/apis/{namespace}", + "pathParams": [ + "namespace" + ], + "publicPathParams": [ + "namespace" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryListApiDocumentsParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "createApiDocument", + "publicOperation": "createApiDocument", + "deprecated": false, + "method": "POST", + "path": "/v1/apis/{namespace}", + "pathParams": [ + "namespace" + ], + "publicPathParams": [ + "namespace" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "title", + "description", + "version", + "slug", + "ruleset", + "isPrivate", + "document" + ], + "publicBodyParams": [ + "title", + "description", + "version", + "slug", + "ruleset", + "isPrivate", + "document" + ], + "bodyParamDetails": [ + { + "name": "title", + "required": true + }, + { + "name": "description", + "required": false + }, + { + "name": "version", + "required": true + }, + { + "name": "slug", + "required": true + }, + { + "name": "ruleset", + "required": false + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "document", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryCreateApiDocumentParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "updateApiDocument", + "publicOperation": "updateApiDocument", + "deprecated": false, + "method": "PATCH", + "path": "/v1/apis/{namespace}/{slug}", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "title", + "description", + "isPrivate", + "ruleset" + ], + "publicBodyParams": [ + "title", + "description", + "isPrivate", + "ruleset" + ], + "bodyParamDetails": [ + { + "name": "title", + "required": false + }, + { + "name": "description", + "required": false + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "ruleset", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryUpdateApiDocumentParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "deleteApiDocument", + "publicOperation": "deleteApiDocument", + "deprecated": false, + "method": "DELETE", + "path": "/v1/apis/{namespace}/{slug}", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryDeleteApiDocumentParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "retrieveApiDocumentVersion", + "publicOperation": "retrieveApiDocumentVersion", + "deprecated": false, + "method": "GET", + "path": "/v1/apis/{namespace}/{slug}/version/{semver}", + "pathParams": [ + "namespace", + "slug", + "semver" + ], + "publicPathParams": [ + "namespace", + "slug", + "semver" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryRetrieveApiDocumentVersionParams" + }, + "response": { + "status": "200", + "contentType": "text/plain", + "encoding": "text", + "contents": [ + { + "contentType": "text/plain", + "encoding": "text" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "updateApiDocumentVersion", + "publicOperation": "updateApiDocumentVersion", + "deprecated": false, + "method": "PATCH", + "path": "/v1/apis/{namespace}/{slug}/version/{semver}", + "pathParams": [ + "namespace", + "slug", + "semver" + ], + "publicPathParams": [ + "namespace", + "slug", + "semver" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "document" + ], + "publicBodyParams": [ + "document" + ], + "bodyParamDetails": [ + { + "name": "document", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryUpdateApiDocumentVersionParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "deleteApiDocumentVersion", + "publicOperation": "deleteApiDocumentVersion", + "deprecated": false, + "method": "DELETE", + "path": "/v1/apis/{namespace}/{slug}/version/{semver}", + "pathParams": [ + "namespace", + "slug", + "semver" + ], + "publicPathParams": [ + "namespace", + "slug", + "semver" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryDeleteApiDocumentVersionParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "listApiDocumentVersionMetadata", + "publicOperation": "listApiDocumentVersionMetadata", + "deprecated": false, + "method": "GET", + "path": "/v1/apis/{namespace}/{slug}/version/{semver}/metadata", + "pathParams": [ + "namespace", + "slug", + "semver" + ], + "publicPathParams": [ + "namespace", + "slug", + "semver" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryListApiDocumentVersionMetadataParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "responseModel": { + "name": "managed_doc_version", + "publicAliases": [] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "createApiDocumentVersion", + "publicOperation": "createApiDocumentVersion", + "deprecated": false, + "method": "POST", + "path": "/v1/apis/{namespace}/{slug}/version", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "version", + "document", + "force" + ], + "publicBodyParams": [ + "version", + "document", + "force" + ], + "bodyParamDetails": [ + { + "name": "version", + "required": true + }, + { + "name": "document", + "required": true + }, + { + "name": "force", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryCreateApiDocumentVersionParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "responseModel": { + "name": "managed_doc_version", + "publicAliases": [] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "createApiDocumentAccessGroup", + "publicOperation": "createApiDocumentAccessGroup", + "deprecated": false, + "method": "POST", + "path": "/v1/apis/{namespace}/{slug}/access-group", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "accessGroupSlug" + ], + "publicBodyParams": [ + "accessGroupSlug" + ], + "bodyParamDetails": [ + { + "name": "accessGroupSlug", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryCreateApiDocumentAccessGroupParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "deleteApiDocumentAccessGroup", + "publicOperation": "deleteApiDocumentAccessGroup", + "deprecated": false, + "method": "DELETE", + "path": "/v1/apis/{namespace}/{slug}/access-group", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "accessGroupSlug" + ], + "publicBodyParams": [ + "accessGroupSlug" + ], + "bodyParamDetails": [ + { + "name": "accessGroupSlug", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RegistryDeleteApiDocumentAccessGroupParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "schemas", + "publicResource": "schemas", + "operation": "list", + "publicOperation": "list", + "deprecated": false, + "method": "GET", + "path": "/v1/schemas/{namespace}", + "pathParams": [ + "namespace" + ], + "publicPathParams": [ + "namespace" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "SchemaListParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "schemas", + "publicResource": "schemas", + "operation": "create", + "publicOperation": "create", + "deprecated": false, + "method": "POST", + "path": "/v1/schemas/{namespace}", + "pathParams": [ + "namespace" + ], + "publicPathParams": [ + "namespace" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "title", + "description", + "version", + "slug", + "isPrivate", + "document" + ], + "publicBodyParams": [ + "title", + "description", + "version", + "slug", + "isPrivate", + "document" + ], + "bodyParamDetails": [ + { + "name": "title", + "required": true + }, + { + "name": "description", + "required": false + }, + { + "name": "version", + "required": true + }, + { + "name": "slug", + "required": true + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "document", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "SchemaCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "responseModel": { + "name": "uid", + "publicAliases": [] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "schemas", + "publicResource": "schemas", + "operation": "update", + "publicOperation": "update", + "deprecated": false, + "method": "PATCH", + "path": "/v1/schemas/{namespace}/{slug}", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "title", + "description", + "isPrivate" + ], + "publicBodyParams": [ + "title", + "description", + "isPrivate" + ], + "bodyParamDetails": [ + { + "name": "title", + "required": false + }, + { + "name": "description", + "required": false + }, + { + "name": "isPrivate", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "SchemaUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "schemas", + "publicResource": "schemas", + "operation": "delete", + "publicOperation": "delete", + "deprecated": false, + "method": "DELETE", + "path": "/v1/schemas/{namespace}/{slug}", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "SchemaDeleteParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "schemas.version", + "publicResource": "schemas.version", + "operation": "retrieve", + "publicOperation": "retrieve", + "deprecated": false, + "method": "GET", + "path": "/v1/schemas/{namespace}/{slug}/version/{semver}", + "pathParams": [ + "namespace", + "slug", + "semver" + ], + "publicPathParams": [ + "namespace", + "slug", + "semver" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "VersionRetrieveParams" + }, + "response": { + "status": "200", + "contentType": "text/plain", + "encoding": "text", + "contents": [ + { + "contentType": "text/plain", + "encoding": "text" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "schemas.version", + "publicResource": "schemas.version", + "operation": "delete", + "publicOperation": "delete", + "deprecated": false, + "method": "DELETE", + "path": "/v1/schemas/{namespace}/{slug}/version/{semver}", + "pathParams": [ + "namespace", + "slug", + "semver" + ], + "publicPathParams": [ + "namespace", + "slug", + "semver" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "VersionDeleteParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "schemas.version", + "publicResource": "schemas.version", + "operation": "create", + "publicOperation": "create", + "deprecated": false, + "method": "POST", + "path": "/v1/schemas/{namespace}/{slug}/version", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "version", + "document", + "force" + ], + "publicBodyParams": [ + "version", + "document", + "force" + ], + "bodyParamDetails": [ + { + "name": "version", + "required": true + }, + { + "name": "document", + "required": true + }, + { + "name": "force", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "VersionCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "schemas.accessGroup", + "publicResource": "schemas.accessGroup", + "operation": "create", + "publicOperation": "create", + "deprecated": false, + "method": "POST", + "path": "/v1/schemas/{namespace}/{slug}/access-group", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "accessGroupSlug" + ], + "publicBodyParams": [ + "accessGroupSlug" + ], + "bodyParamDetails": [ + { + "name": "accessGroupSlug", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "AccessGroupCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "schemas.accessGroup", + "publicResource": "schemas.accessGroup", + "operation": "delete", + "publicOperation": "delete", + "deprecated": false, + "method": "DELETE", + "path": "/v1/schemas/{namespace}/{slug}/access-group", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "accessGroupSlug" + ], + "publicBodyParams": [ + "accessGroupSlug" + ], + "bodyParamDetails": [ + { + "name": "accessGroupSlug", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "AccessGroupDeleteParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "loginPortals", + "publicResource": "loginPortals", + "operation": "retrieve", + "publicOperation": "retrieve", + "deprecated": false, + "method": "GET", + "path": "/v1/login-portals/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "LoginPortalRetrieveParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "loginPortals", + "publicResource": "loginPortals", + "operation": "update", + "publicOperation": "update", + "deprecated": false, + "method": "PATCH", + "path": "/v1/login-portals/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "title" + ], + "publicBodyParams": [ + "title" + ], + "bodyParamDetails": [ + { + "name": "title", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "LoginPortalUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "loginPortals", + "publicResource": "loginPortals", + "operation": "delete", + "publicOperation": "delete", + "deprecated": false, + "method": "DELETE", + "path": "/v1/login-portals/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "LoginPortalDeleteParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "loginPortals", + "publicResource": "loginPortals", + "operation": "create", + "publicOperation": "create", + "deprecated": false, + "method": "POST", + "path": "/v1/login-portals", + "pathParams": [], + "publicPathParams": [], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "title", + "slug", + "email", + "page" + ], + "publicBodyParams": [ + "title", + "slug", + "email", + "page" + ], + "bodyParamDetails": [ + { + "name": "title", + "required": true + }, + { + "name": "slug", + "required": true + }, + { + "name": "email", + "required": true + }, + { + "name": "page", + "required": true + } + ], + "pathParamDetails": [], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "LoginPortalCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "responseModel": { + "name": "uid", + "publicAliases": [] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "loginPortals", + "publicResource": "loginPortals", + "operation": "list", + "publicOperation": "list", + "deprecated": false, + "method": "GET", + "path": "/v1/login-portals", + "pathParams": [], + "publicPathParams": [], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "accessGroups", + "publicResource": "accessGroups", + "operation": "create", + "publicOperation": "create", + "deprecated": false, + "method": "POST", + "path": "/v1/access-groups", + "pathParams": [], + "publicPathParams": [], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "name", + "slug", + "allowedDomains" + ], + "publicBodyParams": [ + "name", + "slug", + "allowedDomains" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": false + }, + { + "name": "slug", + "required": false + }, + { + "name": "allowedDomains", + "required": false + } + ], + "pathParamDetails": [], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "AccessGroupCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "accessGroups", + "publicResource": "accessGroups", + "operation": "retrieve", + "publicOperation": "retrieve", + "deprecated": false, + "method": "GET", + "path": "/v1/access-groups/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "AccessGroupRetrieveParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "accessGroups", + "publicResource": "accessGroups", + "operation": "update", + "publicOperation": "update", + "deprecated": false, + "method": "PATCH", + "path": "/v1/access-groups/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "name", + "slug" + ], + "publicBodyParams": [ + "name", + "slug" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": false + }, + { + "name": "slug", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "AccessGroupUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "accessGroups", + "publicResource": "accessGroups", + "operation": "delete", + "publicOperation": "delete", + "deprecated": false, + "method": "DELETE", + "path": "/v1/access-groups/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "AccessGroupDeleteParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "accessGroups.domains", + "publicResource": "accessGroups.domains", + "operation": "create", + "publicOperation": "create", + "deprecated": false, + "method": "POST", + "path": "/v1/access-groups/{slug}/domains", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "domain" + ], + "publicBodyParams": [ + "domain" + ], + "bodyParamDetails": [ + { + "name": "domain", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "DomainCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "accessGroups.domains", + "publicResource": "accessGroups.domains", + "operation": "delete", + "publicOperation": "delete", + "deprecated": false, + "method": "DELETE", + "path": "/v1/access-groups/{slug}/domains", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "domain" + ], + "publicBodyParams": [ + "domain" + ], + "bodyParamDetails": [ + { + "name": "domain", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "DomainDeleteParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "rules", + "publicResource": "rules", + "operation": "listRulesets", + "publicOperation": "listRulesets", + "deprecated": false, + "method": "GET", + "path": "/v1/rulesets/{namespace}", + "pathParams": [ + "namespace" + ], + "publicPathParams": [ + "namespace" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RuleListRulesetsParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "rules", + "publicResource": "rules", + "operation": "createRuleset", + "publicOperation": "createRuleset", + "deprecated": false, + "method": "POST", + "path": "/v1/rulesets/{namespace}", + "pathParams": [ + "namespace" + ], + "publicPathParams": [ + "namespace" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "title", + "description", + "slug", + "isPrivate", + "document" + ], + "publicBodyParams": [ + "title", + "description", + "slug", + "isPrivate", + "document" + ], + "bodyParamDetails": [ + { + "name": "title", + "required": true + }, + { + "name": "description", + "required": false + }, + { + "name": "slug", + "required": true + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "document", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RuleCreateRulesetParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "responseModel": { + "name": "uid", + "publicAliases": [] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "rules", + "publicResource": "rules", + "operation": "updateRuleset", + "publicOperation": "updateRuleset", + "deprecated": false, + "method": "PATCH", + "path": "/v1/rulesets/{namespace}/{slug}", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "namespace", + "slug", + "title", + "description", + "isPrivate" + ], + "publicBodyParams": [ + "namespace", + "slug", + "title", + "description", + "isPrivate" + ], + "bodyParamDetails": [ + { + "name": "namespace", + "required": false + }, + { + "name": "slug", + "required": false + }, + { + "name": "title", + "required": false + }, + { + "name": "description", + "required": false + }, + { + "name": "isPrivate", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RuleUpdateRulesetParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "rules", + "publicResource": "rules", + "operation": "deleteRuleset", + "publicOperation": "deleteRuleset", + "deprecated": false, + "method": "DELETE", + "path": "/v1/rulesets/{namespace}/{slug}", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RuleDeleteRulesetParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "rules", + "publicResource": "rules", + "operation": "retrieveRulesetDocument", + "publicOperation": "retrieveRulesetDocument", + "deprecated": false, + "method": "GET", + "path": "/v1/rulesets/{namespace}/{slug}", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RuleRetrieveRulesetDocumentParams" + }, + "response": { + "status": "200", + "contentType": "text/plain", + "encoding": "text", + "contents": [ + { + "contentType": "text/plain", + "encoding": "text" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "rules", + "publicResource": "rules", + "operation": "createRulesetAccessGroup", + "publicOperation": "createRulesetAccessGroup", + "deprecated": false, + "method": "POST", + "path": "/v1/rulesets/{namespace}/{slug}/access-group", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "accessGroupSlug" + ], + "publicBodyParams": [ + "accessGroupSlug" + ], + "bodyParamDetails": [ + { + "name": "accessGroupSlug", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RuleCreateRulesetAccessGroupParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "rules", + "publicResource": "rules", + "operation": "deleteRulesetAccessGroup", + "publicOperation": "deleteRulesetAccessGroup", + "deprecated": false, + "method": "DELETE", + "path": "/v1/rulesets/{namespace}/{slug}/access-group", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "accessGroupSlug" + ], + "publicBodyParams": [ + "accessGroupSlug" + ], + "bodyParamDetails": [ + { + "name": "accessGroupSlug", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "RuleDeleteRulesetAccessGroupParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "themes", + "publicResource": "themes", + "operation": "list", + "publicOperation": "list", + "deprecated": false, + "method": "GET", + "path": "/v1/themes", + "pathParams": [], + "publicPathParams": [], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "themes", + "publicResource": "themes", + "operation": "create", + "publicOperation": "create", + "deprecated": false, + "method": "POST", + "path": "/v1/themes", + "pathParams": [], + "publicPathParams": [], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "name", + "description", + "slug", + "document" + ], + "publicBodyParams": [ + "name", + "description", + "slug", + "document" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": true + }, + { + "name": "description", + "required": false + }, + { + "name": "slug", + "required": true + }, + { + "name": "document", + "required": true + } + ], + "pathParamDetails": [], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "ThemeCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "responseModel": { + "name": "uid", + "publicAliases": [] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "themes", + "publicResource": "themes", + "operation": "update", + "publicOperation": "update", + "deprecated": false, + "method": "PATCH", + "path": "/v1/themes/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "name", + "description" + ], + "publicBodyParams": [ + "name", + "description" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": false + }, + { + "name": "description", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "ThemeUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "themes", + "publicResource": "themes", + "operation": "replaceDocument", + "publicOperation": "replaceDocument", + "deprecated": false, + "method": "PUT", + "path": "/v1/themes/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "document" + ], + "publicBodyParams": [ + "document" + ], + "bodyParamDetails": [ + { + "name": "document", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "ThemeReplaceDocumentParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "themes", + "publicResource": "themes", + "operation": "delete", + "publicOperation": "delete", + "deprecated": false, + "method": "DELETE", + "path": "/v1/themes/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "ThemeDeleteParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "themes", + "publicResource": "themes", + "operation": "retrieve", + "publicOperation": "retrieve", + "deprecated": false, + "method": "GET", + "path": "/v1/themes/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "ThemeRetrieveParams" + }, + "response": { + "status": "200", + "contentType": "text/plain", + "encoding": "text", + "contents": [ + { + "contentType": "text/plain", + "encoding": "text" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "teams", + "publicResource": "teams", + "operation": "list", + "publicOperation": "list", + "deprecated": false, + "method": "GET", + "path": "/v1/teams", + "pathParams": [], + "publicPathParams": [], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "teams.members", + "publicResource": "teams.members", + "operation": "list", + "publicOperation": "list", + "deprecated": false, + "method": "GET", + "path": "/v1/teams/members", + "pathParams": [], + "publicPathParams": [], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "teams.members", + "publicResource": "teams.members", + "operation": "update", + "publicOperation": "update", + "deprecated": false, + "method": "PATCH", + "path": "/v1/teams/members/{uid}", + "pathParams": [ + "uid" + ], + "publicPathParams": [ + "uid" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "role" + ], + "publicBodyParams": [ + "role" + ], + "bodyParamDetails": [ + { + "name": "role", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "uid", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "MemberUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "teams.members", + "publicResource": "teams.members", + "operation": "delete", + "publicOperation": "delete", + "deprecated": false, + "method": "DELETE", + "path": "/v1/teams/members/{uid}", + "pathParams": [ + "uid" + ], + "publicPathParams": [ + "uid" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "uid", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "MemberDeleteParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", "encoding": "json" } ], @@ -2135,41 +11823,58 @@ "transport": "http" }, { - "resource": "registry", - "publicResource": "registry", - "operation": "listApiDocuments", - "publicOperation": "listApiDocuments", + "resource": "teams.invites", + "publicResource": "teams.invites", + "operation": "member", + "publicOperation": "member", "deprecated": false, - "method": "GET", - "path": "/v1/apis/{namespace}", - "pathParams": [ - "namespace" - ], - "publicPathParams": [ - "namespace" - ], + "method": "POST", + "path": "/v1/teams/invites", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ + "bodyParams": [ + "email", + "role" + ], + "publicBodyParams": [ + "email", + "role" + ], + "bodyParamDetails": [ { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false + "name": "email", + "required": true + }, + { + "name": "role", + "required": true } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryListApiDocumentsParams" + "publicName": "InviteMemberParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -2289,74 +11994,183 @@ "transport": "http" }, { - "resource": "registry", - "publicResource": "registry", - "operation": "createApiDocument", - "publicOperation": "createApiDocument", + "resource": "teams.invites", + "publicResource": "teams.invites", + "operation": "resend", + "publicOperation": "resend", "deprecated": false, - "method": "POST", - "path": "/v1/apis/{namespace}", + "method": "PATCH", + "path": "/v1/teams/invites/{uid}", "pathParams": [ - "namespace" + "uid" ], "publicPathParams": [ - "namespace" + "uid" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "title", - "description", - "version", - "slug", - "ruleset", - "isPrivate", - "document" - ], - "publicBodyParams": [ - "title", - "description", - "version", - "slug", - "ruleset", - "isPrivate", - "document" - ], - "bodyParamDetails": [ + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "title", - "required": true - }, + "name": "uid", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "InviteResendParams" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ { - "name": "description", - "required": false + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } }, { - "name": "version", - "required": true + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } }, { - "name": "slug", - "required": true + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } }, { - "name": "ruleset", - "required": false + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } }, { - "name": "isPrivate", - "required": false + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } }, { - "name": "document", - "required": true + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } } ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "teams.invites", + "publicResource": "teams.invites", + "operation": "cancel", + "publicOperation": "cancel", + "deprecated": false, + "method": "DELETE", + "path": "/v1/teams/invites/{uid}", + "pathParams": [ + "uid" + ], + "publicPathParams": [ + "uid" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { - "name": "namespace", + "name": "uid", "required": true, "style": "simple", "explode": false @@ -2366,22 +12180,9 @@ "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], - "cookieParamDetails": [], - "paramsModel": { - "publicName": "RegistryCreateApiDocumentParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "cookieParamDetails": [], + "paramsModel": { + "publicName": "InviteCancelParams" }, "response": { "status": "200", @@ -2501,90 +12302,28 @@ "transport": "http" }, { - "resource": "registry", - "publicResource": "registry", - "operation": "updateApiDocument", - "publicOperation": "updateApiDocument", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "listGuides", + "publicOperation": "listGuides", "deprecated": false, - "method": "PATCH", - "path": "/v1/apis/{namespace}/{slug}", - "pathParams": [ - "namespace", - "slug" - ], - "publicPathParams": [ - "namespace", - "slug" - ], + "method": "GET", + "path": "/v1/guides", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "title", - "description", - "isPrivate", - "ruleset" - ], - "publicBodyParams": [ - "title", - "description", - "isPrivate", - "ruleset" - ], - "bodyParamDetails": [ - { - "name": "title", - "required": false - }, - { - "name": "description", - "required": false - }, - { - "name": "isPrivate", - "required": false - }, - { - "name": "ruleset", - "required": false - } - ], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "RegistryUpdateApiDocumentParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" - }, "response": { "status": "200", "contentType": "application/json", @@ -2703,49 +12442,76 @@ "transport": "http" }, { - "resource": "registry", - "publicResource": "registry", - "operation": "deleteApiDocument", - "publicOperation": "deleteApiDocument", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "createGuide", + "publicOperation": "createGuide", "deprecated": false, - "method": "DELETE", - "path": "/v1/apis/{namespace}/{slug}", - "pathParams": [ - "namespace", - "slug" - ], - "publicPathParams": [ - "namespace", - "slug" - ], + "method": "POST", + "path": "/v1/guides", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ + "bodyParams": [ + "name", + "slug", + "isPrivate", + "allowedUsers", + "allowedDomains" + ], + "publicBodyParams": [ + "name", + "slug", + "isPrivate", + "allowedUsers", + "allowedDomains" + ], + "bodyParamDetails": [ { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false + "name": "name", + "required": true }, { "name": "slug", - "required": true, - "style": "simple", - "explode": false + "required": false + }, + { + "name": "isPrivate", + "required": true + }, + { + "name": "allowedUsers", + "required": true + }, + { + "name": "allowedDomains", + "required": true } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryDeleteApiDocumentParams" + "publicName": "ScalarDocCreateGuideParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -2865,22 +12631,18 @@ "transport": "http" }, { - "resource": "registry", - "publicResource": "registry", - "operation": "retrieveApiDocumentVersion", - "publicOperation": "retrieveApiDocumentVersion", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "publishGuide", + "publicOperation": "publishGuide", "deprecated": false, - "method": "GET", - "path": "/v1/apis/{namespace}/{slug}/version/{semver}", + "method": "POST", + "path": "/v1/guides/{slug}/publish", "pathParams": [ - "namespace", - "slug", - "semver" + "slug" ], "publicPathParams": [ - "namespace", - "slug", - "semver" + "slug" ], "queryParams": [], "publicQueryParams": [], @@ -2890,23 +12652,11 @@ "publicBodyParams": [], "bodyParamDetails": [], "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, { "name": "slug", "required": true, "style": "simple", "explode": false - }, - { - "name": "semver", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -2915,16 +12665,16 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryRetrieveApiDocumentVersionParams" + "publicName": "ScalarDocPublishGuideParams" }, "response": { "status": "200", - "contentType": "text/plain", - "encoding": "text", + "contentType": "application/json", + "encoding": "json", "contents": [ { - "contentType": "text/plain", - "encoding": "text" + "contentType": "application/json", + "encoding": "json" } ] }, @@ -3034,80 +12784,42 @@ "responseLinks": [], "transport": "http" }, - { - "resource": "registry", - "publicResource": "registry", - "operation": "updateApiDocumentVersion", - "publicOperation": "updateApiDocumentVersion", - "deprecated": false, - "method": "PATCH", - "path": "/v1/apis/{namespace}/{slug}/version/{semver}", - "pathParams": [ - "namespace", - "slug", - "semver" - ], - "publicPathParams": [ - "namespace", - "slug", - "semver" - ], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [ - "document" - ], - "publicBodyParams": [ - "document" - ], - "bodyParamDetails": [ - { - "name": "document", - "required": true - } - ], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - }, + { + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "listProjects", + "publicOperation": "listProjects", + "deprecated": false, + "method": "GET", + "path": "/v1/docs", + "pathParams": [], + "publicPathParams": [], + "queryParams": [ + "limit" + ], + "publicQueryParams": [ + "limit" + ], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], + "queryParamDetails": [ { - "name": "semver", - "required": true, - "style": "simple", - "explode": false + "name": "limit", + "required": false, + "style": "form", + "explode": true } ], - "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryUpdateApiDocumentVersionParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "ScalarDocListProjectsParams" }, "response": { "status": "200", @@ -3227,57 +12939,88 @@ "transport": "http" }, { - "resource": "registry", - "publicResource": "registry", - "operation": "deleteApiDocumentVersion", - "publicOperation": "deleteApiDocumentVersion", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "createProject", + "publicOperation": "createProject", "deprecated": false, - "method": "DELETE", - "path": "/v1/apis/{namespace}/{slug}/version/{semver}", - "pathParams": [ - "namespace", - "slug", - "semver" - ], - "publicPathParams": [ - "namespace", - "slug", - "semver" - ], + "method": "POST", + "path": "/v1/docs", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ + "bodyParams": [ + "name", + "slug", + "isPrivate", + "blank", + "provider", + "githubRepository", + "bitbucketRepository" + ], + "publicBodyParams": [ + "name", + "slug", + "isPrivate", + "blank", + "provider", + "githubRepository", + "bitbucketRepository" + ], + "bodyParamDetails": [ { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false + "name": "name", + "required": true }, { "name": "slug", - "required": true, - "style": "simple", - "explode": false + "required": false }, { - "name": "semver", - "required": true, - "style": "simple", - "explode": false + "name": "isPrivate", + "required": false + }, + { + "name": "blank", + "required": false + }, + { + "name": "provider", + "required": true + }, + { + "name": "githubRepository", + "required": false + }, + { + "name": "bitbucketRepository", + "required": false } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryDeleteApiDocumentVersionParams" + "publicName": "ScalarDocCreateProjectParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -3290,6 +13033,10 @@ } ] }, + "responseModel": { + "name": "docs_project", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -3397,22 +13144,18 @@ "transport": "http" }, { - "resource": "registry", - "publicResource": "registry", - "operation": "listApiDocumentVersionMetadata", - "publicOperation": "listApiDocumentVersionMetadata", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "retrieveProject", + "publicOperation": "retrieveProject", "deprecated": false, "method": "GET", - "path": "/v1/apis/{namespace}/{slug}/version/{semver}/metadata", + "path": "/v1/docs/{slug}", "pathParams": [ - "namespace", - "slug", - "semver" + "slug" ], "publicPathParams": [ - "namespace", - "slug", - "semver" + "slug" ], "queryParams": [], "publicQueryParams": [], @@ -3422,23 +13165,11 @@ "publicBodyParams": [], "bodyParamDetails": [], "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, { "name": "slug", "required": true, "style": "simple", "explode": false - }, - { - "name": "semver", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -3447,7 +13178,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryListApiDocumentVersionMetadataParams" + "publicName": "ScalarDocRetrieveProjectParams" }, "response": { "status": "200", @@ -3461,7 +13192,7 @@ ] }, "responseModel": { - "name": "managed_doc_version", + "name": "docs_project", "publicAliases": [] }, "result": { @@ -3571,19 +13302,17 @@ "transport": "http" }, { - "resource": "registry", - "publicResource": "registry", - "operation": "createApiDocumentVersion", - "publicOperation": "createApiDocumentVersion", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "updateProject", + "publicOperation": "updateProject", "deprecated": false, - "method": "POST", - "path": "/v1/apis/{namespace}/{slug}/version", + "method": "PATCH", + "path": "/v1/docs/{slug}", "pathParams": [ - "namespace", "slug" ], "publicPathParams": [ - "namespace", "slug" ], "queryParams": [], @@ -3591,36 +13320,54 @@ "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "version", - "document", - "force" + "name", + "isPrivate", + "accessGroups", + "loginPortalUid", + "activeThemeId", + "agentEnabled", + "analyticsEnabled" ], "publicBodyParams": [ - "version", - "document", - "force" + "name", + "isPrivate", + "accessGroups", + "loginPortalUid", + "activeThemeId", + "agentEnabled", + "analyticsEnabled" ], "bodyParamDetails": [ { - "name": "version", - "required": true + "name": "name", + "required": false }, { - "name": "document", - "required": true + "name": "isPrivate", + "required": false }, { - "name": "force", + "name": "accessGroups", + "required": false + }, + { + "name": "loginPortalUid", + "required": false + }, + { + "name": "activeThemeId", + "required": false + }, + { + "name": "agentEnabled", + "required": false + }, + { + "name": "analyticsEnabled", "required": false } ], "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, { "name": "slug", "required": true, @@ -3634,7 +13381,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryCreateApiDocumentVersionParams" + "publicName": "ScalarDocUpdateProjectParams" }, "requestBody": { "contentType": "application/json", @@ -3660,10 +13407,6 @@ } ] }, - "responseModel": { - "name": "managed_doc_version", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -3771,71 +13514,41 @@ "transport": "http" }, { - "resource": "registry", - "publicResource": "registry", - "operation": "createApiDocumentAccessGroup", - "publicOperation": "createApiDocumentAccessGroup", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "deleteProject", + "publicOperation": "deleteProject", "deprecated": false, - "method": "POST", - "path": "/v1/apis/{namespace}/{slug}/access-group", + "method": "DELETE", + "path": "/v1/docs/{slug}", "pathParams": [ - "namespace", "slug" ], "publicPathParams": [ - "namespace", "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "accessGroupSlug" - ], - "publicBodyParams": [ - "accessGroupSlug" - ], - "bodyParamDetails": [ - { - "name": "accessGroupSlug", - "required": true - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - } - ], - "queryParamDetails": [], - "headerParamDetails": [], - "cookieParams": [], - "publicCookieParams": [], - "cookieParamDetails": [], - "paramsModel": { - "publicName": "RegistryCreateApiDocumentAccessGroupParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "ScalarDocDeleteProjectParams" }, "response": { "status": "200", @@ -3955,19 +13668,17 @@ "transport": "http" }, { - "resource": "registry", - "publicResource": "registry", - "operation": "deleteApiDocumentAccessGroup", - "publicOperation": "deleteApiDocumentAccessGroup", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "publishProject", + "publicOperation": "publishProject", "deprecated": false, - "method": "DELETE", - "path": "/v1/apis/{namespace}/{slug}/access-group", + "method": "POST", + "path": "/v1/docs/{slug}/publish", "pathParams": [ - "namespace", "slug" ], "publicPathParams": [ - "namespace", "slug" ], "queryParams": [], @@ -3975,24 +13686,30 @@ "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "accessGroupSlug" + "commitSha", + "preview", + "configPath" ], "publicBodyParams": [ - "accessGroupSlug" + "commitSha", + "preview", + "configPath" ], "bodyParamDetails": [ { - "name": "accessGroupSlug", - "required": true + "name": "commitSha", + "required": false + }, + { + "name": "preview", + "required": false + }, + { + "name": "configPath", + "required": false } ], "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, { "name": "slug", "required": true, @@ -4006,7 +13723,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryDeleteApiDocumentAccessGroupParams" + "publicName": "ScalarDocPublishProjectParams" }, "requestBody": { "contentType": "application/json", @@ -4139,21 +13856,25 @@ "transport": "http" }, { - "resource": "schemas", - "publicResource": "schemas", - "operation": "list", - "publicOperation": "list", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "listProjectConfig", + "publicOperation": "listProjectConfig", "deprecated": false, "method": "GET", - "path": "/v1/schemas/{namespace}", + "path": "/v1/docs/{slug}/config", "pathParams": [ - "namespace" + "slug" ], "publicPathParams": [ - "namespace" + "slug" + ], + "queryParams": [ + "ref" + ], + "publicQueryParams": [ + "ref" ], - "queryParams": [], - "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [], @@ -4161,19 +13882,26 @@ "bodyParamDetails": [], "pathParamDetails": [ { - "name": "namespace", + "name": "slug", "required": true, "style": "simple", "explode": false } ], - "queryParamDetails": [], + "queryParamDetails": [ + { + "name": "ref", + "required": false, + "style": "form", + "explode": true + } + ], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SchemaListParams" + "publicName": "ScalarDocListProjectConfigParams" }, "response": { "status": "200", @@ -4293,68 +14021,62 @@ "transport": "http" }, { - "resource": "schemas", - "publicResource": "schemas", - "operation": "create", - "publicOperation": "create", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "updateProjectConfig", + "publicOperation": "updateProjectConfig", "deprecated": false, - "method": "POST", - "path": "/v1/schemas/{namespace}", + "method": "PUT", + "path": "/v1/docs/{slug}/config", "pathParams": [ - "namespace" + "slug" ], "publicPathParams": [ - "namespace" + "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "title", - "description", - "version", - "slug", - "isPrivate", - "document" + "content", + "ref", + "baseToken", + "message", + "path" ], "publicBodyParams": [ - "title", - "description", - "version", - "slug", - "isPrivate", - "document" + "content", + "ref", + "baseToken", + "message", + "path" ], "bodyParamDetails": [ { - "name": "title", + "name": "content", "required": true }, { - "name": "description", + "name": "ref", "required": false }, { - "name": "version", - "required": true - }, - { - "name": "slug", - "required": true + "name": "baseToken", + "required": false }, { - "name": "isPrivate", + "name": "message", "required": false }, { - "name": "document", - "required": true + "name": "path", + "required": false } ], "pathParamDetails": [ { - "name": "namespace", + "name": "slug", "required": true, "style": "simple", "explode": false @@ -4366,7 +14088,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SchemaCreateParams" + "publicName": "ScalarDocUpdateProjectConfigParams" }, "requestBody": { "contentType": "application/json", @@ -4392,10 +14114,6 @@ } ] }, - "responseModel": { - "name": "uid", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -4503,56 +14221,27 @@ "transport": "http" }, { - "resource": "schemas", - "publicResource": "schemas", - "operation": "update", - "publicOperation": "update", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "listProjectDomain", + "publicOperation": "listProjectDomain", "deprecated": false, - "method": "PATCH", - "path": "/v1/schemas/{namespace}/{slug}", + "method": "GET", + "path": "/v1/docs/{slug}/domain", "pathParams": [ - "namespace", "slug" ], "publicPathParams": [ - "namespace", "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "title", - "description", - "isPrivate" - ], - "publicBodyParams": [ - "title", - "description", - "isPrivate" - ], - "bodyParamDetails": [ - { - "name": "title", - "required": false - }, - { - "name": "description", - "required": false - }, - { - "name": "isPrivate", - "required": false - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, { "name": "slug", "required": true, @@ -4566,20 +14255,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SchemaUpdateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "ScalarDocListProjectDomainParams" }, "response": { "status": "200", @@ -4699,19 +14375,17 @@ "transport": "http" }, { - "resource": "schemas", - "publicResource": "schemas", - "operation": "delete", - "publicOperation": "delete", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "listProjectDomainStatus", + "publicOperation": "listProjectDomainStatus", "deprecated": false, - "method": "DELETE", - "path": "/v1/schemas/{namespace}/{slug}", + "method": "GET", + "path": "/v1/docs/{slug}/domain/status", "pathParams": [ - "namespace", "slug" ], "publicPathParams": [ - "namespace", "slug" ], "queryParams": [], @@ -4722,12 +14396,6 @@ "publicBodyParams": [], "bodyParamDetails": [], "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, { "name": "slug", "required": true, @@ -4741,7 +14409,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SchemaDeleteParams" + "publicName": "ScalarDocListProjectDomainStatusParams" }, "response": { "status": "200", @@ -4861,23 +14529,15 @@ "transport": "http" }, { - "resource": "schemas.version", - "publicResource": "schemas.version", - "operation": "retrieve", - "publicOperation": "retrieve", + "resource": "namespaces", + "publicResource": "namespaces", + "operation": "list", + "publicOperation": "list", "deprecated": false, "method": "GET", - "path": "/v1/schemas/{namespace}/{slug}/version/{semver}", - "pathParams": [ - "namespace", - "slug", - "semver" - ], - "publicPathParams": [ - "namespace", - "slug", - "semver" - ], + "path": "/v1/namespaces", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -4885,42 +14545,20 @@ "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "semver", - "required": true, - "style": "simple", - "explode": false - } - ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "VersionRetrieveParams" - }, "response": { "status": "200", - "contentType": "text/plain", - "encoding": "text", + "contentType": "application/json", + "encoding": "json", "contents": [ { - "contentType": "text/plain", - "encoding": "text" + "contentType": "application/json", + "encoding": "json" } ] }, @@ -5031,57 +14669,52 @@ "transport": "http" }, { - "resource": "schemas.version", - "publicResource": "schemas.version", - "operation": "delete", - "publicOperation": "delete", - "deprecated": false, - "method": "DELETE", - "path": "/v1/schemas/{namespace}/{slug}/version/{semver}", - "pathParams": [ - "namespace", - "slug", - "semver" - ], - "publicPathParams": [ - "namespace", - "slug", - "semver" - ], + "resource": "authentication", + "publicResource": "authentication", + "operation": "exchangePersonalToken", + "publicOperation": "exchangePersonalToken", + "deprecated": false, + "method": "POST", + "path": "/v1/auth/exchange", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - }, + "bodyParams": [ + "personalToken" + ], + "publicBodyParams": [ + "personalToken" + ], + "bodyParamDetails": [ { - "name": "semver", - "required": true, - "style": "simple", - "explode": false + "name": "personalToken", + "required": true } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "VersionDeleteParams" + "publicName": "AuthenticationExchangePersonalTokenParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -5201,84 +14834,28 @@ "transport": "http" }, { - "resource": "schemas.version", - "publicResource": "schemas.version", - "operation": "create", - "publicOperation": "create", + "resource": "authentication", + "publicResource": "authentication", + "operation": "listCurrentUser", + "publicOperation": "listCurrentUser", "deprecated": false, - "method": "POST", - "path": "/v1/schemas/{namespace}/{slug}/version", - "pathParams": [ - "namespace", - "slug" - ], - "publicPathParams": [ - "namespace", - "slug" - ], + "method": "GET", + "path": "/v1/auth/me", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "version", - "document", - "force" - ], - "publicBodyParams": [ - "version", - "document", - "force" - ], - "bodyParamDetails": [ - { - "name": "version", - "required": true - }, - { - "name": "document", - "required": true - }, - { - "name": "force", - "required": false - } - ], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "VersionCreateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" - }, "response": { "status": "200", "contentType": "application/json", @@ -5290,6 +14867,10 @@ } ] }, + "responseModel": { + "name": "user", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -5397,71 +14978,41 @@ "transport": "http" }, { - "resource": "schemas.accessGroup", - "publicResource": "schemas.accessGroup", - "operation": "create", - "publicOperation": "create", + "resource": "sdks", + "publicResource": "sdks", + "operation": "list", + "publicOperation": "list", "deprecated": false, - "method": "POST", - "path": "/v1/schemas/{namespace}/{slug}/access-group", - "pathParams": [ - "namespace", - "slug" + "method": "GET", + "path": "/v1/sdks", + "pathParams": [], + "publicPathParams": [], + "queryParams": [ + "limit" ], - "publicPathParams": [ - "namespace", - "slug" + "publicQueryParams": [ + "limit" ], - "queryParams": [], - "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "accessGroupSlug" - ], - "publicBodyParams": [ - "accessGroupSlug" - ], - "bodyParamDetails": [ - { - "name": "accessGroupSlug", - "required": true - } - ], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], + "queryParamDetails": [ { - "name": "slug", - "required": true, - "style": "simple", - "explode": false + "name": "limit", + "required": false, + "style": "form", + "explode": true } ], - "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "AccessGroupCreateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "SdkListParams" }, "response": { "status": "200", @@ -5581,58 +15132,69 @@ "transport": "http" }, { - "resource": "schemas.accessGroup", - "publicResource": "schemas.accessGroup", - "operation": "delete", - "publicOperation": "delete", + "resource": "sdks", + "publicResource": "sdks", + "operation": "create", + "publicOperation": "create", "deprecated": false, - "method": "DELETE", - "path": "/v1/schemas/{namespace}/{slug}/access-group", - "pathParams": [ - "namespace", - "slug" - ], - "publicPathParams": [ - "namespace", - "slug" - ], + "method": "POST", + "path": "/v1/sdks", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "accessGroupSlug" + "apiUid", + "languages", + "title", + "slug", + "className", + "config" ], "publicBodyParams": [ - "accessGroupSlug" + "apiUid", + "languages", + "title", + "slug", + "className", + "config" ], "bodyParamDetails": [ { - "name": "accessGroupSlug", + "name": "apiUid", "required": true - } - ], - "pathParamDetails": [ + }, { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false + "name": "languages", + "required": true + }, + { + "name": "title", + "required": false }, { "name": "slug", - "required": true, - "style": "simple", - "explode": false + "required": false + }, + { + "name": "className", + "required": false + }, + { + "name": "config", + "required": false } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "AccessGroupDeleteParams" + "publicName": "SdkCreateParams" }, "requestBody": { "contentType": "application/json", @@ -5658,6 +15220,10 @@ } ] }, + "responseModel": { + "name": "uid", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -5765,18 +15331,18 @@ "transport": "http" }, { - "resource": "loginPortals", - "publicResource": "loginPortals", + "resource": "sdks", + "publicResource": "sdks", "operation": "retrieve", "publicOperation": "retrieve", "deprecated": false, "method": "GET", - "path": "/v1/login-portals/{slug}", + "path": "/v1/sdks/{uid}", "pathParams": [ - "slug" + "uid" ], "publicPathParams": [ - "slug" + "uid" ], "queryParams": [], "publicQueryParams": [], @@ -5787,7 +15353,7 @@ "bodyParamDetails": [], "pathParamDetails": [ { - "name": "slug", + "name": "uid", "required": true, "style": "simple", "explode": false @@ -5799,7 +15365,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "LoginPortalRetrieveParams" + "publicName": "SdkRetrieveParams" }, "response": { "status": "200", @@ -5812,6 +15378,10 @@ } ] }, + "responseModel": { + "name": "sdk", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -5919,38 +15489,68 @@ "transport": "http" }, { - "resource": "loginPortals", - "publicResource": "loginPortals", + "resource": "sdks", + "publicResource": "sdks", "operation": "update", "publicOperation": "update", "deprecated": false, "method": "PATCH", - "path": "/v1/login-portals/{slug}", + "path": "/v1/sdks/{uid}", "pathParams": [ - "slug" + "uid" ], "publicPathParams": [ - "slug" + "uid" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "title" + "title", + "slug", + "isPrivate", + "config", + "apiUid", + "apiVersion" ], "publicBodyParams": [ - "title" + "title", + "slug", + "isPrivate", + "config", + "apiUid", + "apiVersion" ], "bodyParamDetails": [ { "name": "title", "required": false + }, + { + "name": "slug", + "required": false + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "config", + "required": false + }, + { + "name": "apiUid", + "required": false + }, + { + "name": "apiVersion", + "required": false } ], "pathParamDetails": [ { - "name": "slug", + "name": "uid", "required": true, "style": "simple", "explode": false @@ -5962,7 +15562,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "LoginPortalUpdateParams" + "publicName": "SdkUpdateParams" }, "requestBody": { "contentType": "application/json", @@ -6095,18 +15695,18 @@ "transport": "http" }, { - "resource": "loginPortals", - "publicResource": "loginPortals", + "resource": "sdks", + "publicResource": "sdks", "operation": "delete", "publicOperation": "delete", "deprecated": false, "method": "DELETE", - "path": "/v1/login-portals/{slug}", + "path": "/v1/sdks/{uid}", "pathParams": [ - "slug" + "uid" ], "publicPathParams": [ - "slug" + "uid" ], "queryParams": [], "publicQueryParams": [], @@ -6117,7 +15717,7 @@ "bodyParamDetails": [], "pathParamDetails": [ { - "name": "slug", + "name": "uid", "required": true, "style": "simple", "explode": false @@ -6129,7 +15729,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "LoginPortalDeleteParams" + "publicName": "SdkDeleteParams" }, "response": { "status": "200", @@ -6249,57 +15849,56 @@ "transport": "http" }, { - "resource": "loginPortals", - "publicResource": "loginPortals", - "operation": "create", - "publicOperation": "create", + "resource": "sdks", + "publicResource": "sdks", + "operation": "build", + "publicOperation": "build", "deprecated": false, "method": "POST", - "path": "/v1/login-portals", - "pathParams": [], - "publicPathParams": [], + "path": "/v1/sdks/{uid}/build", + "pathParams": [ + "uid" + ], + "publicPathParams": [ + "uid" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "title", - "slug", - "email", - "page" + "version", + "languages" ], "publicBodyParams": [ - "title", - "slug", - "email", - "page" + "version", + "languages" ], "bodyParamDetails": [ { - "name": "title", - "required": true - }, - { - "name": "slug", - "required": true + "name": "version", + "required": false }, { - "name": "email", - "required": true - }, + "name": "languages", + "required": false + } + ], + "pathParamDetails": [ { - "name": "page", - "required": true + "name": "uid", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "LoginPortalCreateParams" + "publicName": "SdkBuildParams" }, "requestBody": { "contentType": "application/json", @@ -6325,10 +15924,6 @@ } ] }, - "responseModel": { - "name": "uid", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -6436,28 +16031,70 @@ "transport": "http" }, { - "resource": "loginPortals", - "publicResource": "loginPortals", - "operation": "list", - "publicOperation": "list", + "resource": "sdks.versions", + "publicResource": "sdks.versions", + "operation": "create", + "publicOperation": "create", "deprecated": false, - "method": "GET", - "path": "/v1/login-portals", - "pathParams": [], - "publicPathParams": [], + "method": "POST", + "path": "/v1/sdks/{uid}/versions", + "pathParams": [ + "uid" + ], + "publicPathParams": [ + "uid" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], + "bodyParams": [ + "version", + "apiVersion" + ], + "publicBodyParams": [ + "version", + "apiVersion" + ], + "bodyParamDetails": [ + { + "name": "version", + "required": true + }, + { + "name": "apiVersion", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "uid", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "VersionCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -6576,18 +16213,20 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "listRulesets", - "publicOperation": "listRulesets", + "resource": "sdks.versions", + "publicResource": "sdks.versions", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, - "method": "GET", - "path": "/v1/rulesets/{namespace}", + "method": "DELETE", + "path": "/v1/sdks/{uid}/versions/{version}", "pathParams": [ - "namespace" + "uid", + "version" ], "publicPathParams": [ - "namespace" + "uid", + "version" ], "queryParams": [], "publicQueryParams": [], @@ -6598,7 +16237,13 @@ "bodyParamDetails": [], "pathParamDetails": [ { - "name": "namespace", + "name": "uid", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "version", "required": true, "style": "simple", "explode": false @@ -6610,7 +16255,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleListRulesetsParams" + "publicName": "VersionDeleteParams" }, "response": { "status": "200", @@ -6730,62 +16375,56 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "createRuleset", - "publicOperation": "createRuleset", + "resource": "sdks.repositories", + "publicResource": "sdks.repositories", + "operation": "link", + "publicOperation": "link", "deprecated": false, "method": "POST", - "path": "/v1/rulesets/{namespace}", + "path": "/v1/sdks/{uid}/repositories", "pathParams": [ - "namespace" + "uid" ], "publicPathParams": [ - "namespace" + "uid" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "title", - "description", - "slug", - "isPrivate", - "document" + "language", + "repositoryId", + "baseBranch", + "prereleaseType" ], "publicBodyParams": [ - "title", - "description", - "slug", - "isPrivate", - "document" + "language", + "repositoryId", + "baseBranch", + "prereleaseType" ], "bodyParamDetails": [ { - "name": "title", + "name": "language", "required": true }, { - "name": "description", - "required": false + "name": "repositoryId", + "required": true }, { - "name": "slug", + "name": "baseBranch", "required": true }, { - "name": "isPrivate", + "name": "prereleaseType", "required": false - }, - { - "name": "document", - "required": true } ], "pathParamDetails": [ { - "name": "namespace", + "name": "uid", "required": true, "style": "simple", "explode": false @@ -6797,7 +16436,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleCreateRulesetParams" + "publicName": "RepositoryLinkParams" }, "requestBody": { "contentType": "application/json", @@ -6823,10 +16462,6 @@ } ] }, - "responseModel": { - "name": "uid", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -6934,70 +16569,37 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "updateRuleset", - "publicOperation": "updateRuleset", + "resource": "sdks.repositories", + "publicResource": "sdks.repositories", + "operation": "unlink", + "publicOperation": "unlink", "deprecated": false, - "method": "PATCH", - "path": "/v1/rulesets/{namespace}/{slug}", - "pathParams": [ - "namespace", - "slug" - ], - "publicPathParams": [ - "namespace", - "slug" - ], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [ - "namespace", - "slug", - "title", - "description", - "isPrivate" - ], - "publicBodyParams": [ - "namespace", - "slug", - "title", - "description", - "isPrivate" - ], - "bodyParamDetails": [ - { - "name": "namespace", - "required": false - }, - { - "name": "slug", - "required": false - }, - { - "name": "title", - "required": false - }, - { - "name": "description", - "required": false - }, - { - "name": "isPrivate", - "required": false - } + "method": "DELETE", + "path": "/v1/sdks/{uid}/repositories/{language}", + "pathParams": [ + "uid", + "language" + ], + "publicPathParams": [ + "uid", + "language" ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { - "name": "namespace", + "name": "uid", "required": true, "style": "simple", "explode": false }, { - "name": "slug", + "name": "language", "required": true, "style": "simple", "explode": false @@ -7009,20 +16611,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleUpdateRulesetParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "RepositoryUnlinkParams" }, "response": { "status": "200", @@ -7142,37 +16731,64 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "deleteRuleset", - "publicOperation": "deleteRuleset", + "resource": "sdks.repositories", + "publicResource": "sdks.repositories", + "operation": "updatePublishing", + "publicOperation": "updatePublishing", "deprecated": false, - "method": "DELETE", - "path": "/v1/rulesets/{namespace}/{slug}", + "method": "POST", + "path": "/v1/sdks/{uid}/repositories/{language}/publishing", "pathParams": [ - "namespace", - "slug" + "uid", + "language" ], "publicPathParams": [ - "namespace", - "slug" + "uid", + "language" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], + "bodyParams": [ + "publishOnMerge", + "authMethod", + "access", + "tag" + ], + "publicBodyParams": [ + "publishOnMerge", + "authMethod", + "access", + "tag" + ], + "bodyParamDetails": [ + { + "name": "publishOnMerge", + "required": true + }, + { + "name": "authMethod", + "required": false + }, + { + "name": "access", + "required": false + }, + { + "name": "tag", + "required": false + } + ], "pathParamDetails": [ { - "name": "namespace", + "name": "uid", "required": true, "style": "simple", "explode": false }, { - "name": "slug", + "name": "language", "required": true, "style": "simple", "explode": false @@ -7184,7 +16800,20 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleDeleteRulesetParams" + "publicName": "RepositoryUpdatePublishingParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -7304,21 +16933,15 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "retrieveRulesetDocument", - "publicOperation": "retrieveRulesetDocument", + "resource": "mcp.servers", + "publicResource": "mcp.servers", + "operation": "list", + "publicOperation": "list", "deprecated": false, "method": "GET", - "path": "/v1/rulesets/{namespace}/{slug}", - "pathParams": [ - "namespace", - "slug" - ], - "publicPathParams": [ - "namespace", - "slug" - ], + "path": "/v1/mcp/servers", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -7326,36 +16949,20 @@ "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - } - ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "RuleRetrieveRulesetDocumentParams" - }, "response": { "status": "200", - "contentType": "text/plain", - "encoding": "text", + "contentType": "application/json", + "encoding": "json", "contents": [ { - "contentType": "text/plain", - "encoding": "text" + "contentType": "application/json", + "encoding": "json" } ] }, @@ -7466,58 +17073,57 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "createRulesetAccessGroup", - "publicOperation": "createRulesetAccessGroup", + "resource": "mcp.servers", + "publicResource": "mcp.servers", + "operation": "create", + "publicOperation": "create", "deprecated": false, "method": "POST", - "path": "/v1/rulesets/{namespace}/{slug}/access-group", - "pathParams": [ - "namespace", - "slug" - ], - "publicPathParams": [ - "namespace", - "slug" - ], + "path": "/v1/mcp/servers", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "accessGroupSlug" + "name", + "slug", + "versionUids", + "projectUids" ], "publicBodyParams": [ - "accessGroupSlug" + "name", + "slug", + "versionUids", + "projectUids" ], "bodyParamDetails": [ { - "name": "accessGroupSlug", + "name": "name", "required": true - } - ], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false }, { "name": "slug", - "required": true, - "style": "simple", - "explode": false + "required": false + }, + { + "name": "versionUids", + "required": false + }, + { + "name": "projectUids", + "required": false } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleCreateRulesetAccessGroupParams" + "publicName": "ServerCreateParams" }, "requestBody": { "contentType": "application/json", @@ -7650,46 +17256,29 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "deleteRulesetAccessGroup", - "publicOperation": "deleteRulesetAccessGroup", + "resource": "mcp.servers", + "publicResource": "mcp.servers", + "operation": "retrieve", + "publicOperation": "retrieve", "deprecated": false, - "method": "DELETE", - "path": "/v1/rulesets/{namespace}/{slug}/access-group", + "method": "GET", + "path": "/v1/mcp/servers/{id}", "pathParams": [ - "namespace", - "slug" + "id" ], "publicPathParams": [ - "namespace", - "slug" + "id" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "accessGroupSlug" - ], - "publicBodyParams": [ - "accessGroupSlug" - ], - "bodyParamDetails": [ - { - "name": "accessGroupSlug", - "required": true - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", + "name": "id", "required": true, "style": "simple", "explode": false @@ -7701,20 +17290,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleDeleteRulesetAccessGroupParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "ServerRetrieveParams" }, "response": { "status": "200", @@ -7727,6 +17303,10 @@ } ] }, + "responseModel": { + "name": "mcp_server", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -7834,28 +17414,88 @@ "transport": "http" }, { - "resource": "themes", - "publicResource": "themes", - "operation": "list", - "publicOperation": "list", + "resource": "mcp.servers", + "publicResource": "mcp.servers", + "operation": "update", + "publicOperation": "update", "deprecated": false, - "method": "GET", - "path": "/v1/themes", - "pathParams": [], - "publicPathParams": [], + "method": "PATCH", + "path": "/v1/mcp/servers/{id}", + "pathParams": [ + "id" + ], + "publicPathParams": [ + "id" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], + "bodyParams": [ + "name", + "slug", + "autoAddOperations", + "operations", + "docsPages" + ], + "publicBodyParams": [ + "name", + "slug", + "autoAddOperations", + "operations", + "docsPages" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": false + }, + { + "name": "slug", + "required": false + }, + { + "name": "autoAddOperations", + "required": false + }, + { + "name": "operations", + "required": false + }, + { + "name": "docsPages", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "id", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "ServerUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -7867,6 +17507,10 @@ } ] }, + "responseModel": { + "name": "mcp_server", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -7974,70 +17618,41 @@ "transport": "http" }, { - "resource": "themes", - "publicResource": "themes", - "operation": "create", - "publicOperation": "create", + "resource": "mcp.servers", + "publicResource": "mcp.servers", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, - "method": "POST", - "path": "/v1/themes", - "pathParams": [], - "publicPathParams": [], + "method": "DELETE", + "path": "/v1/mcp/servers/{id}", + "pathParams": [ + "id" + ], + "publicPathParams": [ + "id" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "name", - "description", - "slug", - "document" - ], - "publicBodyParams": [ - "name", - "description", - "slug", - "document" - ], - "bodyParamDetails": [ - { - "name": "name", - "required": true - }, - { - "name": "description", - "required": false - }, - { - "name": "slug", - "required": true - }, + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "document", - "required": true + "name": "id", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ThemeCreateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "ServerDeleteParams" }, "response": { "status": "200", @@ -8050,10 +17665,6 @@ } ] }, - "responseModel": { - "name": "uid", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -8161,44 +17772,29 @@ "transport": "http" }, { - "resource": "themes", - "publicResource": "themes", - "operation": "update", - "publicOperation": "update", + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "list", + "publicOperation": "list", "deprecated": false, - "method": "PATCH", - "path": "/v1/themes/{slug}", + "method": "GET", + "path": "/v1/mcp/servers/{id}/installations", "pathParams": [ - "slug" + "id" ], "publicPathParams": [ - "slug" + "id" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "name", - "description" - ], - "publicBodyParams": [ - "name", - "description" - ], - "bodyParamDetails": [ - { - "name": "name", - "required": false - }, - { - "name": "description", - "required": false - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { - "name": "slug", + "name": "id", "required": true, "style": "simple", "explode": false @@ -8210,20 +17806,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ThemeUpdateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "InstallationListParams" }, "response": { "status": "200", @@ -8343,38 +17926,50 @@ "transport": "http" }, { - "resource": "themes", - "publicResource": "themes", - "operation": "replaceDocument", - "publicOperation": "replaceDocument", + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "create", + "publicOperation": "create", "deprecated": false, - "method": "PUT", - "path": "/v1/themes/{slug}", + "method": "POST", + "path": "/v1/mcp/servers/{id}/installations", "pathParams": [ - "slug" + "id" ], "publicPathParams": [ - "slug" + "id" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "document" + "name", + "slug", + "documentAuth" ], "publicBodyParams": [ - "document" + "name", + "slug", + "documentAuth" ], "bodyParamDetails": [ { - "name": "document", + "name": "name", + "required": true + }, + { + "name": "slug", + "required": false + }, + { + "name": "documentAuth", "required": true } ], "pathParamDetails": [ { - "name": "slug", + "name": "id", "required": true, "style": "simple", "explode": false @@ -8386,7 +17981,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ThemeReplaceDocumentParams" + "publicName": "InstallationCreateParams" }, "requestBody": { "contentType": "application/json", @@ -8412,6 +18007,10 @@ } ] }, + "responseModel": { + "name": "mcp_installation", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -8519,18 +18118,20 @@ "transport": "http" }, { - "resource": "themes", - "publicResource": "themes", - "operation": "delete", - "publicOperation": "delete", + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "retrieve", + "publicOperation": "retrieve", "deprecated": false, - "method": "DELETE", - "path": "/v1/themes/{slug}", + "method": "GET", + "path": "/v1/mcp/servers/{id}/installations/{installationId}", "pathParams": [ - "slug" + "id", + "installationId" ], "publicPathParams": [ - "slug" + "id", + "installationId" ], "queryParams": [], "publicQueryParams": [], @@ -8541,7 +18142,13 @@ "bodyParamDetails": [], "pathParamDetails": [ { - "name": "slug", + "name": "id", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "installationId", "required": true, "style": "simple", "explode": false @@ -8553,7 +18160,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ThemeDeleteParams" + "publicName": "InstallationRetrieveParams" }, "response": { "status": "200", @@ -8566,6 +18173,10 @@ } ] }, + "responseModel": { + "name": "mcp_installation", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -8673,29 +18284,76 @@ "transport": "http" }, { - "resource": "themes", - "publicResource": "themes", - "operation": "retrieve", - "publicOperation": "retrieve", + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "update", + "publicOperation": "update", "deprecated": false, - "method": "GET", - "path": "/v1/themes/{slug}", + "method": "PATCH", + "path": "/v1/mcp/servers/{id}/installations/{installationId}", "pathParams": [ - "slug" + "id", + "installationId" ], "publicPathParams": [ - "slug" + "id", + "installationId" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ + "bodyParams": [ + "name", + "slug", + "isPrivate", + "loginPortalUid", + "documentAuth", + "mcpVersion" + ], + "publicBodyParams": [ + "name", + "slug", + "isPrivate", + "loginPortalUid", + "documentAuth", + "mcpVersion" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": false + }, { "name": "slug", + "required": false + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "loginPortalUid", + "required": false + }, + { + "name": "documentAuth", + "required": false + }, + { + "name": "mcpVersion", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "id", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "installationId", "required": true, "style": "simple", "explode": false @@ -8707,19 +18365,36 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ThemeRetrieveParams" + "publicName": "InstallationUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", - "contentType": "text/plain", - "encoding": "text", + "contentType": "application/json", + "encoding": "json", "contents": [ { - "contentType": "text/plain", - "encoding": "text" + "contentType": "application/json", + "encoding": "json" } ] }, + "responseModel": { + "name": "mcp_installation", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -8827,15 +18502,21 @@ "transport": "http" }, { - "resource": "teams", - "publicResource": "teams", - "operation": "list", - "publicOperation": "list", + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, - "method": "GET", - "path": "/v1/teams", - "pathParams": [], - "publicPathParams": [], + "method": "DELETE", + "path": "/v1/mcp/servers/{id}/installations/{installationId}", + "pathParams": [ + "id", + "installationId" + ], + "publicPathParams": [ + "id", + "installationId" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -8843,12 +18524,28 @@ "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [], + "pathParamDetails": [ + { + "name": "id", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "installationId", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "InstallationDeleteParams" + }, "response": { "status": "200", "contentType": "application/json", @@ -8967,28 +18664,72 @@ "transport": "http" }, { - "resource": "scalarDocs", - "publicResource": "scalarDocs", - "operation": "listGuides", - "publicOperation": "listGuides", + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "createAccessGroup", + "publicOperation": "createAccessGroup", "deprecated": false, - "method": "GET", - "path": "/v1/guides", - "pathParams": [], - "publicPathParams": [], + "method": "POST", + "path": "/v1/mcp/servers/{id}/installations/{installationId}/access-group", + "pathParams": [ + "id", + "installationId" + ], + "publicPathParams": [ + "id", + "installationId" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], + "bodyParams": [ + "accessGroupUid" + ], + "publicBodyParams": [ + "accessGroupUid" + ], + "bodyParamDetails": [ + { + "name": "accessGroupUid", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "id", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "installationId", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "InstallationCreateAccessGroupParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -9107,63 +18848,58 @@ "transport": "http" }, { - "resource": "scalarDocs", - "publicResource": "scalarDocs", - "operation": "createGuide", - "publicOperation": "createGuide", + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "deleteAccessGroup", + "publicOperation": "deleteAccessGroup", "deprecated": false, - "method": "POST", - "path": "/v1/guides", - "pathParams": [], - "publicPathParams": [], + "method": "DELETE", + "path": "/v1/mcp/servers/{id}/installations/{installationId}/access-group", + "pathParams": [ + "id", + "installationId" + ], + "publicPathParams": [ + "id", + "installationId" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "name", - "slug", - "isPrivate", - "allowedUsers", - "allowedDomains" + "accessGroupUid" ], "publicBodyParams": [ - "name", - "slug", - "isPrivate", - "allowedUsers", - "allowedDomains" + "accessGroupUid" ], "bodyParamDetails": [ { - "name": "name", - "required": true - }, - { - "name": "slug", - "required": false - }, - { - "name": "isPrivate", + "name": "accessGroupUid", "required": true - }, + } + ], + "pathParamDetails": [ { - "name": "allowedUsers", - "required": true + "name": "id", + "required": true, + "style": "simple", + "explode": false }, { - "name": "allowedDomains", - "required": true + "name": "installationId", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocCreateGuideParams" + "publicName": "InstallationDeleteAccessGroupParams" }, "requestBody": { "contentType": "application/json", @@ -9296,19 +19032,15 @@ "transport": "http" }, { - "resource": "scalarDocs", - "publicResource": "scalarDocs", - "operation": "publishGuide", - "publicOperation": "publishGuide", + "resource": "oAuth", + "publicResource": "oAuth", + "operation": "oauthAuthorize", + "publicOperation": "oauthAuthorize", "deprecated": false, - "method": "POST", - "path": "/v1/guides/{slug}/publish", - "pathParams": [ - "slug" - ], - "publicPathParams": [ - "slug" - ], + "method": "GET", + "path": "/v1/oauth/authorize", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -9316,22 +19048,12 @@ "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - } - ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "ScalarDocPublishGuideParams" - }, "response": { "status": "200", "contentType": "application/json", @@ -9450,28 +19172,95 @@ "transport": "http" }, { - "resource": "namespaces", - "publicResource": "namespaces", - "operation": "list", - "publicOperation": "list", + "resource": "oAuth", + "publicResource": "oAuth", + "operation": "oauthToken", + "publicOperation": "oauthToken", "deprecated": false, - "method": "GET", - "path": "/v1/namespaces", + "method": "POST", + "path": "/v1/oauth/token", "pathParams": [], "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], + "bodyParams": [ + "grant_type", + "client_id", + "client_secret", + "code", + "redirect_uri", + "code_verifier", + "refresh_token", + "scope" + ], + "publicBodyParams": [ + "grant_type", + "client_id", + "client_secret", + "code", + "redirect_uri", + "code_verifier", + "refresh_token", + "scope" + ], + "bodyParamDetails": [ + { + "name": "grant_type", + "required": true + }, + { + "name": "client_id", + "required": false + }, + { + "name": "client_secret", + "required": false + }, + { + "name": "code", + "required": false + }, + { + "name": "redirect_uri", + "required": false + }, + { + "name": "code_verifier", + "required": false + }, + { + "name": "refresh_token", + "required": false + }, + { + "name": "scope", + "required": false + } + ], "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "OAuthOauthTokenParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -9590,13 +19379,13 @@ "transport": "http" }, { - "resource": "authentication", - "publicResource": "authentication", - "operation": "exchangePersonalToken", - "publicOperation": "exchangePersonalToken", + "resource": "oAuth", + "publicResource": "oAuth", + "operation": "oauthRevoke", + "publicOperation": "oauthRevoke", "deprecated": false, "method": "POST", - "path": "/v1/auth/exchange", + "path": "/v1/oauth/revoke", "pathParams": [], "publicPathParams": [], "queryParams": [], @@ -9604,15 +19393,33 @@ "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "personalToken" + "token", + "token_type_hint", + "client_id", + "client_secret" ], "publicBodyParams": [ - "personalToken" + "token", + "token_type_hint", + "client_id", + "client_secret" ], "bodyParamDetails": [ { - "name": "personalToken", + "name": "token", "required": true + }, + { + "name": "token_type_hint", + "required": false + }, + { + "name": "client_id", + "required": false + }, + { + "name": "client_secret", + "required": false } ], "pathParamDetails": [], @@ -9622,7 +19429,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "AuthenticationExchangePersonalTokenParams" + "publicName": "OAuthOauthRevokeParams" }, "requestBody": { "contentType": "application/json", @@ -9755,13 +19562,13 @@ "transport": "http" }, { - "resource": "authentication", - "publicResource": "authentication", - "operation": "listCurrentUser", - "publicOperation": "listCurrentUser", + "resource": "oAuth", + "publicResource": "oAuth", + "operation": "oauthAuthorizationServerMetadata", + "publicOperation": "oauthAuthorizationServerMetadata", "deprecated": false, "method": "GET", - "path": "/v1/auth/me", + "path": "/.well-known/oauth-authorization-server", "pathParams": [], "publicPathParams": [], "queryParams": [], @@ -9789,7 +19596,7 @@ ] }, "responseModel": { - "name": "user", + "name": "oauth_authorization_server_metadata", "publicAliases": [] }, "result": { diff --git a/sig/scalar_api_ruby/client.rbs b/sig/scalar_api_ruby/client.rbs index 2ebf533..9c4afe3 100644 --- a/sig/scalar_api_ruby/client.rbs +++ b/sig/scalar_api_ruby/client.rbs @@ -18,6 +18,8 @@ module Scalar attr_reader login_portals: Scalar::Resources::LoginPortals + attr_reader access_groups: Scalar::Resources::AccessGroups + attr_reader rules: Scalar::Resources::Rules attr_reader themes: Scalar::Resources::Themes @@ -30,6 +32,12 @@ module Scalar attr_reader authentication: Scalar::Resources::Authentication + attr_reader sdks: Scalar::Resources::Sdks + + attr_reader mcp: Scalar::Resources::Mcp + + attr_reader o_auth: Scalar::Resources::OAuth + private def auth_headers: -> ::Hash[String, String] def initialize: ( diff --git a/sig/scalar_api_ruby/models.rbs b/sig/scalar_api_ruby/models.rbs index 15aa69a..b01903d 100644 --- a/sig/scalar_api_ruby/models.rbs +++ b/sig/scalar_api_ruby/models.rbs @@ -1,10 +1,34 @@ module Scalar class AccessGroup = Scalar::Models::AccessGroup + class AccessGroupCreateParams = Scalar::Models::AccessGroupCreateParams + + class AccessGroupDeleteParams = Scalar::Models::AccessGroupDeleteParams + + class AccessGroupName = Scalar::Models::AccessGroupName + + class AccessGroupRetrieveParams = Scalar::Models::AccessGroupRetrieveParams + + module AccessGroups = Scalar::Models::AccessGroups + + class AccessGroupUpdateParams = Scalar::Models::AccessGroupUpdateParams + + class ActiveDeployment = Scalar::Models::ActiveDeployment + + class APIDocument = Scalar::Models::APIDocument + class AuthenticationExchangePersonalTokenParams = Scalar::Models::AuthenticationExchangePersonalTokenParams class AuthenticationListCurrentUserParams = Scalar::Models::AuthenticationListCurrentUserParams + class DocsProject = Scalar::Models::DocsProject + + class GithubProject = Scalar::Models::GithubProject + + class GithubProjectRepository = Scalar::Models::GithubProjectRepository + + class LoginPortal = Scalar::Models::LoginPortal + class LoginPortalCreateParams = Scalar::Models::LoginPortalCreateParams class LoginPortalDeleteParams = Scalar::Models::LoginPortalDeleteParams @@ -21,12 +45,34 @@ module Scalar class ManagedDocVersion = Scalar::Models::ManagedDocVersion + class ManagedSchemaVersion = Scalar::Models::ManagedSchemaVersion + + module Mcp = Scalar::Models::Mcp + + module Method = Scalar::Models::Method + class Namespace = Scalar::Models::Namespace class NamespaceListParams = Scalar::Models::NamespaceListParams class Nanoid = Scalar::Models::Nanoid + class OauthAuthorizationServerMetadata = Scalar::Models::OauthAuthorizationServerMetadata + + class OauthError = Scalar::Models::OauthError + + class OAuthOauthAuthorizationServerMetadataParams = Scalar::Models::OAuthOauthAuthorizationServerMetadataParams + + class OAuthOauthAuthorizeParams = Scalar::Models::OAuthOauthAuthorizeParams + + class OAuthOauthRevokeParams = Scalar::Models::OAuthOauthRevokeParams + + class OAuthOauthTokenParams = Scalar::Models::OAuthOauthTokenParams + + module OauthScope = Scalar::Models::OauthScope + + class OauthToken = Scalar::Models::OauthToken + class RegistryCreateAPIDocumentAccessGroupParams = Scalar::Models::RegistryCreateAPIDocumentAccessGroupParams class RegistryCreateAPIDocumentParams = Scalar::Models::RegistryCreateAPIDocumentParams @@ -51,6 +97,8 @@ module Scalar class RegistryUpdateAPIDocumentVersionParams = Scalar::Models::RegistryUpdateAPIDocumentVersionParams + class Rule = Scalar::Models::Rule + class RuleCreateRulesetAccessGroupParams = Scalar::Models::RuleCreateRulesetAccessGroupParams class RuleCreateRulesetParams = Scalar::Models::RuleCreateRulesetParams @@ -67,10 +115,32 @@ module Scalar class ScalarDocCreateGuideParams = Scalar::Models::ScalarDocCreateGuideParams + class ScalarDocCreateProjectParams = Scalar::Models::ScalarDocCreateProjectParams + + class ScalarDocDeleteProjectParams = Scalar::Models::ScalarDocDeleteProjectParams + class ScalarDocListGuidesParams = Scalar::Models::ScalarDocListGuidesParams + class ScalarDocListProjectConfigParams = Scalar::Models::ScalarDocListProjectConfigParams + + class ScalarDocListProjectDomainParams = Scalar::Models::ScalarDocListProjectDomainParams + + class ScalarDocListProjectDomainStatusParams = Scalar::Models::ScalarDocListProjectDomainStatusParams + + class ScalarDocListProjectsParams = Scalar::Models::ScalarDocListProjectsParams + class ScalarDocPublishGuideParams = Scalar::Models::ScalarDocPublishGuideParams + class ScalarDocPublishProjectParams = Scalar::Models::ScalarDocPublishProjectParams + + class ScalarDocRetrieveProjectParams = Scalar::Models::ScalarDocRetrieveProjectParams + + class ScalarDocUpdateProjectConfigParams = Scalar::Models::ScalarDocUpdateProjectConfigParams + + class ScalarDocUpdateProjectParams = Scalar::Models::ScalarDocUpdateProjectParams + + class Schema = Scalar::Models::Schema + class SchemaCreateParams = Scalar::Models::SchemaCreateParams class SchemaDeleteParams = Scalar::Models::SchemaDeleteParams @@ -81,10 +151,42 @@ module Scalar class SchemaUpdateParams = Scalar::Models::SchemaUpdateParams + class Sdk = Scalar::Models::Sdk + + class SdkBuildParams = Scalar::Models::SdkBuildParams + + class SdkCreateParams = Scalar::Models::SdkCreateParams + + class SdkDeleteParams = Scalar::Models::SdkDeleteParams + + class SdkListParams = Scalar::Models::SdkListParams + + class SdkRetrieveParams = Scalar::Models::SdkRetrieveParams + + module Sdks = Scalar::Models::Sdks + + class SdkTargetSummary = Scalar::Models::SdkTargetSummary + + class SdkUpdateParams = Scalar::Models::SdkUpdateParams + + class SdkVersion = Scalar::Models::SdkVersion + class Slug = Scalar::Models::Slug + class Team = Scalar::Models::Team + + class TeamImage = Scalar::Models::TeamImage + class TeamListParams = Scalar::Models::TeamListParams + class TeamName = Scalar::Models::TeamName + + module Teams = Scalar::Models::Teams + + class TeamSummary = Scalar::Models::TeamSummary + + class Theme = Scalar::Models::Theme + class ThemeCreateParams = Scalar::Models::ThemeCreateParams class ThemeDeleteParams = Scalar::Models::ThemeDeleteParams @@ -101,6 +203,8 @@ module Scalar class UID = Scalar::Models::UID + class User = Scalar::Models::User + class Value400 = Scalar::Models::Value400 class Value401 = Scalar::Models::Value401 diff --git a/sig/scalar_api_ruby/models/access_group_create_params.rbs b/sig/scalar_api_ruby/models/access_group_create_params.rbs new file mode 100644 index 0000000..01978db --- /dev/null +++ b/sig/scalar_api_ruby/models/access_group_create_params.rbs @@ -0,0 +1,38 @@ +module Scalar + module Models + type access_group_create_params = + { allowed_domains: top, name: String, slug: String } + & Scalar::Internal::Type::request_parameters + + class AccessGroupCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_reader allowed_domains: top? + + def allowed_domains=: (top) -> top + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader slug: String? + + def slug=: (String) -> String + + def initialize: ( + ?allowed_domains: top, + ?name: String, + ?slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + allowed_domains: top, + name: String, + slug: String, + request_options: Scalar::RequestOptions + } + end + end +end diff --git a/sig/scalar_api_ruby/models/access_group_create_response.rbs b/sig/scalar_api_ruby/models/access_group_create_response.rbs new file mode 100644 index 0000000..4e31e84 --- /dev/null +++ b/sig/scalar_api_ruby/models/access_group_create_response.rbs @@ -0,0 +1,40 @@ +module Scalar + module Models + type access_group_create_response = + { + allowed_domains: top, + allowed_emails: top, + name: String, + slug: String, + uid: String + } + + class AccessGroupCreateResponse < Scalar::Internal::Type::BaseModel + attr_accessor allowed_domains: top + + attr_accessor allowed_emails: top + + attr_accessor name: String + + attr_accessor slug: String + + attr_accessor uid: String + + def initialize: ( + allowed_domains: top, + allowed_emails: top, + name: String, + slug: String, + uid: String + ) -> void + + def to_hash: -> { + allowed_domains: top, + allowed_emails: top, + name: String, + slug: String, + uid: String + } + end + end +end diff --git a/sig/scalar_api_ruby/models/access_group_delete_params.rbs b/sig/scalar_api_ruby/models/access_group_delete_params.rbs new file mode 100644 index 0000000..4178d94 --- /dev/null +++ b/sig/scalar_api_ruby/models/access_group_delete_params.rbs @@ -0,0 +1,20 @@ +module Scalar + module Models + type access_group_delete_params = + { slug: String } & Scalar::Internal::Type::request_parameters + + class AccessGroupDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + def initialize: ( + slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { slug: String, request_options: Scalar::RequestOptions } + end + end +end diff --git a/sig/scalar_api_ruby/models/access_group_name.rbs b/sig/scalar_api_ruby/models/access_group_name.rbs new file mode 100644 index 0000000..01f011e --- /dev/null +++ b/sig/scalar_api_ruby/models/access_group_name.rbs @@ -0,0 +1,5 @@ +module Scalar + module Models + class AccessGroupName = String + end +end diff --git a/sig/scalar_api_ruby/models/access_group_retrieve_params.rbs b/sig/scalar_api_ruby/models/access_group_retrieve_params.rbs new file mode 100644 index 0000000..395f9be --- /dev/null +++ b/sig/scalar_api_ruby/models/access_group_retrieve_params.rbs @@ -0,0 +1,20 @@ +module Scalar + module Models + type access_group_retrieve_params = + { slug: String } & Scalar::Internal::Type::request_parameters + + class AccessGroupRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + def initialize: ( + slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { slug: String, request_options: Scalar::RequestOptions } + end + end +end diff --git a/sig/scalar_api_ruby/models/access_group_retrieve_response.rbs b/sig/scalar_api_ruby/models/access_group_retrieve_response.rbs new file mode 100644 index 0000000..3de1f87 --- /dev/null +++ b/sig/scalar_api_ruby/models/access_group_retrieve_response.rbs @@ -0,0 +1,40 @@ +module Scalar + module Models + type access_group_retrieve_response = + { + allowed_domains: top, + allowed_emails: top, + name: String, + slug: String, + uid: String + } + + class AccessGroupRetrieveResponse < Scalar::Internal::Type::BaseModel + attr_accessor allowed_domains: top + + attr_accessor allowed_emails: top + + attr_accessor name: String + + attr_accessor slug: String + + attr_accessor uid: String + + def initialize: ( + allowed_domains: top, + allowed_emails: top, + name: String, + slug: String, + uid: String + ) -> void + + def to_hash: -> { + allowed_domains: top, + allowed_emails: top, + name: String, + slug: String, + uid: String + } + end + end +end diff --git a/sig/scalar_api_ruby/models/access_group_update_params.rbs b/sig/scalar_api_ruby/models/access_group_update_params.rbs new file mode 100644 index 0000000..e284d23 --- /dev/null +++ b/sig/scalar_api_ruby/models/access_group_update_params.rbs @@ -0,0 +1,36 @@ +module Scalar + module Models + type access_group_update_params = + { path_slug: String, name: String, body_slug: String } + & Scalar::Internal::Type::request_parameters + + class AccessGroupUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor path_slug: String + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader body_slug: String? + + def body_slug=: (String) -> String + + def initialize: ( + path_slug: String, + ?name: String, + ?body_slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + path_slug: String, + name: String, + body_slug: String, + request_options: Scalar::RequestOptions + } + end + end +end diff --git a/sig/scalar_api_ruby/models/access_groups/domain_create_params.rbs b/sig/scalar_api_ruby/models/access_groups/domain_create_params.rbs new file mode 100644 index 0000000..f6d54ba --- /dev/null +++ b/sig/scalar_api_ruby/models/access_groups/domain_create_params.rbs @@ -0,0 +1,30 @@ +module Scalar + module Models + module AccessGroups + type domain_create_params = + { slug: String, domain: String } + & Scalar::Internal::Type::request_parameters + + class DomainCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + attr_accessor domain: String + + def initialize: ( + slug: String, + domain: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + slug: String, + domain: String, + request_options: Scalar::RequestOptions + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/access_groups/domain_delete_params.rbs b/sig/scalar_api_ruby/models/access_groups/domain_delete_params.rbs new file mode 100644 index 0000000..d595f27 --- /dev/null +++ b/sig/scalar_api_ruby/models/access_groups/domain_delete_params.rbs @@ -0,0 +1,30 @@ +module Scalar + module Models + module AccessGroups + type domain_delete_params = + { slug: String, domain: String } + & Scalar::Internal::Type::request_parameters + + class DomainDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + attr_accessor domain: String + + def initialize: ( + slug: String, + domain: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + slug: String, + domain: String, + request_options: Scalar::RequestOptions + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/access_groups/email_domain.rbs b/sig/scalar_api_ruby/models/access_groups/email_domain.rbs new file mode 100644 index 0000000..90bc2fa --- /dev/null +++ b/sig/scalar_api_ruby/models/access_groups/email_domain.rbs @@ -0,0 +1,7 @@ +module Scalar + module Models + module AccessGroups + class EmailDomain = String + end + end +end diff --git a/sig/scalar_api_ruby/models/active_deployment.rbs b/sig/scalar_api_ruby/models/active_deployment.rbs new file mode 100644 index 0000000..9238426 --- /dev/null +++ b/sig/scalar_api_ruby/models/active_deployment.rbs @@ -0,0 +1,22 @@ +module Scalar + module Models + type active_deployment = + { domain: String, published_at: Integer, uid: String } + + class ActiveDeployment < Scalar::Internal::Type::BaseModel + attr_accessor domain: String + + attr_accessor published_at: Integer + + attr_accessor uid: String + + def initialize: ( + domain: String, + published_at: Integer, + uid: String + ) -> void + + def to_hash: -> { domain: String, published_at: Integer, uid: String } + end + end +end diff --git a/sig/scalar_api_ruby/models/api_document.rbs b/sig/scalar_api_ruby/models/api_document.rbs new file mode 100644 index 0000000..f3994ad --- /dev/null +++ b/sig/scalar_api_ruby/models/api_document.rbs @@ -0,0 +1,60 @@ +module Scalar + module Models + type api_document = + { + description: String, + is_private: bool, + namespace: String, + slug: String, + tags: top, + title: String, + uid: String, + version: String, + versions: ::Array[Scalar::ManagedDocVersion] + } + + class APIDocument < Scalar::Internal::Type::BaseModel + attr_accessor description: String + + attr_accessor is_private: bool + + attr_accessor namespace: String + + attr_accessor slug: String + + attr_accessor tags: top + + attr_accessor title: String + + attr_accessor uid: String + + attr_accessor version: String + + attr_accessor versions: ::Array[Scalar::ManagedDocVersion] + + def initialize: ( + description: String, + is_private: bool, + namespace: String, + slug: String, + tags: top, + title: String, + uid: String, + version: String, + versions: ::Array[Scalar::ManagedDocVersion] + ) -> void + + def to_hash: -> { + description: String, + is_private: bool, + namespace: String, + slug: String, + tags: top, + title: String, + uid: String, + version: String, + versions: ::Array[Scalar::ManagedDocVersion] + } + end + end +end diff --git a/sig/scalar_api_ruby/models/docs_project.rbs b/sig/scalar_api_ruby/models/docs_project.rbs new file mode 100644 index 0000000..77489bc --- /dev/null +++ b/sig/scalar_api_ruby/models/docs_project.rbs @@ -0,0 +1,70 @@ +module Scalar + module Models + type docs_project = + { + access_groups: top, + active_theme_id: String, + agent_enabled: bool, + analytics_enabled: bool, + is_private: bool, + last_published: Integer?, + login_portal_uid: String, + name: String, + publish_status: String, + slug: String, + uid: String + } + + class DocsProject < Scalar::Internal::Type::BaseModel + attr_accessor access_groups: top + + attr_accessor active_theme_id: String + + attr_accessor agent_enabled: bool + + attr_accessor analytics_enabled: bool + + attr_accessor is_private: bool + + attr_accessor last_published: Integer? + + attr_accessor login_portal_uid: String + + attr_accessor name: String + + attr_accessor publish_status: String + + attr_accessor slug: String + + attr_accessor uid: String + + def initialize: ( + access_groups: top, + active_theme_id: String, + agent_enabled: bool, + analytics_enabled: bool, + is_private: bool, + last_published: Integer?, + login_portal_uid: String, + name: String, + publish_status: String, + slug: String, + uid: String + ) -> void + + def to_hash: -> { + access_groups: top, + active_theme_id: String, + agent_enabled: bool, + analytics_enabled: bool, + is_private: bool, + last_published: Integer?, + login_portal_uid: String, + name: String, + publish_status: String, + slug: String, + uid: String + } + end + end +end diff --git a/sig/scalar_api_ruby/models/github_project.rbs b/sig/scalar_api_ruby/models/github_project.rbs new file mode 100644 index 0000000..3835824 --- /dev/null +++ b/sig/scalar_api_ruby/models/github_project.rbs @@ -0,0 +1,112 @@ +module Scalar + module Models + type github_project = + { + access_groups: top, + active_deployment: Scalar::ActiveDeployment?, + active_theme_id: String, + agent_enabled: bool, + analytics_enabled: bool, + created_at: Integer, + is_private: bool, + last_published: Integer?, + last_published_uid: String?, + login_portal_uid: String, + name: String, + publish_message: String, + publish_status: String, + slug: String, + uid: String, + updated_at: Integer, + user_info_hook_url: String, + repository: Scalar::GithubProjectRepository?, + typesense_id: Float + } + + class GithubProject < Scalar::Internal::Type::BaseModel + attr_accessor access_groups: top + + attr_accessor active_deployment: Scalar::ActiveDeployment? + + attr_accessor active_theme_id: String + + attr_accessor agent_enabled: bool + + attr_accessor analytics_enabled: bool + + attr_accessor created_at: Integer + + attr_accessor is_private: bool + + attr_accessor last_published: Integer? + + attr_accessor last_published_uid: String? + + attr_accessor login_portal_uid: String + + attr_accessor name: String + + attr_accessor publish_message: String + + attr_accessor publish_status: String + + attr_accessor slug: String + + attr_accessor uid: String + + attr_accessor updated_at: Integer + + attr_accessor user_info_hook_url: String + + attr_accessor repository: Scalar::GithubProjectRepository? + + attr_reader typesense_id: Float? + + def typesense_id=: (Float) -> Float + + def initialize: ( + access_groups: top, + active_deployment: Scalar::ActiveDeployment?, + active_theme_id: String, + agent_enabled: bool, + analytics_enabled: bool, + created_at: Integer, + is_private: bool, + last_published: Integer?, + last_published_uid: String?, + login_portal_uid: String, + name: String, + publish_message: String, + publish_status: String, + slug: String, + uid: String, + updated_at: Integer, + user_info_hook_url: String, + ?repository: Scalar::GithubProjectRepository?, + ?typesense_id: Float + ) -> void + + def to_hash: -> { + access_groups: top, + active_deployment: Scalar::ActiveDeployment?, + active_theme_id: String, + agent_enabled: bool, + analytics_enabled: bool, + created_at: Integer, + is_private: bool, + last_published: Integer?, + last_published_uid: String?, + login_portal_uid: String, + name: String, + publish_message: String, + publish_status: String, + slug: String, + uid: String, + updated_at: Integer, + user_info_hook_url: String, + repository: Scalar::GithubProjectRepository?, + typesense_id: Float + } + end + end +end diff --git a/sig/scalar_api_ruby/models/github_project_repository.rbs b/sig/scalar_api_ruby/models/github_project_repository.rbs new file mode 100644 index 0000000..8c32435 --- /dev/null +++ b/sig/scalar_api_ruby/models/github_project_repository.rbs @@ -0,0 +1,60 @@ +module Scalar + module Models + type github_project_repository = + { + id: Float, + branch: String, + config_path: String, + expired: bool, + linked_by: String, + name: String, + pr_comments: bool, + publish_on_merge: bool, + publish_previews: bool + } + + class GithubProjectRepository < Scalar::Internal::Type::BaseModel + attr_accessor id: Float + + attr_accessor branch: String + + attr_accessor config_path: String + + attr_accessor expired: bool + + attr_accessor linked_by: String + + attr_accessor name: String + + attr_accessor pr_comments: bool + + attr_accessor publish_on_merge: bool + + attr_accessor publish_previews: bool + + def initialize: ( + id: Float, + branch: String, + config_path: String, + expired: bool, + linked_by: String, + name: String, + pr_comments: bool, + publish_on_merge: bool, + publish_previews: bool + ) -> void + + def to_hash: -> { + id: Float, + branch: String, + config_path: String, + expired: bool, + linked_by: String, + name: String, + pr_comments: bool, + publish_on_merge: bool, + publish_previews: bool + } + end + end +end diff --git a/sig/scalar_api_ruby/models/login_portal.rbs b/sig/scalar_api_ruby/models/login_portal.rbs new file mode 100644 index 0000000..fc43f8b --- /dev/null +++ b/sig/scalar_api_ruby/models/login_portal.rbs @@ -0,0 +1,17 @@ +module Scalar + module Models + type login_portal = { slug: String, title: String, uid: String } + + class LoginPortal < Scalar::Internal::Type::BaseModel + attr_accessor slug: String + + attr_accessor title: String + + attr_accessor uid: String + + def initialize: (slug: String, title: String, uid: String) -> void + + def to_hash: -> { slug: String, title: String, uid: String } + end + end +end diff --git a/sig/scalar_api_ruby/models/login_portal_list_response.rbs b/sig/scalar_api_ruby/models/login_portal_list_response.rbs index 3b1c061..dadbd1d 100644 --- a/sig/scalar_api_ruby/models/login_portal_list_response.rbs +++ b/sig/scalar_api_ruby/models/login_portal_list_response.rbs @@ -1,22 +1,6 @@ module Scalar module Models - type login_portal_list_response_item = - { slug: String, title: String, uid: String } - - class LoginPortalListResponseItem < Scalar::Internal::Type::BaseModel - attr_accessor slug: String - - attr_accessor title: String - - attr_accessor uid: String - - def initialize: (slug: String, title: String, uid: String) -> void - - def to_hash: -> { slug: String, title: String, uid: String } - end - - type login_portal_list_response = - ::Array[Scalar::Models::LoginPortalListResponseItem] + type login_portal_list_response = ::Array[Scalar::LoginPortal] LoginPortalListResponse: Scalar::Internal::Type::Converter end diff --git a/sig/scalar_api_ruby/models/managed_doc_version.rbs b/sig/scalar_api_ruby/models/managed_doc_version.rbs index f4bd017..fe416d5 100644 --- a/sig/scalar_api_ruby/models/managed_doc_version.rbs +++ b/sig/scalar_api_ruby/models/managed_doc_version.rbs @@ -83,26 +83,26 @@ module Scalar type tool = { enabled_tools: ::Array[Scalar::Models::ManagedDocVersion::Tool::enabled_tool], - method_: Scalar::Models::ManagedDocVersion::Tool::method_, + method_: Scalar::Models::method_, path: String } class Tool < Scalar::Internal::Type::BaseModel attr_accessor enabled_tools: ::Array[Scalar::Models::ManagedDocVersion::Tool::enabled_tool] - attr_accessor method_: Scalar::Models::ManagedDocVersion::Tool::method_ + attr_accessor method_: Scalar::Models::method_ attr_accessor path: String def initialize: ( enabled_tools: ::Array[Scalar::Models::ManagedDocVersion::Tool::enabled_tool], - method_: Scalar::Models::ManagedDocVersion::Tool::method_, + method_: Scalar::Models::method_, path: String ) -> void def to_hash: -> { enabled_tools: ::Array[Scalar::Models::ManagedDocVersion::Tool::enabled_tool], - method_: Scalar::Models::ManagedDocVersion::Tool::method_, + method_: Scalar::Models::method_, path: String } @@ -116,33 +116,6 @@ module Scalar def self?.values: -> ::Array[Scalar::Models::ManagedDocVersion::Tool::enabled_tool] end - - type method_ = - :delete - | :get - | :head - | :options - | :patch - | :post - | :put - | :query - | :trace - - module Method - extend Scalar::Internal::Type::Enum - - DELETE: :delete - GET: :get - HEAD: :head - OPTIONS: :options - PATCH: :patch - POST: :post - PUT: :put - QUERY: :query - TRACE: :trace - - def self?.values: -> ::Array[Scalar::Models::ManagedDocVersion::Tool::method_] - end end end end diff --git a/sig/scalar_api_ruby/models/managed_schema_version.rbs b/sig/scalar_api_ruby/models/managed_schema_version.rbs new file mode 100644 index 0000000..bb3ec94 --- /dev/null +++ b/sig/scalar_api_ruby/models/managed_schema_version.rbs @@ -0,0 +1,49 @@ +module Scalar + module Models + type managed_schema_version = + { + created_at: Integer, + uid: String, + updated_at: Integer, + version: String, + json_sha: String, + yaml_sha: String + } + + class ManagedSchemaVersion < Scalar::Internal::Type::BaseModel + attr_accessor created_at: Integer + + attr_accessor uid: String + + attr_accessor updated_at: Integer + + attr_accessor version: String + + attr_reader json_sha: String? + + def json_sha=: (String) -> String + + attr_reader yaml_sha: String? + + def yaml_sha=: (String) -> String + + def initialize: ( + created_at: Integer, + uid: String, + updated_at: Integer, + version: String, + ?json_sha: String, + ?yaml_sha: String + ) -> void + + def to_hash: -> { + created_at: Integer, + uid: String, + updated_at: Integer, + version: String, + json_sha: String, + yaml_sha: String + } + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/mcp_installation.rbs b/sig/scalar_api_ruby/models/mcp/mcp_installation.rbs new file mode 100644 index 0000000..f516682 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/mcp_installation.rbs @@ -0,0 +1,69 @@ +module Scalar + module Models + class McpInstallation = Mcp::McpInstallation + + module Mcp + type mcp_installation = + { + id: String, + access_groups: ::Array[String], + credential_redaction_enabled: bool, + is_private: bool, + login_portal_uid: String?, + mcp_server_id: String, + mcp_version: String?, + name: String, + pii_redaction_enabled: bool, + slug: String + } + + class McpInstallation < Scalar::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor access_groups: ::Array[String] + + attr_accessor credential_redaction_enabled: bool + + attr_accessor is_private: bool + + attr_accessor login_portal_uid: String? + + attr_accessor mcp_server_id: String + + attr_accessor mcp_version: String? + + attr_accessor name: String + + attr_accessor pii_redaction_enabled: bool + + attr_accessor slug: String + + def initialize: ( + id: String, + access_groups: ::Array[String], + credential_redaction_enabled: bool, + is_private: bool, + login_portal_uid: String?, + mcp_server_id: String, + mcp_version: String?, + name: String, + pii_redaction_enabled: bool, + slug: String + ) -> void + + def to_hash: -> { + id: String, + access_groups: ::Array[String], + credential_redaction_enabled: bool, + is_private: bool, + login_portal_uid: String?, + mcp_server_id: String, + mcp_version: String?, + name: String, + pii_redaction_enabled: bool, + slug: String + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/mcp_server.rbs b/sig/scalar_api_ruby/models/mcp/mcp_server.rbs new file mode 100644 index 0000000..8dd9ffc --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/mcp_server.rbs @@ -0,0 +1,49 @@ +module Scalar + module Models + class McpServer = Mcp::McpServer + + module Mcp + type mcp_server = + { + id: String, + auto_add_operations: bool, + created_at: String, + name: String, + slug: String, + updated_at: String + } + + class McpServer < Scalar::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor auto_add_operations: bool + + attr_accessor created_at: String + + attr_accessor name: String + + attr_accessor slug: String + + attr_accessor updated_at: String + + def initialize: ( + id: String, + auto_add_operations: bool, + created_at: String, + name: String, + slug: String, + updated_at: String + ) -> void + + def to_hash: -> { + id: String, + auto_add_operations: bool, + created_at: String, + name: String, + slug: String, + updated_at: String + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/server_create_params.rbs b/sig/scalar_api_ruby/models/mcp/server_create_params.rbs new file mode 100644 index 0000000..f364cbe --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/server_create_params.rbs @@ -0,0 +1,49 @@ +module Scalar + module Models + module Mcp + type server_create_params = + { + name: String, + project_uids: ::Array[String], + slug: String, + version_uids: ::Array[String] + } + & Scalar::Internal::Type::request_parameters + + class ServerCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor name: String + + attr_reader project_uids: ::Array[String]? + + def project_uids=: (::Array[String]) -> ::Array[String] + + attr_reader slug: String? + + def slug=: (String) -> String + + attr_reader version_uids: ::Array[String]? + + def version_uids=: (::Array[String]) -> ::Array[String] + + def initialize: ( + name: String, + ?project_uids: ::Array[String], + ?slug: String, + ?version_uids: ::Array[String], + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + name: String, + project_uids: ::Array[String], + slug: String, + version_uids: ::Array[String], + request_options: Scalar::RequestOptions + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/server_create_response.rbs b/sig/scalar_api_ruby/models/mcp/server_create_response.rbs new file mode 100644 index 0000000..e697105 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/server_create_response.rbs @@ -0,0 +1,27 @@ +module Scalar + module Models + module Mcp + type server_create_response = + { + installation: Scalar::Mcp::McpInstallation, + server: Scalar::Mcp::McpServer + } + + class ServerCreateResponse < Scalar::Internal::Type::BaseModel + attr_accessor installation: Scalar::Mcp::McpInstallation + + attr_accessor server: Scalar::Mcp::McpServer + + def initialize: ( + installation: Scalar::Mcp::McpInstallation, + server: Scalar::Mcp::McpServer + ) -> void + + def to_hash: -> { + installation: Scalar::Mcp::McpInstallation, + server: Scalar::Mcp::McpServer + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/server_delete_params.rbs b/sig/scalar_api_ruby/models/mcp/server_delete_params.rbs new file mode 100644 index 0000000..5ae964d --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/server_delete_params.rbs @@ -0,0 +1,22 @@ +module Scalar + module Models + module Mcp + type server_delete_params = + { id: String } & Scalar::Internal::Type::request_parameters + + class ServerDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor id: String + + def initialize: ( + id: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { id: String, request_options: Scalar::RequestOptions } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/server_list_params.rbs b/sig/scalar_api_ruby/models/mcp/server_list_params.rbs new file mode 100644 index 0000000..181ec95 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/server_list_params.rbs @@ -0,0 +1,17 @@ +module Scalar + module Models + module Mcp + type server_list_params = + { } & Scalar::Internal::Type::request_parameters + + class ServerListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + def initialize: (?request_options: Scalar::request_opts) -> void + + def to_hash: -> { request_options: Scalar::RequestOptions } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/server_list_response.rbs b/sig/scalar_api_ruby/models/mcp/server_list_response.rbs new file mode 100644 index 0000000..96a40fc --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/server_list_response.rbs @@ -0,0 +1,9 @@ +module Scalar + module Models + module Mcp + type server_list_response = ::Array[Scalar::Mcp::McpServer] + + ServerListResponse: Scalar::Internal::Type::Converter + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/server_retrieve_params.rbs b/sig/scalar_api_ruby/models/mcp/server_retrieve_params.rbs new file mode 100644 index 0000000..9173496 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/server_retrieve_params.rbs @@ -0,0 +1,22 @@ +module Scalar + module Models + module Mcp + type server_retrieve_params = + { id: String } & Scalar::Internal::Type::request_parameters + + class ServerRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor id: String + + def initialize: ( + id: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { id: String, request_options: Scalar::RequestOptions } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/server_update_params.rbs b/sig/scalar_api_ruby/models/mcp/server_update_params.rbs new file mode 100644 index 0000000..d8d2184 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/server_update_params.rbs @@ -0,0 +1,63 @@ +module Scalar + module Models + module Mcp + type server_update_params = + { + id: String, + auto_add_operations: bool, + docs_pages: ::Array[String], + name: String, + operations: ::Array[String], + slug: String + } + & Scalar::Internal::Type::request_parameters + + class ServerUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor id: String + + attr_reader auto_add_operations: bool? + + def auto_add_operations=: (bool) -> bool + + attr_reader docs_pages: ::Array[String]? + + def docs_pages=: (::Array[String]) -> ::Array[String] + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader operations: ::Array[String]? + + def operations=: (::Array[String]) -> ::Array[String] + + attr_reader slug: String? + + def slug=: (String) -> String + + def initialize: ( + id: String, + ?auto_add_operations: bool, + ?docs_pages: ::Array[String], + ?name: String, + ?operations: ::Array[String], + ?slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + id: String, + auto_add_operations: bool, + docs_pages: ::Array[String], + name: String, + operations: ::Array[String], + slug: String, + request_options: Scalar::RequestOptions + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rbs b/sig/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rbs new file mode 100644 index 0000000..2c730d6 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rbs @@ -0,0 +1,36 @@ +module Scalar + module Models + module Mcp + module Servers + type installation_create_access_group_params = + { id: String, installation_id: String, access_group_uid: String } + & Scalar::Internal::Type::request_parameters + + class InstallationCreateAccessGroupParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor id: String + + attr_accessor installation_id: String + + attr_accessor access_group_uid: String + + def initialize: ( + id: String, + installation_id: String, + access_group_uid: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + id: String, + installation_id: String, + access_group_uid: String, + request_options: Scalar::RequestOptions + } + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/servers/installation_create_params.rbs b/sig/scalar_api_ruby/models/mcp/servers/installation_create_params.rbs new file mode 100644 index 0000000..de2bc59 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/servers/installation_create_params.rbs @@ -0,0 +1,47 @@ +module Scalar + module Models + module Mcp + module Servers + type installation_create_params = + { + id: String, + document_auth: ::Hash[Symbol, top], + name: String, + slug: String + } + & Scalar::Internal::Type::request_parameters + + class InstallationCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor id: String + + attr_accessor document_auth: ::Hash[Symbol, top] + + attr_accessor name: String + + attr_reader slug: String? + + def slug=: (String) -> String + + def initialize: ( + id: String, + document_auth: ::Hash[Symbol, top], + name: String, + ?slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + id: String, + document_auth: ::Hash[Symbol, top], + name: String, + slug: String, + request_options: Scalar::RequestOptions + } + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rbs b/sig/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rbs new file mode 100644 index 0000000..5d8ec11 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rbs @@ -0,0 +1,36 @@ +module Scalar + module Models + module Mcp + module Servers + type installation_delete_access_group_params = + { id: String, installation_id: String, access_group_uid: String } + & Scalar::Internal::Type::request_parameters + + class InstallationDeleteAccessGroupParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor id: String + + attr_accessor installation_id: String + + attr_accessor access_group_uid: String + + def initialize: ( + id: String, + installation_id: String, + access_group_uid: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + id: String, + installation_id: String, + access_group_uid: String, + request_options: Scalar::RequestOptions + } + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/servers/installation_delete_params.rbs b/sig/scalar_api_ruby/models/mcp/servers/installation_delete_params.rbs new file mode 100644 index 0000000..c0427ee --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/servers/installation_delete_params.rbs @@ -0,0 +1,32 @@ +module Scalar + module Models + module Mcp + module Servers + type installation_delete_params = + { id: String, installation_id: String } + & Scalar::Internal::Type::request_parameters + + class InstallationDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor id: String + + attr_accessor installation_id: String + + def initialize: ( + id: String, + installation_id: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + id: String, + installation_id: String, + request_options: Scalar::RequestOptions + } + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/servers/installation_list_params.rbs b/sig/scalar_api_ruby/models/mcp/servers/installation_list_params.rbs new file mode 100644 index 0000000..540fbf3 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/servers/installation_list_params.rbs @@ -0,0 +1,27 @@ +module Scalar + module Models + module Mcp + module Servers + type installation_list_params = + { id: String } & Scalar::Internal::Type::request_parameters + + class InstallationListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor id: String + + def initialize: ( + id: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + id: String, + request_options: Scalar::RequestOptions + } + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/servers/installation_list_response.rbs b/sig/scalar_api_ruby/models/mcp/servers/installation_list_response.rbs new file mode 100644 index 0000000..a071df9 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/servers/installation_list_response.rbs @@ -0,0 +1,12 @@ +module Scalar + module Models + module Mcp + module Servers + type installation_list_response = + ::Array[Scalar::Mcp::Servers::McpInstallationListItem] + + InstallationListResponse: Scalar::Internal::Type::Converter + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rbs b/sig/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rbs new file mode 100644 index 0000000..580ed87 --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/servers/installation_retrieve_params.rbs @@ -0,0 +1,32 @@ +module Scalar + module Models + module Mcp + module Servers + type installation_retrieve_params = + { id: String, installation_id: String } + & Scalar::Internal::Type::request_parameters + + class InstallationRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor id: String + + attr_accessor installation_id: String + + def initialize: ( + id: String, + installation_id: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + id: String, + installation_id: String, + request_options: Scalar::RequestOptions + } + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/servers/installation_update_params.rbs b/sig/scalar_api_ruby/models/mcp/servers/installation_update_params.rbs new file mode 100644 index 0000000..125f2cb --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/servers/installation_update_params.rbs @@ -0,0 +1,73 @@ +module Scalar + module Models + module Mcp + module Servers + type installation_update_params = + { + id: String, + installation_id: String, + document_auth: ::Hash[Symbol, top], + is_private: bool, + login_portal_uid: String?, + mcp_version: String?, + name: String, + slug: String + } + & Scalar::Internal::Type::request_parameters + + class InstallationUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor id: String + + attr_accessor installation_id: String + + attr_reader document_auth: ::Hash[Symbol, top]? + + def document_auth=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + + attr_reader is_private: bool? + + def is_private=: (bool) -> bool + + attr_accessor login_portal_uid: String? + + attr_accessor mcp_version: String? + + attr_reader name: String? + + def name=: (String) -> String + + attr_reader slug: String? + + def slug=: (String) -> String + + def initialize: ( + id: String, + installation_id: String, + ?document_auth: ::Hash[Symbol, top], + ?is_private: bool, + ?login_portal_uid: String?, + ?mcp_version: String?, + ?name: String, + ?slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + id: String, + installation_id: String, + document_auth: ::Hash[Symbol, top], + is_private: bool, + login_portal_uid: String?, + mcp_version: String?, + name: String, + slug: String, + request_options: Scalar::RequestOptions + } + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rbs b/sig/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rbs new file mode 100644 index 0000000..1c4071d --- /dev/null +++ b/sig/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rbs @@ -0,0 +1,44 @@ +module Scalar + module Models + module Mcp + module Servers + type mcp_installation_list_item = + { + id: String, + is_private: bool, + mcp_version: String?, + name: String, + slug: String + } + + class McpInstallationListItem < Scalar::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor is_private: bool + + attr_accessor mcp_version: String? + + attr_accessor name: String + + attr_accessor slug: String + + def initialize: ( + id: String, + is_private: bool, + mcp_version: String?, + name: String, + slug: String + ) -> void + + def to_hash: -> { + id: String, + is_private: bool, + mcp_version: String?, + name: String, + slug: String + } + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/method.rbs b/sig/scalar_api_ruby/models/method.rbs new file mode 100644 index 0000000..dbfa7ae --- /dev/null +++ b/sig/scalar_api_ruby/models/method.rbs @@ -0,0 +1,30 @@ +module Scalar + module Models + type method_ = + :delete + | :get + | :head + | :options + | :patch + | :post + | :put + | :query + | :trace + + module Method + extend Scalar::Internal::Type::Enum + + DELETE: :delete + GET: :get + HEAD: :head + OPTIONS: :options + PATCH: :patch + POST: :post + PUT: :put + QUERY: :query + TRACE: :trace + + def self?.values: -> ::Array[Scalar::Models::method_] + end + end +end diff --git a/sig/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbs b/sig/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbs new file mode 100644 index 0000000..7161f18 --- /dev/null +++ b/sig/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbs @@ -0,0 +1,15 @@ +module Scalar + module Models + type o_auth_oauth_authorization_server_metadata_params = + { } & Scalar::Internal::Type::request_parameters + + class OAuthOauthAuthorizationServerMetadataParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + def initialize: (?request_options: Scalar::request_opts) -> void + + def to_hash: -> { request_options: Scalar::RequestOptions } + end + end +end diff --git a/sig/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbs b/sig/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbs new file mode 100644 index 0000000..a571ecd --- /dev/null +++ b/sig/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbs @@ -0,0 +1,15 @@ +module Scalar + module Models + type o_auth_oauth_authorize_params = + { } & Scalar::Internal::Type::request_parameters + + class OAuthOauthAuthorizeParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + def initialize: (?request_options: Scalar::request_opts) -> void + + def to_hash: -> { request_options: Scalar::RequestOptions } + end + end +end diff --git a/sig/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbs b/sig/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbs new file mode 100644 index 0000000..d9a25ac --- /dev/null +++ b/sig/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbs @@ -0,0 +1,47 @@ +module Scalar + module Models + type o_auth_oauth_revoke_params = + { + token: String, + client_id: String, + client_secret: String, + token_type_hint: String + } + & Scalar::Internal::Type::request_parameters + + class OAuthOauthRevokeParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor token: String + + attr_reader client_id: String? + + def client_id=: (String) -> String + + attr_reader client_secret: String? + + def client_secret=: (String) -> String + + attr_reader token_type_hint: String? + + def token_type_hint=: (String) -> String + + def initialize: ( + token: String, + ?client_id: String, + ?client_secret: String, + ?token_type_hint: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + token: String, + client_id: String, + client_secret: String, + token_type_hint: String, + request_options: Scalar::RequestOptions + } + end + end +end diff --git a/sig/scalar_api_ruby/models/o_auth_oauth_token_params.rbs b/sig/scalar_api_ruby/models/o_auth_oauth_token_params.rbs new file mode 100644 index 0000000..1e0b00e --- /dev/null +++ b/sig/scalar_api_ruby/models/o_auth_oauth_token_params.rbs @@ -0,0 +1,75 @@ +module Scalar + module Models + type o_auth_oauth_token_params = + { + grant_type: String, + client_id: String, + client_secret: String, + code: String, + code_verifier: String, + redirect_uri: String, + refresh_token: String, + scope: String + } + & Scalar::Internal::Type::request_parameters + + class OAuthOauthTokenParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor grant_type: String + + attr_reader client_id: String? + + def client_id=: (String) -> String + + attr_reader client_secret: String? + + def client_secret=: (String) -> String + + attr_reader code: String? + + def code=: (String) -> String + + attr_reader code_verifier: String? + + def code_verifier=: (String) -> String + + attr_reader redirect_uri: String? + + def redirect_uri=: (String) -> String + + attr_reader refresh_token: String? + + def refresh_token=: (String) -> String + + attr_reader scope: String? + + def scope=: (String) -> String + + def initialize: ( + grant_type: String, + ?client_id: String, + ?client_secret: String, + ?code: String, + ?code_verifier: String, + ?redirect_uri: String, + ?refresh_token: String, + ?scope: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + grant_type: String, + client_id: String, + client_secret: String, + code: String, + code_verifier: String, + redirect_uri: String, + refresh_token: String, + scope: String, + request_options: Scalar::RequestOptions + } + end + end +end diff --git a/sig/scalar_api_ruby/models/o_auth_oauth_token_response.rbs b/sig/scalar_api_ruby/models/o_auth_oauth_token_response.rbs new file mode 100644 index 0000000..7f6120e --- /dev/null +++ b/sig/scalar_api_ruby/models/o_auth_oauth_token_response.rbs @@ -0,0 +1,11 @@ +module Scalar + module Models + type o_auth_oauth_token_response = Scalar::OauthToken | Scalar::OauthError + + module OAuthOauthTokenResponse + extend Scalar::Internal::Type::Union + + def self?.variants: -> ::Array[Scalar::Models::o_auth_oauth_token_response] + end + end +end diff --git a/sig/scalar_api_ruby/models/oauth_authorization_server_metadata.rbs b/sig/scalar_api_ruby/models/oauth_authorization_server_metadata.rbs new file mode 100644 index 0000000..0985a7f --- /dev/null +++ b/sig/scalar_api_ruby/models/oauth_authorization_server_metadata.rbs @@ -0,0 +1,65 @@ +module Scalar + module Models + type oauth_authorization_server_metadata = + { + authorization_endpoint: String, + code_challenge_methods_supported: ::Array[String], + grant_types_supported: ::Array[String], + issuer: String, + response_types_supported: ::Array[String], + revocation_endpoint: String, + revocation_endpoint_auth_methods_supported: ::Array[String], + scopes_supported: ::Array[String], + token_endpoint: String, + token_endpoint_auth_methods_supported: ::Array[String] + } + + class OauthAuthorizationServerMetadata < Scalar::Internal::Type::BaseModel + attr_accessor authorization_endpoint: String + + attr_accessor code_challenge_methods_supported: ::Array[String] + + attr_accessor grant_types_supported: ::Array[String] + + attr_accessor issuer: String + + attr_accessor response_types_supported: ::Array[String] + + attr_accessor revocation_endpoint: String + + attr_accessor revocation_endpoint_auth_methods_supported: ::Array[String] + + attr_accessor scopes_supported: ::Array[String] + + attr_accessor token_endpoint: String + + attr_accessor token_endpoint_auth_methods_supported: ::Array[String] + + def initialize: ( + authorization_endpoint: String, + code_challenge_methods_supported: ::Array[String], + grant_types_supported: ::Array[String], + issuer: String, + response_types_supported: ::Array[String], + revocation_endpoint: String, + revocation_endpoint_auth_methods_supported: ::Array[String], + scopes_supported: ::Array[String], + token_endpoint: String, + token_endpoint_auth_methods_supported: ::Array[String] + ) -> void + + def to_hash: -> { + authorization_endpoint: String, + code_challenge_methods_supported: ::Array[String], + grant_types_supported: ::Array[String], + issuer: String, + response_types_supported: ::Array[String], + revocation_endpoint: String, + revocation_endpoint_auth_methods_supported: ::Array[String], + scopes_supported: ::Array[String], + token_endpoint: String, + token_endpoint_auth_methods_supported: ::Array[String] + } + end + end +end diff --git a/sig/scalar_api_ruby/models/oauth_error.rbs b/sig/scalar_api_ruby/models/oauth_error.rbs new file mode 100644 index 0000000..d42c37b --- /dev/null +++ b/sig/scalar_api_ruby/models/oauth_error.rbs @@ -0,0 +1,17 @@ +module Scalar + module Models + type oauth_error = { error: String, error_description: String } + + class OauthError < Scalar::Internal::Type::BaseModel + attr_accessor error: String + + attr_reader error_description: String? + + def error_description=: (String) -> String + + def initialize: (error: String, ?error_description: String) -> void + + def to_hash: -> { error: String, error_description: String } + end + end +end diff --git a/sig/scalar_api_ruby/models/oauth_scope.rbs b/sig/scalar_api_ruby/models/oauth_scope.rbs new file mode 100644 index 0000000..fb4dcaa --- /dev/null +++ b/sig/scalar_api_ruby/models/oauth_scope.rbs @@ -0,0 +1,15 @@ +module Scalar + module Models + type oauth_scope = :read | :write | :admin + + module OauthScope + extend Scalar::Internal::Type::Enum + + READ: :read + WRITE: :write + ADMIN: :admin + + def self?.values: -> ::Array[Scalar::Models::oauth_scope] + end + end +end diff --git a/sig/scalar_api_ruby/models/oauth_token.rbs b/sig/scalar_api_ruby/models/oauth_token.rbs new file mode 100644 index 0000000..1f6f32c --- /dev/null +++ b/sig/scalar_api_ruby/models/oauth_token.rbs @@ -0,0 +1,40 @@ +module Scalar + module Models + type oauth_token = + { + access_token: String, + expires_in: Integer, + refresh_token: String, + scope: Scalar::Models::oauth_scope, + token_type: :Bearer + } + + class OauthToken < Scalar::Internal::Type::BaseModel + attr_accessor access_token: String + + attr_accessor expires_in: Integer + + attr_accessor refresh_token: String + + attr_accessor scope: Scalar::Models::oauth_scope + + attr_accessor token_type: :Bearer + + def initialize: ( + access_token: String, + expires_in: Integer, + refresh_token: String, + scope: Scalar::Models::oauth_scope, + ?token_type: :Bearer + ) -> void + + def to_hash: -> { + access_token: String, + expires_in: Integer, + refresh_token: String, + scope: Scalar::Models::oauth_scope, + token_type: :Bearer + } + end + end +end diff --git a/sig/scalar_api_ruby/models/registry_list_all_api_documents_response.rbs b/sig/scalar_api_ruby/models/registry_list_all_api_documents_response.rbs index c39623f..2db2542 100644 --- a/sig/scalar_api_ruby/models/registry_list_all_api_documents_response.rbs +++ b/sig/scalar_api_ruby/models/registry_list_all_api_documents_response.rbs @@ -1,64 +1,6 @@ module Scalar module Models - type registry_list_all_api_documents_response_item = - { - description: String, - is_private: bool, - namespace: String, - slug: String, - tags: top, - title: String, - uid: String, - version: String, - versions: ::Array[Scalar::ManagedDocVersion] - } - - class RegistryListAllAPIDocumentsResponseItem < Scalar::Internal::Type::BaseModel - attr_accessor description: String - - attr_accessor is_private: bool - - attr_accessor namespace: String - - attr_accessor slug: String - - attr_accessor tags: top - - attr_accessor title: String - - attr_accessor uid: String - - attr_accessor version: String - - attr_accessor versions: ::Array[Scalar::ManagedDocVersion] - - def initialize: ( - description: String, - is_private: bool, - namespace: String, - slug: String, - tags: top, - title: String, - uid: String, - version: String, - versions: ::Array[Scalar::ManagedDocVersion] - ) -> void - - def to_hash: -> { - description: String, - is_private: bool, - namespace: String, - slug: String, - tags: top, - title: String, - uid: String, - version: String, - versions: ::Array[Scalar::ManagedDocVersion] - } - end - - type registry_list_all_api_documents_response = - ::Array[Scalar::Models::RegistryListAllAPIDocumentsResponseItem] + type registry_list_all_api_documents_response = ::Array[Scalar::APIDocument] RegistryListAllAPIDocumentsResponse: Scalar::Internal::Type::Converter end diff --git a/sig/scalar_api_ruby/models/registry_list_api_documents_response.rbs b/sig/scalar_api_ruby/models/registry_list_api_documents_response.rbs index b5f9a10..8349daa 100644 --- a/sig/scalar_api_ruby/models/registry_list_api_documents_response.rbs +++ b/sig/scalar_api_ruby/models/registry_list_api_documents_response.rbs @@ -1,64 +1,6 @@ module Scalar module Models - type registry_list_api_documents_response_item = - { - description: String, - is_private: bool, - namespace: String, - slug: String, - tags: top, - title: String, - uid: String, - version: String, - versions: ::Array[Scalar::ManagedDocVersion] - } - - class RegistryListAPIDocumentsResponseItem < Scalar::Internal::Type::BaseModel - attr_accessor description: String - - attr_accessor is_private: bool - - attr_accessor namespace: String - - attr_accessor slug: String - - attr_accessor tags: top - - attr_accessor title: String - - attr_accessor uid: String - - attr_accessor version: String - - attr_accessor versions: ::Array[Scalar::ManagedDocVersion] - - def initialize: ( - description: String, - is_private: bool, - namespace: String, - slug: String, - tags: top, - title: String, - uid: String, - version: String, - versions: ::Array[Scalar::ManagedDocVersion] - ) -> void - - def to_hash: -> { - description: String, - is_private: bool, - namespace: String, - slug: String, - tags: top, - title: String, - uid: String, - version: String, - versions: ::Array[Scalar::ManagedDocVersion] - } - end - - type registry_list_api_documents_response = - ::Array[Scalar::Models::RegistryListAPIDocumentsResponseItem] + type registry_list_api_documents_response = ::Array[Scalar::APIDocument] RegistryListAPIDocumentsResponse: Scalar::Internal::Type::Converter end diff --git a/sig/scalar_api_ruby/models/rule.rbs b/sig/scalar_api_ruby/models/rule.rbs new file mode 100644 index 0000000..f360472 --- /dev/null +++ b/sig/scalar_api_ruby/models/rule.rbs @@ -0,0 +1,45 @@ +module Scalar + module Models + type rule = + { + description: String, + is_private: bool, + namespace: String, + slug: String, + title: String, + uid: String + } + + class Rule < Scalar::Internal::Type::BaseModel + attr_accessor description: String + + attr_accessor is_private: bool + + attr_accessor namespace: String + + attr_accessor slug: String + + attr_accessor title: String + + attr_accessor uid: String + + def initialize: ( + description: String, + is_private: bool, + namespace: String, + slug: String, + title: String, + uid: String + ) -> void + + def to_hash: -> { + description: String, + is_private: bool, + namespace: String, + slug: String, + title: String, + uid: String + } + end + end +end diff --git a/sig/scalar_api_ruby/models/rule_list_rulesets_response.rbs b/sig/scalar_api_ruby/models/rule_list_rulesets_response.rbs index fc65878..3dbc15e 100644 --- a/sig/scalar_api_ruby/models/rule_list_rulesets_response.rbs +++ b/sig/scalar_api_ruby/models/rule_list_rulesets_response.rbs @@ -1,49 +1,6 @@ module Scalar module Models - type rule_list_rulesets_response_item = - { - description: String, - is_private: bool, - namespace: String, - slug: String, - title: String, - uid: String - } - - class RuleListRulesetsResponseItem < Scalar::Internal::Type::BaseModel - attr_accessor description: String - - attr_accessor is_private: bool - - attr_accessor namespace: String - - attr_accessor slug: String - - attr_accessor title: String - - attr_accessor uid: String - - def initialize: ( - description: String, - is_private: bool, - namespace: String, - slug: String, - title: String, - uid: String - ) -> void - - def to_hash: -> { - description: String, - is_private: bool, - namespace: String, - slug: String, - title: String, - uid: String - } - end - - type rule_list_rulesets_response = - ::Array[Scalar::Models::RuleListRulesetsResponseItem] + type rule_list_rulesets_response = ::Array[Scalar::Rule] RuleListRulesetsResponse: Scalar::Internal::Type::Converter end diff --git a/sig/scalar_api_ruby/models/scalar_doc_create_project_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_create_project_params.rbs new file mode 100644 index 0000000..fd546d9 --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_create_project_params.rbs @@ -0,0 +1,106 @@ +module Scalar + module Models + type scalar_doc_create_project_params = + { + name: String, + provider: Scalar::Models::ScalarDocCreateProjectParams::provider, + bitbucket_repository: Scalar::ScalarDocCreateProjectParams::BitbucketRepository, + blank: bool, + github_repository: Scalar::ScalarDocCreateProjectParams::GithubRepository, + is_private: bool, + slug: String + } + & Scalar::Internal::Type::request_parameters + + class ScalarDocCreateProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor name: String + + attr_accessor provider: Scalar::Models::ScalarDocCreateProjectParams::provider + + attr_reader bitbucket_repository: Scalar::ScalarDocCreateProjectParams::BitbucketRepository? + + def bitbucket_repository=: ( + Scalar::ScalarDocCreateProjectParams::BitbucketRepository + ) -> Scalar::ScalarDocCreateProjectParams::BitbucketRepository + + attr_reader blank: bool? + + def blank=: (bool) -> bool + + attr_reader github_repository: Scalar::ScalarDocCreateProjectParams::GithubRepository? + + def github_repository=: ( + Scalar::ScalarDocCreateProjectParams::GithubRepository + ) -> Scalar::ScalarDocCreateProjectParams::GithubRepository + + attr_reader is_private: bool? + + def is_private=: (bool) -> bool + + attr_reader slug: String? + + def slug=: (String) -> String + + def initialize: ( + name: String, + provider: Scalar::Models::ScalarDocCreateProjectParams::provider, + ?bitbucket_repository: Scalar::ScalarDocCreateProjectParams::BitbucketRepository, + ?blank: bool, + ?github_repository: Scalar::ScalarDocCreateProjectParams::GithubRepository, + ?is_private: bool, + ?slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + name: String, + provider: Scalar::Models::ScalarDocCreateProjectParams::provider, + bitbucket_repository: Scalar::ScalarDocCreateProjectParams::BitbucketRepository, + blank: bool, + github_repository: Scalar::ScalarDocCreateProjectParams::GithubRepository, + is_private: bool, + slug: String, + request_options: Scalar::RequestOptions + } + + type provider = :forgejo | :github | :bitbucket + + module Provider + extend Scalar::Internal::Type::Enum + + FORGEJO: :forgejo + GITHUB: :github + BITBUCKET: :bitbucket + + def self?.values: -> ::Array[Scalar::Models::ScalarDocCreateProjectParams::provider] + end + + type bitbucket_repository = { repo_uuid: String, workspace_uuid: String } + + class BitbucketRepository < Scalar::Internal::Type::BaseModel + attr_accessor repo_uuid: String + + attr_accessor workspace_uuid: String + + def initialize: (repo_uuid: String, workspace_uuid: String) -> void + + def to_hash: -> { repo_uuid: String, workspace_uuid: String } + end + + type github_repository = { installation_id: Integer, repo_id: Integer } + + class GithubRepository < Scalar::Internal::Type::BaseModel + attr_accessor installation_id: Integer + + attr_accessor repo_id: Integer + + def initialize: (installation_id: Integer, repo_id: Integer) -> void + + def to_hash: -> { installation_id: Integer, repo_id: Integer } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_delete_project_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_delete_project_params.rbs new file mode 100644 index 0000000..a10e62e --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_delete_project_params.rbs @@ -0,0 +1,20 @@ +module Scalar + module Models + type scalar_doc_delete_project_params = + { slug: String } & Scalar::Internal::Type::request_parameters + + class ScalarDocDeleteProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + def initialize: ( + slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { slug: String, request_options: Scalar::RequestOptions } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_list_guides_response.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_guides_response.rbs index 1bf376d..af1d56c 100644 --- a/sig/scalar_api_ruby/models/scalar_doc_list_guides_response.rbs +++ b/sig/scalar_api_ruby/models/scalar_doc_list_guides_response.rbs @@ -1,192 +1,6 @@ module Scalar module Models - type scalar_doc_list_guides_response_item = - { - access_groups: top, - active_deployment: Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment?, - active_theme_id: String, - agent_enabled: bool, - analytics_enabled: bool, - created_at: Integer, - is_private: bool, - last_published: Integer?, - last_published_uid: String?, - login_portal_uid: String, - name: String, - publish_message: String, - publish_status: String, - slug: String, - uid: String, - updated_at: Integer, - user_info_hook_url: String, - repository: Scalar::Models::ScalarDocListGuidesResponseItem::Repository?, - typesense_id: Float - } - - class ScalarDocListGuidesResponseItem < Scalar::Internal::Type::BaseModel - attr_accessor access_groups: top - - attr_accessor active_deployment: Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment? - - attr_accessor active_theme_id: String - - attr_accessor agent_enabled: bool - - attr_accessor analytics_enabled: bool - - attr_accessor created_at: Integer - - attr_accessor is_private: bool - - attr_accessor last_published: Integer? - - attr_accessor last_published_uid: String? - - attr_accessor login_portal_uid: String - - attr_accessor name: String - - attr_accessor publish_message: String - - attr_accessor publish_status: String - - attr_accessor slug: String - - attr_accessor uid: String - - attr_accessor updated_at: Integer - - attr_accessor user_info_hook_url: String - - attr_accessor repository: Scalar::Models::ScalarDocListGuidesResponseItem::Repository? - - attr_reader typesense_id: Float? - - def typesense_id=: (Float) -> Float - - def initialize: ( - access_groups: top, - active_deployment: Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment?, - active_theme_id: String, - agent_enabled: bool, - analytics_enabled: bool, - created_at: Integer, - is_private: bool, - last_published: Integer?, - last_published_uid: String?, - login_portal_uid: String, - name: String, - publish_message: String, - publish_status: String, - slug: String, - uid: String, - updated_at: Integer, - user_info_hook_url: String, - ?repository: Scalar::Models::ScalarDocListGuidesResponseItem::Repository?, - ?typesense_id: Float - ) -> void - - def to_hash: -> { - access_groups: top, - active_deployment: Scalar::Models::ScalarDocListGuidesResponseItem::ActiveDeployment?, - active_theme_id: String, - agent_enabled: bool, - analytics_enabled: bool, - created_at: Integer, - is_private: bool, - last_published: Integer?, - last_published_uid: String?, - login_portal_uid: String, - name: String, - publish_message: String, - publish_status: String, - slug: String, - uid: String, - updated_at: Integer, - user_info_hook_url: String, - repository: Scalar::Models::ScalarDocListGuidesResponseItem::Repository?, - typesense_id: Float - } - - type active_deployment = - { domain: String, published_at: Integer, uid: String } - - class ActiveDeployment < Scalar::Internal::Type::BaseModel - attr_accessor domain: String - - attr_accessor published_at: Integer - - attr_accessor uid: String - - def initialize: ( - domain: String, - published_at: Integer, - uid: String - ) -> void - - def to_hash: -> { domain: String, published_at: Integer, uid: String } - end - - type repository = - { - id: Float, - branch: String, - config_path: String, - expired: bool, - linked_by: String, - name: String, - pr_comments: bool, - publish_on_merge: bool, - publish_previews: bool - } - - class Repository < Scalar::Internal::Type::BaseModel - attr_accessor id: Float - - attr_accessor branch: String - - attr_accessor config_path: String - - attr_accessor expired: bool - - attr_accessor linked_by: String - - attr_accessor name: String - - attr_accessor pr_comments: bool - - attr_accessor publish_on_merge: bool - - attr_accessor publish_previews: bool - - def initialize: ( - id: Float, - branch: String, - config_path: String, - expired: bool, - linked_by: String, - name: String, - pr_comments: bool, - publish_on_merge: bool, - publish_previews: bool - ) -> void - - def to_hash: -> { - id: Float, - branch: String, - config_path: String, - expired: bool, - linked_by: String, - name: String, - pr_comments: bool, - publish_on_merge: bool, - publish_previews: bool - } - end - end - - type scalar_doc_list_guides_response = - ::Array[Scalar::Models::ScalarDocListGuidesResponseItem] + type scalar_doc_list_guides_response = ::Array[Scalar::GithubProject] ScalarDocListGuidesResponse: Scalar::Internal::Type::Converter end diff --git a/sig/scalar_api_ruby/models/scalar_doc_list_project_config_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_project_config_params.rbs new file mode 100644 index 0000000..24f0539 --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_list_project_config_params.rbs @@ -0,0 +1,29 @@ +module Scalar + module Models + type scalar_doc_list_project_config_params = + { slug: String, ref: String } & Scalar::Internal::Type::request_parameters + + class ScalarDocListProjectConfigParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + attr_reader ref: String? + + def ref=: (String) -> String + + def initialize: ( + slug: String, + ?ref: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + slug: String, + ref: String, + request_options: Scalar::RequestOptions + } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_list_project_config_response.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_project_config_response.rbs new file mode 100644 index 0000000..3481867 --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_list_project_config_response.rbs @@ -0,0 +1,30 @@ +module Scalar + module Models + type scalar_doc_list_project_config_response = + { base_token: String, content: String, path: String, ref: String } + + class ScalarDocListProjectConfigResponse < Scalar::Internal::Type::BaseModel + attr_accessor base_token: String + + attr_accessor content: String + + attr_accessor path: String + + attr_accessor ref: String + + def initialize: ( + base_token: String, + content: String, + path: String, + ref: String + ) -> void + + def to_hash: -> { + base_token: String, + content: String, + path: String, + ref: String + } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rbs new file mode 100644 index 0000000..65bf36e --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rbs @@ -0,0 +1,20 @@ +module Scalar + module Models + type scalar_doc_list_project_domain_params = + { slug: String } & Scalar::Internal::Type::request_parameters + + class ScalarDocListProjectDomainParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + def initialize: ( + slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { slug: String, request_options: Scalar::RequestOptions } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rbs new file mode 100644 index 0000000..23ec83c --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rbs @@ -0,0 +1,16 @@ +module Scalar + module Models + type scalar_doc_list_project_domain_response = + { custom_domain: String?, scalar_domain: String? } + + class ScalarDocListProjectDomainResponse < Scalar::Internal::Type::BaseModel + attr_accessor custom_domain: String? + + attr_accessor scalar_domain: String? + + def initialize: (custom_domain: String?, scalar_domain: String?) -> void + + def to_hash: -> { custom_domain: String?, scalar_domain: String? } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rbs new file mode 100644 index 0000000..694155c --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rbs @@ -0,0 +1,20 @@ +module Scalar + module Models + type scalar_doc_list_project_domain_status_params = + { slug: String } & Scalar::Internal::Type::request_parameters + + class ScalarDocListProjectDomainStatusParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + def initialize: ( + slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { slug: String, request_options: Scalar::RequestOptions } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rbs new file mode 100644 index 0000000..8c4925b --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rbs @@ -0,0 +1,59 @@ +module Scalar + module Models + type scalar_doc_list_project_domain_status_response = + { + domain: String?, + expected: Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected?, + found: ::Array[String], + status: Scalar::Models::ScalarDocListProjectDomainStatusResponse::status + } + + class ScalarDocListProjectDomainStatusResponse < Scalar::Internal::Type::BaseModel + attr_accessor domain: String? + + attr_accessor expected: Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected? + + attr_accessor found: ::Array[String] + + attr_accessor status: Scalar::Models::ScalarDocListProjectDomainStatusResponse::status + + def initialize: ( + domain: String?, + expected: Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected?, + found: ::Array[String], + status: Scalar::Models::ScalarDocListProjectDomainStatusResponse::status + ) -> void + + def to_hash: -> { + domain: String?, + expected: Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected?, + found: ::Array[String], + status: Scalar::Models::ScalarDocListProjectDomainStatusResponse::status + } + + type expected = { target: String, type: :CNAME } + + class Expected < Scalar::Internal::Type::BaseModel + attr_accessor target: String + + attr_accessor type: :CNAME + + def initialize: (target: String, ?type: :CNAME) -> void + + def to_hash: -> { target: String, type: :CNAME } + end + + type status = :verified | :pending | :misconfigured + + module Status + extend Scalar::Internal::Type::Enum + + VERIFIED: :verified + PENDING: :pending + MISCONFIGURED: :misconfigured + + def self?.values: -> ::Array[Scalar::Models::ScalarDocListProjectDomainStatusResponse::status] + end + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_list_projects_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_projects_params.rbs new file mode 100644 index 0000000..6103467 --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_list_projects_params.rbs @@ -0,0 +1,25 @@ +module Scalar + module Models + type scalar_doc_list_projects_params = + { limit: Integer } & Scalar::Internal::Type::request_parameters + + class ScalarDocListProjectsParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_reader limit: Integer? + + def limit=: (Integer) -> Integer + + def initialize: ( + ?limit: Integer, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + limit: Integer, + request_options: Scalar::RequestOptions + } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_list_projects_response.rbs b/sig/scalar_api_ruby/models/scalar_doc_list_projects_response.rbs new file mode 100644 index 0000000..ba587e8 --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_list_projects_response.rbs @@ -0,0 +1,19 @@ +module Scalar + module Models + type scalar_doc_list_projects_response = + { data: ::Array[Scalar::DocsProject], has_more: bool } + + class ScalarDocListProjectsResponse < Scalar::Internal::Type::BaseModel + attr_accessor data: ::Array[Scalar::DocsProject] + + attr_accessor has_more: bool + + def initialize: ( + data: ::Array[Scalar::DocsProject], + has_more: bool + ) -> void + + def to_hash: -> { data: ::Array[Scalar::DocsProject], has_more: bool } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_publish_project_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_publish_project_params.rbs new file mode 100644 index 0000000..bf30763 --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_publish_project_params.rbs @@ -0,0 +1,42 @@ +module Scalar + module Models + type scalar_doc_publish_project_params = + { slug: String, commit_sha: String, config_path: String, preview: bool } + & Scalar::Internal::Type::request_parameters + + class ScalarDocPublishProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + attr_reader commit_sha: String? + + def commit_sha=: (String) -> String + + attr_reader config_path: String? + + def config_path=: (String) -> String + + attr_reader preview: bool? + + def preview=: (bool) -> bool + + def initialize: ( + slug: String, + ?commit_sha: String, + ?config_path: String, + ?preview: bool, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + slug: String, + commit_sha: String, + config_path: String, + preview: bool, + request_options: Scalar::RequestOptions + } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_publish_project_response.rbs b/sig/scalar_api_ruby/models/scalar_doc_publish_project_response.rbs new file mode 100644 index 0000000..cd90da2 --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_publish_project_response.rbs @@ -0,0 +1,13 @@ +module Scalar + module Models + type scalar_doc_publish_project_response = { publish_uid: String } + + class ScalarDocPublishProjectResponse < Scalar::Internal::Type::BaseModel + attr_accessor publish_uid: String + + def initialize: (publish_uid: String) -> void + + def to_hash: -> { publish_uid: String } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rbs new file mode 100644 index 0000000..7875bfb --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rbs @@ -0,0 +1,20 @@ +module Scalar + module Models + type scalar_doc_retrieve_project_params = + { slug: String } & Scalar::Internal::Type::request_parameters + + class ScalarDocRetrieveProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + def initialize: ( + slug: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { slug: String, request_options: Scalar::RequestOptions } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_update_project_config_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_update_project_config_params.rbs new file mode 100644 index 0000000..67eb6eb --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_update_project_config_params.rbs @@ -0,0 +1,59 @@ +module Scalar + module Models + type scalar_doc_update_project_config_params = + { + slug: String, + content: String, + base_token: String, + message: String, + path: String, + ref: String + } + & Scalar::Internal::Type::request_parameters + + class ScalarDocUpdateProjectConfigParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + attr_accessor content: String + + attr_reader base_token: String? + + def base_token=: (String) -> String + + attr_reader message: String? + + def message=: (String) -> String + + attr_reader path: String? + + def path=: (String) -> String + + attr_reader ref: String? + + def ref=: (String) -> String + + def initialize: ( + slug: String, + content: String, + ?base_token: String, + ?message: String, + ?path: String, + ?ref: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + slug: String, + content: String, + base_token: String, + message: String, + path: String, + ref: String, + request_options: Scalar::RequestOptions + } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_update_project_config_response.rbs b/sig/scalar_api_ruby/models/scalar_doc_update_project_config_response.rbs new file mode 100644 index 0000000..e7ba845 --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_update_project_config_response.rbs @@ -0,0 +1,22 @@ +module Scalar + module Models + type scalar_doc_update_project_config_response = + { base_token: String, commit_sha: String?, ref: String } + + class ScalarDocUpdateProjectConfigResponse < Scalar::Internal::Type::BaseModel + attr_accessor base_token: String + + attr_accessor commit_sha: String? + + attr_accessor ref: String + + def initialize: ( + base_token: String, + commit_sha: String?, + ref: String + ) -> void + + def to_hash: -> { base_token: String, commit_sha: String?, ref: String } + end + end +end diff --git a/sig/scalar_api_ruby/models/scalar_doc_update_project_params.rbs b/sig/scalar_api_ruby/models/scalar_doc_update_project_params.rbs new file mode 100644 index 0000000..15ce9be --- /dev/null +++ b/sig/scalar_api_ruby/models/scalar_doc_update_project_params.rbs @@ -0,0 +1,85 @@ +module Scalar + module Models + type scalar_doc_update_project_params = + { + slug: String, + access_groups: ::Array[String], + active_theme_id: String, + agent_enabled: bool, + analytics_enabled: bool, + is_private: bool, + login_portal_uid: Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid, + name: String + } + & Scalar::Internal::Type::request_parameters + + class ScalarDocUpdateProjectParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor slug: String + + attr_reader access_groups: ::Array[String]? + + def access_groups=: (::Array[String]) -> ::Array[String] + + attr_reader active_theme_id: String? + + def active_theme_id=: (String) -> String + + attr_reader agent_enabled: bool? + + def agent_enabled=: (bool) -> bool + + attr_reader analytics_enabled: bool? + + def analytics_enabled=: (bool) -> bool + + attr_reader is_private: bool? + + def is_private=: (bool) -> bool + + attr_reader login_portal_uid: Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid? + + def login_portal_uid=: ( + Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid + ) -> Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid + + attr_reader name: String? + + def name=: (String) -> String + + def initialize: ( + slug: String, + ?access_groups: ::Array[String], + ?active_theme_id: String, + ?agent_enabled: bool, + ?analytics_enabled: bool, + ?is_private: bool, + ?login_portal_uid: Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid, + ?name: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + slug: String, + access_groups: ::Array[String], + active_theme_id: String, + agent_enabled: bool, + analytics_enabled: bool, + is_private: bool, + login_portal_uid: Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid, + name: String, + request_options: Scalar::RequestOptions + } + + type login_portal_uid = String | :"" + + module LoginPortalUID + extend Scalar::Internal::Type::Union + + def self?.variants: -> ::Array[Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid] + end + end + end +end diff --git a/sig/scalar_api_ruby/models/schema.rbs b/sig/scalar_api_ruby/models/schema.rbs new file mode 100644 index 0000000..cdb6556 --- /dev/null +++ b/sig/scalar_api_ruby/models/schema.rbs @@ -0,0 +1,50 @@ +module Scalar + module Models + type schema = + { + description: String, + is_private: bool, + namespace: String, + slug: String, + title: String, + uid: String, + versions: ::Array[Scalar::ManagedSchemaVersion] + } + + class Schema < Scalar::Internal::Type::BaseModel + attr_accessor description: String + + attr_accessor is_private: bool + + attr_accessor namespace: String + + attr_accessor slug: String + + attr_accessor title: String + + attr_accessor uid: String + + attr_accessor versions: ::Array[Scalar::ManagedSchemaVersion] + + def initialize: ( + description: String, + is_private: bool, + namespace: String, + slug: String, + title: String, + uid: String, + versions: ::Array[Scalar::ManagedSchemaVersion] + ) -> void + + def to_hash: -> { + description: String, + is_private: bool, + namespace: String, + slug: String, + title: String, + uid: String, + versions: ::Array[Scalar::ManagedSchemaVersion] + } + end + end +end diff --git a/sig/scalar_api_ruby/models/schema_list_response.rbs b/sig/scalar_api_ruby/models/schema_list_response.rbs index fc0c926..c3d9e8a 100644 --- a/sig/scalar_api_ruby/models/schema_list_response.rbs +++ b/sig/scalar_api_ruby/models/schema_list_response.rbs @@ -1,99 +1,6 @@ module Scalar module Models - type schema_list_response_item = - { - description: String, - is_private: bool, - namespace: String, - slug: String, - title: String, - uid: String, - versions: ::Array[Scalar::Models::SchemaListResponseItem::Version] - } - - class SchemaListResponseItem < Scalar::Internal::Type::BaseModel - attr_accessor description: String - - attr_accessor is_private: bool - - attr_accessor namespace: String - - attr_accessor slug: String - - attr_accessor title: String - - attr_accessor uid: String - - attr_accessor versions: ::Array[Scalar::Models::SchemaListResponseItem::Version] - - def initialize: ( - description: String, - is_private: bool, - namespace: String, - slug: String, - title: String, - uid: String, - versions: ::Array[Scalar::Models::SchemaListResponseItem::Version] - ) -> void - - def to_hash: -> { - description: String, - is_private: bool, - namespace: String, - slug: String, - title: String, - uid: String, - versions: ::Array[Scalar::Models::SchemaListResponseItem::Version] - } - - type version = - { - created_at: Integer, - uid: String, - updated_at: Integer, - version: String, - json_sha: String, - yaml_sha: String - } - - class Version < Scalar::Internal::Type::BaseModel - attr_accessor created_at: Integer - - attr_accessor uid: String - - attr_accessor updated_at: Integer - - attr_accessor version: String - - attr_reader json_sha: String? - - def json_sha=: (String) -> String - - attr_reader yaml_sha: String? - - def yaml_sha=: (String) -> String - - def initialize: ( - created_at: Integer, - uid: String, - updated_at: Integer, - version: String, - ?json_sha: String, - ?yaml_sha: String - ) -> void - - def to_hash: -> { - created_at: Integer, - uid: String, - updated_at: Integer, - version: String, - json_sha: String, - yaml_sha: String - } - end - end - - type schema_list_response = ::Array[Scalar::Models::SchemaListResponseItem] + type schema_list_response = ::Array[Scalar::Schema] SchemaListResponse: Scalar::Internal::Type::Converter end diff --git a/sig/scalar_api_ruby/models/sdk.rbs b/sig/scalar_api_ruby/models/sdk.rbs new file mode 100644 index 0000000..396ea78 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk.rbs @@ -0,0 +1,70 @@ +module Scalar + module Models + type sdk = + { + api_uid: String?, + current_version: String, + description: String, + is_private: bool, + namespace: String, + slug: String, + targets: ::Array[Scalar::SdkTargetSummary], + title: String, + uid: String, + versions: ::Array[Scalar::SdkVersion], + api_version: String? + } + + class Sdk < Scalar::Internal::Type::BaseModel + attr_accessor api_uid: String? + + attr_accessor current_version: String + + attr_accessor description: String + + attr_accessor is_private: bool + + attr_accessor namespace: String + + attr_accessor slug: String + + attr_accessor targets: ::Array[Scalar::SdkTargetSummary] + + attr_accessor title: String + + attr_accessor uid: String + + attr_accessor versions: ::Array[Scalar::SdkVersion] + + attr_accessor api_version: String? + + def initialize: ( + api_uid: String?, + current_version: String, + description: String, + is_private: bool, + namespace: String, + slug: String, + targets: ::Array[Scalar::SdkTargetSummary], + title: String, + uid: String, + versions: ::Array[Scalar::SdkVersion], + ?api_version: String? + ) -> void + + def to_hash: -> { + api_uid: String?, + current_version: String, + description: String, + is_private: bool, + namespace: String, + slug: String, + targets: ::Array[Scalar::SdkTargetSummary], + title: String, + uid: String, + versions: ::Array[Scalar::SdkVersion], + api_version: String? + } + end + end +end diff --git a/sig/scalar_api_ruby/models/sdk_build_params.rbs b/sig/scalar_api_ruby/models/sdk_build_params.rbs new file mode 100644 index 0000000..b719c15 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk_build_params.rbs @@ -0,0 +1,77 @@ +module Scalar + module Models + type sdk_build_params = + { + uid: String, + languages: ::Array[Scalar::Models::SdkBuildParams::language], + version: String + } + & Scalar::Internal::Type::request_parameters + + class SdkBuildParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + attr_reader languages: ::Array[Scalar::Models::SdkBuildParams::language]? + + def languages=: ( + ::Array[Scalar::Models::SdkBuildParams::language] + ) -> ::Array[Scalar::Models::SdkBuildParams::language] + + attr_reader version: String? + + def version=: (String) -> String + + def initialize: ( + uid: String, + ?languages: ::Array[Scalar::Models::SdkBuildParams::language], + ?version: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + uid: String, + languages: ::Array[Scalar::Models::SdkBuildParams::language], + version: String, + request_options: Scalar::RequestOptions + } + + type language = + :typescript + | :python + | :cli + | :csharp + | :java + | :ruby + | :php + | :go + | :rust + | :kotlin + | :swift + | :cpp + | :dart + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT: :typescript + PYTHON: :python + CLI: :cli + CSHARP: :csharp + JAVA: :java + RUBY: :ruby + PHP: :php + GO: :go + RUST: :rust + KOTLIN: :kotlin + SWIFT: :swift + CPP: :cpp + DART: :dart + + def self?.values: -> ::Array[Scalar::Models::SdkBuildParams::language] + end + end + end +end diff --git a/sig/scalar_api_ruby/models/sdk_build_response.rbs b/sig/scalar_api_ruby/models/sdk_build_response.rbs new file mode 100644 index 0000000..ff0e401 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk_build_response.rbs @@ -0,0 +1,13 @@ +module Scalar + module Models + type sdk_build_response = { version: String } + + class SdkBuildResponse < Scalar::Internal::Type::BaseModel + attr_accessor version: String + + def initialize: (version: String) -> void + + def to_hash: -> { version: String } + end + end +end diff --git a/sig/scalar_api_ruby/models/sdk_create_params.rbs b/sig/scalar_api_ruby/models/sdk_create_params.rbs new file mode 100644 index 0000000..e8f68f3 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk_create_params.rbs @@ -0,0 +1,94 @@ +module Scalar + module Models + type sdk_create_params = + { + api_uid: String, + languages: ::Array[Scalar::Models::SdkCreateParams::language], + class_name: String, + config: String, + slug: String, + title: String + } + & Scalar::Internal::Type::request_parameters + + class SdkCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor api_uid: String + + attr_accessor languages: ::Array[Scalar::Models::SdkCreateParams::language] + + attr_reader class_name: String? + + def class_name=: (String) -> String + + attr_reader config: String? + + def config=: (String) -> String + + attr_reader slug: String? + + def slug=: (String) -> String + + attr_reader title: String? + + def title=: (String) -> String + + def initialize: ( + api_uid: String, + languages: ::Array[Scalar::Models::SdkCreateParams::language], + ?class_name: String, + ?config: String, + ?slug: String, + ?title: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + api_uid: String, + languages: ::Array[Scalar::Models::SdkCreateParams::language], + class_name: String, + config: String, + slug: String, + title: String, + request_options: Scalar::RequestOptions + } + + type language = + :typescript + | :python + | :cli + | :csharp + | :java + | :ruby + | :php + | :go + | :rust + | :kotlin + | :swift + | :cpp + | :dart + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT: :typescript + PYTHON: :python + CLI: :cli + CSHARP: :csharp + JAVA: :java + RUBY: :ruby + PHP: :php + GO: :go + RUST: :rust + KOTLIN: :kotlin + SWIFT: :swift + CPP: :cpp + DART: :dart + + def self?.values: -> ::Array[Scalar::Models::SdkCreateParams::language] + end + end + end +end diff --git a/sig/scalar_api_ruby/models/sdk_delete_params.rbs b/sig/scalar_api_ruby/models/sdk_delete_params.rbs new file mode 100644 index 0000000..8d12e99 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk_delete_params.rbs @@ -0,0 +1,20 @@ +module Scalar + module Models + type sdk_delete_params = + { uid: String } & Scalar::Internal::Type::request_parameters + + class SdkDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + def initialize: ( + uid: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { uid: String, request_options: Scalar::RequestOptions } + end + end +end diff --git a/sig/scalar_api_ruby/models/sdk_list_params.rbs b/sig/scalar_api_ruby/models/sdk_list_params.rbs new file mode 100644 index 0000000..a0ad5f4 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk_list_params.rbs @@ -0,0 +1,25 @@ +module Scalar + module Models + type sdk_list_params = + { limit: Integer } & Scalar::Internal::Type::request_parameters + + class SdkListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_reader limit: Integer? + + def limit=: (Integer) -> Integer + + def initialize: ( + ?limit: Integer, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + limit: Integer, + request_options: Scalar::RequestOptions + } + end + end +end diff --git a/sig/scalar_api_ruby/models/sdk_list_response.rbs b/sig/scalar_api_ruby/models/sdk_list_response.rbs new file mode 100644 index 0000000..574bdcc --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk_list_response.rbs @@ -0,0 +1,15 @@ +module Scalar + module Models + type sdk_list_response = { data: ::Array[Scalar::Sdk], has_more: bool } + + class SdkListResponse < Scalar::Internal::Type::BaseModel + attr_accessor data: ::Array[Scalar::Sdk] + + attr_accessor has_more: bool + + def initialize: (data: ::Array[Scalar::Sdk], has_more: bool) -> void + + def to_hash: -> { data: ::Array[Scalar::Sdk], has_more: bool } + end + end +end diff --git a/sig/scalar_api_ruby/models/sdk_retrieve_params.rbs b/sig/scalar_api_ruby/models/sdk_retrieve_params.rbs new file mode 100644 index 0000000..8761391 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk_retrieve_params.rbs @@ -0,0 +1,20 @@ +module Scalar + module Models + type sdk_retrieve_params = + { uid: String } & Scalar::Internal::Type::request_parameters + + class SdkRetrieveParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + def initialize: ( + uid: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { uid: String, request_options: Scalar::RequestOptions } + end + end +end diff --git a/sig/scalar_api_ruby/models/sdk_target_summary.rbs b/sig/scalar_api_ruby/models/sdk_target_summary.rbs new file mode 100644 index 0000000..6895b56 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk_target_summary.rbs @@ -0,0 +1,57 @@ +module Scalar + module Models + type sdk_target_summary = + { language: Scalar::Models::SdkTargetSummary::language, slug: String } + + class SdkTargetSummary < Scalar::Internal::Type::BaseModel + attr_accessor language: Scalar::Models::SdkTargetSummary::language + + attr_accessor slug: String + + def initialize: ( + language: Scalar::Models::SdkTargetSummary::language, + slug: String + ) -> void + + def to_hash: -> { + language: Scalar::Models::SdkTargetSummary::language, + slug: String + } + + type language = + :typescript + | :python + | :cli + | :csharp + | :java + | :ruby + | :php + | :go + | :rust + | :kotlin + | :swift + | :cpp + | :dart + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT: :typescript + PYTHON: :python + CLI: :cli + CSHARP: :csharp + JAVA: :java + RUBY: :ruby + PHP: :php + GO: :go + RUST: :rust + KOTLIN: :kotlin + SWIFT: :swift + CPP: :cpp + DART: :dart + + def self?.values: -> ::Array[Scalar::Models::SdkTargetSummary::language] + end + end + end +end diff --git a/sig/scalar_api_ruby/models/sdk_update_params.rbs b/sig/scalar_api_ruby/models/sdk_update_params.rbs new file mode 100644 index 0000000..d2782af --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk_update_params.rbs @@ -0,0 +1,64 @@ +module Scalar + module Models + type sdk_update_params = + { + uid: String, + api_uid: String?, + api_version: String?, + config: String, + is_private: bool, + slug: String, + title: String + } + & Scalar::Internal::Type::request_parameters + + class SdkUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + attr_accessor api_uid: String? + + attr_accessor api_version: String? + + attr_reader config: String? + + def config=: (String) -> String + + attr_reader is_private: bool? + + def is_private=: (bool) -> bool + + attr_reader slug: String? + + def slug=: (String) -> String + + attr_reader title: String? + + def title=: (String) -> String + + def initialize: ( + uid: String, + ?api_uid: String?, + ?api_version: String?, + ?config: String, + ?is_private: bool, + ?slug: String, + ?title: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + uid: String, + api_uid: String?, + api_version: String?, + config: String, + is_private: bool, + slug: String, + title: String, + request_options: Scalar::RequestOptions + } + end + end +end diff --git a/sig/scalar_api_ruby/models/sdk_version.rbs b/sig/scalar_api_ruby/models/sdk_version.rbs new file mode 100644 index 0000000..0b8f756 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdk_version.rbs @@ -0,0 +1,95 @@ +module Scalar + module Models + type sdk_version = + { + api_version: String, + languages: ::Array[Scalar::Models::SdkVersion::language], + status: Scalar::Models::SdkVersion::status, + version: String, + created_at: Integer, + published_at: Integer + } + + class SdkVersion < Scalar::Internal::Type::BaseModel + attr_accessor api_version: String + + attr_accessor languages: ::Array[Scalar::Models::SdkVersion::language] + + attr_accessor status: Scalar::Models::SdkVersion::status + + attr_accessor version: String + + attr_reader created_at: Integer? + + def created_at=: (Integer) -> Integer + + attr_reader published_at: Integer? + + def published_at=: (Integer) -> Integer + + def initialize: ( + api_version: String, + languages: ::Array[Scalar::Models::SdkVersion::language], + status: Scalar::Models::SdkVersion::status, + version: String, + ?created_at: Integer, + ?published_at: Integer + ) -> void + + def to_hash: -> { + api_version: String, + languages: ::Array[Scalar::Models::SdkVersion::language], + status: Scalar::Models::SdkVersion::status, + version: String, + created_at: Integer, + published_at: Integer + } + + type language = + :typescript + | :python + | :cli + | :csharp + | :java + | :ruby + | :php + | :go + | :rust + | :kotlin + | :swift + | :cpp + | :dart + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT: :typescript + PYTHON: :python + CLI: :cli + CSHARP: :csharp + JAVA: :java + RUBY: :ruby + PHP: :php + GO: :go + RUST: :rust + KOTLIN: :kotlin + SWIFT: :swift + CPP: :cpp + DART: :dart + + def self?.values: -> ::Array[Scalar::Models::SdkVersion::language] + end + + type status = :draft | :published + + module Status + extend Scalar::Internal::Type::Enum + + DRAFT: :draft + PUBLISHED: :published + + def self?.values: -> ::Array[Scalar::Models::SdkVersion::status] + end + end + end +end diff --git a/sig/scalar_api_ruby/models/sdks/repository_link_params.rbs b/sig/scalar_api_ruby/models/sdks/repository_link_params.rbs new file mode 100644 index 0000000..2857891 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdks/repository_link_params.rbs @@ -0,0 +1,85 @@ +module Scalar + module Models + module Sdks + type repository_link_params = + { + uid: String, + base_branch: String, + language: Scalar::Models::Sdks::RepositoryLinkParams::language, + repository_id: Integer, + prerelease_type: String + } + & Scalar::Internal::Type::request_parameters + + class RepositoryLinkParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + attr_accessor base_branch: String + + attr_accessor language: Scalar::Models::Sdks::RepositoryLinkParams::language + + attr_accessor repository_id: Integer + + attr_reader prerelease_type: String? + + def prerelease_type=: (String) -> String + + def initialize: ( + uid: String, + base_branch: String, + language: Scalar::Models::Sdks::RepositoryLinkParams::language, + repository_id: Integer, + ?prerelease_type: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + uid: String, + base_branch: String, + language: Scalar::Models::Sdks::RepositoryLinkParams::language, + repository_id: Integer, + prerelease_type: String, + request_options: Scalar::RequestOptions + } + + type language = + :typescript + | :python + | :cli + | :csharp + | :java + | :ruby + | :php + | :go + | :rust + | :kotlin + | :swift + | :cpp + | :dart + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT: :typescript + PYTHON: :python + CLI: :cli + CSHARP: :csharp + JAVA: :java + RUBY: :ruby + PHP: :php + GO: :go + RUST: :rust + KOTLIN: :kotlin + SWIFT: :swift + CPP: :cpp + DART: :dart + + def self?.values: -> ::Array[Scalar::Models::Sdks::RepositoryLinkParams::language] + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/sdks/repository_link_response.rbs b/sig/scalar_api_ruby/models/sdks/repository_link_response.rbs new file mode 100644 index 0000000..df6d88b --- /dev/null +++ b/sig/scalar_api_ruby/models/sdks/repository_link_response.rbs @@ -0,0 +1,17 @@ +module Scalar + module Models + module Sdks + type repository_link_response = { branch: String, repo: String } + + class RepositoryLinkResponse < Scalar::Internal::Type::BaseModel + attr_accessor branch: String + + attr_accessor repo: String + + def initialize: (branch: String, repo: String) -> void + + def to_hash: -> { branch: String, repo: String } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/sdks/repository_unlink_params.rbs b/sig/scalar_api_ruby/models/sdks/repository_unlink_params.rbs new file mode 100644 index 0000000..6920178 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdks/repository_unlink_params.rbs @@ -0,0 +1,68 @@ +module Scalar + module Models + module Sdks + type repository_unlink_params = + { + uid: String, + language: Scalar::Models::Sdks::RepositoryUnlinkParams::language + } + & Scalar::Internal::Type::request_parameters + + class RepositoryUnlinkParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + attr_accessor language: Scalar::Models::Sdks::RepositoryUnlinkParams::language + + def initialize: ( + uid: String, + language: Scalar::Models::Sdks::RepositoryUnlinkParams::language, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + uid: String, + language: Scalar::Models::Sdks::RepositoryUnlinkParams::language, + request_options: Scalar::RequestOptions + } + + type language = + :typescript + | :python + | :cli + | :csharp + | :java + | :ruby + | :php + | :go + | :rust + | :kotlin + | :swift + | :cpp + | :dart + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT: :typescript + PYTHON: :python + CLI: :cli + CSHARP: :csharp + JAVA: :java + RUBY: :ruby + PHP: :php + GO: :go + RUST: :rust + KOTLIN: :kotlin + SWIFT: :swift + CPP: :cpp + DART: :dart + + def self?.values: -> ::Array[Scalar::Models::Sdks::RepositoryUnlinkParams::language] + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/sdks/repository_update_publishing_params.rbs b/sig/scalar_api_ruby/models/sdks/repository_update_publishing_params.rbs new file mode 100644 index 0000000..9c30dc6 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdks/repository_update_publishing_params.rbs @@ -0,0 +1,120 @@ +module Scalar + module Models + module Sdks + type repository_update_publishing_params = + { + uid: String, + language: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::language, + publish_on_merge: bool, + access: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::access, + auth_method: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::auth_method, + tag: String + } + & Scalar::Internal::Type::request_parameters + + class RepositoryUpdatePublishingParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + attr_accessor language: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::language + + attr_accessor publish_on_merge: bool + + attr_reader access: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::access? + + def access=: ( + Scalar::Models::Sdks::RepositoryUpdatePublishingParams::access + ) -> Scalar::Models::Sdks::RepositoryUpdatePublishingParams::access + + attr_reader auth_method: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::auth_method? + + def auth_method=: ( + Scalar::Models::Sdks::RepositoryUpdatePublishingParams::auth_method + ) -> Scalar::Models::Sdks::RepositoryUpdatePublishingParams::auth_method + + attr_reader tag: String? + + def tag=: (String) -> String + + def initialize: ( + uid: String, + language: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::language, + publish_on_merge: bool, + ?access: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::access, + ?auth_method: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::auth_method, + ?tag: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + uid: String, + language: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::language, + publish_on_merge: bool, + access: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::access, + auth_method: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::auth_method, + tag: String, + request_options: Scalar::RequestOptions + } + + type language = + :typescript + | :python + | :cli + | :csharp + | :java + | :ruby + | :php + | :go + | :rust + | :kotlin + | :swift + | :cpp + | :dart + + module Language + extend Scalar::Internal::Type::Enum + + TYPESCRIPT: :typescript + PYTHON: :python + CLI: :cli + CSHARP: :csharp + JAVA: :java + RUBY: :ruby + PHP: :php + GO: :go + RUST: :rust + KOTLIN: :kotlin + SWIFT: :swift + CPP: :cpp + DART: :dart + + def self?.values: -> ::Array[Scalar::Models::Sdks::RepositoryUpdatePublishingParams::language] + end + + type access = :public | :restricted + + module Access + extend Scalar::Internal::Type::Enum + + PUBLIC: :public + RESTRICTED: :restricted + + def self?.values: -> ::Array[Scalar::Models::Sdks::RepositoryUpdatePublishingParams::access] + end + + type auth_method = :oidc | :"access-token" + + module AuthMethod + extend Scalar::Internal::Type::Enum + + OIDC: :oidc + ACCESS_TOKEN: :"access-token" + + def self?.values: -> ::Array[Scalar::Models::Sdks::RepositoryUpdatePublishingParams::auth_method] + end + end + end + end +end diff --git a/sig/scalar_api_ruby/models/sdks/version_create_params.rbs b/sig/scalar_api_ruby/models/sdks/version_create_params.rbs new file mode 100644 index 0000000..307df39 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdks/version_create_params.rbs @@ -0,0 +1,34 @@ +module Scalar + module Models + module Sdks + type version_create_params = + { uid: String, api_version: String, version: String } + & Scalar::Internal::Type::request_parameters + + class VersionCreateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + attr_accessor api_version: String + + attr_accessor version: String + + def initialize: ( + uid: String, + api_version: String, + version: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + uid: String, + api_version: String, + version: String, + request_options: Scalar::RequestOptions + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/sdks/version_delete_params.rbs b/sig/scalar_api_ruby/models/sdks/version_delete_params.rbs new file mode 100644 index 0000000..e928d58 --- /dev/null +++ b/sig/scalar_api_ruby/models/sdks/version_delete_params.rbs @@ -0,0 +1,30 @@ +module Scalar + module Models + module Sdks + type version_delete_params = + { uid: String, version: String } + & Scalar::Internal::Type::request_parameters + + class VersionDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + attr_accessor version: String + + def initialize: ( + uid: String, + version: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + uid: String, + version: String, + request_options: Scalar::RequestOptions + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/team.rbs b/sig/scalar_api_ruby/models/team.rbs new file mode 100644 index 0000000..aa9e746 --- /dev/null +++ b/sig/scalar_api_ruby/models/team.rbs @@ -0,0 +1,42 @@ +module Scalar + module Models + type team = + { + name: String, + slug: String, + theme: String, + uid: String, + image_uri: String + } + + class Team < Scalar::Internal::Type::BaseModel + attr_accessor name: String + + attr_accessor slug: String + + attr_accessor theme: String + + attr_accessor uid: String + + attr_reader image_uri: String? + + def image_uri=: (String) -> String + + def initialize: ( + name: String, + slug: String, + theme: String, + uid: String, + ?image_uri: String + ) -> void + + def to_hash: -> { + name: String, + slug: String, + theme: String, + uid: String, + image_uri: String + } + end + end +end diff --git a/sig/scalar_api_ruby/models/team_image.rbs b/sig/scalar_api_ruby/models/team_image.rbs new file mode 100644 index 0000000..5ec6f4a --- /dev/null +++ b/sig/scalar_api_ruby/models/team_image.rbs @@ -0,0 +1,5 @@ +module Scalar + module Models + class TeamImage = String + end +end diff --git a/sig/scalar_api_ruby/models/team_list_response.rbs b/sig/scalar_api_ruby/models/team_list_response.rbs index b2bc21d..97882c1 100644 --- a/sig/scalar_api_ruby/models/team_list_response.rbs +++ b/sig/scalar_api_ruby/models/team_list_response.rbs @@ -1,45 +1,6 @@ module Scalar module Models - type team_list_response_item = - { - name: String, - slug: String, - theme: String, - uid: String, - image_uri: String - } - - class TeamListResponseItem < Scalar::Internal::Type::BaseModel - attr_accessor name: String - - attr_accessor slug: String - - attr_accessor theme: String - - attr_accessor uid: String - - attr_reader image_uri: String? - - def image_uri=: (String) -> String - - def initialize: ( - name: String, - slug: String, - theme: String, - uid: String, - ?image_uri: String - ) -> void - - def to_hash: -> { - name: String, - slug: String, - theme: String, - uid: String, - image_uri: String - } - end - - type team_list_response = ::Array[Scalar::Models::TeamListResponseItem] + type team_list_response = ::Array[Scalar::Team] TeamListResponse: Scalar::Internal::Type::Converter end diff --git a/sig/scalar_api_ruby/models/team_name.rbs b/sig/scalar_api_ruby/models/team_name.rbs new file mode 100644 index 0000000..300f2be --- /dev/null +++ b/sig/scalar_api_ruby/models/team_name.rbs @@ -0,0 +1,5 @@ +module Scalar + module Models + class TeamName = String + end +end diff --git a/sig/scalar_api_ruby/models/team_summary.rbs b/sig/scalar_api_ruby/models/team_summary.rbs new file mode 100644 index 0000000..bce8e0d --- /dev/null +++ b/sig/scalar_api_ruby/models/team_summary.rbs @@ -0,0 +1,19 @@ +module Scalar + module Models + type team_summary = { name: String, uid: String, image_uri: String } + + class TeamSummary < Scalar::Internal::Type::BaseModel + attr_accessor name: String + + attr_accessor uid: String + + attr_reader image_uri: String? + + def image_uri=: (String) -> String + + def initialize: (name: String, uid: String, ?image_uri: String) -> void + + def to_hash: -> { name: String, uid: String, image_uri: String } + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/email.rbs b/sig/scalar_api_ruby/models/teams/email.rbs new file mode 100644 index 0000000..1e47a34 --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/email.rbs @@ -0,0 +1,7 @@ +module Scalar + module Models + module Teams + class Email = String + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/invite_cancel_params.rbs b/sig/scalar_api_ruby/models/teams/invite_cancel_params.rbs new file mode 100644 index 0000000..90d6cb1 --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/invite_cancel_params.rbs @@ -0,0 +1,22 @@ +module Scalar + module Models + module Teams + type invite_cancel_params = + { uid: String } & Scalar::Internal::Type::request_parameters + + class InviteCancelParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + def initialize: ( + uid: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { uid: String, request_options: Scalar::RequestOptions } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/invite_member_params.rbs b/sig/scalar_api_ruby/models/teams/invite_member_params.rbs new file mode 100644 index 0000000..f354476 --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/invite_member_params.rbs @@ -0,0 +1,30 @@ +module Scalar + module Models + module Teams + type invite_member_params = + { email: String, role: Scalar::Models::Teams::role } + & Scalar::Internal::Type::request_parameters + + class InviteMemberParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor email: String + + attr_accessor role: Scalar::Models::Teams::role + + def initialize: ( + email: String, + role: Scalar::Models::Teams::role, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + email: String, + role: Scalar::Models::Teams::role, + request_options: Scalar::RequestOptions + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/invite_resend_params.rbs b/sig/scalar_api_ruby/models/teams/invite_resend_params.rbs new file mode 100644 index 0000000..e5e97ad --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/invite_resend_params.rbs @@ -0,0 +1,22 @@ +module Scalar + module Models + module Teams + type invite_resend_params = + { uid: String } & Scalar::Internal::Type::request_parameters + + class InviteResendParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + def initialize: ( + uid: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { uid: String, request_options: Scalar::RequestOptions } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/member_delete_params.rbs b/sig/scalar_api_ruby/models/teams/member_delete_params.rbs new file mode 100644 index 0000000..4e3b384 --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/member_delete_params.rbs @@ -0,0 +1,22 @@ +module Scalar + module Models + module Teams + type member_delete_params = + { uid: String } & Scalar::Internal::Type::request_parameters + + class MemberDeleteParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + def initialize: ( + uid: String, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { uid: String, request_options: Scalar::RequestOptions } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/member_list_params.rbs b/sig/scalar_api_ruby/models/teams/member_list_params.rbs new file mode 100644 index 0000000..6afd8b4 --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/member_list_params.rbs @@ -0,0 +1,17 @@ +module Scalar + module Models + module Teams + type member_list_params = + { } & Scalar::Internal::Type::request_parameters + + class MemberListParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + def initialize: (?request_options: Scalar::request_opts) -> void + + def to_hash: -> { request_options: Scalar::RequestOptions } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/member_list_response.rbs b/sig/scalar_api_ruby/models/teams/member_list_response.rbs new file mode 100644 index 0000000..41c12cd --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/member_list_response.rbs @@ -0,0 +1,27 @@ +module Scalar + module Models + module Teams + type member_list_response = + { + members: ::Array[Scalar::Teams::TeamMember], + pending_invites: ::Array[Scalar::Teams::TeamInvite] + } + + class MemberListResponse < Scalar::Internal::Type::BaseModel + attr_accessor members: ::Array[Scalar::Teams::TeamMember] + + attr_accessor pending_invites: ::Array[Scalar::Teams::TeamInvite] + + def initialize: ( + members: ::Array[Scalar::Teams::TeamMember], + pending_invites: ::Array[Scalar::Teams::TeamInvite] + ) -> void + + def to_hash: -> { + members: ::Array[Scalar::Teams::TeamMember], + pending_invites: ::Array[Scalar::Teams::TeamInvite] + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/member_update_params.rbs b/sig/scalar_api_ruby/models/teams/member_update_params.rbs new file mode 100644 index 0000000..d86682a --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/member_update_params.rbs @@ -0,0 +1,30 @@ +module Scalar + module Models + module Teams + type member_update_params = + { uid: String, role: Scalar::Models::Teams::role } + & Scalar::Internal::Type::request_parameters + + class MemberUpdateParams < Scalar::Internal::Type::BaseModel + extend Scalar::Internal::Type::RequestParameters::Converter + include Scalar::Internal::Type::RequestParameters + + attr_accessor uid: String + + attr_accessor role: Scalar::Models::Teams::role + + def initialize: ( + uid: String, + role: Scalar::Models::Teams::role, + ?request_options: Scalar::request_opts + ) -> void + + def to_hash: -> { + uid: String, + role: Scalar::Models::Teams::role, + request_options: Scalar::RequestOptions + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/role.rbs b/sig/scalar_api_ruby/models/teams/role.rbs new file mode 100644 index 0000000..66a25c0 --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/role.rbs @@ -0,0 +1,18 @@ +module Scalar + module Models + module Teams + type role = :owner | :admin | :editor | :viewer + + module Role + extend Scalar::Internal::Type::Enum + + OWNER: :owner + ADMIN: :admin + EDITOR: :editor + VIEWER: :viewer + + def self?.values: -> ::Array[Scalar::Models::Teams::role] + end + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/team_invite.rbs b/sig/scalar_api_ruby/models/teams/team_invite.rbs new file mode 100644 index 0000000..41b6767 --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/team_invite.rbs @@ -0,0 +1,41 @@ +module Scalar + module Models + class TeamInvite = Teams::TeamInvite + + module Teams + type team_invite = + { + email: String, + role: Scalar::Models::Teams::role, + uid: String, + expires: Float + } + + class TeamInvite < Scalar::Internal::Type::BaseModel + attr_accessor email: String + + attr_accessor role: Scalar::Models::Teams::role + + attr_accessor uid: String + + attr_reader expires: Float? + + def expires=: (Float) -> Float + + def initialize: ( + email: String, + role: Scalar::Models::Teams::role, + uid: String, + ?expires: Float + ) -> void + + def to_hash: -> { + email: String, + role: Scalar::Models::Teams::role, + uid: String, + expires: Float + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/teams/team_member.rbs b/sig/scalar_api_ruby/models/teams/team_member.rbs new file mode 100644 index 0000000..5792fda --- /dev/null +++ b/sig/scalar_api_ruby/models/teams/team_member.rbs @@ -0,0 +1,41 @@ +module Scalar + module Models + class TeamMember = Teams::TeamMember + + module Teams + type team_member = + { + display_name: String, + role: Scalar::Models::Teams::role, + uid: String, + image_uri: String + } + + class TeamMember < Scalar::Internal::Type::BaseModel + attr_accessor display_name: String + + attr_accessor role: Scalar::Models::Teams::role + + attr_accessor uid: String + + attr_reader image_uri: String? + + def image_uri=: (String) -> String + + def initialize: ( + display_name: String, + role: Scalar::Models::Teams::role, + uid: String, + ?image_uri: String + ) -> void + + def to_hash: -> { + display_name: String, + role: Scalar::Models::Teams::role, + uid: String, + image_uri: String + } + end + end + end +end diff --git a/sig/scalar_api_ruby/models/theme.rbs b/sig/scalar_api_ruby/models/theme.rbs new file mode 100644 index 0000000..b5a91fb --- /dev/null +++ b/sig/scalar_api_ruby/models/theme.rbs @@ -0,0 +1,30 @@ +module Scalar + module Models + type theme = + { description: String, name: String, slug: String, uid: String } + + class Theme < Scalar::Internal::Type::BaseModel + attr_accessor description: String + + attr_accessor name: String + + attr_accessor slug: String + + attr_accessor uid: String + + def initialize: ( + description: String, + name: String, + slug: String, + uid: String + ) -> void + + def to_hash: -> { + description: String, + name: String, + slug: String, + uid: String + } + end + end +end diff --git a/sig/scalar_api_ruby/models/theme_list_response.rbs b/sig/scalar_api_ruby/models/theme_list_response.rbs index 85f4f66..29f1f18 100644 --- a/sig/scalar_api_ruby/models/theme_list_response.rbs +++ b/sig/scalar_api_ruby/models/theme_list_response.rbs @@ -1,33 +1,6 @@ module Scalar module Models - type theme_list_response_item = - { description: String, name: String, slug: String, uid: String } - - class ThemeListResponseItem < Scalar::Internal::Type::BaseModel - attr_accessor description: String - - attr_accessor name: String - - attr_accessor slug: String - - attr_accessor uid: String - - def initialize: ( - description: String, - name: String, - slug: String, - uid: String - ) -> void - - def to_hash: -> { - description: String, - name: String, - slug: String, - uid: String - } - end - - type theme_list_response = ::Array[Scalar::Models::ThemeListResponseItem] + type theme_list_response = ::Array[Scalar::Theme] ThemeListResponse: Scalar::Internal::Type::Converter end diff --git a/sig/scalar_api_ruby/models/authentication_list_current_user_response.rbs b/sig/scalar_api_ruby/models/user.rbs similarity index 51% rename from sig/scalar_api_ruby/models/authentication_list_current_user_response.rbs rename to sig/scalar_api_ruby/models/user.rbs index 1f54a50..ba4b289 100644 --- a/sig/scalar_api_ruby/models/authentication_list_current_user_response.rbs +++ b/sig/scalar_api_ruby/models/user.rbs @@ -1,18 +1,18 @@ module Scalar module Models - type authentication_list_current_user_response = + type user = { active_team_id: String?, created_at: Integer, email: String, has_github: bool, - teams: ::Array[Scalar::Models::AuthenticationListCurrentUserResponse::Team], + teams: ::Array[Scalar::TeamSummary], uid: String, updated_at: Integer, theme: String } - class AuthenticationListCurrentUserResponse < Scalar::Internal::Type::BaseModel + class User < Scalar::Internal::Type::BaseModel attr_accessor active_team_id: String? attr_accessor created_at: Integer @@ -21,7 +21,7 @@ module Scalar attr_accessor has_github: bool - attr_accessor teams: ::Array[Scalar::Models::AuthenticationListCurrentUserResponse::Team] + attr_accessor teams: ::Array[Scalar::TeamSummary] attr_accessor uid: String @@ -36,7 +36,7 @@ module Scalar created_at: Integer, email: String, has_github: bool, - teams: ::Array[Scalar::Models::AuthenticationListCurrentUserResponse::Team], + teams: ::Array[Scalar::TeamSummary], uid: String, updated_at: Integer, ?theme: String @@ -47,27 +47,11 @@ module Scalar created_at: Integer, email: String, has_github: bool, - teams: ::Array[Scalar::Models::AuthenticationListCurrentUserResponse::Team], + teams: ::Array[Scalar::TeamSummary], uid: String, updated_at: Integer, theme: String } - - type team = { name: String, uid: String, image_uri: String } - - class Team < Scalar::Internal::Type::BaseModel - attr_accessor name: String - - attr_accessor uid: String - - attr_reader image_uri: String? - - def image_uri=: (String) -> String - - def initialize: (name: String, uid: String, ?image_uri: String) -> void - - def to_hash: -> { name: String, uid: String, image_uri: String } - end end end end diff --git a/sig/scalar_api_ruby/resources/access_groups.rbs b/sig/scalar_api_ruby/resources/access_groups.rbs new file mode 100644 index 0000000..c33c4fb --- /dev/null +++ b/sig/scalar_api_ruby/resources/access_groups.rbs @@ -0,0 +1,30 @@ +module Scalar + module Resources + class AccessGroups + attr_reader domains: Scalar::Resources::AccessGroups::Domains + + def create: ( + ?allowed_domains: top, + ?name: String, + ?slug: String, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::AccessGroupCreateResponse + + def retrieve: ( + String slug, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::AccessGroupRetrieveResponse + + def update: ( + String path_slug, + ?name: String, + ?body_slug: String, + ?request_options: Scalar::request_opts + ) -> top + + def delete: (String slug, ?request_options: Scalar::request_opts) -> top + + def initialize: (client: Scalar::Client) -> void + end + end +end diff --git a/sig/scalar_api_ruby/resources/access_groups/domains.rbs b/sig/scalar_api_ruby/resources/access_groups/domains.rbs new file mode 100644 index 0000000..1c0dccc --- /dev/null +++ b/sig/scalar_api_ruby/resources/access_groups/domains.rbs @@ -0,0 +1,21 @@ +module Scalar + module Resources + class AccessGroups + class Domains + def create: ( + String slug, + domain: String, + ?request_options: Scalar::request_opts + ) -> top + + def delete: ( + String slug, + domain: String, + ?request_options: Scalar::request_opts + ) -> top + + def initialize: (client: Scalar::Client) -> void + end + end + end +end diff --git a/sig/scalar_api_ruby/resources/authentication.rbs b/sig/scalar_api_ruby/resources/authentication.rbs index b4adf04..7e36a2f 100644 --- a/sig/scalar_api_ruby/resources/authentication.rbs +++ b/sig/scalar_api_ruby/resources/authentication.rbs @@ -8,7 +8,7 @@ module Scalar def list_current_user: ( ?request_options: Scalar::request_opts - ) -> Scalar::Models::AuthenticationListCurrentUserResponse + ) -> Scalar::User def initialize: (client: Scalar::Client) -> void end diff --git a/sig/scalar_api_ruby/resources/login_portals.rbs b/sig/scalar_api_ruby/resources/login_portals.rbs index 4b477f4..5c97900 100644 --- a/sig/scalar_api_ruby/resources/login_portals.rbs +++ b/sig/scalar_api_ruby/resources/login_portals.rbs @@ -22,7 +22,7 @@ module Scalar def list: ( ?request_options: Scalar::request_opts - ) -> ::Array[Scalar::Models::LoginPortalListResponseItem] + ) -> ::Array[Scalar::LoginPortal] def delete: (String slug, ?request_options: Scalar::request_opts) -> top diff --git a/sig/scalar_api_ruby/resources/mcp.rbs b/sig/scalar_api_ruby/resources/mcp.rbs new file mode 100644 index 0000000..e0b4b08 --- /dev/null +++ b/sig/scalar_api_ruby/resources/mcp.rbs @@ -0,0 +1,9 @@ +module Scalar + module Resources + class Mcp + attr_reader servers: Scalar::Resources::Mcp::Servers + + def initialize: (client: Scalar::Client) -> void + end + end +end diff --git a/sig/scalar_api_ruby/resources/mcp/servers.rbs b/sig/scalar_api_ruby/resources/mcp/servers.rbs new file mode 100644 index 0000000..c8cfa8e --- /dev/null +++ b/sig/scalar_api_ruby/resources/mcp/servers.rbs @@ -0,0 +1,40 @@ +module Scalar + module Resources + class Mcp + class Servers + attr_reader installations: Scalar::Resources::Mcp::Servers::Installations + + def create: ( + name: String, + ?project_uids: ::Array[String], + ?slug: String, + ?version_uids: ::Array[String], + ?request_options: Scalar::request_opts + ) -> Scalar::Models::Mcp::ServerCreateResponse + + def retrieve: ( + String id, + ?request_options: Scalar::request_opts + ) -> Scalar::Mcp::McpServer + + def update: ( + String id, + ?auto_add_operations: bool, + ?docs_pages: ::Array[String], + ?name: String, + ?operations: ::Array[String], + ?slug: String, + ?request_options: Scalar::request_opts + ) -> Scalar::Mcp::McpServer + + def list: ( + ?request_options: Scalar::request_opts + ) -> ::Array[Scalar::Mcp::McpServer] + + def delete: (String id, ?request_options: Scalar::request_opts) -> top + + def initialize: (client: Scalar::Client) -> void + end + end + end +end diff --git a/sig/scalar_api_ruby/resources/mcp/servers/installations.rbs b/sig/scalar_api_ruby/resources/mcp/servers/installations.rbs new file mode 100644 index 0000000..494a7e2 --- /dev/null +++ b/sig/scalar_api_ruby/resources/mcp/servers/installations.rbs @@ -0,0 +1,62 @@ +module Scalar + module Resources + class Mcp + class Servers + class Installations + def create: ( + String id, + document_auth: ::Hash[Symbol, top], + name: String, + ?slug: String, + ?request_options: Scalar::request_opts + ) -> Scalar::Mcp::McpInstallation + + def retrieve: ( + String installation_id, + id: String, + ?request_options: Scalar::request_opts + ) -> Scalar::Mcp::McpInstallation + + def update: ( + String installation_id, + id: String, + ?document_auth: ::Hash[Symbol, top], + ?is_private: bool, + ?login_portal_uid: String?, + ?mcp_version: String?, + ?name: String, + ?slug: String, + ?request_options: Scalar::request_opts + ) -> Scalar::Mcp::McpInstallation + + def list: ( + String id, + ?request_options: Scalar::request_opts + ) -> ::Array[Scalar::Mcp::Servers::McpInstallationListItem] + + def delete: ( + String installation_id, + id: String, + ?request_options: Scalar::request_opts + ) -> top + + def create_access_group: ( + String installation_id, + id: String, + access_group_uid: String, + ?request_options: Scalar::request_opts + ) -> top + + def delete_access_group: ( + String installation_id, + id: String, + access_group_uid: String, + ?request_options: Scalar::request_opts + ) -> top + + def initialize: (client: Scalar::Client) -> void + end + end + end + end +end diff --git a/sig/scalar_api_ruby/resources/o_auth.rbs b/sig/scalar_api_ruby/resources/o_auth.rbs new file mode 100644 index 0000000..12022dc --- /dev/null +++ b/sig/scalar_api_ruby/resources/o_auth.rbs @@ -0,0 +1,33 @@ +module Scalar + module Resources + class OAuth + def oauth_authorization_server_metadata: ( + ?request_options: Scalar::request_opts + ) -> Scalar::OauthAuthorizationServerMetadata + + def oauth_authorize: (?request_options: Scalar::request_opts) -> top + + def oauth_revoke: ( + token: String, + ?client_id: String, + ?client_secret: String, + ?token_type_hint: String, + ?request_options: Scalar::request_opts + ) -> Scalar::OauthError + + def oauth_token: ( + grant_type: String, + ?client_id: String, + ?client_secret: String, + ?code: String, + ?code_verifier: String, + ?redirect_uri: String, + ?refresh_token: String, + ?scope: String, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::o_auth_oauth_token_response + + def initialize: (client: Scalar::Client) -> void + end + end +end diff --git a/sig/scalar_api_ruby/resources/registry.rbs b/sig/scalar_api_ruby/resources/registry.rbs index 06e1363..d635aed 100644 --- a/sig/scalar_api_ruby/resources/registry.rbs +++ b/sig/scalar_api_ruby/resources/registry.rbs @@ -51,7 +51,7 @@ module Scalar def list_all_api_documents: ( ?request_options: Scalar::request_opts - ) -> ::Array[Scalar::Models::RegistryListAllAPIDocumentsResponseItem] + ) -> ::Array[Scalar::APIDocument] def list_api_document_version_metadata: ( String semver, @@ -63,7 +63,7 @@ module Scalar def list_api_documents: ( String namespace, ?request_options: Scalar::request_opts - ) -> ::Array[Scalar::Models::RegistryListAPIDocumentsResponseItem] + ) -> ::Array[Scalar::APIDocument] def retrieve_api_document_version: ( String semver, diff --git a/sig/scalar_api_ruby/resources/rules.rbs b/sig/scalar_api_ruby/resources/rules.rbs index 2c6c627..7e5dac3 100644 --- a/sig/scalar_api_ruby/resources/rules.rbs +++ b/sig/scalar_api_ruby/resources/rules.rbs @@ -34,7 +34,7 @@ module Scalar def list_rulesets: ( String namespace, ?request_options: Scalar::request_opts - ) -> ::Array[Scalar::Models::RuleListRulesetsResponseItem] + ) -> ::Array[Scalar::Rule] def retrieve_ruleset_document: ( String slug, diff --git a/sig/scalar_api_ruby/resources/scalar_docs.rbs b/sig/scalar_api_ruby/resources/scalar_docs.rbs index b2113e6..6113254 100644 --- a/sig/scalar_api_ruby/resources/scalar_docs.rbs +++ b/sig/scalar_api_ruby/resources/scalar_docs.rbs @@ -10,15 +10,87 @@ module Scalar ?request_options: Scalar::request_opts ) -> Scalar::Models::ScalarDocCreateGuideResponse + def create_project: ( + name: String, + provider: Scalar::Models::ScalarDocCreateProjectParams::provider, + ?bitbucket_repository: Scalar::ScalarDocCreateProjectParams::BitbucketRepository, + ?blank: bool, + ?github_repository: Scalar::ScalarDocCreateProjectParams::GithubRepository, + ?is_private: bool, + ?slug: String, + ?request_options: Scalar::request_opts + ) -> Scalar::DocsProject + + def delete_project: ( + String slug, + ?request_options: Scalar::request_opts + ) -> top + def list_guides: ( ?request_options: Scalar::request_opts - ) -> ::Array[Scalar::Models::ScalarDocListGuidesResponseItem] + ) -> ::Array[Scalar::GithubProject] + + def list_project_config: ( + String slug, + ?ref: String, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::ScalarDocListProjectConfigResponse + + def list_project_domain: ( + String slug, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::ScalarDocListProjectDomainResponse + + def list_project_domain_status: ( + String slug, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::ScalarDocListProjectDomainStatusResponse + + def list_projects: ( + ?limit: Integer, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::ScalarDocListProjectsResponse def publish_guide: ( String slug, ?request_options: Scalar::request_opts ) -> Scalar::Models::ScalarDocPublishGuideResponse + def publish_project: ( + String slug, + ?commit_sha: String, + ?config_path: String, + ?preview: bool, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::ScalarDocPublishProjectResponse + + def retrieve_project: ( + String slug, + ?request_options: Scalar::request_opts + ) -> Scalar::DocsProject + + def update_project: ( + String slug, + ?access_groups: ::Array[String], + ?active_theme_id: String, + ?agent_enabled: bool, + ?analytics_enabled: bool, + ?is_private: bool, + ?login_portal_uid: Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid, + ?name: String, + ?request_options: Scalar::request_opts + ) -> top + + def update_project_config: ( + String slug, + content: String, + ?base_token: String, + ?message: String, + ?path: String, + ?ref: String, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::ScalarDocUpdateProjectConfigResponse + def initialize: (client: Scalar::Client) -> void end end diff --git a/sig/scalar_api_ruby/resources/schemas.rbs b/sig/scalar_api_ruby/resources/schemas.rbs index acd6892..e44e87e 100644 --- a/sig/scalar_api_ruby/resources/schemas.rbs +++ b/sig/scalar_api_ruby/resources/schemas.rbs @@ -28,7 +28,7 @@ module Scalar def list: ( String namespace, ?request_options: Scalar::request_opts - ) -> ::Array[Scalar::Models::SchemaListResponseItem] + ) -> ::Array[Scalar::Schema] def delete: ( String slug, diff --git a/sig/scalar_api_ruby/resources/sdks.rbs b/sig/scalar_api_ruby/resources/sdks.rbs new file mode 100644 index 0000000..99253e0 --- /dev/null +++ b/sig/scalar_api_ruby/resources/sdks.rbs @@ -0,0 +1,51 @@ +module Scalar + module Resources + class Sdks + attr_reader versions: Scalar::Resources::Sdks::Versions + + attr_reader repositories: Scalar::Resources::Sdks::Repositories + + def create: ( + api_uid: String, + languages: ::Array[Scalar::Models::SdkCreateParams::language], + ?class_name: String, + ?config: String, + ?slug: String, + ?title: String, + ?request_options: Scalar::request_opts + ) -> Scalar::UID + + def retrieve: ( + String uid, + ?request_options: Scalar::request_opts + ) -> Scalar::Sdk + + def update: ( + String uid, + ?api_uid: String?, + ?api_version: String?, + ?config: String, + ?is_private: bool, + ?slug: String, + ?title: String, + ?request_options: Scalar::request_opts + ) -> top + + def list: ( + ?limit: Integer, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::SdkListResponse + + def delete: (String uid, ?request_options: Scalar::request_opts) -> top + + def build: ( + String uid, + ?languages: ::Array[Scalar::Models::SdkBuildParams::language], + ?version: String, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::SdkBuildResponse + + def initialize: (client: Scalar::Client) -> void + end + end +end diff --git a/sig/scalar_api_ruby/resources/sdks/repositories.rbs b/sig/scalar_api_ruby/resources/sdks/repositories.rbs new file mode 100644 index 0000000..9c11f96 --- /dev/null +++ b/sig/scalar_api_ruby/resources/sdks/repositories.rbs @@ -0,0 +1,34 @@ +module Scalar + module Resources + class Sdks + class Repositories + def link: ( + String uid, + base_branch: String, + language: Scalar::Models::Sdks::RepositoryLinkParams::language, + repository_id: Integer, + ?prerelease_type: String, + ?request_options: Scalar::request_opts + ) -> Scalar::Models::Sdks::RepositoryLinkResponse + + def unlink: ( + Scalar::Models::Sdks::RepositoryUnlinkParams::language language, + uid: String, + ?request_options: Scalar::request_opts + ) -> top + + def update_publishing: ( + Scalar::Models::Sdks::RepositoryUpdatePublishingParams::language language, + uid: String, + publish_on_merge: bool, + ?access: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::access, + ?auth_method: Scalar::Models::Sdks::RepositoryUpdatePublishingParams::auth_method, + ?tag: String, + ?request_options: Scalar::request_opts + ) -> top + + def initialize: (client: Scalar::Client) -> void + end + end + end +end diff --git a/sig/scalar_api_ruby/resources/sdks/versions.rbs b/sig/scalar_api_ruby/resources/sdks/versions.rbs new file mode 100644 index 0000000..b9fb2f2 --- /dev/null +++ b/sig/scalar_api_ruby/resources/sdks/versions.rbs @@ -0,0 +1,22 @@ +module Scalar + module Resources + class Sdks + class Versions + def create: ( + String uid, + api_version: String, + version: String, + ?request_options: Scalar::request_opts + ) -> top + + def delete: ( + String version, + uid: String, + ?request_options: Scalar::request_opts + ) -> top + + def initialize: (client: Scalar::Client) -> void + end + end + end +end diff --git a/sig/scalar_api_ruby/resources/teams.rbs b/sig/scalar_api_ruby/resources/teams.rbs index 8fcaae5..76555b1 100644 --- a/sig/scalar_api_ruby/resources/teams.rbs +++ b/sig/scalar_api_ruby/resources/teams.rbs @@ -1,9 +1,13 @@ module Scalar module Resources class Teams + attr_reader members: Scalar::Resources::Teams::Members + + attr_reader invites: Scalar::Resources::Teams::Invites + def list: ( ?request_options: Scalar::request_opts - ) -> ::Array[Scalar::Models::TeamListResponseItem] + ) -> ::Array[Scalar::Team] def initialize: (client: Scalar::Client) -> void end diff --git a/sig/scalar_api_ruby/resources/teams/invites.rbs b/sig/scalar_api_ruby/resources/teams/invites.rbs new file mode 100644 index 0000000..6b23e60 --- /dev/null +++ b/sig/scalar_api_ruby/resources/teams/invites.rbs @@ -0,0 +1,19 @@ +module Scalar + module Resources + class Teams + class Invites + def cancel: (String uid, ?request_options: Scalar::request_opts) -> top + + def member: ( + email: String, + role: Scalar::Models::Teams::role, + ?request_options: Scalar::request_opts + ) -> top + + def resend: (String uid, ?request_options: Scalar::request_opts) -> top + + def initialize: (client: Scalar::Client) -> void + end + end + end +end diff --git a/sig/scalar_api_ruby/resources/teams/members.rbs b/sig/scalar_api_ruby/resources/teams/members.rbs new file mode 100644 index 0000000..87181b2 --- /dev/null +++ b/sig/scalar_api_ruby/resources/teams/members.rbs @@ -0,0 +1,21 @@ +module Scalar + module Resources + class Teams + class Members + def update: ( + String uid, + role: Scalar::Models::Teams::role, + ?request_options: Scalar::request_opts + ) -> top + + def list: ( + ?request_options: Scalar::request_opts + ) -> Scalar::Models::Teams::MemberListResponse + + def delete: (String uid, ?request_options: Scalar::request_opts) -> top + + def initialize: (client: Scalar::Client) -> void + end + end + end +end diff --git a/sig/scalar_api_ruby/resources/themes.rbs b/sig/scalar_api_ruby/resources/themes.rbs index de89cff..f84fa0e 100644 --- a/sig/scalar_api_ruby/resources/themes.rbs +++ b/sig/scalar_api_ruby/resources/themes.rbs @@ -23,7 +23,7 @@ module Scalar def list: ( ?request_options: Scalar::request_opts - ) -> ::Array[Scalar::Models::ThemeListResponseItem] + ) -> ::Array[Scalar::Theme] def delete: (String slug, ?request_options: Scalar::request_opts) -> top diff --git a/tests/smoke-test.rb b/tests/smoke-test.rb index 366252a..a980f7a 100644 --- a/tests/smoke-test.rb +++ b/tests/smoke-test.rb @@ -314,6 +314,58 @@ path: "/v1/login-portals/{slug}", run: -> { client.login_portals.delete("slug") } }, + { + operation: "create", + method: "POST", + path: "/v1/access-groups", + label: "required params", + run: -> { client.access_groups.create } + }, + { + operation: "create", + method: "POST", + path: "/v1/access-groups", + label: "all params", + run: -> { client.access_groups.create({allowed_domains: {}, name: "", slug: "x"}) } + }, + { + operation: "retrieve", + method: "GET", + path: "/v1/access-groups/{slug}", + run: -> { client.access_groups.retrieve("slug") } + }, + { + operation: "update", + method: "PATCH", + path: "/v1/access-groups/{slug}", + label: "required params", + run: -> { client.access_groups.update("path_slug") } + }, + { + operation: "update", + method: "PATCH", + path: "/v1/access-groups/{slug}", + label: "all params", + run: -> { client.access_groups.update("path_slug", {name: "", body_slug: "x"}) } + }, + { + operation: "delete", + method: "DELETE", + path: "/v1/access-groups/{slug}", + run: -> { client.access_groups.delete("slug") } + }, + { + operation: "create", + method: "POST", + path: "/v1/access-groups/{slug}/domains", + run: -> { client.access_groups.domains.create("slug", {domain: ""}) } + }, + { + operation: "delete", + method: "DELETE", + path: "/v1/access-groups/{slug}/domains", + run: -> { client.access_groups.domains.delete("slug", {domain: ""}) } + }, { operation: "createRuleset", method: "POST", @@ -441,6 +493,37 @@ run: -> { client.themes.replace_document("slug", {document: ""}) } }, {operation: "list", method: "GET", path: "/v1/teams", run: -> { client.teams.list }}, + { + operation: "update", + method: "PATCH", + path: "/v1/teams/members/{uid}", + run: -> { client.teams.members.update("uidxx", {role: "owner"}) } + }, + {operation: "list", method: "GET", path: "/v1/teams/members", run: -> { client.teams.members.list }}, + { + operation: "delete", + method: "DELETE", + path: "/v1/teams/members/{uid}", + run: -> { client.teams.members.delete("uidxx") } + }, + { + operation: "cancel", + method: "DELETE", + path: "/v1/teams/invites/{uid}", + run: -> { client.teams.invites.cancel("uidxx") } + }, + { + operation: "member", + method: "POST", + path: "/v1/teams/invites", + run: -> { client.teams.invites.member({email: "user@example.com", role: "owner"}) } + }, + { + operation: "resend", + method: "PATCH", + path: "/v1/teams/invites/{uid}", + run: -> { client.teams.invites.resend("uidxx") } + }, { operation: "createGuide", method: "POST", @@ -461,13 +544,159 @@ ) end }, + { + operation: "createProject", + method: "POST", + path: "/v1/docs", + label: "required params", + run: -> { client.scalar_docs.create_project({name: "", provider: "forgejo"}) } + }, + { + operation: "createProject", + method: "POST", + path: "/v1/docs", + label: "all params", + run: -> do + client.scalar_docs.create_project( + { + name: "", + provider: "forgejo", + bitbucket_repository: { + "workspaceUuid" => "", + "repoUuid" => "" + }, + blank: false, + github_repository: { + "installationId" => 0, + "repoId" => 0 + }, + is_private: false, + slug: "x" + } + ) + end + }, + { + operation: "deleteProject", + method: "DELETE", + path: "/v1/docs/{slug}", + run: -> { client.scalar_docs.delete_project("slug") } + }, {operation: "listGuides", method: "GET", path: "/v1/guides", run: -> { client.scalar_docs.list_guides }}, + { + operation: "listProjectConfig", + method: "GET", + path: "/v1/docs/{slug}/config", + label: "required params", + run: -> { client.scalar_docs.list_project_config("slug") } + }, + { + operation: "listProjectConfig", + method: "GET", + path: "/v1/docs/{slug}/config", + label: "all params", + run: -> { client.scalar_docs.list_project_config("slug", {ref: "ref"}) } + }, + { + operation: "listProjectDomain", + method: "GET", + path: "/v1/docs/{slug}/domain", + run: -> { client.scalar_docs.list_project_domain("slug") } + }, + { + operation: "listProjectDomainStatus", + method: "GET", + path: "/v1/docs/{slug}/domain/status", + run: -> { client.scalar_docs.list_project_domain_status("slug") } + }, + { + operation: "listProjects", + method: "GET", + path: "/v1/docs", + label: "required params", + run: -> { client.scalar_docs.list_projects } + }, + { + operation: "listProjects", + method: "GET", + path: "/v1/docs", + label: "all params", + run: -> { client.scalar_docs.list_projects({limit: 1}) } + }, { operation: "publishGuide", method: "POST", path: "/v1/guides/{slug}/publish", run: -> { client.scalar_docs.publish_guide("slug") } }, + { + operation: "publishProject", + method: "POST", + path: "/v1/docs/{slug}/publish", + label: "required params", + run: -> { client.scalar_docs.publish_project("slug") } + }, + { + operation: "publishProject", + method: "POST", + path: "/v1/docs/{slug}/publish", + label: "all params", + run: -> do + client.scalar_docs.publish_project("slug", {commit_sha: "", config_path: "", preview: false}) + end + }, + { + operation: "retrieveProject", + method: "GET", + path: "/v1/docs/{slug}", + run: -> { client.scalar_docs.retrieve_project("slug") } + }, + { + operation: "updateProject", + method: "PATCH", + path: "/v1/docs/{slug}", + label: "required params", + run: -> { client.scalar_docs.update_project("slug") } + }, + { + operation: "updateProject", + method: "PATCH", + path: "/v1/docs/{slug}", + label: "all params", + run: -> do + client.scalar_docs.update_project( + "slug", + { + access_groups: ["xxxxx"], + active_theme_id: "xxxxx", + agent_enabled: false, + analytics_enabled: false, + is_private: false, + login_portal_uid: "xxxxx", + name: "" + } + ) + end + }, + { + operation: "updateProjectConfig", + method: "PUT", + path: "/v1/docs/{slug}/config", + label: "required params", + run: -> { client.scalar_docs.update_project_config("slug", {content: ""}) } + }, + { + operation: "updateProjectConfig", + method: "PUT", + path: "/v1/docs/{slug}/config", + label: "all params", + run: -> do + client.scalar_docs.update_project_config( + "slug", + {content: "", base_token: "", message: "", path: "", ref: ""} + ) + end + }, {operation: "list", method: "GET", path: "/v1/namespaces", run: -> { client.namespaces.list }}, { operation: "exchangePersonalToken", @@ -480,6 +709,315 @@ method: "GET", path: "/v1/auth/me", run: -> { client.authentication.list_current_user } + }, + { + operation: "create", + method: "POST", + path: "/v1/sdks", + label: "required params", + run: -> { client.sdks.create({api_uid: "xxxxx", languages: ["typescript"]}) } + }, + { + operation: "create", + method: "POST", + path: "/v1/sdks", + label: "all params", + run: -> do + client.sdks.create( + {api_uid: "xxxxx", languages: ["typescript"], class_name: "", config: "", slug: "x", title: ""} + ) + end + }, + {operation: "retrieve", method: "GET", path: "/v1/sdks/{uid}", run: -> { client.sdks.retrieve("uidxx") }}, + { + operation: "update", + method: "PATCH", + path: "/v1/sdks/{uid}", + label: "required params", + run: -> { client.sdks.update("uidxx") } + }, + { + operation: "update", + method: "PATCH", + path: "/v1/sdks/{uid}", + label: "all params", + run: -> do + client.sdks.update( + "uidxx", + {api_uid: "xxxxx", api_version: "", config: "", is_private: false, slug: "x", title: ""} + ) + end + }, + { + operation: "list", + method: "GET", + path: "/v1/sdks", + label: "required params", + run: -> { client.sdks.list } + }, + { + operation: "list", + method: "GET", + path: "/v1/sdks", + label: "all params", + run: -> { client.sdks.list({limit: 1}) } + }, + {operation: "delete", method: "DELETE", path: "/v1/sdks/{uid}", run: -> { client.sdks.delete("uidxx") }}, + { + operation: "build", + method: "POST", + path: "/v1/sdks/{uid}/build", + label: "required params", + run: -> { client.sdks.build("uidxx") } + }, + { + operation: "build", + method: "POST", + path: "/v1/sdks/{uid}/build", + label: "all params", + run: -> { client.sdks.build("uidxx", {languages: ["typescript"], version: ""}) } + }, + { + operation: "create", + method: "POST", + path: "/v1/sdks/{uid}/versions", + run: -> { client.sdks.versions.create("uidxx", {api_version: "", version: ""}) } + }, + { + operation: "delete", + method: "DELETE", + path: "/v1/sdks/{uid}/versions/{version}", + run: -> { client.sdks.versions.delete("version", {uid: "uidxx"}) } + }, + { + operation: "link", + method: "POST", + path: "/v1/sdks/{uid}/repositories", + label: "required params", + run: -> do + client.sdks.repositories.link("uidxx", {base_branch: "", language: "typescript", repository_id: 0}) + end + }, + { + operation: "link", + method: "POST", + path: "/v1/sdks/{uid}/repositories", + label: "all params", + run: -> do + client.sdks.repositories.link( + "uidxx", + {base_branch: "", language: "typescript", repository_id: 0, prerelease_type: ""} + ) + end + }, + { + operation: "unlink", + method: "DELETE", + path: "/v1/sdks/{uid}/repositories/{language}", + run: -> { client.sdks.repositories.unlink("typescript", {uid: "uidxx"}) } + }, + { + operation: "updatePublishing", + method: "POST", + path: "/v1/sdks/{uid}/repositories/{language}/publishing", + label: "required params", + run: -> do + client.sdks.repositories.update_publishing("typescript", {uid: "uidxx", publish_on_merge: false}) + end + }, + { + operation: "updatePublishing", + method: "POST", + path: "/v1/sdks/{uid}/repositories/{language}/publishing", + label: "all params", + run: -> do + client.sdks.repositories.update_publishing( + "typescript", + {uid: "uidxx", publish_on_merge: false, access: "public", auth_method: "oidc", tag: ""} + ) + end + }, + { + operation: "create", + method: "POST", + path: "/v1/mcp/servers", + label: "required params", + run: -> { client.mcp.servers.create({name: "x"}) } + }, + { + operation: "create", + method: "POST", + path: "/v1/mcp/servers", + label: "all params", + run: -> { client.mcp.servers.create({name: "x", project_uids: [""], slug: "x", version_uids: [""]}) } + }, + { + operation: "retrieve", + method: "GET", + path: "/v1/mcp/servers/{id}", + run: -> { client.mcp.servers.retrieve("id") } + }, + { + operation: "update", + method: "PATCH", + path: "/v1/mcp/servers/{id}", + label: "required params", + run: -> { client.mcp.servers.update("id") } + }, + { + operation: "update", + method: "PATCH", + path: "/v1/mcp/servers/{id}", + label: "all params", + run: -> do + client.mcp.servers.update( + "id", + {auto_add_operations: false, docs_pages: [""], name: "x", operations: [""], slug: "x"} + ) + end + }, + {operation: "list", method: "GET", path: "/v1/mcp/servers", run: -> { client.mcp.servers.list }}, + { + operation: "delete", + method: "DELETE", + path: "/v1/mcp/servers/{id}", + run: -> { client.mcp.servers.delete("id") } + }, + { + operation: "create", + method: "POST", + path: "/v1/mcp/servers/{id}/installations", + label: "required params", + run: -> { client.mcp.servers.installations.create("id", {document_auth: {}, name: "x"}) } + }, + { + operation: "create", + method: "POST", + path: "/v1/mcp/servers/{id}/installations", + label: "all params", + run: -> { client.mcp.servers.installations.create("id", {document_auth: {}, name: "x", slug: "x"}) } + }, + { + operation: "retrieve", + method: "GET", + path: "/v1/mcp/servers/{id}/installations/{installationId}", + run: -> { client.mcp.servers.installations.retrieve("installation_id", {id: "id"}) } + }, + { + operation: "update", + method: "PATCH", + path: "/v1/mcp/servers/{id}/installations/{installationId}", + label: "required params", + run: -> { client.mcp.servers.installations.update("installation_id", {id: "id"}) } + }, + { + operation: "update", + method: "PATCH", + path: "/v1/mcp/servers/{id}/installations/{installationId}", + label: "all params", + run: -> do + client.mcp.servers.installations.update( + "installation_id", + { + id: "id", + document_auth: {}, + is_private: false, + login_portal_uid: "", + mcp_version: "", + name: "x", + slug: "x" + } + ) + end + }, + { + operation: "list", + method: "GET", + path: "/v1/mcp/servers/{id}/installations", + run: -> { client.mcp.servers.installations.list("id") } + }, + { + operation: "delete", + method: "DELETE", + path: "/v1/mcp/servers/{id}/installations/{installationId}", + run: -> { client.mcp.servers.installations.delete("installation_id", {id: "id"}) } + }, + { + operation: "createAccessGroup", + method: "POST", + path: "/v1/mcp/servers/{id}/installations/{installationId}/access-group", + run: -> do + client.mcp.servers.installations.create_access_group( + "installation_id", + {id: "id", access_group_uid: "xxxxx"} + ) + end + }, + { + operation: "deleteAccessGroup", + method: "DELETE", + path: "/v1/mcp/servers/{id}/installations/{installationId}/access-group", + run: -> do + client.mcp.servers.installations.delete_access_group( + "installation_id", + {id: "id", access_group_uid: "xxxxx"} + ) + end + }, + { + operation: "oauthAuthorizationServerMetadata", + method: "GET", + path: "/.well-known/oauth-authorization-server", + run: -> { client.o_auth.oauth_authorization_server_metadata } + }, + { + operation: "oauthAuthorize", + method: "GET", + path: "/v1/oauth/authorize", + run: -> { client.o_auth.oauth_authorize } + }, + { + operation: "oauthRevoke", + method: "POST", + path: "/v1/oauth/revoke", + label: "required params", + run: -> { client.o_auth.oauth_revoke({token: ""}) } + }, + { + operation: "oauthRevoke", + method: "POST", + path: "/v1/oauth/revoke", + label: "all params", + run: -> do + client.o_auth.oauth_revoke({token: "", client_id: "", client_secret: "", token_type_hint: ""}) + end + }, + { + operation: "oauthToken", + method: "POST", + path: "/v1/oauth/token", + label: "required params", + run: -> { client.o_auth.oauth_token({grant_type: ""}) } + }, + { + operation: "oauthToken", + method: "POST", + path: "/v1/oauth/token", + label: "all params", + run: -> do + client.o_auth.oauth_token( + { + grant_type: "", + client_id: "", + client_secret: "", + code: "", + code_verifier: "", + redirect_uri: "", + refresh_token: "", + scope: "" + } + ) + end } ] From 21db53f16e8ed92be07de3f544e780bb44373872 Mon Sep 17 00:00:00 2001 From: scalarbot Date: Fri, 2 Oct 2026 16:33:26 +0000 Subject: [PATCH 3/7] feat(api)!: update property api_document.tags (+3 more changes) - Property `api_document.tags` type changed from `unknown` to `string`. - Property `managed_doc_version.tools` type changed from `Array` to `Array`. - Property `github_project.accessGroups` type changed from `unknown` to `string`. - Property `docs_project.accessGroups` type changed from `unknown` to `string`. BREAKING CHANGE: 4 breaking changes to the SDK surface. - Property `api_document.tags` type changed from `unknown` to `string`. - Property `managed_doc_version.tools` type changed from `Array` to `Array`. - Property `github_project.accessGroups` type changed from `unknown` to `string`. - Property `docs_project.accessGroups` type changed from `unknown` to `string`. Build: OocRChcN6mN9IwfcNU6zh --- api.md | 160 +-- .../models/access_group_create_params.rb | 6 +- .../models/access_group_create_response.rb | 12 +- .../models/access_group_retrieve_response.rb | 12 +- lib/scalar_api_ruby/models/api_document.rb | 6 +- lib/scalar_api_ruby/models/docs_project.rb | 6 +- lib/scalar_api_ruby/models/github_project.rb | 6 +- .../resources/access_groups.rb | 2 +- .../models/access_group_create_params.rbi | 8 +- .../models/access_group_create_response.rbi | 12 +- .../models/access_group_retrieve_response.rbi | 12 +- rbi/scalar_api_ruby/models/api_document.rbi | 6 +- rbi/scalar_api_ruby/models/docs_project.rbi | 6 +- rbi/scalar_api_ruby/models/github_project.rbi | 6 +- .../resources/access_groups.rbi | 2 +- scalar-sdk.manifest.json | 1151 ++++++++++++++++- .../models/access_group_create_params.rbs | 10 +- .../models/access_group_create_response.rbs | 16 +- .../models/access_group_retrieve_response.rbs | 16 +- sig/scalar_api_ruby/models/api_document.rbs | 8 +- sig/scalar_api_ruby/models/docs_project.rbs | 8 +- sig/scalar_api_ruby/models/github_project.rbs | 8 +- .../resources/access_groups.rbs | 2 +- tests/smoke-test.rb | 489 ++++--- 24 files changed, 1656 insertions(+), 314 deletions(-) diff --git a/api.md b/api.md index fa1a939..f5fddf4 100644 --- a/api.md +++ b/api.md @@ -161,7 +161,7 @@ List API documents in a namespace. | Response | [`APIDocument`](././lib/scalar_api_ruby/models/api_document.rb) | ```ruby -response = client.registry.list_api_documents("namespace") +response = client.registry.list_api_documents("acme") puts response.inspect ``` @@ -176,7 +176,7 @@ Create an API document. | Response | [`RegistryCreateAPIDocumentResponse`](././lib/scalar_api_ruby/models/registry_create_api_document_response.rb) | ```ruby -response = client.registry.create_api_document("namespace", { document: "", slug: "", title: "", version: "x", description: "", is_private: false, ruleset: "" }) +response = client.registry.create_api_document("acme", { document: "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Acme API\",\"version\":\"1.2.0\"},\"paths\":{}}", slug: "acme-api", title: "Acme API", version: "1.2.0", description: "API for managing Acme products and orders.", is_private: false, ruleset: "extends: [\"spectral:oas\"]" }) puts response.inspect ``` @@ -190,7 +190,7 @@ Update metadata for an API document. | Request | [`RegistryUpdateAPIDocumentParams`](././lib/scalar_api_ruby/models/registry_update_api_document_params.rb) | ```ruby -response = client.registry.update_api_document("slug", { namespace: "namespace", description: "", is_private: false, ruleset: "", title: "" }) +response = client.registry.update_api_document("acme-api", { namespace: "acme", description: "API for managing Acme products and orders.", is_private: false, ruleset: "extends: [\"spectral:oas\"]", title: "Acme API" }) puts response.inspect ``` @@ -204,7 +204,7 @@ Delete an API document and all versions. | Request | [`RegistryDeleteAPIDocumentParams`](././lib/scalar_api_ruby/models/registry_delete_api_document_params.rb) | ```ruby -response = client.registry.delete_api_document("slug", { namespace: "namespace" }) +response = client.registry.delete_api_document("acme-api", { namespace: "acme" }) puts response.inspect ``` @@ -218,7 +218,7 @@ Get a specific API document version. | Request | [`RegistryRetrieveAPIDocumentVersionParams`](././lib/scalar_api_ruby/models/registry_retrieve_api_document_version_params.rb) | ```ruby -response = client.registry.retrieve_api_document_version("semver", { namespace: "namespace", slug: "slug" }) +response = client.registry.retrieve_api_document_version("1.2.0", { namespace: "acme", slug: "acme-api" }) puts response.inspect ``` @@ -233,7 +233,7 @@ Update the registry file content for an API document version. | Response | [`RegistryUpdateAPIDocumentVersionResponse`](././lib/scalar_api_ruby/models/registry_update_api_document_version_response.rb) | ```ruby -response = client.registry.update_api_document_version("semver", { namespace: "namespace", slug: "slug", document: "" }) +response = client.registry.update_api_document_version("1.2.0", { namespace: "acme", slug: "acme-api", document: "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Acme API\",\"version\":\"1.2.0\"},\"paths\":{}}" }) puts response.inspect ``` @@ -247,7 +247,7 @@ Delete a specific API document version. | Request | [`RegistryDeleteAPIDocumentVersionParams`](././lib/scalar_api_ruby/models/registry_delete_api_document_version_params.rb) | ```ruby -response = client.registry.delete_api_document_version("semver", { namespace: "namespace", slug: "slug" }) +response = client.registry.delete_api_document_version("1.2.0", { namespace: "acme", slug: "acme-api" }) puts response.inspect ``` @@ -262,7 +262,7 @@ Get metadata (uid, content shas, version sha, tags) for a specific API document | Response | [`ManagedDocVersion`](././lib/scalar_api_ruby/models/managed_doc_version.rb) | ```ruby -response = client.registry.list_api_document_version_metadata("semver", { namespace: "namespace", slug: "slug" }) +response = client.registry.list_api_document_version_metadata("1.2.0", { namespace: "acme", slug: "acme-api" }) puts response.inspect ``` @@ -277,7 +277,7 @@ Create a new API document version. | Response | [`ManagedDocVersion`](././lib/scalar_api_ruby/models/managed_doc_version.rb) | ```ruby -response = client.registry.create_api_document_version("slug", { namespace: "namespace", document: "", version: "x", force: false }) +response = client.registry.create_api_document_version("acme-api", { namespace: "acme", document: "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Acme API\",\"version\":\"1.2.0\"},\"paths\":{}}", version: "1.2.0", force: false }) puts response.inspect ``` @@ -291,7 +291,7 @@ Add an access group to an API document. | Request | [`RegistryCreateAPIDocumentAccessGroupParams`](././lib/scalar_api_ruby/models/registry_create_api_document_access_group_params.rb) | ```ruby -response = client.registry.create_api_document_access_group("slug", { access_group_slug: "x", namespace: "namespace" }) +response = client.registry.create_api_document_access_group("acme-api", { access_group_slug: "acme-api", namespace: "acme" }) puts response.inspect ``` @@ -305,7 +305,7 @@ Remove an access group from an API document. | Request | [`RegistryDeleteAPIDocumentAccessGroupParams`](././lib/scalar_api_ruby/models/registry_delete_api_document_access_group_params.rb) | ```ruby -response = client.registry.delete_api_document_access_group("slug", { access_group_slug: "x", namespace: "namespace" }) +response = client.registry.delete_api_document_access_group("acme-api", { access_group_slug: "acme-api", namespace: "acme" }) puts response.inspect ``` @@ -324,7 +324,7 @@ List schemas in a namespace. | Response | [`Schema`](././lib/scalar_api_ruby/models/schema.rb) | ```ruby -response = client.schemas.list("namespace") +response = client.schemas.list("acme") puts response.inspect ``` @@ -339,7 +339,7 @@ Create a schema in a namespace. | Response | [`UID`](././lib/scalar_api_ruby/models/uid.rb) | ```ruby -response = client.schemas.create("namespace", { document: "", slug: "", title: "", version: "x", description: "", is_private: false }) +response = client.schemas.create("acme", { document: "{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"examples\":[\"Acme\"]}}}", slug: "customer", title: "Customer", version: "1.2.0", description: "API for managing Acme products and orders.", is_private: false }) puts response.inspect ``` @@ -353,7 +353,7 @@ Update schema metadata. | Request | [`SchemaUpdateParams`](././lib/scalar_api_ruby/models/schema_update_params.rb) | ```ruby -response = client.schemas.update("slug", { namespace: "namespace", description: "", is_private: false, title: "" }) +response = client.schemas.update("customer", { namespace: "acme", description: "API for managing Acme products and orders.", is_private: false, title: "Customer" }) puts response.inspect ``` @@ -367,7 +367,7 @@ Delete a schema and all related versions. | Request | [`SchemaDeleteParams`](././lib/scalar_api_ruby/models/schema_delete_params.rb) | ```ruby -response = client.schemas.delete("slug", { namespace: "namespace" }) +response = client.schemas.delete("customer", { namespace: "acme" }) puts response.inspect ``` @@ -385,7 +385,7 @@ Get a specific schema version document. | Request | [`VersionRetrieveParams`](././lib/scalar_api_ruby/models/schemas/version_retrieve_params.rb) | ```ruby -response = client.schemas.version.retrieve("semver", { namespace: "namespace", slug: "slug" }) +response = client.schemas.version.retrieve("1.2.0", { namespace: "acme", slug: "customer" }) puts response.inspect ``` @@ -399,7 +399,7 @@ Delete a schema version. | Request | [`VersionDeleteParams`](././lib/scalar_api_ruby/models/schemas/version_delete_params.rb) | ```ruby -response = client.schemas.version.delete("semver", { namespace: "namespace", slug: "slug" }) +response = client.schemas.version.delete("1.2.0", { namespace: "acme", slug: "customer" }) puts response.inspect ``` @@ -414,7 +414,7 @@ Create a schema version. | Response | [`Schemas::VersionCreateResponse`](././lib/scalar_api_ruby/models/schemas/version_create_response.rb) | ```ruby -response = client.schemas.version.create("slug", { namespace: "namespace", document: "", version: "x", force: false }) +response = client.schemas.version.create("customer", { namespace: "acme", document: "{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"examples\":[\"Acme\"]}}}", version: "1.2.0", force: false }) puts response.inspect ``` @@ -432,7 +432,7 @@ Add an access group to a schema. | Request | [`AccessGroupCreateParams`](././lib/scalar_api_ruby/models/schemas/access_group_create_params.rb) | ```ruby -response = client.schemas.access_group.create("slug", { access_group_slug: "x", namespace: "namespace" }) +response = client.schemas.access_group.create("customer", { access_group_slug: "acme-api", namespace: "acme" }) puts response.inspect ``` @@ -446,7 +446,7 @@ Remove an access group from a schema. | Request | [`AccessGroupDeleteParams`](././lib/scalar_api_ruby/models/schemas/access_group_delete_params.rb) | ```ruby -response = client.schemas.access_group.delete("slug", { access_group_slug: "x", namespace: "namespace" }) +response = client.schemas.access_group.delete("customer", { access_group_slug: "acme-api", namespace: "acme" }) puts response.inspect ``` @@ -465,7 +465,7 @@ Get a login portal by slug. | Response | [`LoginPortalRetrieveResponse`](././lib/scalar_api_ruby/models/login_portal_retrieve_response.rb) | ```ruby -response = client.login_portals.retrieve("slug") +response = client.login_portals.retrieve("acme-login") puts response.inspect ``` @@ -479,7 +479,7 @@ Update metadata for a login portal. | Request | [`LoginPortalUpdateParams`](././lib/scalar_api_ruby/models/login_portal_update_params.rb) | ```ruby -response = client.login_portals.update("slug", { title: "" }) +response = client.login_portals.update("acme-login", { title: "Acme Private Documentation" }) puts response.inspect ``` @@ -493,7 +493,7 @@ Delete a login portal. | Request | [`LoginPortalDeleteParams`](././lib/scalar_api_ruby/models/login_portal_delete_params.rb) | ```ruby -response = client.login_portals.delete("slug") +response = client.login_portals.delete("acme-login") puts response.inspect ``` @@ -508,7 +508,7 @@ Create a login portal for the current team. | Response | [`UID`](././lib/scalar_api_ruby/models/uid.rb) | ```ruby -response = client.login_portals.create({ email: { "logo" => "", "logoSize" => "100", "buttonText" => "Login", "message" => "Click to access private documentation hosted by scalar.com", "title" => "Private Docs", "mainColor" => "\#2a2f45", "mainBackground" => "\#f6f6f6", "cardColor" => "\#2a2f45", "cardBackground" => "\#fff", "buttonColor" => "\#fff", "buttonBackground" => "\#0f0f0f" }, page: { "title" => "Scalar Private Docs", "description" => "Login to access your documentation", "head" => "", "script" => "", "theme" => "", "companyName" => "", "logo" => "", "logoURL" => "", "favicon" => "", "termsLink" => "", "privacyLink" => "", "formTitle" => "Scalar Private Docs", "formDescription" => "Login to access your documentation", "formImage" => "" }, slug: "", title: "" }) +response = client.login_portals.create({ email: { "logo" => "", "logoSize" => "100", "buttonText" => "Login", "message" => "Click to access private documentation hosted by scalar.com", "title" => "Private Docs", "mainColor" => "\#2a2f45", "mainBackground" => "\#f6f6f6", "cardColor" => "\#2a2f45", "cardBackground" => "\#fff", "buttonColor" => "\#fff", "buttonBackground" => "\#0f0f0f" }, page: { "title" => "Scalar Private Docs", "description" => "Login to access your documentation", "head" => "", "script" => "", "theme" => "", "companyName" => "", "logo" => "", "logoURL" => "", "favicon" => "", "termsLink" => "", "privacyLink" => "", "formTitle" => "Scalar Private Docs", "formDescription" => "Login to access your documentation", "formImage" => "" }, slug: "acme-login", title: "Acme Private Documentation" }) puts response.inspect ``` @@ -542,7 +542,7 @@ Create a group for the current team. Requires docs edit permission and the acces | Response | [`AccessGroupCreateResponse`](././lib/scalar_api_ruby/models/access_group_create_response.rb) | ```ruby -response = client.access_groups.create({ allowed_domains: { }, name: "", slug: "x" }) +response = client.access_groups.create({ allowed_domains: "example.com", name: "Engineering", slug: "acme-api" }) puts response.inspect ``` @@ -557,7 +557,7 @@ Get a group and its email and domain allowlists by slug. | Response | [`AccessGroupRetrieveResponse`](././lib/scalar_api_ruby/models/access_group_retrieve_response.rb) | ```ruby -response = client.access_groups.retrieve("slug") +response = client.access_groups.retrieve("acme-api") puts response.inspect ``` @@ -571,7 +571,7 @@ Update group metadata. Requires docs edit permission. After changing the slug, u | Request | [`AccessGroupUpdateParams`](././lib/scalar_api_ruby/models/access_group_update_params.rb) | ```ruby -response = client.access_groups.update("path_slug", { name: "", body_slug: "x" }) +response = client.access_groups.update("acme-api", { name: "Engineering", body_slug: "acme-api" }) puts response.inspect ``` @@ -585,7 +585,7 @@ Delete a group and remove its project assignments. Requires docs edit permission | Request | [`AccessGroupDeleteParams`](././lib/scalar_api_ruby/models/access_group_delete_params.rb) | ```ruby -response = client.access_groups.delete("slug") +response = client.access_groups.delete("acme-api") puts response.inspect ``` @@ -603,7 +603,7 @@ Allow an exact email domain in a group. Requires docs edit permission. A group s | Request | [`DomainCreateParams`](././lib/scalar_api_ruby/models/access_groups/domain_create_params.rb) | ```ruby -response = client.access_groups.domains.create("slug", { domain: "" }) +response = client.access_groups.domains.create("acme-api", { domain: "example.com" }) puts response.inspect ``` @@ -617,7 +617,7 @@ Remove an exact email domain from a group. Requires docs edit permission. Other | Request | [`DomainDeleteParams`](././lib/scalar_api_ruby/models/access_groups/domain_delete_params.rb) | ```ruby -response = client.access_groups.domains.delete("slug", { domain: "" }) +response = client.access_groups.domains.delete("acme-api", { domain: "example.com" }) puts response.inspect ``` @@ -636,7 +636,7 @@ List all rulesets in a namespace. | Response | [`Rule`](././lib/scalar_api_ruby/models/rule.rb) | ```ruby -response = client.rules.list_rulesets("namespace") +response = client.rules.list_rulesets("acme") puts response.inspect ``` @@ -651,7 +651,7 @@ Create a rule in a namespace. | Response | [`UID`](././lib/scalar_api_ruby/models/uid.rb) | ```ruby -response = client.rules.create_ruleset("namespace", { document: "", slug: "", title: "", description: "", is_private: false }) +response = client.rules.create_ruleset("acme", { document: "extends: [\"spectral:oas\"]\nrules:\n info-contact: warn\n", slug: "acme-rules", title: "Acme API Rules", description: "API for managing Acme products and orders.", is_private: false }) puts response.inspect ``` @@ -665,7 +665,7 @@ Update rule metadata by slug. | Request | [`RuleUpdateRulesetParams`](././lib/scalar_api_ruby/models/rule_update_ruleset_params.rb) | ```ruby -response = client.rules.update_ruleset("path_slug", { path_namespace: "path_namespace", description: "", is_private: false, body_namespace: "", body_slug: "", title: "" }) +response = client.rules.update_ruleset("acme-rules", { path_namespace: "acme", description: "API for managing Acme products and orders.", is_private: false, body_namespace: "acme", body_slug: "acme-rules", title: "Acme API Rules" }) puts response.inspect ``` @@ -679,7 +679,7 @@ Delete a rule by slug. | Request | [`RuleDeleteRulesetParams`](././lib/scalar_api_ruby/models/rule_delete_ruleset_params.rb) | ```ruby -response = client.rules.delete_ruleset("slug", { namespace: "namespace" }) +response = client.rules.delete_ruleset("acme-rules", { namespace: "acme" }) puts response.inspect ``` @@ -693,7 +693,7 @@ Get a rule document by slug. | Request | [`RuleRetrieveRulesetDocumentParams`](././lib/scalar_api_ruby/models/rule_retrieve_ruleset_document_params.rb) | ```ruby -response = client.rules.retrieve_ruleset_document("slug", { namespace: "namespace" }) +response = client.rules.retrieve_ruleset_document("acme-rules", { namespace: "acme" }) puts response.inspect ``` @@ -707,7 +707,7 @@ Grant an access group to a rule. | Request | [`RuleCreateRulesetAccessGroupParams`](././lib/scalar_api_ruby/models/rule_create_ruleset_access_group_params.rb) | ```ruby -response = client.rules.create_ruleset_access_group("slug", { access_group_slug: "x", namespace: "namespace" }) +response = client.rules.create_ruleset_access_group("acme-rules", { access_group_slug: "acme-api", namespace: "acme" }) puts response.inspect ``` @@ -721,7 +721,7 @@ Remove an access group from a rule. | Request | [`RuleDeleteRulesetAccessGroupParams`](././lib/scalar_api_ruby/models/rule_delete_ruleset_access_group_params.rb) | ```ruby -response = client.rules.delete_ruleset_access_group("slug", { access_group_slug: "x", namespace: "namespace" }) +response = client.rules.delete_ruleset_access_group("acme-rules", { access_group_slug: "acme-api", namespace: "acme" }) puts response.inspect ``` @@ -755,7 +755,7 @@ Create a team theme. | Response | [`UID`](././lib/scalar_api_ruby/models/uid.rb) | ```ruby -response = client.themes.create({ document: "", name: "", slug: "", description: "" }) +response = client.themes.create({ document: ":root { --scalar-color-1: \#1f2937; }", name: "Acme Theme", slug: "acme-theme", description: "API for managing Acme products and orders." }) puts response.inspect ``` @@ -769,7 +769,7 @@ Update theme metadata. | Request | [`ThemeUpdateParams`](././lib/scalar_api_ruby/models/theme_update_params.rb) | ```ruby -response = client.themes.update("slug", { description: "", name: "" }) +response = client.themes.update("acme-theme", { description: "API for managing Acme products and orders.", name: "Acme Theme" }) puts response.inspect ``` @@ -783,7 +783,7 @@ Replace the theme document. | Request | [`ThemeReplaceDocumentParams`](././lib/scalar_api_ruby/models/theme_replace_document_params.rb) | ```ruby -response = client.themes.replace_document("slug", { document: "" }) +response = client.themes.replace_document("acme-theme", { document: ":root { --scalar-color-1: \#1f2937; }" }) puts response.inspect ``` @@ -797,7 +797,7 @@ Delete a theme by slug. | Request | [`ThemeDeleteParams`](././lib/scalar_api_ruby/models/theme_delete_params.rb) | ```ruby -response = client.themes.delete("slug") +response = client.themes.delete("acme-theme") puts response.inspect ``` @@ -811,7 +811,7 @@ Get the theme document by slug. | Request | [`ThemeRetrieveParams`](././lib/scalar_api_ruby/models/theme_retrieve_params.rb) | ```ruby -response = client.themes.retrieve("slug") +response = client.themes.retrieve("acme-theme") puts response.inspect ``` @@ -863,7 +863,7 @@ Change what a member of the current team is allowed to do. | Request | [`MemberUpdateParams`](././lib/scalar_api_ruby/models/teams/member_update_params.rb) | ```ruby -response = client.teams.members.update("uidxx", { role: "owner" }) +response = client.teams.members.update("UakgbKJ5m9gl0JDMbcJqL", { role: "owner" }) puts response.inspect ``` @@ -877,7 +877,7 @@ Remove someone from the current team. | Request | [`MemberDeleteParams`](././lib/scalar_api_ruby/models/teams/member_delete_params.rb) | ```ruby -response = client.teams.members.delete("uidxx") +response = client.teams.members.delete("UakgbKJ5m9gl0JDMbcJqL") puts response.inspect ``` @@ -895,7 +895,7 @@ Invite someone to the current team by email. | Request | [`InviteMemberParams`](././lib/scalar_api_ruby/models/teams/invite_member_params.rb) | ```ruby -response = client.teams.invites.member({ email: "user@example.com", role: "owner" }) +response = client.teams.invites.member({ email: "alex@example.com", role: "owner" }) puts response.inspect ``` @@ -909,7 +909,7 @@ Send the invite email again. | Request | [`InviteResendParams`](././lib/scalar_api_ruby/models/teams/invite_resend_params.rb) | ```ruby -response = client.teams.invites.resend("uidxx") +response = client.teams.invites.resend("UakgbKJ5m9gl0JDMbcJqL") puts response.inspect ``` @@ -923,7 +923,7 @@ Withdraw an invite that has not been accepted. | Request | [`InviteCancelParams`](././lib/scalar_api_ruby/models/teams/invite_cancel_params.rb) | ```ruby -response = client.teams.invites.cancel("uidxx") +response = client.teams.invites.cancel("UakgbKJ5m9gl0JDMbcJqL") puts response.inspect ``` @@ -957,7 +957,7 @@ Create a guide project. | Response | [`ScalarDocCreateGuideResponse`](././lib/scalar_api_ruby/models/scalar_doc_create_guide_response.rb) | ```ruby -response = client.scalar_docs.create_guide({ allowed_domains: [], allowed_users: [], is_private: false, name: "", slug: "x" }) +response = client.scalar_docs.create_guide({ allowed_domains: [], allowed_users: [], is_private: false, name: "Acme Documentation", slug: "acme-api" }) puts response.inspect ``` @@ -972,7 +972,7 @@ Start a new publish process. | Response | [`ScalarDocPublishGuideResponse`](././lib/scalar_api_ruby/models/scalar_doc_publish_guide_response.rb) | ```ruby -response = client.scalar_docs.publish_guide("slug") +response = client.scalar_docs.publish_guide("acme-docs") puts response.inspect ``` @@ -1002,7 +1002,7 @@ Create a docs project. Omit `provider` to have Scalar host the repository. | Response | [`DocsProject`](././lib/scalar_api_ruby/models/docs_project.rb) | ```ruby -response = client.scalar_docs.create_project({ name: "", provider: "forgejo", bitbucket_repository: { "workspaceUuid" => "", "repoUuid" => "" }, blank: false, github_repository: { "installationId" => 0, "repoId" => 0 }, is_private: false, slug: "x" }) +response = client.scalar_docs.create_project({ name: "Acme Documentation", provider: "forgejo", bitbucket_repository: { "workspaceUuid" => "{12345678-1234-4234-8234-123456789abc}", "repoUuid" => "{abcdef01-1234-4234-8234-123456789abc}" }, blank: true, github_repository: { "installationId" => 84, "repoId" => 123456789 }, is_private: false, slug: "acme-api" }) puts response.inspect ``` @@ -1017,7 +1017,7 @@ Get a single docs project by its slug. | Response | [`DocsProject`](././lib/scalar_api_ruby/models/docs_project.rb) | ```ruby -response = client.scalar_docs.retrieve_project("slug") +response = client.scalar_docs.retrieve_project("acme-docs") puts response.inspect ``` @@ -1031,7 +1031,7 @@ Update project settings. Set `isPrivate` with `accessGroups` to put the site beh | Request | [`ScalarDocUpdateProjectParams`](././lib/scalar_api_ruby/models/scalar_doc_update_project_params.rb) | ```ruby -response = client.scalar_docs.update_project("slug", { access_groups: ["xxxxx"], active_theme_id: "xxxxx", agent_enabled: false, analytics_enabled: false, is_private: false, login_portal_uid: "xxxxx", name: "" }) +response = client.scalar_docs.update_project("acme-docs", { access_groups: ["xxxxx"], active_theme_id: "UakgbKJ5m9gl0JDMbcJqL", agent_enabled: true, analytics_enabled: true, is_private: false, login_portal_uid: "xxxxx", name: "Acme Documentation" }) puts response.inspect ``` @@ -1045,7 +1045,7 @@ Delete a docs project, its deploys, its publish records and its cached builds. | Request | [`ScalarDocDeleteProjectParams`](././lib/scalar_api_ruby/models/scalar_doc_delete_project_params.rb) | ```ruby -response = client.scalar_docs.delete_project("slug") +response = client.scalar_docs.delete_project("acme-docs") puts response.inspect ``` @@ -1060,7 +1060,7 @@ Start a build and deploy. The returned `publishUid` identifies the publish recor | Response | [`ScalarDocPublishProjectResponse`](././lib/scalar_api_ruby/models/scalar_doc_publish_project_response.rb) | ```ruby -response = client.scalar_docs.publish_project("slug", { commit_sha: "", config_path: "", preview: false }) +response = client.scalar_docs.publish_project("acme-docs", { commit_sha: "0123456789abcdef0123456789abcdef01234567", config_path: "scalar.config.json", preview: false }) puts response.inspect ``` @@ -1075,7 +1075,7 @@ Read `scalar.config.json` straight from the project repository, without cloning | Response | [`ScalarDocListProjectConfigResponse`](././lib/scalar_api_ruby/models/scalar_doc_list_project_config_response.rb) | ```ruby -response = client.scalar_docs.list_project_config("slug") +response = client.scalar_docs.list_project_config("acme-docs") puts response.inspect ``` @@ -1090,7 +1090,7 @@ Commit `scalar.config.json` straight to the project repository. Pass the `baseTo | Response | [`ScalarDocUpdateProjectConfigResponse`](././lib/scalar_api_ruby/models/scalar_doc_update_project_config_response.rb) | ```ruby -response = client.scalar_docs.update_project_config("slug", { content: "", base_token: "", message: "", path: "", ref: "" }) +response = client.scalar_docs.update_project_config("acme-docs", { content: "{\"name\":\"Acme Documentation\"}", base_token: "example-edit-token", message: "Update documentation configuration", path: "scalar.config.json", ref: "main" }) puts response.inspect ``` @@ -1105,7 +1105,7 @@ The domains the project serves on — the Scalar-hosted one and the custom one, | Response | [`ScalarDocListProjectDomainResponse`](././lib/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rb) | ```ruby -response = client.scalar_docs.list_project_domain("slug") +response = client.scalar_docs.list_project_domain("acme-docs") puts response.inspect ``` @@ -1120,7 +1120,7 @@ Whether the project custom domain points at Scalar yet. `expected` is the CNAME | Response | [`ScalarDocListProjectDomainStatusResponse`](././lib/scalar_api_ruby/models/scalar_doc_list_project_domain_status_response.rb) | ```ruby -response = client.scalar_docs.list_project_domain_status("slug") +response = client.scalar_docs.list_project_domain_status("acme-docs") puts response.inspect ``` @@ -1157,7 +1157,7 @@ Exchange an API key for an access token. | Response | [`AuthenticationExchangePersonalTokenResponse`](././lib/scalar_api_ruby/models/authentication_exchange_personal_token_response.rb) | ```ruby -response = client.authentication.exchange_personal_token({ personal_token: "" }) +response = client.authentication.exchange_personal_token({ personal_token: "scalar_example_personal_token" }) puts response.inspect ``` @@ -1206,7 +1206,7 @@ Create an SDK from an API document, targeting one or more languages. | Response | [`UID`](././lib/scalar_api_ruby/models/uid.rb) | ```ruby -response = client.sdks.create({ api_uid: "xxxxx", languages: ["typescript"], class_name: "", config: "", slug: "x", title: "" }) +response = client.sdks.create({ api_uid: "UakgbKJ5m9gl0JDMbcJqL", languages: ["typescript"], class_name: "Acme", config: "{\"targets\":{\"typescript\":{\"packageName\":\"@acme/sdk\"}}}", slug: "acme-api", title: "Acme SDK" }) puts response.inspect ``` @@ -1221,7 +1221,7 @@ Get a single SDK by its uid. | Response | [`Sdk`](././lib/scalar_api_ruby/models/sdk.rb) | ```ruby -response = client.sdks.retrieve("uidxx") +response = client.sdks.retrieve("UakgbKJ5m9gl0JDMbcJqL") puts response.inspect ``` @@ -1235,7 +1235,7 @@ Update SDK metadata, its linked API, or its config. | Request | [`SdkUpdateParams`](././lib/scalar_api_ruby/models/sdk_update_params.rb) | ```ruby -response = client.sdks.update("uidxx", { api_uid: "xxxxx", api_version: "", config: "", is_private: false, slug: "x", title: "" }) +response = client.sdks.update("UakgbKJ5m9gl0JDMbcJqL", { api_uid: "UakgbKJ5m9gl0JDMbcJqL", api_version: "", config: "{\"targets\":{\"typescript\":{\"packageName\":\"@acme/sdk\"}}}", is_private: false, slug: "acme-api", title: "Acme SDK" }) puts response.inspect ``` @@ -1249,7 +1249,7 @@ Delete an SDK and every version it holds. | Request | [`SdkDeleteParams`](././lib/scalar_api_ruby/models/sdk_delete_params.rb) | ```ruby -response = client.sdks.delete("uidxx") +response = client.sdks.delete("UakgbKJ5m9gl0JDMbcJqL") puts response.inspect ``` @@ -1264,7 +1264,7 @@ Start a build. Omit `version` to build the current work — the open draft, else | Response | [`SdkBuildResponse`](././lib/scalar_api_ruby/models/sdk_build_response.rb) | ```ruby -response = client.sdks.build("uidxx", { languages: ["typescript"], version: "" }) +response = client.sdks.build("UakgbKJ5m9gl0JDMbcJqL", { languages: ["typescript"], version: "1.2.0" }) puts response.inspect ``` @@ -1282,7 +1282,7 @@ Create a new SDK version against a specific API version. | Request | [`VersionCreateParams`](././lib/scalar_api_ruby/models/sdks/version_create_params.rb) | ```ruby -response = client.sdks.versions.create("uidxx", { api_version: "", version: "" }) +response = client.sdks.versions.create("UakgbKJ5m9gl0JDMbcJqL", { api_version: "1.2.0", version: "1.2.0" }) puts response.inspect ``` @@ -1296,7 +1296,7 @@ Permanently delete one version of an SDK. | Request | [`VersionDeleteParams`](././lib/scalar_api_ruby/models/sdks/version_delete_params.rb) | ```ruby -response = client.sdks.versions.delete("version", { uid: "uidxx" }) +response = client.sdks.versions.delete("1.2.0", { uid: "UakgbKJ5m9gl0JDMbcJqL" }) puts response.inspect ``` @@ -1315,7 +1315,7 @@ Link one language target to a GitHub repository, so builds sync there. | Response | [`Sdks::RepositoryLinkResponse`](././lib/scalar_api_ruby/models/sdks/repository_link_response.rb) | ```ruby -response = client.sdks.repositories.link("uidxx", { base_branch: "", language: "typescript", repository_id: 0, prerelease_type: "" }) +response = client.sdks.repositories.link("UakgbKJ5m9gl0JDMbcJqL", { base_branch: "main", language: "typescript", repository_id: 123456789, prerelease_type: "beta" }) puts response.inspect ``` @@ -1329,7 +1329,7 @@ Unlink one language target from its repository. | Request | [`RepositoryUnlinkParams`](././lib/scalar_api_ruby/models/sdks/repository_unlink_params.rb) | ```ruby -response = client.sdks.repositories.unlink("typescript", { uid: "uidxx" }) +response = client.sdks.repositories.unlink("typescript", { uid: "UakgbKJ5m9gl0JDMbcJqL" }) puts response.inspect ``` @@ -1343,7 +1343,7 @@ Toggle publish-on-merge and the release settings for a linked target. | Request | [`RepositoryUpdatePublishingParams`](././lib/scalar_api_ruby/models/sdks/repository_update_publishing_params.rb) | ```ruby -response = client.sdks.repositories.update_publishing("typescript", { uid: "uidxx", publish_on_merge: false, access: "public", auth_method: "oidc", tag: "" }) +response = client.sdks.repositories.update_publishing("typescript", { uid: "UakgbKJ5m9gl0JDMbcJqL", publish_on_merge: true, access: "public", auth_method: "oidc", tag: "latest" }) puts response.inspect ``` @@ -1379,7 +1379,7 @@ Create an MCP server over one or more API document versions. The response carrie | Response | [`Mcp::ServerCreateResponse`](././lib/scalar_api_ruby/models/mcp/server_create_response.rb) | ```ruby -response = client.mcp.servers.create({ name: "x", project_uids: [""], slug: "x", version_uids: [""] }) +response = client.mcp.servers.create({ name: "Acme MCP", project_uids: [""], slug: "acme-api", version_uids: [""] }) puts response.inspect ``` @@ -1394,7 +1394,7 @@ Get a single MCP server by its id. | Response | [`Mcp::McpServer`](././lib/scalar_api_ruby/models/mcp/mcp_server.rb) | ```ruby -response = client.mcp.servers.retrieve("id") +response = client.mcp.servers.retrieve("42") puts response.inspect ``` @@ -1409,7 +1409,7 @@ Update MCP server metadata and which tools it exposes. | Response | [`Mcp::McpServer`](././lib/scalar_api_ruby/models/mcp/mcp_server.rb) | ```ruby -response = client.mcp.servers.update("id", { auto_add_operations: false, docs_pages: [""], name: "x", operations: [""], slug: "x" }) +response = client.mcp.servers.update("42", { auto_add_operations: true, docs_pages: [""], name: "Acme MCP", operations: [""], slug: "acme-api" }) puts response.inspect ``` @@ -1423,7 +1423,7 @@ Delete an MCP server and every installation it serves. | Request | [`ServerDeleteParams`](././lib/scalar_api_ruby/models/mcp/server_delete_params.rb) | ```ruby -response = client.mcp.servers.delete("id") +response = client.mcp.servers.delete("42") puts response.inspect ``` @@ -1442,7 +1442,7 @@ List the installations of an MCP server. An installation is what an MCP client c | Response | [`Mcp::Servers::McpInstallationListItem`](././lib/scalar_api_ruby/models/mcp/servers/mcp_installation_list_item.rb) | ```ruby -response = client.mcp.servers.installations.list("id") +response = client.mcp.servers.installations.list("42") puts response.inspect ``` @@ -1457,7 +1457,7 @@ Create an installation of an MCP server. `documentAuth` holds the credentials th | Response | [`Mcp::McpInstallation`](././lib/scalar_api_ruby/models/mcp/mcp_installation.rb) | ```ruby -response = client.mcp.servers.installations.create("id", { document_auth: { }, name: "x", slug: "x" }) +response = client.mcp.servers.installations.create("42", { document_auth: { }, name: "Acme MCP", slug: "acme-api" }) puts response.inspect ``` @@ -1472,7 +1472,7 @@ Get a single installation of an MCP server. | Response | [`Mcp::McpInstallation`](././lib/scalar_api_ruby/models/mcp/mcp_installation.rb) | ```ruby -response = client.mcp.servers.installations.retrieve("installation_id", { id: "id" }) +response = client.mcp.servers.installations.retrieve("84", { id: "42" }) puts response.inspect ``` @@ -1487,7 +1487,7 @@ Update an installation. Set `isPrivate` and add access groups to put it behind a | Response | [`Mcp::McpInstallation`](././lib/scalar_api_ruby/models/mcp/mcp_installation.rb) | ```ruby -response = client.mcp.servers.installations.update("installation_id", { id: "id", document_auth: { }, is_private: false, login_portal_uid: "", mcp_version: "", name: "x", slug: "x" }) +response = client.mcp.servers.installations.update("84", { id: "42", document_auth: { }, is_private: false, login_portal_uid: "", mcp_version: "", name: "Acme MCP", slug: "acme-api" }) puts response.inspect ``` @@ -1501,7 +1501,7 @@ Delete an installation of an MCP server. | Request | [`InstallationDeleteParams`](././lib/scalar_api_ruby/models/mcp/servers/installation_delete_params.rb) | ```ruby -response = client.mcp.servers.installations.delete("installation_id", { id: "id" }) +response = client.mcp.servers.installations.delete("84", { id: "42" }) puts response.inspect ``` @@ -1515,7 +1515,7 @@ Let an access group reach a private installation. | Request | [`InstallationCreateAccessGroupParams`](././lib/scalar_api_ruby/models/mcp/servers/installation_create_access_group_params.rb) | ```ruby -response = client.mcp.servers.installations.create_access_group("installation_id", { id: "id", access_group_uid: "xxxxx" }) +response = client.mcp.servers.installations.create_access_group("84", { id: "42", access_group_uid: "UakgbKJ5m9gl0JDMbcJqL" }) puts response.inspect ``` @@ -1529,7 +1529,7 @@ Stop an access group reaching a private installation. | Request | [`InstallationDeleteAccessGroupParams`](././lib/scalar_api_ruby/models/mcp/servers/installation_delete_access_group_params.rb) | ```ruby -response = client.mcp.servers.installations.delete_access_group("installation_id", { id: "id", access_group_uid: "xxxxx" }) +response = client.mcp.servers.installations.delete_access_group("84", { id: "42", access_group_uid: "UakgbKJ5m9gl0JDMbcJqL" }) puts response.inspect ``` diff --git a/lib/scalar_api_ruby/models/access_group_create_params.rb b/lib/scalar_api_ruby/models/access_group_create_params.rb index 0f7dd22..e05eb92 100644 --- a/lib/scalar_api_ruby/models/access_group_create_params.rb +++ b/lib/scalar_api_ruby/models/access_group_create_params.rb @@ -9,8 +9,8 @@ class AccessGroupCreateParams < Scalar::Internal::Type::BaseModel # @!attribute allowed_domains # - # @return [Object, nil] - optional :allowed_domains, Scalar::Internal::Type::Unknown, api_name: :allowedDomains + # @return [String, nil] + optional :allowed_domains, String, api_name: :allowedDomains # @!attribute name # @@ -23,7 +23,7 @@ class AccessGroupCreateParams < Scalar::Internal::Type::BaseModel optional :slug, String # @!method initialize(allowed_domains: nil, name: nil, slug: nil, request_options: {}) - # @param allowed_domains [Object] + # @param allowed_domains [String] # @param name [String] # @param slug [String] # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/scalar_api_ruby/models/access_group_create_response.rb b/lib/scalar_api_ruby/models/access_group_create_response.rb index ced125b..2db3ea5 100644 --- a/lib/scalar_api_ruby/models/access_group_create_response.rb +++ b/lib/scalar_api_ruby/models/access_group_create_response.rb @@ -6,13 +6,13 @@ module Models class AccessGroupCreateResponse < Scalar::Internal::Type::BaseModel # @!attribute allowed_domains # - # @return [Object] - required :allowed_domains, Scalar::Internal::Type::Unknown, api_name: :allowedDomains + # @return [String] + required :allowed_domains, String, api_name: :allowedDomains # @!attribute allowed_emails # - # @return [Object] - required :allowed_emails, Scalar::Internal::Type::Unknown, api_name: :allowedEmails + # @return [String] + required :allowed_emails, String, api_name: :allowedEmails # @!attribute name # @@ -30,8 +30,8 @@ class AccessGroupCreateResponse < Scalar::Internal::Type::BaseModel required :uid, String # @!method initialize(allowed_domains:, allowed_emails:, name:, slug:, uid:) - # @param allowed_domains [Object] - # @param allowed_emails [Object] + # @param allowed_domains [String] + # @param allowed_emails [String] # @param name [String] # @param slug [String] # @param uid [String] diff --git a/lib/scalar_api_ruby/models/access_group_retrieve_response.rb b/lib/scalar_api_ruby/models/access_group_retrieve_response.rb index 0a564a4..673baba 100644 --- a/lib/scalar_api_ruby/models/access_group_retrieve_response.rb +++ b/lib/scalar_api_ruby/models/access_group_retrieve_response.rb @@ -6,13 +6,13 @@ module Models class AccessGroupRetrieveResponse < Scalar::Internal::Type::BaseModel # @!attribute allowed_domains # - # @return [Object] - required :allowed_domains, Scalar::Internal::Type::Unknown, api_name: :allowedDomains + # @return [String] + required :allowed_domains, String, api_name: :allowedDomains # @!attribute allowed_emails # - # @return [Object] - required :allowed_emails, Scalar::Internal::Type::Unknown, api_name: :allowedEmails + # @return [String] + required :allowed_emails, String, api_name: :allowedEmails # @!attribute name # @@ -30,8 +30,8 @@ class AccessGroupRetrieveResponse < Scalar::Internal::Type::BaseModel required :uid, String # @!method initialize(allowed_domains:, allowed_emails:, name:, slug:, uid:) - # @param allowed_domains [Object] - # @param allowed_emails [Object] + # @param allowed_domains [String] + # @param allowed_emails [String] # @param name [String] # @param slug [String] # @param uid [String] diff --git a/lib/scalar_api_ruby/models/api_document.rb b/lib/scalar_api_ruby/models/api_document.rb index 47f1525..6094dbf 100644 --- a/lib/scalar_api_ruby/models/api_document.rb +++ b/lib/scalar_api_ruby/models/api_document.rb @@ -25,8 +25,8 @@ class APIDocument < Scalar::Internal::Type::BaseModel # @!attribute tags # - # @return [Object] - required :tags, Scalar::Internal::Type::Unknown + # @return [String] + required :tags, String # @!attribute title # @@ -53,7 +53,7 @@ class APIDocument < Scalar::Internal::Type::BaseModel # @param is_private [Boolean] # @param namespace [String] # @param slug [String] - # @param tags [Object] + # @param tags [String] # @param title [String] # @param uid [String] # @param version [String] diff --git a/lib/scalar_api_ruby/models/docs_project.rb b/lib/scalar_api_ruby/models/docs_project.rb index bbbfcda..927c037 100644 --- a/lib/scalar_api_ruby/models/docs_project.rb +++ b/lib/scalar_api_ruby/models/docs_project.rb @@ -6,8 +6,8 @@ module Models class DocsProject < Scalar::Internal::Type::BaseModel # @!attribute access_groups # - # @return [Object] - required :access_groups, Scalar::Internal::Type::Unknown, api_name: :accessGroups + # @return [String] + required :access_groups, String, api_name: :accessGroups # @!attribute active_theme_id # @@ -60,7 +60,7 @@ class DocsProject < Scalar::Internal::Type::BaseModel required :uid, String # @!method initialize(access_groups:, active_theme_id:, agent_enabled:, analytics_enabled:, is_private:, last_published:, login_portal_uid:, name:, publish_status:, slug:, uid:) - # @param access_groups [Object] + # @param access_groups [String] # @param active_theme_id [String] # @param agent_enabled [Boolean] # @param analytics_enabled [Boolean] diff --git a/lib/scalar_api_ruby/models/github_project.rb b/lib/scalar_api_ruby/models/github_project.rb index 933e157..fdcd616 100644 --- a/lib/scalar_api_ruby/models/github_project.rb +++ b/lib/scalar_api_ruby/models/github_project.rb @@ -5,8 +5,8 @@ module Models class GithubProject < Scalar::Internal::Type::BaseModel # @!attribute access_groups # - # @return [Object] - required :access_groups, Scalar::Internal::Type::Unknown, api_name: :accessGroups + # @return [String] + required :access_groups, String, api_name: :accessGroups # @!attribute active_deployment # @@ -99,7 +99,7 @@ class GithubProject < Scalar::Internal::Type::BaseModel optional :typesense_id, Float, api_name: :typesenseId # @!method initialize(access_groups:, active_deployment:, active_theme_id:, agent_enabled:, analytics_enabled:, created_at:, is_private:, last_published:, last_published_uid:, login_portal_uid:, name:, publish_message:, publish_status:, slug:, uid:, updated_at:, user_info_hook_url:, repository: nil, typesense_id: nil) - # @param access_groups [Object] + # @param access_groups [String] # @param active_deployment [Scalar::Models::ActiveDeployment, nil] # @param active_theme_id [String] # @param agent_enabled [Boolean] diff --git a/lib/scalar_api_ruby/resources/access_groups.rb b/lib/scalar_api_ruby/resources/access_groups.rb index b7980c5..3883f58 100644 --- a/lib/scalar_api_ruby/resources/access_groups.rb +++ b/lib/scalar_api_ruby/resources/access_groups.rb @@ -14,7 +14,7 @@ class AccessGroups # # @overload create(allowed_domains: nil, name: nil, slug: nil, request_options: {}) # - # @param allowed_domains [Object] + # @param allowed_domains [String] # @param name [String] # @param slug [String] # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] diff --git a/rbi/scalar_api_ruby/models/access_group_create_params.rbi b/rbi/scalar_api_ruby/models/access_group_create_params.rbi index 1b7dd0b..b725bee 100644 --- a/rbi/scalar_api_ruby/models/access_group_create_params.rbi +++ b/rbi/scalar_api_ruby/models/access_group_create_params.rbi @@ -11,10 +11,10 @@ module Scalar T.any(Scalar::AccessGroupCreateParams, Scalar::Internal::AnyHash) end - sig { returns(T.nilable(T.anything)) } + sig { returns(T.nilable(String)) } attr_reader :allowed_domains - sig { params(allowed_domains: T.anything).void } + sig { params(allowed_domains: String).void } attr_writer :allowed_domains sig { returns(T.nilable(String)) } @@ -31,7 +31,7 @@ module Scalar sig do params( - allowed_domains: T.anything, + allowed_domains: String, name: String, slug: String, request_options: Scalar::RequestOptions::OrHash @@ -48,7 +48,7 @@ module Scalar sig do override.returns( { - allowed_domains: T.anything, + allowed_domains: String, name: String, slug: String, request_options: Scalar::RequestOptions diff --git a/rbi/scalar_api_ruby/models/access_group_create_response.rbi b/rbi/scalar_api_ruby/models/access_group_create_response.rbi index 46a3d5a..17e3338 100644 --- a/rbi/scalar_api_ruby/models/access_group_create_response.rbi +++ b/rbi/scalar_api_ruby/models/access_group_create_response.rbi @@ -11,10 +11,10 @@ module Scalar ) end - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :allowed_domains - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :allowed_emails sig { returns(String) } @@ -28,8 +28,8 @@ module Scalar sig do params( - allowed_domains: T.anything, - allowed_emails: T.anything, + allowed_domains: String, + allowed_emails: String, name: String, slug: String, uid: String @@ -41,8 +41,8 @@ module Scalar sig do override.returns( { - allowed_domains: T.anything, - allowed_emails: T.anything, + allowed_domains: String, + allowed_emails: String, name: String, slug: String, uid: String diff --git a/rbi/scalar_api_ruby/models/access_group_retrieve_response.rbi b/rbi/scalar_api_ruby/models/access_group_retrieve_response.rbi index 4acd2a3..7fc3a91 100644 --- a/rbi/scalar_api_ruby/models/access_group_retrieve_response.rbi +++ b/rbi/scalar_api_ruby/models/access_group_retrieve_response.rbi @@ -11,10 +11,10 @@ module Scalar ) end - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :allowed_domains - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :allowed_emails sig { returns(String) } @@ -28,8 +28,8 @@ module Scalar sig do params( - allowed_domains: T.anything, - allowed_emails: T.anything, + allowed_domains: String, + allowed_emails: String, name: String, slug: String, uid: String @@ -41,8 +41,8 @@ module Scalar sig do override.returns( { - allowed_domains: T.anything, - allowed_emails: T.anything, + allowed_domains: String, + allowed_emails: String, name: String, slug: String, uid: String diff --git a/rbi/scalar_api_ruby/models/api_document.rbi b/rbi/scalar_api_ruby/models/api_document.rbi index 08e4f81..570fcc4 100644 --- a/rbi/scalar_api_ruby/models/api_document.rbi +++ b/rbi/scalar_api_ruby/models/api_document.rbi @@ -18,7 +18,7 @@ module Scalar sig { returns(String) } attr_accessor :slug - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :tags sig { returns(String) } @@ -39,7 +39,7 @@ module Scalar is_private: T::Boolean, namespace: String, slug: String, - tags: T.anything, + tags: String, title: String, uid: String, version: String, @@ -66,7 +66,7 @@ module Scalar is_private: T::Boolean, namespace: String, slug: String, - tags: T.anything, + tags: String, title: String, uid: String, version: String, diff --git a/rbi/scalar_api_ruby/models/docs_project.rbi b/rbi/scalar_api_ruby/models/docs_project.rbi index 13479cf..20c7278 100644 --- a/rbi/scalar_api_ruby/models/docs_project.rbi +++ b/rbi/scalar_api_ruby/models/docs_project.rbi @@ -6,7 +6,7 @@ module Scalar OrHash = T.type_alias { T.any(Scalar::DocsProject, Scalar::Internal::AnyHash) } - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :access_groups sig { returns(String) } @@ -41,7 +41,7 @@ module Scalar sig do params( - access_groups: T.anything, + access_groups: String, active_theme_id: String, agent_enabled: T::Boolean, analytics_enabled: T::Boolean, @@ -72,7 +72,7 @@ module Scalar sig do override.returns( { - access_groups: T.anything, + access_groups: String, active_theme_id: String, agent_enabled: T::Boolean, analytics_enabled: T::Boolean, diff --git a/rbi/scalar_api_ruby/models/github_project.rbi b/rbi/scalar_api_ruby/models/github_project.rbi index 505f9ae..84eed6f 100644 --- a/rbi/scalar_api_ruby/models/github_project.rbi +++ b/rbi/scalar_api_ruby/models/github_project.rbi @@ -6,7 +6,7 @@ module Scalar OrHash = T.type_alias { T.any(Scalar::GithubProject, Scalar::Internal::AnyHash) } - sig { returns(T.anything) } + sig { returns(String) } attr_accessor :access_groups sig { returns(T.nilable(Scalar::ActiveDeployment)) } @@ -82,7 +82,7 @@ module Scalar sig do params( - access_groups: T.anything, + access_groups: String, active_deployment: T.nilable(Scalar::ActiveDeployment::OrHash), active_theme_id: String, agent_enabled: T::Boolean, @@ -129,7 +129,7 @@ module Scalar sig do override.returns( { - access_groups: T.anything, + access_groups: String, active_deployment: T.nilable(Scalar::ActiveDeployment), active_theme_id: String, agent_enabled: T::Boolean, diff --git a/rbi/scalar_api_ruby/resources/access_groups.rbi b/rbi/scalar_api_ruby/resources/access_groups.rbi index c01ef93..1332fb0 100644 --- a/rbi/scalar_api_ruby/resources/access_groups.rbi +++ b/rbi/scalar_api_ruby/resources/access_groups.rbi @@ -13,7 +13,7 @@ module Scalar # wildcards or implicit subdomain matching. sig do params( - allowed_domains: T.anything, + allowed_domains: String, name: String, slug: String, request_options: Scalar::RequestOptions::OrHash diff --git a/scalar-sdk.manifest.json b/scalar-sdk.manifest.json index a3e3a29..37aebde 100644 --- a/scalar-sdk.manifest.json +++ b/scalar-sdk.manifest.json @@ -46,6 +46,15 @@ "source": "400", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": { + "message": "Invalid request parameters.", + "code": "bad-request" + } + }, "type": { "kind": "object", "properties": [ @@ -78,6 +87,15 @@ "source": "401", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": { + "message": "Invalid authentication token.", + "code": "unauthorized" + } + }, "type": { "kind": "object", "properties": [ @@ -110,6 +128,15 @@ "source": "403", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": { + "message": "You do not have permission to access this resource.", + "code": "forbidden" + } + }, "type": { "kind": "object", "properties": [ @@ -142,6 +169,15 @@ "source": "404", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": { + "message": "Resource not found.", + "code": "not-found" + } + }, "type": { "kind": "object", "properties": [ @@ -174,6 +210,15 @@ "source": "422", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": { + "message": "The request body contains invalid values.", + "code": "invalid-payload" + } + }, "type": { "kind": "object", "properties": [ @@ -206,6 +251,15 @@ "source": "500", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": { + "message": "An unexpected error occurred.", + "code": "unknown" + } + }, "type": { "kind": "object", "properties": [ @@ -246,6 +300,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -256,6 +316,12 @@ "publicName": "version", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "1.2.0" + }, "type": { "kind": "ref", "name": "version" @@ -266,6 +332,12 @@ "publicName": "title", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "primitive", "type": "string", @@ -279,6 +351,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -289,6 +367,12 @@ "publicName": "description", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "API for managing Acme products and orders." + }, "type": { "kind": "primitive", "type": "string" @@ -299,6 +383,12 @@ "publicName": "namespace", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme" + }, "type": { "kind": "ref", "name": "namespace" @@ -309,6 +399,12 @@ "publicName": "isPrivate", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": false + }, "type": { "kind": "primitive", "type": "boolean" @@ -319,8 +415,18 @@ "publicName": "tags", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": [ + "products", + "orders" + ] + }, "type": { - "kind": "unknown" + "kind": "primitive", + "type": "string" } }, { @@ -345,6 +451,12 @@ "source": "nanoid", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "primitive", "type": "string", @@ -358,6 +470,12 @@ "source": "version", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "1.2.0" + }, "type": { "kind": "primitive", "type": "string", @@ -371,6 +489,12 @@ "source": "slug", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "primitive", "type": "string", @@ -386,6 +510,12 @@ "source": "namespace", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme" + }, "type": { "kind": "primitive", "type": "string", @@ -409,6 +539,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -419,6 +555,12 @@ "publicName": "createdAt", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600000 + }, "type": { "kind": "primitive", "type": "number" @@ -429,6 +571,12 @@ "publicName": "version", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "1.2.0" + }, "type": { "kind": "ref", "name": "version" @@ -439,6 +587,12 @@ "publicName": "upgraded", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": false + }, "type": { "kind": "primitive", "type": "boolean" @@ -449,6 +603,12 @@ "publicName": "endpointCount", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 12 + }, "type": { "kind": "union", "variants": [ @@ -471,6 +631,12 @@ "publicName": "embedStatus", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "complete" + }, "type": { "kind": "union", "variants": [ @@ -500,6 +666,15 @@ "publicName": "tags", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": [ + "products", + "orders" + ] + }, "type": { "kind": "array", "items": { @@ -523,6 +698,12 @@ "publicName": "path", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "/products" + }, "type": { "kind": "primitive", "type": "string" @@ -572,6 +753,12 @@ "publicName": "yamlSha", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789" + }, "type": { "kind": "primitive", "type": "string" @@ -582,6 +769,12 @@ "publicName": "jsonSha", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" + }, "type": { "kind": "primitive", "type": "string" @@ -646,6 +839,12 @@ "publicName": "accessGroupSlug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -668,6 +867,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -678,6 +883,12 @@ "publicName": "title", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "primitive", "type": "string", @@ -691,6 +902,12 @@ "publicName": "description", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "API for managing Acme products and orders." + }, "type": { "kind": "primitive", "type": "string" @@ -701,6 +918,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -711,6 +934,12 @@ "publicName": "namespace", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme" + }, "type": { "kind": "ref", "name": "namespace" @@ -721,6 +950,12 @@ "publicName": "isPrivate", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": false + }, "type": { "kind": "primitive", "type": "boolean" @@ -756,6 +991,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -766,6 +1007,12 @@ "publicName": "createdAt", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "ref", "name": "timestamp" @@ -776,6 +1023,12 @@ "publicName": "updatedAt", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "ref", "name": "timestamp" @@ -786,6 +1039,12 @@ "publicName": "version", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "1.2.0" + }, "type": { "kind": "ref", "name": "version" @@ -796,6 +1055,12 @@ "publicName": "yamlSha", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789" + }, "type": { "kind": "primitive", "type": "string", @@ -809,6 +1074,12 @@ "publicName": "jsonSha", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" + }, "type": { "kind": "primitive", "type": "string", @@ -826,6 +1097,12 @@ "source": "timestamp", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "primitive", "type": "integer", @@ -848,6 +1125,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -870,6 +1153,12 @@ "publicName": "logo", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "\"Acme\"" + }, "type": { "kind": "primitive", "type": "string" @@ -880,6 +1169,12 @@ "publicName": "logoSize", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "100" + }, "type": { "kind": "primitive", "type": "string" @@ -890,6 +1185,12 @@ "publicName": "buttonText", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Access documentation" + }, "type": { "kind": "primitive", "type": "string", @@ -903,6 +1204,12 @@ "publicName": "message", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Click to access Acme private API documentation." + }, "type": { "kind": "primitive", "type": "string", @@ -916,6 +1223,12 @@ "publicName": "title", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "primitive", "type": "string", @@ -929,6 +1242,12 @@ "publicName": "mainColor", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "#1f2937" + }, "type": { "kind": "primitive", "type": "string", @@ -942,6 +1261,12 @@ "publicName": "mainBackground", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "#f9fafb" + }, "type": { "kind": "primitive", "type": "string", @@ -955,6 +1280,12 @@ "publicName": "cardColor", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "#1f2937" + }, "type": { "kind": "primitive", "type": "string", @@ -968,6 +1299,12 @@ "publicName": "cardBackground", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "#ffffff" + }, "type": { "kind": "primitive", "type": "string", @@ -981,6 +1318,12 @@ "publicName": "buttonColor", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "#ffffff" + }, "type": { "kind": "primitive", "type": "string", @@ -994,6 +1337,12 @@ "publicName": "buttonBackground", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "#2563eb" + }, "type": { "kind": "primitive", "type": "string", @@ -1019,6 +1368,12 @@ "publicName": "title", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "primitive", "type": "string", @@ -1032,6 +1387,12 @@ "publicName": "description", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Sign in with your work email to access Acme documentation." + }, "type": { "kind": "primitive", "type": "string", @@ -1045,6 +1406,12 @@ "publicName": "head", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "" + }, "type": { "kind": "primitive", "type": "string" @@ -1055,6 +1422,12 @@ "publicName": "script", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "document.documentElement.dataset.company = \"acme\";" + }, "type": { "kind": "primitive", "type": "string" @@ -1065,6 +1438,12 @@ "publicName": "theme", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "TakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "primitive", "type": "string" @@ -1075,6 +1454,12 @@ "publicName": "companyName", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme" + }, "type": { "kind": "primitive", "type": "string", @@ -1088,6 +1473,12 @@ "publicName": "logo", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "\"Acme\"" + }, "type": { "kind": "primitive", "type": "string" @@ -1098,6 +1489,12 @@ "publicName": "logoURL", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "https://example.com" + }, "type": { "kind": "primitive", "type": "string" @@ -1108,6 +1505,12 @@ "publicName": "favicon", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "https://example.com/favicon.ico" + }, "type": { "kind": "primitive", "type": "string" @@ -1118,6 +1521,12 @@ "publicName": "termsLink", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "https://example.com/terms" + }, "type": { "kind": "primitive", "type": "string" @@ -1128,6 +1537,12 @@ "publicName": "privacyLink", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "https://example.com/privacy" + }, "type": { "kind": "primitive", "type": "string" @@ -1138,6 +1553,12 @@ "publicName": "formTitle", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Sign in to Acme Documentation" + }, "type": { "kind": "primitive", "type": "string", @@ -1151,6 +1572,12 @@ "publicName": "formDescription", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Sign in with your work email to access Acme documentation." + }, "type": { "kind": "primitive", "type": "string", @@ -1164,6 +1591,12 @@ "publicName": "formImage", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "https://example.com/login-banner.png" + }, "type": { "kind": "primitive", "type": "string" @@ -1186,6 +1619,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -1196,6 +1635,12 @@ "publicName": "title", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "primitive", "type": "string", @@ -1209,6 +1654,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -1223,6 +1674,12 @@ "source": "access_group_name", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Engineering" + }, "type": { "kind": "primitive", "type": "string", @@ -1236,6 +1693,12 @@ "source": "email_domain", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "example.com" + }, "type": { "kind": "primitive", "type": "string", @@ -1258,6 +1721,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -1268,6 +1737,12 @@ "publicName": "title", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "primitive", "type": "string", @@ -1281,6 +1756,12 @@ "publicName": "description", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "API for managing Acme products and orders." + }, "type": { "kind": "primitive", "type": "string" @@ -1291,6 +1772,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -1301,6 +1788,12 @@ "publicName": "namespace", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme" + }, "type": { "kind": "ref", "name": "namespace" @@ -1311,6 +1804,12 @@ "publicName": "isPrivate", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": false + }, "type": { "kind": "primitive", "type": "boolean" @@ -1333,6 +1832,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -1343,6 +1848,12 @@ "publicName": "name", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme Theme" + }, "type": { "kind": "primitive", "type": "string" @@ -1353,6 +1864,12 @@ "publicName": "description", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Custom colors for Acme documentation." + }, "type": { "kind": "primitive", "type": "string" @@ -1363,6 +1880,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-theme" + }, "type": { "kind": "ref", "name": "slug" @@ -1385,6 +1908,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -1395,6 +1924,12 @@ "publicName": "name", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "ref", "name": "team_name" @@ -1405,6 +1940,12 @@ "publicName": "imageUri", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "https://example.com/alex.png" + }, "type": { "kind": "ref", "name": "team_image" @@ -1415,6 +1956,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -1425,6 +1972,12 @@ "publicName": "theme", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "default" + }, "type": { "kind": "primitive", "type": "string" @@ -1439,6 +1992,12 @@ "source": "team_name", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme" + }, "type": { "kind": "primitive", "type": "string" @@ -1449,6 +2008,12 @@ "source": "team_image", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "https://example.com/logo.svg" + }, "type": { "kind": "primitive", "type": "string" @@ -1467,6 +2032,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -1487,6 +2058,12 @@ "publicName": "displayName", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Alex Morgan" + }, "type": { "kind": "primitive", "type": "string" @@ -1497,6 +2074,12 @@ "publicName": "imageUri", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "https://example.com/alex.png" + }, "type": { "kind": "primitive", "type": "string" @@ -1546,6 +2129,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -1556,6 +2145,12 @@ "publicName": "email", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "alex@example.com" + }, "type": { "kind": "ref", "name": "email" @@ -1576,6 +2171,12 @@ "publicName": "expires", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735776000 + }, "type": { "kind": "primitive", "type": "number" @@ -1590,6 +2191,12 @@ "source": "email", "publicAliases": [], "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "alex@example.com" + }, "type": { "kind": "primitive", "type": "string", @@ -1612,6 +2219,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -1622,6 +2235,12 @@ "publicName": "createdAt", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "ref", "name": "timestamp" @@ -1632,6 +2251,12 @@ "publicName": "updatedAt", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "ref", "name": "timestamp" @@ -1642,6 +2267,12 @@ "publicName": "name", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme Documentation" + }, "type": { "kind": "primitive", "type": "string" @@ -1670,6 +2301,12 @@ "publicName": "lastPublished", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "union", "variants": [ @@ -1688,6 +2325,12 @@ "publicName": "lastPublishedUid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "PakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "union", "variants": [ @@ -1706,6 +2349,12 @@ "publicName": "loginPortalUid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "LakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "primitive", "type": "string" @@ -1716,6 +2365,12 @@ "publicName": "userInfoHookUrl", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "https://example.com/hooks/user-info" + }, "type": { "kind": "primitive", "type": "string" @@ -1726,6 +2381,12 @@ "publicName": "activeThemeId", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "TakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "primitive", "type": "string" @@ -1736,6 +2397,12 @@ "publicName": "typesenseId", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 42 + }, "type": { "kind": "primitive", "type": "number" @@ -1746,6 +2413,12 @@ "publicName": "isPrivate", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": false + }, "type": { "kind": "primitive", "type": "boolean" @@ -1756,6 +2429,12 @@ "publicName": "agentEnabled", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -1766,6 +2445,12 @@ "publicName": "analyticsEnabled", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -1776,8 +2461,17 @@ "publicName": "accessGroups", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": [ + "UakgbKJ5m9gl0JDMbcJqL" + ] + }, "type": { - "kind": "unknown" + "kind": "primitive", + "type": "string" } }, { @@ -1785,6 +2479,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -1795,6 +2495,12 @@ "publicName": "publishStatus", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "published" + }, "type": { "kind": "primitive", "type": "string" @@ -1805,6 +2511,12 @@ "publicName": "publishMessage", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Documentation published successfully." + }, "type": { "kind": "primitive", "type": "string" @@ -1845,6 +2557,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "primitive", "type": "string" @@ -1855,6 +2573,12 @@ "publicName": "domain", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "docs.example.com" + }, "type": { "kind": "primitive", "type": "string" @@ -1865,6 +2589,12 @@ "publicName": "publishedAt", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "ref", "name": "timestamp" @@ -1887,6 +2617,12 @@ "publicName": "linkedBy", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "primitive", "type": "string" @@ -1897,6 +2633,12 @@ "publicName": "id", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 123456789 + }, "type": { "kind": "primitive", "type": "number" @@ -1907,6 +2649,12 @@ "publicName": "name", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme Documentation" + }, "type": { "kind": "primitive", "type": "string", @@ -1920,6 +2668,12 @@ "publicName": "configPath", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "scalar.config.json" + }, "type": { "kind": "primitive", "type": "string" @@ -1930,6 +2684,12 @@ "publicName": "branch", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "main" + }, "type": { "kind": "primitive", "type": "string" @@ -1940,6 +2700,12 @@ "publicName": "publishOnMerge", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -1950,6 +2716,12 @@ "publicName": "publishPreviews", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -1960,6 +2732,12 @@ "publicName": "prComments", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -1970,6 +2748,12 @@ "publicName": "expired", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": false + }, "type": { "kind": "primitive", "type": "boolean" @@ -1992,6 +2776,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -2002,6 +2792,12 @@ "publicName": "name", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "ref", "name": "team_name" @@ -2012,6 +2808,12 @@ "publicName": "imageUri", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "https://example.com/alex.png" + }, "type": { "kind": "ref", "name": "team_image" @@ -2034,6 +2836,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -2044,6 +2852,12 @@ "publicName": "createdAt", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "ref", "name": "timestamp" @@ -2054,6 +2868,12 @@ "publicName": "updatedAt", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "ref", "name": "timestamp" @@ -2064,6 +2884,12 @@ "publicName": "email", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "alex@example.com" + }, "type": { "kind": "ref", "name": "email" @@ -2074,6 +2900,12 @@ "publicName": "theme", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "default" + }, "type": { "kind": "primitive", "type": "string" @@ -2084,6 +2916,12 @@ "publicName": "activeTeamId", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "GakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "union", "variants": [ @@ -2102,6 +2940,12 @@ "publicName": "hasGithub", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -2137,6 +2981,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -2147,6 +2997,12 @@ "publicName": "title", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "primitive", "type": "string", @@ -2160,6 +3016,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -2170,6 +3032,12 @@ "publicName": "namespace", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme" + }, "type": { "kind": "ref", "name": "namespace" @@ -2180,6 +3048,12 @@ "publicName": "description", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "API for managing Acme products and orders." + }, "type": { "kind": "primitive", "type": "string" @@ -2190,6 +3064,12 @@ "publicName": "isPrivate", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": false + }, "type": { "kind": "primitive", "type": "boolean" @@ -2200,6 +3080,12 @@ "publicName": "apiUid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "union", "variants": [ @@ -2218,6 +3104,12 @@ "publicName": "apiVersion", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "1.2.0" + }, "type": { "kind": "union", "variants": [ @@ -2236,6 +3128,12 @@ "publicName": "currentVersion", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "1.2.0" + }, "type": { "kind": "ref", "name": "version" @@ -2284,6 +3182,12 @@ "publicName": "language", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "typescript" + }, "type": { "kind": "enum", "values": [ @@ -2338,6 +3242,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-sdk" + }, "type": { "kind": "ref", "name": "slug" @@ -2360,6 +3270,12 @@ "publicName": "version", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "1.2.0" + }, "type": { "kind": "ref", "name": "version" @@ -2370,6 +3286,12 @@ "publicName": "apiVersion", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "1.2.0" + }, "type": { "kind": "ref", "name": "version" @@ -2380,6 +3302,12 @@ "publicName": "status", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "published" + }, "type": { "kind": "enum", "values": [ @@ -2401,6 +3329,14 @@ "publicName": "languages", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": [ + "typescript" + ] + }, "type": { "kind": "array", "items": { @@ -2458,6 +3394,12 @@ "publicName": "publishedAt", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "ref", "name": "timestamp" @@ -2468,6 +3410,12 @@ "publicName": "createdAt", "required": false, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "ref", "name": "timestamp" @@ -2490,6 +3438,12 @@ "publicName": "uid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "UakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "ref", "name": "nanoid" @@ -2500,6 +3454,12 @@ "publicName": "name", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme Documentation" + }, "type": { "kind": "primitive", "type": "string" @@ -2510,6 +3470,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -2520,6 +3486,12 @@ "publicName": "isPrivate", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": false + }, "type": { "kind": "primitive", "type": "boolean" @@ -2530,8 +3502,17 @@ "publicName": "accessGroups", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": [ + "UakgbKJ5m9gl0JDMbcJqL" + ] + }, "type": { - "kind": "unknown" + "kind": "primitive", + "type": "string" } }, { @@ -2539,6 +3520,12 @@ "publicName": "loginPortalUid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "LakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "primitive", "type": "string" @@ -2549,6 +3536,12 @@ "publicName": "activeThemeId", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "TakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "primitive", "type": "string" @@ -2559,6 +3552,12 @@ "publicName": "agentEnabled", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -2569,6 +3568,12 @@ "publicName": "analyticsEnabled", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -2579,6 +3584,12 @@ "publicName": "lastPublished", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": 1735689600 + }, "type": { "kind": "union", "variants": [ @@ -2597,6 +3608,12 @@ "publicName": "publishStatus", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "published" + }, "type": { "kind": "primitive", "type": "string" @@ -2619,6 +3636,12 @@ "publicName": "id", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "42" + }, "type": { "kind": "primitive", "type": "string" @@ -2629,6 +3652,12 @@ "publicName": "name", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "primitive", "type": "string" @@ -2639,6 +3668,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -2649,6 +3684,12 @@ "publicName": "autoAddOperations", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -2659,6 +3700,12 @@ "publicName": "createdAt", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "2025-01-01T00:00:00.000Z" + }, "type": { "kind": "primitive", "type": "string" @@ -2669,6 +3716,12 @@ "publicName": "updatedAt", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "2025-01-01T00:00:00.000Z" + }, "type": { "kind": "primitive", "type": "string" @@ -2691,6 +3744,12 @@ "publicName": "id", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "42" + }, "type": { "kind": "primitive", "type": "string" @@ -2701,6 +3760,12 @@ "publicName": "mcpServerId", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "42" + }, "type": { "kind": "primitive", "type": "string" @@ -2711,6 +3776,12 @@ "publicName": "name", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "primitive", "type": "string" @@ -2721,6 +3792,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -2731,6 +3808,12 @@ "publicName": "isPrivate", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": false + }, "type": { "kind": "primitive", "type": "boolean" @@ -2741,6 +3824,14 @@ "publicName": "accessGroups", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": [ + "UakgbKJ5m9gl0JDMbcJqL" + ] + }, "type": { "kind": "array", "items": { @@ -2754,6 +3845,12 @@ "publicName": "loginPortalUid", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "LakgbKJ5m9gl0JDMbcJqL" + }, "type": { "kind": "union", "variants": [ @@ -2772,6 +3869,12 @@ "publicName": "mcpVersion", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "1.2.0" + }, "type": { "kind": "union", "variants": [ @@ -2790,6 +3893,12 @@ "publicName": "piiRedactionEnabled", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -2800,6 +3909,12 @@ "publicName": "credentialRedactionEnabled", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": true + }, "type": { "kind": "primitive", "type": "boolean" @@ -2822,6 +3937,12 @@ "publicName": "id", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "42" + }, "type": { "kind": "primitive", "type": "string" @@ -2832,6 +3953,12 @@ "publicName": "name", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "Acme API" + }, "type": { "kind": "primitive", "type": "string" @@ -2842,6 +3969,12 @@ "publicName": "slug", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "acme-api" + }, "type": { "kind": "ref", "name": "slug" @@ -2852,6 +3985,12 @@ "publicName": "isPrivate", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": false + }, "type": { "kind": "primitive", "type": "boolean" @@ -2862,6 +4001,12 @@ "publicName": "mcpVersion", "required": true, "deprecated": false, + "extensions": { + "source": [ + "examples" + ], + "examples": "1.2.0" + }, "type": { "kind": "union", "variants": [ diff --git a/sig/scalar_api_ruby/models/access_group_create_params.rbs b/sig/scalar_api_ruby/models/access_group_create_params.rbs index 01978db..c0a1918 100644 --- a/sig/scalar_api_ruby/models/access_group_create_params.rbs +++ b/sig/scalar_api_ruby/models/access_group_create_params.rbs @@ -1,16 +1,16 @@ module Scalar module Models type access_group_create_params = - { allowed_domains: top, name: String, slug: String } + { allowed_domains: String, name: String, slug: String } & Scalar::Internal::Type::request_parameters class AccessGroupCreateParams < Scalar::Internal::Type::BaseModel extend Scalar::Internal::Type::RequestParameters::Converter include Scalar::Internal::Type::RequestParameters - attr_reader allowed_domains: top? + attr_reader allowed_domains: String? - def allowed_domains=: (top) -> top + def allowed_domains=: (String) -> String attr_reader name: String? @@ -21,14 +21,14 @@ module Scalar def slug=: (String) -> String def initialize: ( - ?allowed_domains: top, + ?allowed_domains: String, ?name: String, ?slug: String, ?request_options: Scalar::request_opts ) -> void def to_hash: -> { - allowed_domains: top, + allowed_domains: String, name: String, slug: String, request_options: Scalar::RequestOptions diff --git a/sig/scalar_api_ruby/models/access_group_create_response.rbs b/sig/scalar_api_ruby/models/access_group_create_response.rbs index 4e31e84..42a7f63 100644 --- a/sig/scalar_api_ruby/models/access_group_create_response.rbs +++ b/sig/scalar_api_ruby/models/access_group_create_response.rbs @@ -2,17 +2,17 @@ module Scalar module Models type access_group_create_response = { - allowed_domains: top, - allowed_emails: top, + allowed_domains: String, + allowed_emails: String, name: String, slug: String, uid: String } class AccessGroupCreateResponse < Scalar::Internal::Type::BaseModel - attr_accessor allowed_domains: top + attr_accessor allowed_domains: String - attr_accessor allowed_emails: top + attr_accessor allowed_emails: String attr_accessor name: String @@ -21,16 +21,16 @@ module Scalar attr_accessor uid: String def initialize: ( - allowed_domains: top, - allowed_emails: top, + allowed_domains: String, + allowed_emails: String, name: String, slug: String, uid: String ) -> void def to_hash: -> { - allowed_domains: top, - allowed_emails: top, + allowed_domains: String, + allowed_emails: String, name: String, slug: String, uid: String diff --git a/sig/scalar_api_ruby/models/access_group_retrieve_response.rbs b/sig/scalar_api_ruby/models/access_group_retrieve_response.rbs index 3de1f87..602b990 100644 --- a/sig/scalar_api_ruby/models/access_group_retrieve_response.rbs +++ b/sig/scalar_api_ruby/models/access_group_retrieve_response.rbs @@ -2,17 +2,17 @@ module Scalar module Models type access_group_retrieve_response = { - allowed_domains: top, - allowed_emails: top, + allowed_domains: String, + allowed_emails: String, name: String, slug: String, uid: String } class AccessGroupRetrieveResponse < Scalar::Internal::Type::BaseModel - attr_accessor allowed_domains: top + attr_accessor allowed_domains: String - attr_accessor allowed_emails: top + attr_accessor allowed_emails: String attr_accessor name: String @@ -21,16 +21,16 @@ module Scalar attr_accessor uid: String def initialize: ( - allowed_domains: top, - allowed_emails: top, + allowed_domains: String, + allowed_emails: String, name: String, slug: String, uid: String ) -> void def to_hash: -> { - allowed_domains: top, - allowed_emails: top, + allowed_domains: String, + allowed_emails: String, name: String, slug: String, uid: String diff --git a/sig/scalar_api_ruby/models/api_document.rbs b/sig/scalar_api_ruby/models/api_document.rbs index f3994ad..e5d8a7d 100644 --- a/sig/scalar_api_ruby/models/api_document.rbs +++ b/sig/scalar_api_ruby/models/api_document.rbs @@ -6,7 +6,7 @@ module Scalar is_private: bool, namespace: String, slug: String, - tags: top, + tags: String, title: String, uid: String, version: String, @@ -22,7 +22,7 @@ module Scalar attr_accessor slug: String - attr_accessor tags: top + attr_accessor tags: String attr_accessor title: String @@ -37,7 +37,7 @@ module Scalar is_private: bool, namespace: String, slug: String, - tags: top, + tags: String, title: String, uid: String, version: String, @@ -49,7 +49,7 @@ module Scalar is_private: bool, namespace: String, slug: String, - tags: top, + tags: String, title: String, uid: String, version: String, diff --git a/sig/scalar_api_ruby/models/docs_project.rbs b/sig/scalar_api_ruby/models/docs_project.rbs index 77489bc..f387435 100644 --- a/sig/scalar_api_ruby/models/docs_project.rbs +++ b/sig/scalar_api_ruby/models/docs_project.rbs @@ -2,7 +2,7 @@ module Scalar module Models type docs_project = { - access_groups: top, + access_groups: String, active_theme_id: String, agent_enabled: bool, analytics_enabled: bool, @@ -16,7 +16,7 @@ module Scalar } class DocsProject < Scalar::Internal::Type::BaseModel - attr_accessor access_groups: top + attr_accessor access_groups: String attr_accessor active_theme_id: String @@ -39,7 +39,7 @@ module Scalar attr_accessor uid: String def initialize: ( - access_groups: top, + access_groups: String, active_theme_id: String, agent_enabled: bool, analytics_enabled: bool, @@ -53,7 +53,7 @@ module Scalar ) -> void def to_hash: -> { - access_groups: top, + access_groups: String, active_theme_id: String, agent_enabled: bool, analytics_enabled: bool, diff --git a/sig/scalar_api_ruby/models/github_project.rbs b/sig/scalar_api_ruby/models/github_project.rbs index 3835824..d3b404f 100644 --- a/sig/scalar_api_ruby/models/github_project.rbs +++ b/sig/scalar_api_ruby/models/github_project.rbs @@ -2,7 +2,7 @@ module Scalar module Models type github_project = { - access_groups: top, + access_groups: String, active_deployment: Scalar::ActiveDeployment?, active_theme_id: String, agent_enabled: bool, @@ -24,7 +24,7 @@ module Scalar } class GithubProject < Scalar::Internal::Type::BaseModel - attr_accessor access_groups: top + attr_accessor access_groups: String attr_accessor active_deployment: Scalar::ActiveDeployment? @@ -65,7 +65,7 @@ module Scalar def typesense_id=: (Float) -> Float def initialize: ( - access_groups: top, + access_groups: String, active_deployment: Scalar::ActiveDeployment?, active_theme_id: String, agent_enabled: bool, @@ -87,7 +87,7 @@ module Scalar ) -> void def to_hash: -> { - access_groups: top, + access_groups: String, active_deployment: Scalar::ActiveDeployment?, active_theme_id: String, agent_enabled: bool, diff --git a/sig/scalar_api_ruby/resources/access_groups.rbs b/sig/scalar_api_ruby/resources/access_groups.rbs index c33c4fb..8908807 100644 --- a/sig/scalar_api_ruby/resources/access_groups.rbs +++ b/sig/scalar_api_ruby/resources/access_groups.rbs @@ -4,7 +4,7 @@ module Scalar attr_reader domains: Scalar::Resources::AccessGroups::Domains def create: ( - ?allowed_domains: top, + ?allowed_domains: String, ?name: String, ?slug: String, ?request_options: Scalar::request_opts diff --git a/tests/smoke-test.rb b/tests/smoke-test.rb index a980f7a..e92379e 100644 --- a/tests/smoke-test.rb +++ b/tests/smoke-test.rb @@ -22,7 +22,16 @@ path: "/v1/apis/{namespace}", label: "required params", run: -> do - client.registry.create_api_document("namespace", {document: "", slug: "", title: "", version: "x"}) + client.registry.create_api_document( + "acme", + { + document: + "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Acme API\",\"version\":\"1.2.0\"},\"paths\":{}}", + slug: "acme-api", + title: "Acme API", + version: "1.2.0" + } + ) end }, { @@ -32,8 +41,17 @@ label: "all params", run: -> do client.registry.create_api_document( - "namespace", - {document: "", slug: "", title: "", version: "x", description: "", is_private: false, ruleset: ""} + "acme", + { + document: + "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Acme API\",\"version\":\"1.2.0\"},\"paths\":{}}", + slug: "acme-api", + title: "Acme API", + version: "1.2.0", + description: "API for managing Acme products and orders.", + is_private: false, + ruleset: "extends: [\"spectral:oas\"]" + } ) end }, @@ -43,8 +61,8 @@ path: "/v1/apis/{namespace}/{slug}/access-group", run: -> do client.registry.create_api_document_access_group( - "slug", - {access_group_slug: "x", namespace: "namespace"} + "acme-api", + {access_group_slug: "acme-api", namespace: "acme"} ) end }, @@ -55,8 +73,13 @@ label: "required params", run: -> do client.registry.create_api_document_version( - "slug", - {namespace: "namespace", document: "", version: "x"} + "acme-api", + { + namespace: "acme", + document: + "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Acme API\",\"version\":\"1.2.0\"},\"paths\":{}}", + version: "1.2.0" + } ) end }, @@ -67,8 +90,14 @@ label: "all params", run: -> do client.registry.create_api_document_version( - "slug", - {namespace: "namespace", document: "", version: "x", force: false} + "acme-api", + { + namespace: "acme", + document: + "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Acme API\",\"version\":\"1.2.0\"},\"paths\":{}}", + version: "1.2.0", + force: false + } ) end }, @@ -76,7 +105,7 @@ operation: "deleteApiDocument", method: "DELETE", path: "/v1/apis/{namespace}/{slug}", - run: -> { client.registry.delete_api_document("slug", {namespace: "namespace"}) } + run: -> { client.registry.delete_api_document("acme-api", {namespace: "acme"}) } }, { operation: "deleteApiDocumentAccessGroup", @@ -84,8 +113,8 @@ path: "/v1/apis/{namespace}/{slug}/access-group", run: -> do client.registry.delete_api_document_access_group( - "slug", - {access_group_slug: "x", namespace: "namespace"} + "acme-api", + {access_group_slug: "acme-api", namespace: "acme"} ) end }, @@ -93,9 +122,7 @@ operation: "deleteApiDocumentVersion", method: "DELETE", path: "/v1/apis/{namespace}/{slug}/version/{semver}", - run: -> do - client.registry.delete_api_document_version("semver", {namespace: "namespace", slug: "slug"}) - end + run: -> { client.registry.delete_api_document_version("1.2.0", {namespace: "acme", slug: "acme-api"}) } }, { operation: "listAllApiDocuments", @@ -108,21 +135,21 @@ method: "GET", path: "/v1/apis/{namespace}/{slug}/version/{semver}/metadata", run: -> do - client.registry.list_api_document_version_metadata("semver", {namespace: "namespace", slug: "slug"}) + client.registry.list_api_document_version_metadata("1.2.0", {namespace: "acme", slug: "acme-api"}) end }, { operation: "listApiDocuments", method: "GET", path: "/v1/apis/{namespace}", - run: -> { client.registry.list_api_documents("namespace") } + run: -> { client.registry.list_api_documents("acme") } }, { operation: "retrieveApiDocumentVersion", method: "GET", path: "/v1/apis/{namespace}/{slug}/version/{semver}", run: -> do - client.registry.retrieve_api_document_version("semver", {namespace: "namespace", slug: "slug"}) + client.registry.retrieve_api_document_version("1.2.0", {namespace: "acme", slug: "acme-api"}) end }, { @@ -130,7 +157,7 @@ method: "PATCH", path: "/v1/apis/{namespace}/{slug}", label: "required params", - run: -> { client.registry.update_api_document("slug", {namespace: "namespace"}) } + run: -> { client.registry.update_api_document("acme-api", {namespace: "acme"}) } }, { operation: "updateApiDocument", @@ -139,8 +166,14 @@ label: "all params", run: -> do client.registry.update_api_document( - "slug", - {namespace: "namespace", description: "", is_private: false, ruleset: "", title: ""} + "acme-api", + { + namespace: "acme", + description: "API for managing Acme products and orders.", + is_private: false, + ruleset: "extends: [\"spectral:oas\"]", + title: "Acme API" + } ) end }, @@ -150,8 +183,13 @@ path: "/v1/apis/{namespace}/{slug}/version/{semver}", run: -> do client.registry.update_api_document_version( - "semver", - {namespace: "namespace", slug: "slug", document: ""} + "1.2.0", + { + namespace: "acme", + slug: "acme-api", + document: + "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Acme API\",\"version\":\"1.2.0\"},\"paths\":{}}" + } ) end }, @@ -160,7 +198,18 @@ method: "POST", path: "/v1/schemas/{namespace}", label: "required params", - run: -> { client.schemas.create("namespace", {document: "", slug: "", title: "", version: "x"}) } + run: -> do + client.schemas.create( + "acme", + { + document: + "{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"examples\":[\"Acme\"]}}}", + slug: "customer", + title: "Customer", + version: "1.2.0" + } + ) + end }, { operation: "create", @@ -169,8 +218,16 @@ label: "all params", run: -> do client.schemas.create( - "namespace", - {document: "", slug: "", title: "", version: "x", description: "", is_private: false} + "acme", + { + document: + "{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"examples\":[\"Acme\"]}}}", + slug: "customer", + title: "Customer", + version: "1.2.0", + description: "API for managing Acme products and orders.", + is_private: false + } ) end }, @@ -179,7 +236,7 @@ method: "PATCH", path: "/v1/schemas/{namespace}/{slug}", label: "required params", - run: -> { client.schemas.update("slug", {namespace: "namespace"}) } + run: -> { client.schemas.update("customer", {namespace: "acme"}) } }, { operation: "update", @@ -187,27 +244,45 @@ path: "/v1/schemas/{namespace}/{slug}", label: "all params", run: -> do - client.schemas.update("slug", {namespace: "namespace", description: "", is_private: false, title: ""}) + client.schemas.update( + "customer", + { + namespace: "acme", + description: "API for managing Acme products and orders.", + is_private: false, + title: "Customer" + } + ) end }, { operation: "list", method: "GET", path: "/v1/schemas/{namespace}", - run: -> { client.schemas.list("namespace") } + run: -> { client.schemas.list("acme") } }, { operation: "delete", method: "DELETE", path: "/v1/schemas/{namespace}/{slug}", - run: -> { client.schemas.delete("slug", {namespace: "namespace"}) } + run: -> { client.schemas.delete("customer", {namespace: "acme"}) } }, { operation: "create", method: "POST", path: "/v1/schemas/{namespace}/{slug}/version", label: "required params", - run: -> { client.schemas.version.create("slug", {namespace: "namespace", document: "", version: "x"}) } + run: -> do + client.schemas.version.create( + "customer", + { + namespace: "acme", + document: + "{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"examples\":[\"Acme\"]}}}", + version: "1.2.0" + } + ) + end }, { operation: "create", @@ -216,8 +291,14 @@ label: "all params", run: -> do client.schemas.version.create( - "slug", - {namespace: "namespace", document: "", version: "x", force: false} + "customer", + { + namespace: "acme", + document: + "{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"examples\":[\"Acme\"]}}}", + version: "1.2.0", + force: false + } ) end }, @@ -225,25 +306,29 @@ operation: "retrieve", method: "GET", path: "/v1/schemas/{namespace}/{slug}/version/{semver}", - run: -> { client.schemas.version.retrieve("semver", {namespace: "namespace", slug: "slug"}) } + run: -> { client.schemas.version.retrieve("1.2.0", {namespace: "acme", slug: "customer"}) } }, { operation: "delete", method: "DELETE", path: "/v1/schemas/{namespace}/{slug}/version/{semver}", - run: -> { client.schemas.version.delete("semver", {namespace: "namespace", slug: "slug"}) } + run: -> { client.schemas.version.delete("1.2.0", {namespace: "acme", slug: "customer"}) } }, { operation: "create", method: "POST", path: "/v1/schemas/{namespace}/{slug}/access-group", - run: -> { client.schemas.access_group.create("slug", {access_group_slug: "x", namespace: "namespace"}) } + run: -> do + client.schemas.access_group.create("customer", {access_group_slug: "acme-api", namespace: "acme"}) + end }, { operation: "delete", method: "DELETE", path: "/v1/schemas/{namespace}/{slug}/access-group", - run: -> { client.schemas.access_group.delete("slug", {access_group_slug: "x", namespace: "namespace"}) } + run: -> do + client.schemas.access_group.delete("customer", {access_group_slug: "acme-api", namespace: "acme"}) + end }, { operation: "create", @@ -281,8 +366,8 @@ "formDescription" => "Login to access your documentation", "formImage" => "" }, - slug: "", - title: "" + slug: "acme-login", + title: "Acme Private Documentation" } ) end @@ -291,28 +376,28 @@ operation: "retrieve", method: "GET", path: "/v1/login-portals/{slug}", - run: -> { client.login_portals.retrieve("slug") } + run: -> { client.login_portals.retrieve("acme-login") } }, { operation: "update", method: "PATCH", path: "/v1/login-portals/{slug}", label: "required params", - run: -> { client.login_portals.update("slug") } + run: -> { client.login_portals.update("acme-login") } }, { operation: "update", method: "PATCH", path: "/v1/login-portals/{slug}", label: "all params", - run: -> { client.login_portals.update("slug", {title: ""}) } + run: -> { client.login_portals.update("acme-login", {title: "Acme Private Documentation"}) } }, {operation: "list", method: "GET", path: "/v1/login-portals", run: -> { client.login_portals.list }}, { operation: "delete", method: "DELETE", path: "/v1/login-portals/{slug}", - run: -> { client.login_portals.delete("slug") } + run: -> { client.login_portals.delete("acme-login") } }, { operation: "create", @@ -326,52 +411,63 @@ method: "POST", path: "/v1/access-groups", label: "all params", - run: -> { client.access_groups.create({allowed_domains: {}, name: "", slug: "x"}) } + run: -> do + client.access_groups.create({allowed_domains: "example.com", name: "Engineering", slug: "acme-api"}) + end }, { operation: "retrieve", method: "GET", path: "/v1/access-groups/{slug}", - run: -> { client.access_groups.retrieve("slug") } + run: -> { client.access_groups.retrieve("acme-api") } }, { operation: "update", method: "PATCH", path: "/v1/access-groups/{slug}", label: "required params", - run: -> { client.access_groups.update("path_slug") } + run: -> { client.access_groups.update("acme-api") } }, { operation: "update", method: "PATCH", path: "/v1/access-groups/{slug}", label: "all params", - run: -> { client.access_groups.update("path_slug", {name: "", body_slug: "x"}) } + run: -> { client.access_groups.update("acme-api", {name: "Engineering", body_slug: "acme-api"}) } }, { operation: "delete", method: "DELETE", path: "/v1/access-groups/{slug}", - run: -> { client.access_groups.delete("slug") } + run: -> { client.access_groups.delete("acme-api") } }, { operation: "create", method: "POST", path: "/v1/access-groups/{slug}/domains", - run: -> { client.access_groups.domains.create("slug", {domain: ""}) } + run: -> { client.access_groups.domains.create("acme-api", {domain: "example.com"}) } }, { operation: "delete", method: "DELETE", path: "/v1/access-groups/{slug}/domains", - run: -> { client.access_groups.domains.delete("slug", {domain: ""}) } + run: -> { client.access_groups.domains.delete("acme-api", {domain: "example.com"}) } }, { operation: "createRuleset", method: "POST", path: "/v1/rulesets/{namespace}", label: "required params", - run: -> { client.rules.create_ruleset("namespace", {document: "", slug: "", title: ""}) } + run: -> do + client.rules.create_ruleset( + "acme", + { + document: "extends: [\"spectral:oas\"]\nrules:\n info-contact: warn\n", + slug: "acme-rules", + title: "Acme API Rules" + } + ) + end }, { operation: "createRuleset", @@ -380,8 +476,14 @@ label: "all params", run: -> do client.rules.create_ruleset( - "namespace", - {document: "", slug: "", title: "", description: "", is_private: false} + "acme", + { + document: "extends: [\"spectral:oas\"]\nrules:\n info-contact: warn\n", + slug: "acme-rules", + title: "Acme API Rules", + description: "API for managing Acme products and orders.", + is_private: false + } ) end }, @@ -390,41 +492,47 @@ method: "POST", path: "/v1/rulesets/{namespace}/{slug}/access-group", run: -> do - client.rules.create_ruleset_access_group("slug", {access_group_slug: "x", namespace: "namespace"}) + client.rules.create_ruleset_access_group( + "acme-rules", + {access_group_slug: "acme-api", namespace: "acme"} + ) end }, { operation: "deleteRuleset", method: "DELETE", path: "/v1/rulesets/{namespace}/{slug}", - run: -> { client.rules.delete_ruleset("slug", {namespace: "namespace"}) } + run: -> { client.rules.delete_ruleset("acme-rules", {namespace: "acme"}) } }, { operation: "deleteRulesetAccessGroup", method: "DELETE", path: "/v1/rulesets/{namespace}/{slug}/access-group", run: -> do - client.rules.delete_ruleset_access_group("slug", {access_group_slug: "x", namespace: "namespace"}) + client.rules.delete_ruleset_access_group( + "acme-rules", + {access_group_slug: "acme-api", namespace: "acme"} + ) end }, { operation: "listRulesets", method: "GET", path: "/v1/rulesets/{namespace}", - run: -> { client.rules.list_rulesets("namespace") } + run: -> { client.rules.list_rulesets("acme") } }, { operation: "retrieveRulesetDocument", method: "GET", path: "/v1/rulesets/{namespace}/{slug}", - run: -> { client.rules.retrieve_ruleset_document("slug", {namespace: "namespace"}) } + run: -> { client.rules.retrieve_ruleset_document("acme-rules", {namespace: "acme"}) } }, { operation: "updateRuleset", method: "PATCH", path: "/v1/rulesets/{namespace}/{slug}", label: "required params", - run: -> { client.rules.update_ruleset("path_slug", {path_namespace: "path_namespace"}) } + run: -> { client.rules.update_ruleset("acme-rules", {path_namespace: "acme"}) } }, { operation: "updateRuleset", @@ -433,14 +541,14 @@ label: "all params", run: -> do client.rules.update_ruleset( - "path_slug", + "acme-rules", { - path_namespace: "path_namespace", - description: "", + path_namespace: "acme", + description: "API for managing Acme products and orders.", is_private: false, - body_namespace: "", - body_slug: "", - title: "" + body_namespace: "acme", + body_slug: "acme-rules", + title: "Acme API Rules" } ) end @@ -450,79 +558,99 @@ method: "POST", path: "/v1/themes", label: "required params", - run: -> { client.themes.create({document: "", name: "", slug: ""}) } + run: -> do + client.themes.create( + {document: ":root { --scalar-color-1: \#1f2937; }", name: "Acme Theme", slug: "acme-theme"} + ) + end }, { operation: "create", method: "POST", path: "/v1/themes", label: "all params", - run: -> { client.themes.create({document: "", name: "", slug: "", description: ""}) } + run: -> do + client.themes.create( + { + document: ":root { --scalar-color-1: \#1f2937; }", + name: "Acme Theme", + slug: "acme-theme", + description: "API for managing Acme products and orders." + } + ) + end }, { operation: "retrieve", method: "GET", path: "/v1/themes/{slug}", - run: -> { client.themes.retrieve("slug") } + run: -> { client.themes.retrieve("acme-theme") } }, { operation: "update", method: "PATCH", path: "/v1/themes/{slug}", label: "required params", - run: -> { client.themes.update("slug") } + run: -> { client.themes.update("acme-theme") } }, { operation: "update", method: "PATCH", path: "/v1/themes/{slug}", label: "all params", - run: -> { client.themes.update("slug", {description: "", name: ""}) } + run: -> do + client.themes.update( + "acme-theme", + {description: "API for managing Acme products and orders.", name: "Acme Theme"} + ) + end }, {operation: "list", method: "GET", path: "/v1/themes", run: -> { client.themes.list }}, { operation: "delete", method: "DELETE", path: "/v1/themes/{slug}", - run: -> { client.themes.delete("slug") } + run: -> { client.themes.delete("acme-theme") } }, { operation: "replaceDocument", method: "PUT", path: "/v1/themes/{slug}", - run: -> { client.themes.replace_document("slug", {document: ""}) } + run: -> do + client.themes.replace_document("acme-theme", {document: ":root { --scalar-color-1: \#1f2937; }"}) + end }, {operation: "list", method: "GET", path: "/v1/teams", run: -> { client.teams.list }}, { operation: "update", method: "PATCH", path: "/v1/teams/members/{uid}", - run: -> { client.teams.members.update("uidxx", {role: "owner"}) } + run: -> { client.teams.members.update("UakgbKJ5m9gl0JDMbcJqL", {role: "owner"}) } }, {operation: "list", method: "GET", path: "/v1/teams/members", run: -> { client.teams.members.list }}, { operation: "delete", method: "DELETE", path: "/v1/teams/members/{uid}", - run: -> { client.teams.members.delete("uidxx") } + run: -> { client.teams.members.delete("UakgbKJ5m9gl0JDMbcJqL") } }, { operation: "cancel", method: "DELETE", path: "/v1/teams/invites/{uid}", - run: -> { client.teams.invites.cancel("uidxx") } + run: -> { client.teams.invites.cancel("UakgbKJ5m9gl0JDMbcJqL") } }, { operation: "member", method: "POST", path: "/v1/teams/invites", - run: -> { client.teams.invites.member({email: "user@example.com", role: "owner"}) } + run: -> { client.teams.invites.member({email: "alex@example.com", role: "owner"}) } }, { operation: "resend", method: "PATCH", path: "/v1/teams/invites/{uid}", - run: -> { client.teams.invites.resend("uidxx") } + run: -> { client.teams.invites.resend("UakgbKJ5m9gl0JDMbcJqL") } }, { operation: "createGuide", @@ -530,7 +658,9 @@ path: "/v1/guides", label: "required params", run: -> do - client.scalar_docs.create_guide({allowed_domains: [], allowed_users: [], is_private: false, name: ""}) + client.scalar_docs.create_guide( + {allowed_domains: [], allowed_users: [], is_private: false, name: "Acme Documentation"} + ) end }, { @@ -540,7 +670,13 @@ label: "all params", run: -> do client.scalar_docs.create_guide( - {allowed_domains: [], allowed_users: [], is_private: false, name: "", slug: "x"} + { + allowed_domains: [], + allowed_users: [], + is_private: false, + name: "Acme Documentation", + slug: "acme-api" + } ) end }, @@ -549,7 +685,7 @@ method: "POST", path: "/v1/docs", label: "required params", - run: -> { client.scalar_docs.create_project({name: "", provider: "forgejo"}) } + run: -> { client.scalar_docs.create_project({name: "Acme Documentation", provider: "forgejo"}) } }, { operation: "createProject", @@ -559,19 +695,19 @@ run: -> do client.scalar_docs.create_project( { - name: "", + name: "Acme Documentation", provider: "forgejo", bitbucket_repository: { - "workspaceUuid" => "", - "repoUuid" => "" + "workspaceUuid" => "{12345678-1234-4234-8234-123456789abc}", + "repoUuid" => "{abcdef01-1234-4234-8234-123456789abc}" }, - blank: false, + blank: true, github_repository: { - "installationId" => 0, - "repoId" => 0 + "installationId" => 84, + "repoId" => 123_456_789 }, is_private: false, - slug: "x" + slug: "acme-api" } ) end @@ -580,7 +716,7 @@ operation: "deleteProject", method: "DELETE", path: "/v1/docs/{slug}", - run: -> { client.scalar_docs.delete_project("slug") } + run: -> { client.scalar_docs.delete_project("acme-docs") } }, {operation: "listGuides", method: "GET", path: "/v1/guides", run: -> { client.scalar_docs.list_guides }}, { @@ -588,26 +724,26 @@ method: "GET", path: "/v1/docs/{slug}/config", label: "required params", - run: -> { client.scalar_docs.list_project_config("slug") } + run: -> { client.scalar_docs.list_project_config("acme-docs") } }, { operation: "listProjectConfig", method: "GET", path: "/v1/docs/{slug}/config", label: "all params", - run: -> { client.scalar_docs.list_project_config("slug", {ref: "ref"}) } + run: -> { client.scalar_docs.list_project_config("acme-docs", {ref: "main"}) } }, { operation: "listProjectDomain", method: "GET", path: "/v1/docs/{slug}/domain", - run: -> { client.scalar_docs.list_project_domain("slug") } + run: -> { client.scalar_docs.list_project_domain("acme-docs") } }, { operation: "listProjectDomainStatus", method: "GET", path: "/v1/docs/{slug}/domain/status", - run: -> { client.scalar_docs.list_project_domain_status("slug") } + run: -> { client.scalar_docs.list_project_domain_status("acme-docs") } }, { operation: "listProjects", @@ -621,20 +757,20 @@ method: "GET", path: "/v1/docs", label: "all params", - run: -> { client.scalar_docs.list_projects({limit: 1}) } + run: -> { client.scalar_docs.list_projects({limit: 20}) } }, { operation: "publishGuide", method: "POST", path: "/v1/guides/{slug}/publish", - run: -> { client.scalar_docs.publish_guide("slug") } + run: -> { client.scalar_docs.publish_guide("acme-docs") } }, { operation: "publishProject", method: "POST", path: "/v1/docs/{slug}/publish", label: "required params", - run: -> { client.scalar_docs.publish_project("slug") } + run: -> { client.scalar_docs.publish_project("acme-docs") } }, { operation: "publishProject", @@ -642,21 +778,28 @@ path: "/v1/docs/{slug}/publish", label: "all params", run: -> do - client.scalar_docs.publish_project("slug", {commit_sha: "", config_path: "", preview: false}) + client.scalar_docs.publish_project( + "acme-docs", + { + commit_sha: "0123456789abcdef0123456789abcdef01234567", + config_path: "scalar.config.json", + preview: false + } + ) end }, { operation: "retrieveProject", method: "GET", path: "/v1/docs/{slug}", - run: -> { client.scalar_docs.retrieve_project("slug") } + run: -> { client.scalar_docs.retrieve_project("acme-docs") } }, { operation: "updateProject", method: "PATCH", path: "/v1/docs/{slug}", label: "required params", - run: -> { client.scalar_docs.update_project("slug") } + run: -> { client.scalar_docs.update_project("acme-docs") } }, { operation: "updateProject", @@ -665,15 +808,15 @@ label: "all params", run: -> do client.scalar_docs.update_project( - "slug", + "acme-docs", { access_groups: ["xxxxx"], - active_theme_id: "xxxxx", - agent_enabled: false, - analytics_enabled: false, + active_theme_id: "UakgbKJ5m9gl0JDMbcJqL", + agent_enabled: true, + analytics_enabled: true, is_private: false, login_portal_uid: "xxxxx", - name: "" + name: "Acme Documentation" } ) end @@ -683,7 +826,9 @@ method: "PUT", path: "/v1/docs/{slug}/config", label: "required params", - run: -> { client.scalar_docs.update_project_config("slug", {content: ""}) } + run: -> do + client.scalar_docs.update_project_config("acme-docs", {content: "{\"name\":\"Acme Documentation\"}"}) + end }, { operation: "updateProjectConfig", @@ -692,8 +837,14 @@ label: "all params", run: -> do client.scalar_docs.update_project_config( - "slug", - {content: "", base_token: "", message: "", path: "", ref: ""} + "acme-docs", + { + content: "{\"name\":\"Acme Documentation\"}", + base_token: "example-edit-token", + message: "Update documentation configuration", + path: "scalar.config.json", + ref: "main" + } ) end }, @@ -702,7 +853,9 @@ operation: "exchangePersonalToken", method: "POST", path: "/v1/auth/exchange", - run: -> { client.authentication.exchange_personal_token({personal_token: ""}) } + run: -> do + client.authentication.exchange_personal_token({personal_token: "scalar_example_personal_token"}) + end }, { operation: "listCurrentUser", @@ -715,7 +868,7 @@ method: "POST", path: "/v1/sdks", label: "required params", - run: -> { client.sdks.create({api_uid: "xxxxx", languages: ["typescript"]}) } + run: -> { client.sdks.create({api_uid: "UakgbKJ5m9gl0JDMbcJqL", languages: ["typescript"]}) } }, { operation: "create", @@ -724,17 +877,29 @@ label: "all params", run: -> do client.sdks.create( - {api_uid: "xxxxx", languages: ["typescript"], class_name: "", config: "", slug: "x", title: ""} + { + api_uid: "UakgbKJ5m9gl0JDMbcJqL", + languages: ["typescript"], + class_name: "Acme", + config: "{\"targets\":{\"typescript\":{\"packageName\":\"@acme/sdk\"}}}", + slug: "acme-api", + title: "Acme SDK" + } ) end }, - {operation: "retrieve", method: "GET", path: "/v1/sdks/{uid}", run: -> { client.sdks.retrieve("uidxx") }}, + { + operation: "retrieve", + method: "GET", + path: "/v1/sdks/{uid}", + run: -> { client.sdks.retrieve("UakgbKJ5m9gl0JDMbcJqL") } + }, { operation: "update", method: "PATCH", path: "/v1/sdks/{uid}", label: "required params", - run: -> { client.sdks.update("uidxx") } + run: -> { client.sdks.update("UakgbKJ5m9gl0JDMbcJqL") } }, { operation: "update", @@ -743,8 +908,15 @@ label: "all params", run: -> do client.sdks.update( - "uidxx", - {api_uid: "xxxxx", api_version: "", config: "", is_private: false, slug: "x", title: ""} + "UakgbKJ5m9gl0JDMbcJqL", + { + api_uid: "UakgbKJ5m9gl0JDMbcJqL", + api_version: "", + config: "{\"targets\":{\"typescript\":{\"packageName\":\"@acme/sdk\"}}}", + is_private: false, + slug: "acme-api", + title: "Acme SDK" + } ) end }, @@ -760,34 +932,41 @@ method: "GET", path: "/v1/sdks", label: "all params", - run: -> { client.sdks.list({limit: 1}) } + run: -> { client.sdks.list({limit: 20}) } + }, + { + operation: "delete", + method: "DELETE", + path: "/v1/sdks/{uid}", + run: -> { client.sdks.delete("UakgbKJ5m9gl0JDMbcJqL") } }, - {operation: "delete", method: "DELETE", path: "/v1/sdks/{uid}", run: -> { client.sdks.delete("uidxx") }}, { operation: "build", method: "POST", path: "/v1/sdks/{uid}/build", label: "required params", - run: -> { client.sdks.build("uidxx") } + run: -> { client.sdks.build("UakgbKJ5m9gl0JDMbcJqL") } }, { operation: "build", method: "POST", path: "/v1/sdks/{uid}/build", label: "all params", - run: -> { client.sdks.build("uidxx", {languages: ["typescript"], version: ""}) } + run: -> { client.sdks.build("UakgbKJ5m9gl0JDMbcJqL", {languages: ["typescript"], version: "1.2.0"}) } }, { operation: "create", method: "POST", path: "/v1/sdks/{uid}/versions", - run: -> { client.sdks.versions.create("uidxx", {api_version: "", version: ""}) } + run: -> do + client.sdks.versions.create("UakgbKJ5m9gl0JDMbcJqL", {api_version: "1.2.0", version: "1.2.0"}) + end }, { operation: "delete", method: "DELETE", path: "/v1/sdks/{uid}/versions/{version}", - run: -> { client.sdks.versions.delete("version", {uid: "uidxx"}) } + run: -> { client.sdks.versions.delete("1.2.0", {uid: "UakgbKJ5m9gl0JDMbcJqL"}) } }, { operation: "link", @@ -795,7 +974,10 @@ path: "/v1/sdks/{uid}/repositories", label: "required params", run: -> do - client.sdks.repositories.link("uidxx", {base_branch: "", language: "typescript", repository_id: 0}) + client.sdks.repositories.link( + "UakgbKJ5m9gl0JDMbcJqL", + {base_branch: "main", language: "typescript", repository_id: 123_456_789} + ) end }, { @@ -805,8 +987,8 @@ label: "all params", run: -> do client.sdks.repositories.link( - "uidxx", - {base_branch: "", language: "typescript", repository_id: 0, prerelease_type: ""} + "UakgbKJ5m9gl0JDMbcJqL", + {base_branch: "main", language: "typescript", repository_id: 123_456_789, prerelease_type: "beta"} ) end }, @@ -814,7 +996,7 @@ operation: "unlink", method: "DELETE", path: "/v1/sdks/{uid}/repositories/{language}", - run: -> { client.sdks.repositories.unlink("typescript", {uid: "uidxx"}) } + run: -> { client.sdks.repositories.unlink("typescript", {uid: "UakgbKJ5m9gl0JDMbcJqL"}) } }, { operation: "updatePublishing", @@ -822,7 +1004,10 @@ path: "/v1/sdks/{uid}/repositories/{language}/publishing", label: "required params", run: -> do - client.sdks.repositories.update_publishing("typescript", {uid: "uidxx", publish_on_merge: false}) + client.sdks.repositories.update_publishing( + "typescript", + {uid: "UakgbKJ5m9gl0JDMbcJqL", publish_on_merge: true} + ) end }, { @@ -833,7 +1018,13 @@ run: -> do client.sdks.repositories.update_publishing( "typescript", - {uid: "uidxx", publish_on_merge: false, access: "public", auth_method: "oidc", tag: ""} + { + uid: "UakgbKJ5m9gl0JDMbcJqL", + publish_on_merge: true, + access: "public", + auth_method: "oidc", + tag: "latest" + } ) end }, @@ -842,27 +1033,31 @@ method: "POST", path: "/v1/mcp/servers", label: "required params", - run: -> { client.mcp.servers.create({name: "x"}) } + run: -> { client.mcp.servers.create({name: "Acme MCP"}) } }, { operation: "create", method: "POST", path: "/v1/mcp/servers", label: "all params", - run: -> { client.mcp.servers.create({name: "x", project_uids: [""], slug: "x", version_uids: [""]}) } + run: -> do + client.mcp.servers.create( + {name: "Acme MCP", project_uids: [""], slug: "acme-api", version_uids: [""]} + ) + end }, { operation: "retrieve", method: "GET", path: "/v1/mcp/servers/{id}", - run: -> { client.mcp.servers.retrieve("id") } + run: -> { client.mcp.servers.retrieve("42") } }, { operation: "update", method: "PATCH", path: "/v1/mcp/servers/{id}", label: "required params", - run: -> { client.mcp.servers.update("id") } + run: -> { client.mcp.servers.update("42") } }, { operation: "update", @@ -871,8 +1066,8 @@ label: "all params", run: -> do client.mcp.servers.update( - "id", - {auto_add_operations: false, docs_pages: [""], name: "x", operations: [""], slug: "x"} + "42", + {auto_add_operations: true, docs_pages: [""], name: "Acme MCP", operations: [""], slug: "acme-api"} ) end }, @@ -881,34 +1076,36 @@ operation: "delete", method: "DELETE", path: "/v1/mcp/servers/{id}", - run: -> { client.mcp.servers.delete("id") } + run: -> { client.mcp.servers.delete("42") } }, { operation: "create", method: "POST", path: "/v1/mcp/servers/{id}/installations", label: "required params", - run: -> { client.mcp.servers.installations.create("id", {document_auth: {}, name: "x"}) } + run: -> { client.mcp.servers.installations.create("42", {document_auth: {}, name: "Acme MCP"}) } }, { operation: "create", method: "POST", path: "/v1/mcp/servers/{id}/installations", label: "all params", - run: -> { client.mcp.servers.installations.create("id", {document_auth: {}, name: "x", slug: "x"}) } + run: -> do + client.mcp.servers.installations.create("42", {document_auth: {}, name: "Acme MCP", slug: "acme-api"}) + end }, { operation: "retrieve", method: "GET", path: "/v1/mcp/servers/{id}/installations/{installationId}", - run: -> { client.mcp.servers.installations.retrieve("installation_id", {id: "id"}) } + run: -> { client.mcp.servers.installations.retrieve("84", {id: "42"}) } }, { operation: "update", method: "PATCH", path: "/v1/mcp/servers/{id}/installations/{installationId}", label: "required params", - run: -> { client.mcp.servers.installations.update("installation_id", {id: "id"}) } + run: -> { client.mcp.servers.installations.update("84", {id: "42"}) } }, { operation: "update", @@ -917,15 +1114,15 @@ label: "all params", run: -> do client.mcp.servers.installations.update( - "installation_id", + "84", { - id: "id", + id: "42", document_auth: {}, is_private: false, login_portal_uid: "", mcp_version: "", - name: "x", - slug: "x" + name: "Acme MCP", + slug: "acme-api" } ) end @@ -934,13 +1131,13 @@ operation: "list", method: "GET", path: "/v1/mcp/servers/{id}/installations", - run: -> { client.mcp.servers.installations.list("id") } + run: -> { client.mcp.servers.installations.list("42") } }, { operation: "delete", method: "DELETE", path: "/v1/mcp/servers/{id}/installations/{installationId}", - run: -> { client.mcp.servers.installations.delete("installation_id", {id: "id"}) } + run: -> { client.mcp.servers.installations.delete("84", {id: "42"}) } }, { operation: "createAccessGroup", @@ -948,8 +1145,8 @@ path: "/v1/mcp/servers/{id}/installations/{installationId}/access-group", run: -> do client.mcp.servers.installations.create_access_group( - "installation_id", - {id: "id", access_group_uid: "xxxxx"} + "84", + {id: "42", access_group_uid: "UakgbKJ5m9gl0JDMbcJqL"} ) end }, @@ -959,8 +1156,8 @@ path: "/v1/mcp/servers/{id}/installations/{installationId}/access-group", run: -> do client.mcp.servers.installations.delete_access_group( - "installation_id", - {id: "id", access_group_uid: "xxxxx"} + "84", + {id: "42", access_group_uid: "UakgbKJ5m9gl0JDMbcJqL"} ) end }, From 04d9ebb2a30e0d09d3e236668e2d7c9d27d3a15b Mon Sep 17 00:00:00 2001 From: scalarbot Date: Fri, 2 Oct 2026 20:37:12 +0000 Subject: [PATCH 4/7] feat(api)!: remove operation oAuth.oauthAuthorize (+9 more changes) - Removed operation `oAuth.oauthAuthorize` (`GET /v1/oauth/authorize`). - Removed operation `oAuth.oauthToken` (`POST /v1/oauth/token`). - Removed operation `oAuth.oauthRevoke` (`POST /v1/oauth/revoke`). - Removed operation `oAuth.oauthAuthorizationServerMetadata` (`GET /.well-known/oauth-authorization-server`). - Removed schema `oauth_token`. - Removed schema `oauth_scope`. - Removed schema `oauth_error`. - Removed schema `oauth_token_request`. - Removed schema `oauth_revoke_request`. - Removed schema `oauth_authorization_server_metadata`. BREAKING CHANGE: 10 breaking changes to the SDK surface. - Removed operation `oAuth.oauthAuthorize` (`GET /v1/oauth/authorize`). - Removed operation `oAuth.oauthToken` (`POST /v1/oauth/token`). - Removed operation `oAuth.oauthRevoke` (`POST /v1/oauth/revoke`). - Removed operation `oAuth.oauthAuthorizationServerMetadata` (`GET /.well-known/oauth-authorization-server`). - Removed schema `oauth_token`. - Removed schema `oauth_scope`. - Removed schema `oauth_error`. - Removed schema `oauth_token_request`. - Removed schema `oauth_revoke_request`. - Removed schema `oauth_authorization_server_metadata`. Build: w6bqazrWFLzxx6FciQhkz --- .claude/skills/scalar-ruby-sdk/SKILL.md | 2 +- README.md | 4 +- SKILL.md | 2 +- api.md | 68 - lib/scalar_api_ruby.rb | 10 - lib/scalar_api_ruby/client.rb | 12 +- lib/scalar_api_ruby/models.rb | 16 - ...th_authorization_server_metadata_params.rb | 14 - .../models/o_auth_oauth_authorize_params.rb | 14 - .../models/o_auth_oauth_revoke_params.rb | 38 - .../models/o_auth_oauth_token_params.rb | 62 - .../models/o_auth_oauth_token_response.rb | 17 - .../oauth_authorization_server_metadata.rb | 70 - lib/scalar_api_ruby/models/oauth_error.rb | 22 - lib/scalar_api_ruby/models/oauth_scope.rb | 16 - lib/scalar_api_ruby/models/oauth_token.rb | 39 - lib/scalar_api_ruby/resources/o_auth.rb | 113 - rbi/scalar_api_ruby/client.rbi | 9 +- rbi/scalar_api_ruby/models.rbi | 18 - ...h_authorization_server_metadata_params.rbi | 30 - .../models/o_auth_oauth_authorize_params.rbi | 27 - .../models/o_auth_oauth_revoke_params.rbi | 68 - .../models/o_auth_oauth_token_params.rbi | 104 - .../models/o_auth_oauth_token_response.rbi | 19 - .../oauth_authorization_server_metadata.rbi | 92 - rbi/scalar_api_ruby/models/oauth_error.rbi | 31 - rbi/scalar_api_ruby/models/oauth_scope.rbi | 20 - rbi/scalar_api_ruby/models/oauth_token.rbi | 57 - rbi/scalar_api_ruby/resources/o_auth.rbi | 87 - reference.md | 4 - scalar-sdk.manifest.json | 6896 +++++++---------- sig/scalar_api_ruby/client.rbs | 2 - sig/scalar_api_ruby/models.rbs | 16 - ...h_authorization_server_metadata_params.rbs | 15 - .../models/o_auth_oauth_authorize_params.rbs | 15 - .../models/o_auth_oauth_revoke_params.rbs | 47 - .../models/o_auth_oauth_token_params.rbs | 75 - .../models/o_auth_oauth_token_response.rbs | 11 - .../oauth_authorization_server_metadata.rbs | 65 - sig/scalar_api_ruby/models/oauth_error.rbs | 17 - sig/scalar_api_ruby/models/oauth_scope.rbs | 15 - sig/scalar_api_ruby/models/oauth_token.rbs | 40 - sig/scalar_api_ruby/resources/o_auth.rbs | 33 - tests/smoke-test.rb | 55 - 44 files changed, 2902 insertions(+), 5485 deletions(-) delete mode 100644 lib/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rb delete mode 100644 lib/scalar_api_ruby/models/o_auth_oauth_authorize_params.rb delete mode 100644 lib/scalar_api_ruby/models/o_auth_oauth_revoke_params.rb delete mode 100644 lib/scalar_api_ruby/models/o_auth_oauth_token_params.rb delete mode 100644 lib/scalar_api_ruby/models/o_auth_oauth_token_response.rb delete mode 100644 lib/scalar_api_ruby/models/oauth_authorization_server_metadata.rb delete mode 100644 lib/scalar_api_ruby/models/oauth_error.rb delete mode 100644 lib/scalar_api_ruby/models/oauth_scope.rb delete mode 100644 lib/scalar_api_ruby/models/oauth_token.rb delete mode 100644 lib/scalar_api_ruby/resources/o_auth.rb delete mode 100644 rbi/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbi delete mode 100644 rbi/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbi delete mode 100644 rbi/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbi delete mode 100644 rbi/scalar_api_ruby/models/o_auth_oauth_token_params.rbi delete mode 100644 rbi/scalar_api_ruby/models/o_auth_oauth_token_response.rbi delete mode 100644 rbi/scalar_api_ruby/models/oauth_authorization_server_metadata.rbi delete mode 100644 rbi/scalar_api_ruby/models/oauth_error.rbi delete mode 100644 rbi/scalar_api_ruby/models/oauth_scope.rbi delete mode 100644 rbi/scalar_api_ruby/models/oauth_token.rbi delete mode 100644 rbi/scalar_api_ruby/resources/o_auth.rbi delete mode 100644 sig/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbs delete mode 100644 sig/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbs delete mode 100644 sig/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbs delete mode 100644 sig/scalar_api_ruby/models/o_auth_oauth_token_params.rbs delete mode 100644 sig/scalar_api_ruby/models/o_auth_oauth_token_response.rbs delete mode 100644 sig/scalar_api_ruby/models/oauth_authorization_server_metadata.rbs delete mode 100644 sig/scalar_api_ruby/models/oauth_error.rbs delete mode 100644 sig/scalar_api_ruby/models/oauth_scope.rbs delete mode 100644 sig/scalar_api_ruby/models/oauth_token.rbs delete mode 100644 sig/scalar_api_ruby/resources/o_auth.rbs diff --git a/.claude/skills/scalar-ruby-sdk/SKILL.md b/.claude/skills/scalar-ruby-sdk/SKILL.md index e0a42bf..59c4c4c 100644 --- a/.claude/skills/scalar-ruby-sdk/SKILL.md +++ b/.claude/skills/scalar-ruby-sdk/SKILL.md @@ -34,7 +34,7 @@ client = Scalar::Client.new( Provide credentials using the options below. Environment variables are read automatically when the target runtime supports them: - `bearer_auth` (env: `BEARER_AUTH`) — Credential for the BearerAuth authentication scheme. -- `o_auth2` (env: `SCALAR_O_AUTH2`) — Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. +- `o_auth2` (env: `SCALAR_OAUTH_TOKEN`) — Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. ## Calling operations diff --git a/README.md b/README.md index 5197f79..6b4366e 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ Pass credentials to the generated client constructor. Environment variables are | Option | Type | Default | Description | | --- | --- | --- | --- | | `bearer_auth` | `String \| nil` | - | Credential for the BearerAuth authentication scheme. Defaults to BEARER_AUTH. | -| `o_auth2` | `String \| nil` | - | Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. Defaults to SCALAR_O_AUTH2. | +| `o_auth2` | `String \| nil` | - | Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. Defaults to SCALAR_OAUTH_TOKEN. | Declared schemes: @@ -108,7 +108,7 @@ client = Scalar::Client.new( | Option | Type | Default | Description | | --- | --- | --- | --- | | `bearer_auth` | `String \| nil` | `ENV["BEARER_AUTH"]` | Credential for the BearerAuth authentication scheme. | -| `o_auth2` | `String \| nil` | `ENV["SCALAR_O_AUTH2"]` | Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. | +| `o_auth2` | `String \| nil` | `ENV["SCALAR_OAUTH_TOKEN"]` | Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. | | `base_url` | `String \| nil` | `ENV["SCALAR_BASE_URL"]` | Override the default API base URL. | | `max_retries` | `Integer` | `2` | Max number of retries to attempt after a failed retryable request. | | `timeout` | `Float` | `60.0` | Seconds to wait for a response before timing out. | diff --git a/SKILL.md b/SKILL.md index 1170acb..944eb1c 100644 --- a/SKILL.md +++ b/SKILL.md @@ -34,7 +34,7 @@ client = Scalar::Client.new( Provide credentials using the options below. Environment variables are read automatically when the target runtime supports them: - `bearer_auth` (env: `BEARER_AUTH`) — Credential for the BearerAuth authentication scheme. -- `o_auth2` (env: `SCALAR_O_AUTH2`) — Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. +- `o_auth2` (env: `SCALAR_OAUTH_TOKEN`) — Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. Each scope implies the weaker ones. ## Calling operations diff --git a/api.md b/api.md index f5fddf4..802a96f 100644 --- a/api.md +++ b/api.md @@ -116,11 +116,6 @@ Complete reference of every operation, grouped by resource. See [the README](./R - [Delete an installation](#delete-an-installation) - [Add an access group](#add-an-access-group) - [Remove an access group](#remove-an-access-group) -- [`OAuth`](#oauth) - - [Start an OAuth authorization](#start-an-oauth-authorization) - - [Exchange a code or refresh token](#exchange-a-code-or-refresh-token) - - [Revoke a refresh token](#revoke-a-refresh-token) - - [Authorization server metadata](#authorization-server-metadata) ## Setup @@ -1533,66 +1528,3 @@ response = client.mcp.servers.installations.delete_access_group("84", { id: "42" puts response.inspect ``` - -## `OAuth` - -OAuth - -### Start an OAuth authorization - -Authorization endpoint (RFC 6749 §4.1.1 with PKCE, RFC 7636). Validates the request and sends the user to the Scalar dashboard to approve it; the user returns to `redirect_uri` with a `code` to exchange at the token endpoint. Only `response_type=code` with `code_challenge_method=S256` is supported. - -| Direction | Type | -| --- | --- | -| Request | [`OAuthOauthAuthorizeParams`](././lib/scalar_api_ruby/models/o_auth_oauth_authorize_params.rb) | - -```ruby -response = client.o_auth.oauth_authorize - -puts response.inspect -``` - -### Exchange a code or refresh token - -Token endpoint (RFC 6749 §4.1.3 and §6). Accepts `application/x-www-form-urlencoded`. Confidential clients authenticate with HTTP Basic or `client_secret` in the body; public clients send `client_id` alone. The `authorization_code` grant needs `code`, `redirect_uri` and `code_verifier`; the `refresh_token` grant needs `refresh_token` and may narrow `scope`. - -| Direction | Type | -| --- | --- | -| Request | [`OAuthOauthTokenParams`](././lib/scalar_api_ruby/models/o_auth_oauth_token_params.rb) | -| Response | [`OAuthOauthTokenResponse`](././lib/scalar_api_ruby/models/o_auth_oauth_token_response.rb) | - -```ruby -response = client.o_auth.oauth_token({ grant_type: "", client_id: "", client_secret: "", code: "", code_verifier: "", redirect_uri: "", refresh_token: "", scope: "" }) - -puts response.inspect -``` - -### Revoke a refresh token - -Revocation endpoint (RFC 7009). Revokes the refresh token and every token issued alongside it. The client authenticates as it does at the token endpoint. Responds 200 whether or not the token was live, as the RFC requires. - -| Direction | Type | -| --- | --- | -| Request | [`OAuthOauthRevokeParams`](././lib/scalar_api_ruby/models/o_auth_oauth_revoke_params.rb) | -| Response | [`OauthError`](././lib/scalar_api_ruby/models/oauth_error.rb) | - -```ruby -response = client.o_auth.oauth_revoke({ token: "", client_id: "", client_secret: "", token_type_hint: "" }) - -puts response.inspect -``` - -### Authorization server metadata - -Discovery document for OAuth clients (RFC 8414): where the endpoints are and what they support. - -| Direction | Type | -| --- | --- | -| Request | [`OAuthOauthAuthorizationServerMetadataParams`](././lib/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rb) | -| Response | [`OauthAuthorizationServerMetadata`](././lib/scalar_api_ruby/models/oauth_authorization_server_metadata.rb) | - -```ruby -response = client.o_auth.oauth_authorization_server_metadata - -puts response.inspect -``` diff --git a/lib/scalar_api_ruby.rb b/lib/scalar_api_ruby.rb index 36de95a..fa15f24 100644 --- a/lib/scalar_api_ruby.rb +++ b/lib/scalar_api_ruby.rb @@ -110,15 +110,6 @@ require_relative "scalar_api_ruby/models/namespace_list_params" require_relative "scalar_api_ruby/models/namespace_list_response" require_relative "scalar_api_ruby/models/nanoid" -require_relative "scalar_api_ruby/models/oauth_authorization_server_metadata" -require_relative "scalar_api_ruby/models/oauth_error" -require_relative "scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params" -require_relative "scalar_api_ruby/models/o_auth_oauth_authorize_params" -require_relative "scalar_api_ruby/models/o_auth_oauth_revoke_params" -require_relative "scalar_api_ruby/models/o_auth_oauth_token_params" -require_relative "scalar_api_ruby/models/o_auth_oauth_token_response" -require_relative "scalar_api_ruby/models/oauth_scope" -require_relative "scalar_api_ruby/models/oauth_token" require_relative "scalar_api_ruby/models/registry_create_api_document_access_group_params" require_relative "scalar_api_ruby/models/registry_create_api_document_params" require_relative "scalar_api_ruby/models/registry_create_api_document_response" @@ -251,4 +242,3 @@ require_relative "scalar_api_ruby/resources/mcp" require_relative "scalar_api_ruby/resources/mcp/servers" require_relative "scalar_api_ruby/resources/mcp/servers/installations" -require_relative "scalar_api_ruby/resources/o_auth" diff --git a/lib/scalar_api_ruby/client.rb b/lib/scalar_api_ruby/client.rb index 3fc9364..678301a 100644 --- a/lib/scalar_api_ruby/client.rb +++ b/lib/scalar_api_ruby/client.rb @@ -18,8 +18,6 @@ class Client < Scalar::Internal::Transport::BaseClient # @return [String, nil] attr_reader :bearer_auth - # Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. - # Each scope implies the weaker ones. # @return [String, nil] attr_reader :o_auth2 @@ -70,10 +68,6 @@ class Client < Scalar::Internal::Transport::BaseClient # @return [Scalar::Resources::Mcp] attr_reader :mcp - # OAuth - # @return [Scalar::Resources::OAuth] - attr_reader :o_auth - # @api private # # @return [Hash{String=>String}] @@ -99,8 +93,7 @@ class Client < Scalar::Internal::Transport::BaseClient # # @param bearer_auth [String, nil] Defaults to `ENV["BEARER_AUTH"]` # - # @param o_auth2 [String, nil] Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. - # Each scope implies the weaker ones. Defaults to `ENV["SCALAR_O_AUTH2"]` + # @param o_auth2 [String, nil] Defaults to `ENV["SCALAR_OAUTH_TOKEN"]` # # @param base_url [String, nil] Override the default base URL for the API, e.g., # `"https://api.example.com/v2/"`. Defaults to `ENV["SCALAR_BASE_URL"]` @@ -114,7 +107,7 @@ class Client < Scalar::Internal::Transport::BaseClient # @param max_retry_delay [Float] def initialize( bearer_auth: ENV["BEARER_AUTH"], - o_auth2: ENV["SCALAR_O_AUTH2"], + o_auth2: ENV["SCALAR_OAUTH_TOKEN"], base_url: ENV["SCALAR_BASE_URL"], max_retries: self.class::DEFAULT_MAX_RETRIES, timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS, @@ -160,7 +153,6 @@ def initialize( @authentication = Scalar::Resources::Authentication.new(client: self) @sdks = Scalar::Resources::Sdks.new(client: self) @mcp = Scalar::Resources::Mcp.new(client: self) - @o_auth = Scalar::Resources::OAuth.new(client: self) end end end diff --git a/lib/scalar_api_ruby/models.rb b/lib/scalar_api_ruby/models.rb index 6b74ea1..379f278 100644 --- a/lib/scalar_api_ruby/models.rb +++ b/lib/scalar_api_ruby/models.rb @@ -100,22 +100,6 @@ module Scalar Nanoid = Scalar::Models::Nanoid - OauthAuthorizationServerMetadata = Scalar::Models::OauthAuthorizationServerMetadata - - OauthError = Scalar::Models::OauthError - - OAuthOauthAuthorizationServerMetadataParams = Scalar::Models::OAuthOauthAuthorizationServerMetadataParams - - OAuthOauthAuthorizeParams = Scalar::Models::OAuthOauthAuthorizeParams - - OAuthOauthRevokeParams = Scalar::Models::OAuthOauthRevokeParams - - OAuthOauthTokenParams = Scalar::Models::OAuthOauthTokenParams - - OauthScope = Scalar::Models::OauthScope - - OauthToken = Scalar::Models::OauthToken - RegistryCreateAPIDocumentAccessGroupParams = Scalar::Models::RegistryCreateAPIDocumentAccessGroupParams RegistryCreateAPIDocumentParams = Scalar::Models::RegistryCreateAPIDocumentParams diff --git a/lib/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rb b/lib/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rb deleted file mode 100644 index 9a30ee3..0000000 --- a/lib/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -module Scalar - module Models - # @see Scalar::Resources::OAuth#oauth_authorization_server_metadata - class OAuthOauthAuthorizationServerMetadataParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/scalar_api_ruby/models/o_auth_oauth_authorize_params.rb b/lib/scalar_api_ruby/models/o_auth_oauth_authorize_params.rb deleted file mode 100644 index 65eec9e..0000000 --- a/lib/scalar_api_ruby/models/o_auth_oauth_authorize_params.rb +++ /dev/null @@ -1,14 +0,0 @@ -# frozen_string_literal: true - -module Scalar - module Models - # @see Scalar::Resources::OAuth#oauth_authorize - class OAuthOauthAuthorizeParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - # @!method initialize(request_options: {}) - # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/scalar_api_ruby/models/o_auth_oauth_revoke_params.rb b/lib/scalar_api_ruby/models/o_auth_oauth_revoke_params.rb deleted file mode 100644 index 946235f..0000000 --- a/lib/scalar_api_ruby/models/o_auth_oauth_revoke_params.rb +++ /dev/null @@ -1,38 +0,0 @@ -# frozen_string_literal: true - -module Scalar - module Models - # @see Scalar::Resources::OAuth#oauth_revoke - class OAuthOauthRevokeParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - # @!attribute token - # - # @return [String] - required :token, String - - # @!attribute client_id - # - # @return [String, nil] - optional :client_id, String - - # @!attribute client_secret - # - # @return [String, nil] - optional :client_secret, String - - # @!attribute token_type_hint - # - # @return [String, nil] - optional :token_type_hint, String - - # @!method initialize(token:, client_id: nil, client_secret: nil, token_type_hint: nil, request_options: {}) - # @param token [String] - # @param client_id [String] - # @param client_secret [String] - # @param token_type_hint [String] - # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/scalar_api_ruby/models/o_auth_oauth_token_params.rb b/lib/scalar_api_ruby/models/o_auth_oauth_token_params.rb deleted file mode 100644 index 3ab505a..0000000 --- a/lib/scalar_api_ruby/models/o_auth_oauth_token_params.rb +++ /dev/null @@ -1,62 +0,0 @@ -# frozen_string_literal: true - -module Scalar - module Models - # @see Scalar::Resources::OAuth#oauth_token - class OAuthOauthTokenParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - # @!attribute grant_type - # - # @return [String] - required :grant_type, String - - # @!attribute client_id - # - # @return [String, nil] - optional :client_id, String - - # @!attribute client_secret - # - # @return [String, nil] - optional :client_secret, String - - # @!attribute code - # - # @return [String, nil] - optional :code, String - - # @!attribute code_verifier - # - # @return [String, nil] - optional :code_verifier, String - - # @!attribute redirect_uri - # - # @return [String, nil] - optional :redirect_uri, String - - # @!attribute refresh_token - # - # @return [String, nil] - optional :refresh_token, String - - # @!attribute scope - # - # @return [String, nil] - optional :scope, String - - # @!method initialize(grant_type:, client_id: nil, client_secret: nil, code: nil, code_verifier: nil, redirect_uri: nil, refresh_token: nil, scope: nil, request_options: {}) - # @param grant_type [String] - # @param client_id [String] - # @param client_secret [String] - # @param code [String] - # @param code_verifier [String] - # @param redirect_uri [String] - # @param refresh_token [String] - # @param scope [String] - # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/scalar_api_ruby/models/o_auth_oauth_token_response.rb b/lib/scalar_api_ruby/models/o_auth_oauth_token_response.rb deleted file mode 100644 index cd2ce28..0000000 --- a/lib/scalar_api_ruby/models/o_auth_oauth_token_response.rb +++ /dev/null @@ -1,17 +0,0 @@ -# frozen_string_literal: true - -module Scalar - module Models - # @see Scalar::Resources::OAuth#oauth_token - module OAuthOauthTokenResponse - extend Scalar::Internal::Type::Union - - variant -> { Scalar::OauthToken } - - variant -> { Scalar::OauthError } - - # @!method self.variants - # @return [Array(Scalar::Models::OauthToken, Scalar::Models::OauthError)] - end - end -end diff --git a/lib/scalar_api_ruby/models/oauth_authorization_server_metadata.rb b/lib/scalar_api_ruby/models/oauth_authorization_server_metadata.rb deleted file mode 100644 index 03b4c79..0000000 --- a/lib/scalar_api_ruby/models/oauth_authorization_server_metadata.rb +++ /dev/null @@ -1,70 +0,0 @@ -# frozen_string_literal: true - -module Scalar - module Models - # @see Scalar::Resources::OAuth#oauth_authorization_server_metadata - class OauthAuthorizationServerMetadata < Scalar::Internal::Type::BaseModel - # @!attribute authorization_endpoint - # - # @return [String] - required :authorization_endpoint, String - - # @!attribute code_challenge_methods_supported - # - # @return [Array] - required :code_challenge_methods_supported, Scalar::Internal::Type::ArrayOf[String] - - # @!attribute grant_types_supported - # - # @return [Array] - required :grant_types_supported, Scalar::Internal::Type::ArrayOf[String] - - # @!attribute issuer - # - # @return [String] - required :issuer, String - - # @!attribute response_types_supported - # - # @return [Array] - required :response_types_supported, Scalar::Internal::Type::ArrayOf[String] - - # @!attribute revocation_endpoint - # - # @return [String] - required :revocation_endpoint, String - - # @!attribute revocation_endpoint_auth_methods_supported - # - # @return [Array] - required :revocation_endpoint_auth_methods_supported, Scalar::Internal::Type::ArrayOf[String] - - # @!attribute scopes_supported - # - # @return [Array] - required :scopes_supported, Scalar::Internal::Type::ArrayOf[String] - - # @!attribute token_endpoint - # - # @return [String] - required :token_endpoint, String - - # @!attribute token_endpoint_auth_methods_supported - # - # @return [Array] - required :token_endpoint_auth_methods_supported, Scalar::Internal::Type::ArrayOf[String] - - # @!method initialize(authorization_endpoint:, code_challenge_methods_supported:, grant_types_supported:, issuer:, response_types_supported:, revocation_endpoint:, revocation_endpoint_auth_methods_supported:, scopes_supported:, token_endpoint:, token_endpoint_auth_methods_supported:) - # @param authorization_endpoint [String] - # @param code_challenge_methods_supported [Array] - # @param grant_types_supported [Array] - # @param issuer [String] - # @param response_types_supported [Array] - # @param revocation_endpoint [String] - # @param revocation_endpoint_auth_methods_supported [Array] - # @param scopes_supported [Array] - # @param token_endpoint [String] - # @param token_endpoint_auth_methods_supported [Array] - end - end -end diff --git a/lib/scalar_api_ruby/models/oauth_error.rb b/lib/scalar_api_ruby/models/oauth_error.rb deleted file mode 100644 index 0bd2f48..0000000 --- a/lib/scalar_api_ruby/models/oauth_error.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -module Scalar - module Models - # @see Scalar::Resources::OAuth#oauth_revoke - class OauthError < Scalar::Internal::Type::BaseModel - # @!attribute error - # - # @return [String] - required :error, String - - # @!attribute error_description - # - # @return [String, nil] - optional :error_description, String - - # @!method initialize(error:, error_description: nil) - # @param error [String] - # @param error_description [String] - end - end -end diff --git a/lib/scalar_api_ruby/models/oauth_scope.rb b/lib/scalar_api_ruby/models/oauth_scope.rb deleted file mode 100644 index 0b4bb62..0000000 --- a/lib/scalar_api_ruby/models/oauth_scope.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module Scalar - module Models - module OauthScope - extend Scalar::Internal::Type::Enum - - READ = :read - WRITE = :write - ADMIN = :admin - - # @!method self.values - # @return [Array] - end - end -end diff --git a/lib/scalar_api_ruby/models/oauth_token.rb b/lib/scalar_api_ruby/models/oauth_token.rb deleted file mode 100644 index b48c4a5..0000000 --- a/lib/scalar_api_ruby/models/oauth_token.rb +++ /dev/null @@ -1,39 +0,0 @@ -# frozen_string_literal: true - -module Scalar - module Models - class OauthToken < Scalar::Internal::Type::BaseModel - # @!attribute access_token - # - # @return [String] - required :access_token, String - - # @!attribute expires_in - # - # @return [Integer] - required :expires_in, Integer - - # @!attribute refresh_token - # - # @return [String] - required :refresh_token, String - - # @!attribute scope - # - # @return [Symbol, Scalar::Models::OauthScope] - required :scope, enum: -> { Scalar::OauthScope } - - # @!attribute token_type - # - # @return [Symbol, :Bearer] - required :token_type, const: :Bearer - - # @!method initialize(access_token:, expires_in:, refresh_token:, scope:, token_type: :Bearer) - # @param access_token [String] - # @param expires_in [Integer] - # @param refresh_token [String] - # @param scope [Symbol, Scalar::Models::OauthScope] - # @param token_type [Symbol, :Bearer] - end - end -end diff --git a/lib/scalar_api_ruby/resources/o_auth.rb b/lib/scalar_api_ruby/resources/o_auth.rb deleted file mode 100644 index 845adeb..0000000 --- a/lib/scalar_api_ruby/resources/o_auth.rb +++ /dev/null @@ -1,113 +0,0 @@ -# frozen_string_literal: true - -module Scalar - module Resources - # OAuth - class OAuth - # Discovery document for OAuth clients (RFC 8414): where the endpoints are and - # what they support. - # - # @overload oauth_authorization_server_metadata(request_options: {}) - # - # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Scalar::Models::OauthAuthorizationServerMetadata] - # - # @see Scalar::Models::OAuthOauthAuthorizationServerMetadataParams - def oauth_authorization_server_metadata(params = {}) - @client.request( - method: :get, - path: ".well-known/oauth-authorization-server", - model: Scalar::OauthAuthorizationServerMetadata, - options: params[:request_options] - ) - end - - # Authorization endpoint (RFC 6749 §4.1.1 with PKCE, RFC 7636). Validates the - # request and sends the user to the Scalar dashboard to approve it; the user - # returns to `redirect_uri` with a `code` to exchange at the token endpoint. Only - # `response_type=code` with `code_challenge_method=S256` is supported. - # - # @overload oauth_authorize(request_options: {}) - # - # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Object] - # - # @see Scalar::Models::OAuthOauthAuthorizeParams - def oauth_authorize(params = {}) - @client.request( - method: :get, - path: "v1/oauth/authorize", - model: Scalar::Internal::Type::Unknown, - options: params[:request_options] - ) - end - - # Revocation endpoint (RFC 7009). Revokes the refresh token and every token issued - # alongside it. The client authenticates as it does at the token endpoint. - # Responds 200 whether or not the token was live, as the RFC requires. - # - # @overload oauth_revoke(token:, client_id: nil, client_secret: nil, token_type_hint: nil, request_options: {}) - # - # @param token [String] - # @param client_id [String] - # @param client_secret [String] - # @param token_type_hint [String] - # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Scalar::Models::OauthError] - # - # @see Scalar::Models::OAuthOauthRevokeParams - def oauth_revoke(params) - parsed, options = Scalar::OAuthOauthRevokeParams.dump_request(params) - @client.request( - method: :post, - path: "v1/oauth/revoke", - body: parsed, - model: Scalar::OauthError, - options: options - ) - end - - # Token endpoint (RFC 6749 §4.1.3 and §6). Accepts - # `application/x-www-form-urlencoded`. Confidential clients authenticate with HTTP - # Basic or `client_secret` in the body; public clients send `client_id` alone. The - # `authorization_code` grant needs `code`, `redirect_uri` and `code_verifier`; the - # `refresh_token` grant needs `refresh_token` and may narrow `scope`. - # - # @overload oauth_token(grant_type:, client_id: nil, client_secret: nil, code: nil, code_verifier: nil, redirect_uri: nil, refresh_token: nil, scope: nil, request_options: {}) - # - # @param grant_type [String] - # @param client_id [String] - # @param client_secret [String] - # @param code [String] - # @param code_verifier [String] - # @param redirect_uri [String] - # @param refresh_token [String] - # @param scope [String] - # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [Scalar::Models::OauthToken, Scalar::Models::OauthError] - # - # @see Scalar::Models::OAuthOauthTokenParams - def oauth_token(params) - parsed, options = Scalar::OAuthOauthTokenParams.dump_request(params) - @client.request( - method: :post, - path: "v1/oauth/token", - body: parsed, - model: Scalar::Models::OAuthOauthTokenResponse, - options: options - ) - end - - # @api private - # - # @param client [Scalar::Client] - def initialize(client:) - @client = client - end - end - end -end diff --git a/rbi/scalar_api_ruby/client.rbi b/rbi/scalar_api_ruby/client.rbi index a108bd9..f9eacf6 100644 --- a/rbi/scalar_api_ruby/client.rbi +++ b/rbi/scalar_api_ruby/client.rbi @@ -63,10 +63,6 @@ module Scalar sig { returns(Scalar::Resources::Mcp) } attr_reader :mcp - # OAuth - sig { returns(Scalar::Resources::OAuth) } - attr_reader :o_auth - # @api private sig { override.returns(T::Hash[String, String]) } private def auth_headers @@ -87,9 +83,8 @@ module Scalar def self.new( # Defaults to `ENV["BEARER_AUTH"]` bearer_auth: ENV["BEARER_AUTH"], - # Authorization code with PKCE (S256), for apps acting on behalf of a Scalar user. - # Each scope implies the weaker ones. Defaults to `ENV["SCALAR_O_AUTH2"]` - o_auth2: ENV["SCALAR_O_AUTH2"], + # Defaults to `ENV["SCALAR_OAUTH_TOKEN"]` + o_auth2: ENV["SCALAR_OAUTH_TOKEN"], # Override the default base URL for the API, e.g., # `"https://api.example.com/v2/"`. Defaults to `ENV["SCALAR_BASE_URL"]` base_url: ENV["SCALAR_BASE_URL"], diff --git a/rbi/scalar_api_ruby/models.rbi b/rbi/scalar_api_ruby/models.rbi index ee11e27..13da1ea 100644 --- a/rbi/scalar_api_ruby/models.rbi +++ b/rbi/scalar_api_ruby/models.rbi @@ -61,24 +61,6 @@ module Scalar Nanoid = Scalar::Models::Nanoid - OauthAuthorizationServerMetadata = - Scalar::Models::OauthAuthorizationServerMetadata - - OauthError = Scalar::Models::OauthError - - OAuthOauthAuthorizationServerMetadataParams = - Scalar::Models::OAuthOauthAuthorizationServerMetadataParams - - OAuthOauthAuthorizeParams = Scalar::Models::OAuthOauthAuthorizeParams - - OAuthOauthRevokeParams = Scalar::Models::OAuthOauthRevokeParams - - OAuthOauthTokenParams = Scalar::Models::OAuthOauthTokenParams - - OauthScope = Scalar::Models::OauthScope - - OauthToken = Scalar::Models::OauthToken - RegistryCreateAPIDocumentAccessGroupParams = Scalar::Models::RegistryCreateAPIDocumentAccessGroupParams diff --git a/rbi/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbi b/rbi/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbi deleted file mode 100644 index 51fee2b..0000000 --- a/rbi/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbi +++ /dev/null @@ -1,30 +0,0 @@ -# typed: strong - -module Scalar - module Models - class OAuthOauthAuthorizationServerMetadataParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - Scalar::OAuthOauthAuthorizationServerMetadataParams, - Scalar::Internal::AnyHash - ) - end - - sig do - params(request_options: Scalar::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Scalar::RequestOptions }) } - def to_hash - end - end - end -end diff --git a/rbi/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbi b/rbi/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbi deleted file mode 100644 index 326fdd0..0000000 --- a/rbi/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbi +++ /dev/null @@ -1,27 +0,0 @@ -# typed: strong - -module Scalar - module Models - class OAuthOauthAuthorizeParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Scalar::OAuthOauthAuthorizeParams, Scalar::Internal::AnyHash) - end - - sig do - params(request_options: Scalar::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: Scalar::RequestOptions }) } - def to_hash - end - end - end -end diff --git a/rbi/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbi b/rbi/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbi deleted file mode 100644 index 658d80a..0000000 --- a/rbi/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbi +++ /dev/null @@ -1,68 +0,0 @@ -# typed: strong - -module Scalar - module Models - class OAuthOauthRevokeParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Scalar::OAuthOauthRevokeParams, Scalar::Internal::AnyHash) - end - - sig { returns(String) } - attr_accessor :token - - sig { returns(T.nilable(String)) } - attr_reader :client_id - - sig { params(client_id: String).void } - attr_writer :client_id - - sig { returns(T.nilable(String)) } - attr_reader :client_secret - - sig { params(client_secret: String).void } - attr_writer :client_secret - - sig { returns(T.nilable(String)) } - attr_reader :token_type_hint - - sig { params(token_type_hint: String).void } - attr_writer :token_type_hint - - sig do - params( - token: String, - client_id: String, - client_secret: String, - token_type_hint: String, - request_options: Scalar::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - token:, - client_id: nil, - client_secret: nil, - token_type_hint: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - token: String, - client_id: String, - client_secret: String, - token_type_hint: String, - request_options: Scalar::RequestOptions - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/scalar_api_ruby/models/o_auth_oauth_token_params.rbi b/rbi/scalar_api_ruby/models/o_auth_oauth_token_params.rbi deleted file mode 100644 index 26f1e52..0000000 --- a/rbi/scalar_api_ruby/models/o_auth_oauth_token_params.rbi +++ /dev/null @@ -1,104 +0,0 @@ -# typed: strong - -module Scalar - module Models - class OAuthOauthTokenParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(Scalar::OAuthOauthTokenParams, Scalar::Internal::AnyHash) - end - - sig { returns(String) } - attr_accessor :grant_type - - sig { returns(T.nilable(String)) } - attr_reader :client_id - - sig { params(client_id: String).void } - attr_writer :client_id - - sig { returns(T.nilable(String)) } - attr_reader :client_secret - - sig { params(client_secret: String).void } - attr_writer :client_secret - - sig { returns(T.nilable(String)) } - attr_reader :code - - sig { params(code: String).void } - attr_writer :code - - sig { returns(T.nilable(String)) } - attr_reader :code_verifier - - sig { params(code_verifier: String).void } - attr_writer :code_verifier - - sig { returns(T.nilable(String)) } - attr_reader :redirect_uri - - sig { params(redirect_uri: String).void } - attr_writer :redirect_uri - - sig { returns(T.nilable(String)) } - attr_reader :refresh_token - - sig { params(refresh_token: String).void } - attr_writer :refresh_token - - sig { returns(T.nilable(String)) } - attr_reader :scope - - sig { params(scope: String).void } - attr_writer :scope - - sig do - params( - grant_type: String, - client_id: String, - client_secret: String, - code: String, - code_verifier: String, - redirect_uri: String, - refresh_token: String, - scope: String, - request_options: Scalar::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - grant_type:, - client_id: nil, - client_secret: nil, - code: nil, - code_verifier: nil, - redirect_uri: nil, - refresh_token: nil, - scope: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - grant_type: String, - client_id: String, - client_secret: String, - code: String, - code_verifier: String, - redirect_uri: String, - refresh_token: String, - scope: String, - request_options: Scalar::RequestOptions - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/scalar_api_ruby/models/o_auth_oauth_token_response.rbi b/rbi/scalar_api_ruby/models/o_auth_oauth_token_response.rbi deleted file mode 100644 index f1ac7f0..0000000 --- a/rbi/scalar_api_ruby/models/o_auth_oauth_token_response.rbi +++ /dev/null @@ -1,19 +0,0 @@ -# typed: strong - -module Scalar - module Models - module OAuthOauthTokenResponse - extend Scalar::Internal::Type::Union - - Variants = T.type_alias { T.any(Scalar::OauthToken, Scalar::OauthError) } - - sig do - override.returns( - T::Array[Scalar::Models::OAuthOauthTokenResponse::Variants] - ) - end - def self.variants - end - end - end -end diff --git a/rbi/scalar_api_ruby/models/oauth_authorization_server_metadata.rbi b/rbi/scalar_api_ruby/models/oauth_authorization_server_metadata.rbi deleted file mode 100644 index da49b6c..0000000 --- a/rbi/scalar_api_ruby/models/oauth_authorization_server_metadata.rbi +++ /dev/null @@ -1,92 +0,0 @@ -# typed: strong - -module Scalar - module Models - class OauthAuthorizationServerMetadata < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Scalar::OauthAuthorizationServerMetadata, - Scalar::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :authorization_endpoint - - sig { returns(T::Array[String]) } - attr_accessor :code_challenge_methods_supported - - sig { returns(T::Array[String]) } - attr_accessor :grant_types_supported - - sig { returns(String) } - attr_accessor :issuer - - sig { returns(T::Array[String]) } - attr_accessor :response_types_supported - - sig { returns(String) } - attr_accessor :revocation_endpoint - - sig { returns(T::Array[String]) } - attr_accessor :revocation_endpoint_auth_methods_supported - - sig { returns(T::Array[String]) } - attr_accessor :scopes_supported - - sig { returns(String) } - attr_accessor :token_endpoint - - sig { returns(T::Array[String]) } - attr_accessor :token_endpoint_auth_methods_supported - - sig do - params( - authorization_endpoint: String, - code_challenge_methods_supported: T::Array[String], - grant_types_supported: T::Array[String], - issuer: String, - response_types_supported: T::Array[String], - revocation_endpoint: String, - revocation_endpoint_auth_methods_supported: T::Array[String], - scopes_supported: T::Array[String], - token_endpoint: String, - token_endpoint_auth_methods_supported: T::Array[String] - ).returns(T.attached_class) - end - def self.new( - authorization_endpoint:, - code_challenge_methods_supported:, - grant_types_supported:, - issuer:, - response_types_supported:, - revocation_endpoint:, - revocation_endpoint_auth_methods_supported:, - scopes_supported:, - token_endpoint:, - token_endpoint_auth_methods_supported: - ) - end - - sig do - override.returns( - { - authorization_endpoint: String, - code_challenge_methods_supported: T::Array[String], - grant_types_supported: T::Array[String], - issuer: String, - response_types_supported: T::Array[String], - revocation_endpoint: String, - revocation_endpoint_auth_methods_supported: T::Array[String], - scopes_supported: T::Array[String], - token_endpoint: String, - token_endpoint_auth_methods_supported: T::Array[String] - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/scalar_api_ruby/models/oauth_error.rbi b/rbi/scalar_api_ruby/models/oauth_error.rbi deleted file mode 100644 index 3d32fec..0000000 --- a/rbi/scalar_api_ruby/models/oauth_error.rbi +++ /dev/null @@ -1,31 +0,0 @@ -# typed: strong - -module Scalar - module Models - class OauthError < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias { T.any(Scalar::OauthError, Scalar::Internal::AnyHash) } - - sig { returns(String) } - attr_accessor :error - - sig { returns(T.nilable(String)) } - attr_reader :error_description - - sig { params(error_description: String).void } - attr_writer :error_description - - sig do - params(error: String, error_description: String).returns( - T.attached_class - ) - end - def self.new(error:, error_description: nil) - end - - sig { override.returns({ error: String, error_description: String }) } - def to_hash - end - end - end -end diff --git a/rbi/scalar_api_ruby/models/oauth_scope.rbi b/rbi/scalar_api_ruby/models/oauth_scope.rbi deleted file mode 100644 index 355128e..0000000 --- a/rbi/scalar_api_ruby/models/oauth_scope.rbi +++ /dev/null @@ -1,20 +0,0 @@ -# typed: strong - -module Scalar - module Models - module OauthScope - extend Scalar::Internal::Type::Enum - - TaggedSymbol = T.type_alias { T.all(Symbol, Scalar::OauthScope) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - READ = T.let(:read, Scalar::OauthScope::TaggedSymbol) - WRITE = T.let(:write, Scalar::OauthScope::TaggedSymbol) - ADMIN = T.let(:admin, Scalar::OauthScope::TaggedSymbol) - - sig { override.returns(T::Array[Scalar::OauthScope::TaggedSymbol]) } - def self.values - end - end - end -end diff --git a/rbi/scalar_api_ruby/models/oauth_token.rbi b/rbi/scalar_api_ruby/models/oauth_token.rbi deleted file mode 100644 index bf08871..0000000 --- a/rbi/scalar_api_ruby/models/oauth_token.rbi +++ /dev/null @@ -1,57 +0,0 @@ -# typed: strong - -module Scalar - module Models - class OauthToken < Scalar::Internal::Type::BaseModel - OrHash = - T.type_alias { T.any(Scalar::OauthToken, Scalar::Internal::AnyHash) } - - sig { returns(String) } - attr_accessor :access_token - - sig { returns(Integer) } - attr_accessor :expires_in - - sig { returns(String) } - attr_accessor :refresh_token - - sig { returns(Scalar::OauthScope::TaggedSymbol) } - attr_accessor :scope - - sig { returns(Symbol) } - attr_accessor :token_type - - sig do - params( - access_token: String, - expires_in: Integer, - refresh_token: String, - scope: Scalar::OauthScope::OrSymbol, - token_type: Symbol - ).returns(T.attached_class) - end - def self.new( - access_token:, - expires_in:, - refresh_token:, - scope:, - token_type: :Bearer - ) - end - - sig do - override.returns( - { - access_token: String, - expires_in: Integer, - refresh_token: String, - scope: Scalar::OauthScope::TaggedSymbol, - token_type: Symbol - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/scalar_api_ruby/resources/o_auth.rbi b/rbi/scalar_api_ruby/resources/o_auth.rbi deleted file mode 100644 index 4624d4d..0000000 --- a/rbi/scalar_api_ruby/resources/o_auth.rbi +++ /dev/null @@ -1,87 +0,0 @@ -# typed: strong - -module Scalar - module Resources - # OAuth - class OAuth - # Discovery document for OAuth clients (RFC 8414): where the endpoints are and - # what they support. - sig do - params(request_options: Scalar::RequestOptions::OrHash).returns( - Scalar::OauthAuthorizationServerMetadata - ) - end - def oauth_authorization_server_metadata(request_options: {}) - end - - # Authorization endpoint (RFC 6749 §4.1.1 with PKCE, RFC 7636). Validates the - # request and sends the user to the Scalar dashboard to approve it; the user - # returns to `redirect_uri` with a `code` to exchange at the token endpoint. Only - # `response_type=code` with `code_challenge_method=S256` is supported. - sig do - params(request_options: Scalar::RequestOptions::OrHash).returns( - T.anything - ) - end - def oauth_authorize(request_options: {}) - end - - # Revocation endpoint (RFC 7009). Revokes the refresh token and every token issued - # alongside it. The client authenticates as it does at the token endpoint. - # Responds 200 whether or not the token was live, as the RFC requires. - sig do - params( - token: String, - client_id: String, - client_secret: String, - token_type_hint: String, - request_options: Scalar::RequestOptions::OrHash - ).returns(Scalar::OauthError) - end - def oauth_revoke( - token:, - client_id: nil, - client_secret: nil, - token_type_hint: nil, - request_options: {} - ) - end - - # Token endpoint (RFC 6749 §4.1.3 and §6). Accepts - # `application/x-www-form-urlencoded`. Confidential clients authenticate with HTTP - # Basic or `client_secret` in the body; public clients send `client_id` alone. The - # `authorization_code` grant needs `code`, `redirect_uri` and `code_verifier`; the - # `refresh_token` grant needs `refresh_token` and may narrow `scope`. - sig do - params( - grant_type: String, - client_id: String, - client_secret: String, - code: String, - code_verifier: String, - redirect_uri: String, - refresh_token: String, - scope: String, - request_options: Scalar::RequestOptions::OrHash - ).returns(Scalar::Models::OAuthOauthTokenResponse::Variants) - end - def oauth_token( - grant_type:, - client_id: nil, - client_secret: nil, - code: nil, - code_verifier: nil, - redirect_uri: nil, - refresh_token: nil, - scope: nil, - request_options: {} - ) - end - - # @api private - sig { params(client: Scalar::Client).returns(T.attached_class) } - def self.new(client:) - end - end - end -end diff --git a/reference.md b/reference.md index c7322fb..41c53e2 100644 --- a/reference.md +++ b/reference.md @@ -93,7 +93,3 @@ - `mcp.servers.installations.delete(...)` — `DELETE /v1/mcp/servers/{id}/installations/{installationId}` - `mcp.servers.installations.create_access_group(...)` — `POST /v1/mcp/servers/{id}/installations/{installationId}/access-group` - `mcp.servers.installations.delete_access_group(...)` — `DELETE /v1/mcp/servers/{id}/installations/{installationId}/access-group` -- `o_auth.oauth_authorization_server_metadata(...)` — `GET /.well-known/oauth-authorization-server` -- `o_auth.oauth_authorize(...)` — `GET /v1/oauth/authorize` -- `o_auth.oauth_revoke(...)` — `POST /v1/oauth/revoke` -- `o_auth.oauth_token(...)` — `POST /v1/oauth/token` diff --git a/scalar-sdk.manifest.json b/scalar-sdk.manifest.json index 37aebde..e34bbeb 100644 --- a/scalar-sdk.manifest.json +++ b/scalar-sdk.manifest.json @@ -4023,1604 +4023,78 @@ ], "additionalProperties": false } - }, - { - "name": "oauth_token", - "source": "oauth_token", - "publicAliases": [], - "deprecated": false, - "type": { - "kind": "object", - "properties": [ - { - "name": "access_token", - "publicName": "access_token", - "required": true, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string" - } - }, - { - "name": "token_type", - "publicName": "token_type", - "required": true, - "deprecated": false, - "type": { - "kind": "literal", - "value": "Bearer" - } - }, - { - "name": "expires_in", - "publicName": "expires_in", - "required": true, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "integer", - "validation": { - "minimum": -9007199254740991, - "maximum": 9007199254740991 - } - } - }, - { - "name": "refresh_token", - "publicName": "refresh_token", - "required": true, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string" - } - }, - { - "name": "scope", - "publicName": "scope", - "required": true, - "deprecated": false, - "type": { - "kind": "ref", - "name": "oauth_scope" - } - } - ], - "additionalProperties": false - } - }, - { - "name": "oauth_scope", - "source": "oauth_scope", - "publicAliases": [], - "deprecated": false, - "type": { - "kind": "enum", - "values": [ - "read", - "write", - "admin" - ], - "names": [ - "Read", - "Write", - "Admin" - ], - "deprecations": [ - false, - false, - false - ] - } - }, - { - "name": "oauth_error", - "source": "oauth_error", - "publicAliases": [], - "deprecated": false, - "type": { - "kind": "object", - "properties": [ - { - "name": "error", - "publicName": "error", - "required": true, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string" - } - }, - { - "name": "error_description", - "publicName": "error_description", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string" - } - } - ], - "additionalProperties": false - } - }, - { - "name": "oauth_token_request", - "source": "oauth_token_request", - "publicAliases": [], - "deprecated": false, - "type": { - "kind": "object", - "properties": [ - { - "name": "grant_type", - "publicName": "grant_type", - "required": true, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 64 - } - } - }, - { - "name": "client_id", - "publicName": "client_id", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 256 - } - } - }, - { - "name": "client_secret", - "publicName": "client_secret", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 256 - } - } - }, - { - "name": "code", - "publicName": "code", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 256 - } - } - }, - { - "name": "redirect_uri", - "publicName": "redirect_uri", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 2048 - } - } - }, - { - "name": "code_verifier", - "publicName": "code_verifier", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 256 - } - } - }, - { - "name": "refresh_token", - "publicName": "refresh_token", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 4096 - } - } - }, - { - "name": "scope", - "publicName": "scope", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 256 - } - } - } - ], - "additionalProperties": false - } - }, - { - "name": "oauth_revoke_request", - "source": "oauth_revoke_request", - "publicAliases": [], - "deprecated": false, - "type": { - "kind": "object", - "properties": [ - { - "name": "token", - "publicName": "token", - "required": true, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 4096 - } - } - }, - { - "name": "token_type_hint", - "publicName": "token_type_hint", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 64 - } - } - }, - { - "name": "client_id", - "publicName": "client_id", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 256 - } - } - }, - { - "name": "client_secret", - "publicName": "client_secret", - "required": false, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string", - "validation": { - "maxLength": 256 - } - } - } - ], - "additionalProperties": false - } - }, - { - "name": "oauth_authorization_server_metadata", - "source": "oauth_authorization_server_metadata", - "publicAliases": [], - "deprecated": false, - "type": { - "kind": "object", - "properties": [ - { - "name": "issuer", - "publicName": "issuer", - "required": true, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string" - } - }, - { - "name": "authorization_endpoint", - "publicName": "authorization_endpoint", - "required": true, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string" - } - }, - { - "name": "token_endpoint", - "publicName": "token_endpoint", - "required": true, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string" - } - }, - { - "name": "revocation_endpoint", - "publicName": "revocation_endpoint", - "required": true, - "deprecated": false, - "type": { - "kind": "primitive", - "type": "string" - } - }, - { - "name": "response_types_supported", - "publicName": "response_types_supported", - "required": true, - "deprecated": false, - "type": { - "kind": "array", - "items": { - "kind": "primitive", - "type": "string" - } - } - }, - { - "name": "grant_types_supported", - "publicName": "grant_types_supported", - "required": true, - "deprecated": false, - "type": { - "kind": "array", - "items": { - "kind": "primitive", - "type": "string" - } - } - }, - { - "name": "code_challenge_methods_supported", - "publicName": "code_challenge_methods_supported", - "required": true, - "deprecated": false, - "type": { - "kind": "array", - "items": { - "kind": "primitive", - "type": "string" - } - } - }, - { - "name": "token_endpoint_auth_methods_supported", - "publicName": "token_endpoint_auth_methods_supported", - "required": true, - "deprecated": false, - "type": { - "kind": "array", - "items": { - "kind": "primitive", - "type": "string" - } - } - }, - { - "name": "revocation_endpoint_auth_methods_supported", - "publicName": "revocation_endpoint_auth_methods_supported", - "required": true, - "deprecated": false, - "type": { - "kind": "array", - "items": { - "kind": "primitive", - "type": "string" - } - } - }, - { - "name": "scopes_supported", - "publicName": "scopes_supported", - "required": true, - "deprecated": false, - "type": { - "kind": "array", - "items": { - "kind": "primitive", - "type": "string" - } - } - } - ], - "additionalProperties": false - } - } - ], - "resources": [ - "registry", - "schemas", - "schemas.version", - "schemas.accessGroup", - "loginPortals", - "accessGroups", - "accessGroups.domains", - "rules", - "themes", - "teams", - "teams.members", - "teams.invites", - "scalarDocs", - "namespaces", - "authentication", - "sdks", - "sdks.versions", - "sdks.repositories", - "mcp", - "mcp.servers", - "mcp.servers.installations", - "oAuth" - ], - "publicResources": [ - "registry", - "schemas", - "schemas.version", - "schemas.accessGroup", - "loginPortals", - "accessGroups", - "accessGroups.domains", - "rules", - "themes", - "teams", - "teams.members", - "teams.invites", - "scalarDocs", - "namespaces", - "authentication", - "sdks", - "sdks.versions", - "sdks.repositories", - "mcp", - "mcp.servers", - "mcp.servers.installations", - "oAuth" - ], - "operations": [ - { - "resource": "registry", - "publicResource": "registry", - "operation": "listAllApiDocuments", - "publicOperation": "listAllApiDocuments", - "deprecated": false, - "method": "GET", - "path": "/v1/apis", - "pathParams": [], - "publicPathParams": [], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], - "queryParamDetails": [], - "headerParamDetails": [], - "cookieParams": [], - "publicCookieParams": [], - "cookieParamDetails": [], - "response": { - "status": "200", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ] - }, - "result": { - "successStatus": "200", - "errorStatuses": [ - "400", - "401", - "403", - "404", - "422", - "500" - ] - }, - "errorResponses": [ - { - "status": "400", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "400", - "publicAliases": [] - } - }, - { - "status": "401", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "401", - "publicAliases": [] - } - }, - { - "status": "403", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "403", - "publicAliases": [] - } - }, - { - "status": "404", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "404", - "publicAliases": [] - } - }, - { - "status": "422", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "422", - "publicAliases": [] - } - }, - { - "status": "500", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "500", - "publicAliases": [] - } - } - ], - "responseLinks": [], - "transport": "http" - }, - { - "resource": "registry", - "publicResource": "registry", - "operation": "listApiDocuments", - "publicOperation": "listApiDocuments", - "deprecated": false, - "method": "GET", - "path": "/v1/apis/{namespace}", - "pathParams": [ - "namespace" - ], - "publicPathParams": [ - "namespace" - ], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - } - ], - "queryParamDetails": [], - "headerParamDetails": [], - "cookieParams": [], - "publicCookieParams": [], - "cookieParamDetails": [], - "paramsModel": { - "publicName": "RegistryListApiDocumentsParams" - }, - "response": { - "status": "200", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ] - }, - "result": { - "successStatus": "200", - "errorStatuses": [ - "400", - "401", - "403", - "404", - "422", - "500" - ] - }, - "errorResponses": [ - { - "status": "400", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "400", - "publicAliases": [] - } - }, - { - "status": "401", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "401", - "publicAliases": [] - } - }, - { - "status": "403", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "403", - "publicAliases": [] - } - }, - { - "status": "404", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "404", - "publicAliases": [] - } - }, - { - "status": "422", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "422", - "publicAliases": [] - } - }, - { - "status": "500", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "500", - "publicAliases": [] - } - } - ], - "responseLinks": [], - "transport": "http" - }, - { - "resource": "registry", - "publicResource": "registry", - "operation": "createApiDocument", - "publicOperation": "createApiDocument", - "deprecated": false, - "method": "POST", - "path": "/v1/apis/{namespace}", - "pathParams": [ - "namespace" - ], - "publicPathParams": [ - "namespace" - ], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [ - "title", - "description", - "version", - "slug", - "ruleset", - "isPrivate", - "document" - ], - "publicBodyParams": [ - "title", - "description", - "version", - "slug", - "ruleset", - "isPrivate", - "document" - ], - "bodyParamDetails": [ - { - "name": "title", - "required": true - }, - { - "name": "description", - "required": false - }, - { - "name": "version", - "required": true - }, - { - "name": "slug", - "required": true - }, - { - "name": "ruleset", - "required": false - }, - { - "name": "isPrivate", - "required": false - }, - { - "name": "document", - "required": true - } - ], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - } - ], - "queryParamDetails": [], - "headerParamDetails": [], - "cookieParams": [], - "publicCookieParams": [], - "cookieParamDetails": [], - "paramsModel": { - "publicName": "RegistryCreateApiDocumentParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" - }, - "response": { - "status": "200", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ] - }, - "result": { - "successStatus": "200", - "errorStatuses": [ - "400", - "401", - "403", - "404", - "422", - "500" - ] - }, - "errorResponses": [ - { - "status": "400", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "400", - "publicAliases": [] - } - }, - { - "status": "401", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "401", - "publicAliases": [] - } - }, - { - "status": "403", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "403", - "publicAliases": [] - } - }, - { - "status": "404", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "404", - "publicAliases": [] - } - }, - { - "status": "422", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "422", - "publicAliases": [] - } - }, - { - "status": "500", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "500", - "publicAliases": [] - } - } - ], - "responseLinks": [], - "transport": "http" - }, - { - "resource": "registry", - "publicResource": "registry", - "operation": "updateApiDocument", - "publicOperation": "updateApiDocument", - "deprecated": false, - "method": "PATCH", - "path": "/v1/apis/{namespace}/{slug}", - "pathParams": [ - "namespace", - "slug" - ], - "publicPathParams": [ - "namespace", - "slug" - ], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [ - "title", - "description", - "isPrivate", - "ruleset" - ], - "publicBodyParams": [ - "title", - "description", - "isPrivate", - "ruleset" - ], - "bodyParamDetails": [ - { - "name": "title", - "required": false - }, - { - "name": "description", - "required": false - }, - { - "name": "isPrivate", - "required": false - }, - { - "name": "ruleset", - "required": false - } - ], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - } - ], - "queryParamDetails": [], - "headerParamDetails": [], - "cookieParams": [], - "publicCookieParams": [], - "cookieParamDetails": [], - "paramsModel": { - "publicName": "RegistryUpdateApiDocumentParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" - }, - "response": { - "status": "200", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ] - }, - "result": { - "successStatus": "200", - "errorStatuses": [ - "400", - "401", - "403", - "404", - "422", - "500" - ] - }, - "errorResponses": [ - { - "status": "400", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "400", - "publicAliases": [] - } - }, - { - "status": "401", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "401", - "publicAliases": [] - } - }, - { - "status": "403", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "403", - "publicAliases": [] - } - }, - { - "status": "404", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "404", - "publicAliases": [] - } - }, - { - "status": "422", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "422", - "publicAliases": [] - } - }, - { - "status": "500", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "500", - "publicAliases": [] - } - } - ], - "responseLinks": [], - "transport": "http" - }, - { - "resource": "registry", - "publicResource": "registry", - "operation": "deleteApiDocument", - "publicOperation": "deleteApiDocument", - "deprecated": false, - "method": "DELETE", - "path": "/v1/apis/{namespace}/{slug}", - "pathParams": [ - "namespace", - "slug" - ], - "publicPathParams": [ - "namespace", - "slug" - ], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - } - ], - "queryParamDetails": [], - "headerParamDetails": [], - "cookieParams": [], - "publicCookieParams": [], - "cookieParamDetails": [], - "paramsModel": { - "publicName": "RegistryDeleteApiDocumentParams" - }, - "response": { - "status": "200", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ] - }, - "result": { - "successStatus": "200", - "errorStatuses": [ - "400", - "401", - "403", - "404", - "422", - "500" - ] - }, - "errorResponses": [ - { - "status": "400", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "400", - "publicAliases": [] - } - }, - { - "status": "401", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "401", - "publicAliases": [] - } - }, - { - "status": "403", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "403", - "publicAliases": [] - } - }, - { - "status": "404", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "404", - "publicAliases": [] - } - }, - { - "status": "422", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "422", - "publicAliases": [] - } - }, - { - "status": "500", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "500", - "publicAliases": [] - } - } - ], - "responseLinks": [], - "transport": "http" - }, - { - "resource": "registry", - "publicResource": "registry", - "operation": "retrieveApiDocumentVersion", - "publicOperation": "retrieveApiDocumentVersion", - "deprecated": false, - "method": "GET", - "path": "/v1/apis/{namespace}/{slug}/version/{semver}", - "pathParams": [ - "namespace", - "slug", - "semver" - ], - "publicPathParams": [ - "namespace", - "slug", - "semver" - ], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "semver", - "required": true, - "style": "simple", - "explode": false - } - ], - "queryParamDetails": [], - "headerParamDetails": [], - "cookieParams": [], - "publicCookieParams": [], - "cookieParamDetails": [], - "paramsModel": { - "publicName": "RegistryRetrieveApiDocumentVersionParams" - }, - "response": { - "status": "200", - "contentType": "text/plain", - "encoding": "text", - "contents": [ - { - "contentType": "text/plain", - "encoding": "text" - } - ] - }, - "result": { - "successStatus": "200", - "errorStatuses": [ - "400", - "401", - "403", - "404", - "422", - "500" - ] - }, - "errorResponses": [ - { - "status": "400", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "400", - "publicAliases": [] - } - }, - { - "status": "401", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "401", - "publicAliases": [] - } - }, - { - "status": "403", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "403", - "publicAliases": [] - } - }, - { - "status": "404", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "404", - "publicAliases": [] - } - }, - { - "status": "422", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "422", - "publicAliases": [] - } - }, - { - "status": "500", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "500", - "publicAliases": [] - } - } - ], - "responseLinks": [], - "transport": "http" - }, + } + ], + "resources": [ + "registry", + "schemas", + "schemas.version", + "schemas.accessGroup", + "loginPortals", + "accessGroups", + "accessGroups.domains", + "rules", + "themes", + "teams", + "teams.members", + "teams.invites", + "scalarDocs", + "namespaces", + "authentication", + "sdks", + "sdks.versions", + "sdks.repositories", + "mcp", + "mcp.servers", + "mcp.servers.installations" + ], + "publicResources": [ + "registry", + "schemas", + "schemas.version", + "schemas.accessGroup", + "loginPortals", + "accessGroups", + "accessGroups.domains", + "rules", + "themes", + "teams", + "teams.members", + "teams.invites", + "scalarDocs", + "namespaces", + "authentication", + "sdks", + "sdks.versions", + "sdks.repositories", + "mcp", + "mcp.servers", + "mcp.servers.installations" + ], + "operations": [ { "resource": "registry", "publicResource": "registry", - "operation": "updateApiDocumentVersion", - "publicOperation": "updateApiDocumentVersion", + "operation": "listAllApiDocuments", + "publicOperation": "listAllApiDocuments", "deprecated": false, - "method": "PATCH", - "path": "/v1/apis/{namespace}/{slug}/version/{semver}", - "pathParams": [ - "namespace", - "slug", - "semver" - ], - "publicPathParams": [ - "namespace", - "slug", - "semver" - ], + "method": "GET", + "path": "/v1/apis", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "document" - ], - "publicBodyParams": [ - "document" - ], - "bodyParamDetails": [ - { - "name": "document", - "required": true - } - ], - "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "semver", - "required": true, - "style": "simple", - "explode": false - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "RegistryUpdateApiDocumentVersionParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" - }, "response": { "status": "200", "contentType": "application/json", @@ -5741,20 +4215,16 @@ { "resource": "registry", "publicResource": "registry", - "operation": "deleteApiDocumentVersion", - "publicOperation": "deleteApiDocumentVersion", + "operation": "listApiDocuments", + "publicOperation": "listApiDocuments", "deprecated": false, - "method": "DELETE", - "path": "/v1/apis/{namespace}/{slug}/version/{semver}", + "method": "GET", + "path": "/v1/apis/{namespace}", "pathParams": [ - "namespace", - "slug", - "semver" + "namespace" ], "publicPathParams": [ - "namespace", - "slug", - "semver" + "namespace" ], "queryParams": [], "publicQueryParams": [], @@ -5769,18 +4239,6 @@ "required": true, "style": "simple", "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - }, - { - "name": "semver", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -5789,7 +4247,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryDeleteApiDocumentVersionParams" + "publicName": "RegistryListApiDocumentsParams" }, "response": { "status": "200", @@ -5911,43 +4369,72 @@ { "resource": "registry", "publicResource": "registry", - "operation": "listApiDocumentVersionMetadata", - "publicOperation": "listApiDocumentVersionMetadata", + "operation": "createApiDocument", + "publicOperation": "createApiDocument", "deprecated": false, - "method": "GET", - "path": "/v1/apis/{namespace}/{slug}/version/{semver}/metadata", + "method": "POST", + "path": "/v1/apis/{namespace}", "pathParams": [ - "namespace", - "slug", - "semver" + "namespace" ], "publicPathParams": [ - "namespace", - "slug", - "semver" + "namespace" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ + "bodyParams": [ + "title", + "description", + "version", + "slug", + "ruleset", + "isPrivate", + "document" + ], + "publicBodyParams": [ + "title", + "description", + "version", + "slug", + "ruleset", + "isPrivate", + "document" + ], + "bodyParamDetails": [ + { + "name": "title", + "required": true + }, { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false + "name": "description", + "required": false + }, + { + "name": "version", + "required": true }, { "name": "slug", - "required": true, - "style": "simple", - "explode": false + "required": true }, { - "name": "semver", + "name": "ruleset", + "required": false + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "document", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", "required": true, "style": "simple", "explode": false @@ -5959,7 +4446,20 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryListApiDocumentVersionMetadataParams" + "publicName": "RegistryCreateApiDocumentParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -5972,10 +4472,6 @@ } ] }, - "responseModel": { - "name": "managed_doc_version", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -6085,11 +4581,11 @@ { "resource": "registry", "publicResource": "registry", - "operation": "createApiDocumentVersion", - "publicOperation": "createApiDocumentVersion", + "operation": "updateApiDocument", + "publicOperation": "updateApiDocument", "deprecated": false, - "method": "POST", - "path": "/v1/apis/{namespace}/{slug}/version", + "method": "PATCH", + "path": "/v1/apis/{namespace}/{slug}", "pathParams": [ "namespace", "slug" @@ -6103,26 +4599,32 @@ "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "version", - "document", - "force" + "title", + "description", + "isPrivate", + "ruleset" ], "publicBodyParams": [ - "version", - "document", - "force" + "title", + "description", + "isPrivate", + "ruleset" ], "bodyParamDetails": [ { - "name": "version", - "required": true + "name": "title", + "required": false }, { - "name": "document", - "required": true + "name": "description", + "required": false }, { - "name": "force", + "name": "isPrivate", + "required": false + }, + { + "name": "ruleset", "required": false } ], @@ -6146,7 +4648,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryCreateApiDocumentVersionParams" + "publicName": "RegistryUpdateApiDocumentParams" }, "requestBody": { "contentType": "application/json", @@ -6172,10 +4674,6 @@ } ] }, - "responseModel": { - "name": "managed_doc_version", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -6285,11 +4783,11 @@ { "resource": "registry", "publicResource": "registry", - "operation": "createApiDocumentAccessGroup", - "publicOperation": "createApiDocumentAccessGroup", + "operation": "deleteApiDocument", + "publicOperation": "deleteApiDocument", "deprecated": false, - "method": "POST", - "path": "/v1/apis/{namespace}/{slug}/access-group", + "method": "DELETE", + "path": "/v1/apis/{namespace}/{slug}", "pathParams": [ "namespace", "slug" @@ -6302,18 +4800,9 @@ "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "accessGroupSlug" - ], - "publicBodyParams": [ - "accessGroupSlug" - ], - "bodyParamDetails": [ - { - "name": "accessGroupSlug", - "required": true - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { "name": "namespace", @@ -6334,20 +4823,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryCreateApiDocumentAccessGroupParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "RegistryDeleteApiDocumentParams" }, "response": { "status": "200", @@ -6469,35 +4945,28 @@ { "resource": "registry", "publicResource": "registry", - "operation": "deleteApiDocumentAccessGroup", - "publicOperation": "deleteApiDocumentAccessGroup", + "operation": "retrieveApiDocumentVersion", + "publicOperation": "retrieveApiDocumentVersion", "deprecated": false, - "method": "DELETE", - "path": "/v1/apis/{namespace}/{slug}/access-group", + "method": "GET", + "path": "/v1/apis/{namespace}/{slug}/version/{semver}", "pathParams": [ "namespace", - "slug" + "slug", + "semver" ], "publicPathParams": [ "namespace", - "slug" + "slug", + "semver" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "accessGroupSlug" - ], - "publicBodyParams": [ - "accessGroupSlug" - ], - "bodyParamDetails": [ - { - "name": "accessGroupSlug", - "required": true - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { "name": "namespace", @@ -6510,6 +4979,12 @@ "required": true, "style": "simple", "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false } ], "queryParamDetails": [], @@ -6518,29 +4993,16 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RegistryDeleteApiDocumentAccessGroupParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "RegistryRetrieveApiDocumentVersionParams" }, "response": { "status": "200", - "contentType": "application/json", - "encoding": "json", + "contentType": "text/plain", + "encoding": "text", "contents": [ { - "contentType": "application/json", - "encoding": "json" + "contentType": "text/plain", + "encoding": "text" } ] }, @@ -6651,32 +5113,57 @@ "transport": "http" }, { - "resource": "schemas", - "publicResource": "schemas", - "operation": "list", - "publicOperation": "list", + "resource": "registry", + "publicResource": "registry", + "operation": "updateApiDocumentVersion", + "publicOperation": "updateApiDocumentVersion", "deprecated": false, - "method": "GET", - "path": "/v1/schemas/{namespace}", + "method": "PATCH", + "path": "/v1/apis/{namespace}/{slug}/version/{semver}", "pathParams": [ - "namespace" + "namespace", + "slug", + "semver" ], "publicPathParams": [ - "namespace" + "namespace", + "slug", + "semver" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], + "bodyParams": [ + "document" + ], + "publicBodyParams": [ + "document" + ], + "bodyParamDetails": [ + { + "name": "document", + "required": true + } + ], "pathParamDetails": [ { "name": "namespace", "required": true, "style": "simple", "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false } ], "queryParamDetails": [], @@ -6685,7 +5172,20 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SchemaListParams" + "publicName": "RegistryUpdateApiDocumentVersionParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -6802,71 +5302,48 @@ } ], "responseLinks": [], - "transport": "http" - }, - { - "resource": "schemas", - "publicResource": "schemas", - "operation": "create", - "publicOperation": "create", + "transport": "http" + }, + { + "resource": "registry", + "publicResource": "registry", + "operation": "deleteApiDocumentVersion", + "publicOperation": "deleteApiDocumentVersion", "deprecated": false, - "method": "POST", - "path": "/v1/schemas/{namespace}", + "method": "DELETE", + "path": "/v1/apis/{namespace}/{slug}/version/{semver}", "pathParams": [ - "namespace" + "namespace", + "slug", + "semver" ], "publicPathParams": [ - "namespace" + "namespace", + "slug", + "semver" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "title", - "description", - "version", - "slug", - "isPrivate", - "document" - ], - "publicBodyParams": [ - "title", - "description", - "version", - "slug", - "isPrivate", - "document" - ], - "bodyParamDetails": [ - { - "name": "title", - "required": true - }, - { - "name": "description", - "required": false - }, + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "version", - "required": true + "name": "namespace", + "required": true, + "style": "simple", + "explode": false }, { "name": "slug", - "required": true - }, - { - "name": "isPrivate", - "required": false + "required": true, + "style": "simple", + "explode": false }, { - "name": "document", - "required": true - } - ], - "pathParamDetails": [ - { - "name": "namespace", + "name": "semver", "required": true, "style": "simple", "explode": false @@ -6878,20 +5355,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SchemaCreateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "RegistryDeleteApiDocumentVersionParams" }, "response": { "status": "200", @@ -6904,10 +5368,6 @@ } ] }, - "responseModel": { - "name": "uid", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -7015,49 +5475,30 @@ "transport": "http" }, { - "resource": "schemas", - "publicResource": "schemas", - "operation": "update", - "publicOperation": "update", + "resource": "registry", + "publicResource": "registry", + "operation": "listApiDocumentVersionMetadata", + "publicOperation": "listApiDocumentVersionMetadata", "deprecated": false, - "method": "PATCH", - "path": "/v1/schemas/{namespace}/{slug}", + "method": "GET", + "path": "/v1/apis/{namespace}/{slug}/version/{semver}/metadata", "pathParams": [ "namespace", - "slug" + "slug", + "semver" ], "publicPathParams": [ "namespace", - "slug" + "slug", + "semver" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "title", - "description", - "isPrivate" - ], - "publicBodyParams": [ - "title", - "description", - "isPrivate" - ], - "bodyParamDetails": [ - { - "name": "title", - "required": false - }, - { - "name": "description", - "required": false - }, - { - "name": "isPrivate", - "required": false - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { "name": "namespace", @@ -7070,6 +5511,12 @@ "required": true, "style": "simple", "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false } ], "queryParamDetails": [], @@ -7078,20 +5525,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SchemaUpdateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "RegistryListApiDocumentVersionMetadataParams" }, "response": { "status": "200", @@ -7104,6 +5538,10 @@ } ] }, + "responseModel": { + "name": "managed_doc_version", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -7211,13 +5649,13 @@ "transport": "http" }, { - "resource": "schemas", - "publicResource": "schemas", - "operation": "delete", - "publicOperation": "delete", + "resource": "registry", + "publicResource": "registry", + "operation": "createApiDocumentVersion", + "publicOperation": "createApiDocumentVersion", "deprecated": false, - "method": "DELETE", - "path": "/v1/schemas/{namespace}/{slug}", + "method": "POST", + "path": "/v1/apis/{namespace}/{slug}/version", "pathParams": [ "namespace", "slug" @@ -7230,9 +5668,30 @@ "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], + "bodyParams": [ + "version", + "document", + "force" + ], + "publicBodyParams": [ + "version", + "document", + "force" + ], + "bodyParamDetails": [ + { + "name": "version", + "required": true + }, + { + "name": "document", + "required": true + }, + { + "name": "force", + "required": false + } + ], "pathParamDetails": [ { "name": "namespace", @@ -7253,7 +5712,20 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SchemaDeleteParams" + "publicName": "RegistryCreateApiDocumentVersionParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -7266,6 +5738,10 @@ } ] }, + "responseModel": { + "name": "managed_doc_version", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -7373,45 +5849,46 @@ "transport": "http" }, { - "resource": "schemas.version", - "publicResource": "schemas.version", - "operation": "retrieve", - "publicOperation": "retrieve", + "resource": "registry", + "publicResource": "registry", + "operation": "createApiDocumentAccessGroup", + "publicOperation": "createApiDocumentAccessGroup", "deprecated": false, - "method": "GET", - "path": "/v1/schemas/{namespace}/{slug}/version/{semver}", + "method": "POST", + "path": "/v1/apis/{namespace}/{slug}/access-group", "pathParams": [ "namespace", - "slug", - "semver" + "slug" ], "publicPathParams": [ "namespace", - "slug", - "semver" + "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ + "bodyParams": [ + "accessGroupSlug" + ], + "publicBodyParams": [ + "accessGroupSlug" + ], + "bodyParamDetails": [ { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, + "name": "accessGroupSlug", + "required": true + } + ], + "pathParamDetails": [ { - "name": "slug", + "name": "namespace", "required": true, "style": "simple", "explode": false }, { - "name": "semver", + "name": "slug", "required": true, "style": "simple", "explode": false @@ -7423,16 +5900,29 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "VersionRetrieveParams" + "publicName": "RegistryCreateApiDocumentAccessGroupParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", - "contentType": "text/plain", - "encoding": "text", + "contentType": "application/json", + "encoding": "json", "contents": [ { - "contentType": "text/plain", - "encoding": "text" + "contentType": "application/json", + "encoding": "json" } ] }, @@ -7543,30 +6033,37 @@ "transport": "http" }, { - "resource": "schemas.version", - "publicResource": "schemas.version", - "operation": "delete", - "publicOperation": "delete", + "resource": "registry", + "publicResource": "registry", + "operation": "deleteApiDocumentAccessGroup", + "publicOperation": "deleteApiDocumentAccessGroup", "deprecated": false, "method": "DELETE", - "path": "/v1/schemas/{namespace}/{slug}/version/{semver}", + "path": "/v1/apis/{namespace}/{slug}/access-group", "pathParams": [ "namespace", - "slug", - "semver" + "slug" ], "publicPathParams": [ "namespace", - "slug", - "semver" + "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], + "bodyParams": [ + "accessGroupSlug" + ], + "publicBodyParams": [ + "accessGroupSlug" + ], + "bodyParamDetails": [ + { + "name": "accessGroupSlug", + "required": true + } + ], "pathParamDetails": [ { "name": "namespace", @@ -7579,12 +6076,6 @@ "required": true, "style": "simple", "explode": false - }, - { - "name": "semver", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -7593,7 +6084,20 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "VersionDeleteParams" + "publicName": "RegistryDeleteApiDocumentAccessGroupParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -7713,61 +6217,32 @@ "transport": "http" }, { - "resource": "schemas.version", - "publicResource": "schemas.version", - "operation": "create", - "publicOperation": "create", + "resource": "schemas", + "publicResource": "schemas", + "operation": "list", + "publicOperation": "list", "deprecated": false, - "method": "POST", - "path": "/v1/schemas/{namespace}/{slug}/version", + "method": "GET", + "path": "/v1/schemas/{namespace}", "pathParams": [ - "namespace", - "slug" + "namespace" ], "publicPathParams": [ - "namespace", - "slug" + "namespace" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "version", - "document", - "force" - ], - "publicBodyParams": [ - "version", - "document", - "force" - ], - "bodyParamDetails": [ - { - "name": "version", - "required": true - }, - { - "name": "document", - "required": true - }, - { - "name": "force", - "required": false - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { "name": "namespace", "required": true, "style": "simple", "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -7776,20 +6251,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "VersionCreateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "SchemaListParams" }, "response": { "status": "200", @@ -7909,34 +6371,62 @@ "transport": "http" }, { - "resource": "schemas.accessGroup", - "publicResource": "schemas.accessGroup", + "resource": "schemas", + "publicResource": "schemas", "operation": "create", "publicOperation": "create", "deprecated": false, "method": "POST", - "path": "/v1/schemas/{namespace}/{slug}/access-group", + "path": "/v1/schemas/{namespace}", "pathParams": [ - "namespace", - "slug" + "namespace" ], "publicPathParams": [ - "namespace", - "slug" + "namespace" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "accessGroupSlug" + "title", + "description", + "version", + "slug", + "isPrivate", + "document" ], "publicBodyParams": [ - "accessGroupSlug" + "title", + "description", + "version", + "slug", + "isPrivate", + "document" ], "bodyParamDetails": [ { - "name": "accessGroupSlug", + "name": "title", + "required": true + }, + { + "name": "description", + "required": false + }, + { + "name": "version", + "required": true + }, + { + "name": "slug", + "required": true + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "document", "required": true } ], @@ -7946,12 +6436,6 @@ "required": true, "style": "simple", "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -7960,7 +6444,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "AccessGroupCreateParams" + "publicName": "SchemaCreateParams" }, "requestBody": { "contentType": "application/json", @@ -7986,6 +6470,10 @@ } ] }, + "responseModel": { + "name": "uid", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -8093,13 +6581,13 @@ "transport": "http" }, { - "resource": "schemas.accessGroup", - "publicResource": "schemas.accessGroup", - "operation": "delete", - "publicOperation": "delete", + "resource": "schemas", + "publicResource": "schemas", + "operation": "update", + "publicOperation": "update", "deprecated": false, - "method": "DELETE", - "path": "/v1/schemas/{namespace}/{slug}/access-group", + "method": "PATCH", + "path": "/v1/schemas/{namespace}/{slug}", "pathParams": [ "namespace", "slug" @@ -8113,15 +6601,27 @@ "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "accessGroupSlug" + "title", + "description", + "isPrivate" ], "publicBodyParams": [ - "accessGroupSlug" + "title", + "description", + "isPrivate" ], "bodyParamDetails": [ { - "name": "accessGroupSlug", - "required": true + "name": "title", + "required": false + }, + { + "name": "description", + "required": false + }, + { + "name": "isPrivate", + "required": false } ], "pathParamDetails": [ @@ -8144,7 +6644,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "AccessGroupDeleteParams" + "publicName": "SchemaUpdateParams" }, "requestBody": { "contentType": "application/json", @@ -8277,17 +6777,19 @@ "transport": "http" }, { - "resource": "loginPortals", - "publicResource": "loginPortals", - "operation": "retrieve", - "publicOperation": "retrieve", + "resource": "schemas", + "publicResource": "schemas", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, - "method": "GET", - "path": "/v1/login-portals/{slug}", + "method": "DELETE", + "path": "/v1/schemas/{namespace}/{slug}", "pathParams": [ + "namespace", "slug" ], "publicPathParams": [ + "namespace", "slug" ], "queryParams": [], @@ -8298,6 +6800,12 @@ "publicBodyParams": [], "bodyParamDetails": [], "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, { "name": "slug", "required": true, @@ -8311,7 +6819,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "LoginPortalRetrieveParams" + "publicName": "SchemaDeleteParams" }, "response": { "status": "200", @@ -8431,41 +6939,48 @@ "transport": "http" }, { - "resource": "loginPortals", - "publicResource": "loginPortals", - "operation": "update", - "publicOperation": "update", + "resource": "schemas.version", + "publicResource": "schemas.version", + "operation": "retrieve", + "publicOperation": "retrieve", "deprecated": false, - "method": "PATCH", - "path": "/v1/login-portals/{slug}", + "method": "GET", + "path": "/v1/schemas/{namespace}/{slug}/version/{semver}", "pathParams": [ - "slug" + "namespace", + "slug", + "semver" ], "publicPathParams": [ - "slug" + "namespace", + "slug", + "semver" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "title" - ], - "publicBodyParams": [ - "title" - ], - "bodyParamDetails": [ - { - "name": "title", - "required": false - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, { "name": "slug", "required": true, "style": "simple", "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false } ], "queryParamDetails": [], @@ -8474,29 +6989,16 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "LoginPortalUpdateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "VersionRetrieveParams" }, "response": { "status": "200", - "contentType": "application/json", - "encoding": "json", + "contentType": "text/plain", + "encoding": "text", "contents": [ { - "contentType": "application/json", - "encoding": "json" + "contentType": "text/plain", + "encoding": "text" } ] }, @@ -8607,18 +7109,22 @@ "transport": "http" }, { - "resource": "loginPortals", - "publicResource": "loginPortals", + "resource": "schemas.version", + "publicResource": "schemas.version", "operation": "delete", "publicOperation": "delete", "deprecated": false, "method": "DELETE", - "path": "/v1/login-portals/{slug}", + "path": "/v1/schemas/{namespace}/{slug}/version/{semver}", "pathParams": [ - "slug" + "namespace", + "slug", + "semver" ], "publicPathParams": [ - "slug" + "namespace", + "slug", + "semver" ], "queryParams": [], "publicQueryParams": [], @@ -8628,11 +7134,23 @@ "publicBodyParams": [], "bodyParamDetails": [], "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, { "name": "slug", "required": true, "style": "simple", "explode": false + }, + { + "name": "semver", + "required": true, + "style": "simple", + "explode": false } ], "queryParamDetails": [], @@ -8641,7 +7159,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "LoginPortalDeleteParams" + "publicName": "VersionDeleteParams" }, "response": { "status": "200", @@ -8761,57 +7279,70 @@ "transport": "http" }, { - "resource": "loginPortals", - "publicResource": "loginPortals", + "resource": "schemas.version", + "publicResource": "schemas.version", "operation": "create", "publicOperation": "create", "deprecated": false, "method": "POST", - "path": "/v1/login-portals", - "pathParams": [], - "publicPathParams": [], + "path": "/v1/schemas/{namespace}/{slug}/version", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "title", - "slug", - "email", - "page" + "version", + "document", + "force" ], "publicBodyParams": [ - "title", - "slug", - "email", - "page" + "version", + "document", + "force" ], "bodyParamDetails": [ { - "name": "title", + "name": "version", "required": true }, { - "name": "slug", + "name": "document", "required": true }, { - "name": "email", - "required": true + "name": "force", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false }, { - "name": "page", - "required": true + "name": "slug", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "LoginPortalCreateParams" + "publicName": "VersionCreateParams" }, "requestBody": { "contentType": "application/json", @@ -8837,10 +7368,6 @@ } ] }, - "responseModel": { - "name": "uid", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -8948,28 +7475,72 @@ "transport": "http" }, { - "resource": "loginPortals", - "publicResource": "loginPortals", - "operation": "list", - "publicOperation": "list", + "resource": "schemas.accessGroup", + "publicResource": "schemas.accessGroup", + "operation": "create", + "publicOperation": "create", "deprecated": false, - "method": "GET", - "path": "/v1/login-portals", - "pathParams": [], - "publicPathParams": [], + "method": "POST", + "path": "/v1/schemas/{namespace}/{slug}/access-group", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], + "bodyParams": [ + "accessGroupSlug" + ], + "publicBodyParams": [ + "accessGroupSlug" + ], + "bodyParamDetails": [ + { + "name": "accessGroupSlug", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "AccessGroupCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -9088,51 +7659,58 @@ "transport": "http" }, { - "resource": "accessGroups", - "publicResource": "accessGroups", - "operation": "create", - "publicOperation": "create", + "resource": "schemas.accessGroup", + "publicResource": "schemas.accessGroup", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, - "method": "POST", - "path": "/v1/access-groups", - "pathParams": [], - "publicPathParams": [], + "method": "DELETE", + "path": "/v1/schemas/{namespace}/{slug}/access-group", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "name", - "slug", - "allowedDomains" + "bodyParams": [ + "accessGroupSlug" ], "publicBodyParams": [ - "name", - "slug", - "allowedDomains" + "accessGroupSlug" ], "bodyParamDetails": [ { - "name": "name", - "required": false - }, + "name": "accessGroupSlug", + "required": true + } + ], + "pathParamDetails": [ { - "name": "slug", - "required": false + "name": "namespace", + "required": true, + "style": "simple", + "explode": false }, { - "name": "allowedDomains", - "required": false + "name": "slug", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "AccessGroupCreateParams" + "publicName": "AccessGroupDeleteParams" }, "requestBody": { "contentType": "application/json", @@ -9265,13 +7843,13 @@ "transport": "http" }, { - "resource": "accessGroups", - "publicResource": "accessGroups", + "resource": "loginPortals", + "publicResource": "loginPortals", "operation": "retrieve", "publicOperation": "retrieve", "deprecated": false, "method": "GET", - "path": "/v1/access-groups/{slug}", + "path": "/v1/login-portals/{slug}", "pathParams": [ "slug" ], @@ -9299,7 +7877,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "AccessGroupRetrieveParams" + "publicName": "LoginPortalRetrieveParams" }, "response": { "status": "200", @@ -9419,13 +7997,13 @@ "transport": "http" }, { - "resource": "accessGroups", - "publicResource": "accessGroups", + "resource": "loginPortals", + "publicResource": "loginPortals", "operation": "update", "publicOperation": "update", "deprecated": false, "method": "PATCH", - "path": "/v1/access-groups/{slug}", + "path": "/v1/login-portals/{slug}", "pathParams": [ "slug" ], @@ -9437,20 +8015,14 @@ "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "name", - "slug" + "title" ], "publicBodyParams": [ - "name", - "slug" + "title" ], "bodyParamDetails": [ { - "name": "name", - "required": false - }, - { - "name": "slug", + "name": "title", "required": false } ], @@ -9468,7 +8040,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "AccessGroupUpdateParams" + "publicName": "LoginPortalUpdateParams" }, "requestBody": { "contentType": "application/json", @@ -9601,13 +8173,13 @@ "transport": "http" }, { - "resource": "accessGroups", - "publicResource": "accessGroups", + "resource": "loginPortals", + "publicResource": "loginPortals", "operation": "delete", "publicOperation": "delete", "deprecated": false, "method": "DELETE", - "path": "/v1/access-groups/{slug}", + "path": "/v1/login-portals/{slug}", "pathParams": [ "slug" ], @@ -9635,7 +8207,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "AccessGroupDeleteParams" + "publicName": "LoginPortalDeleteParams" }, "response": { "status": "200", @@ -9755,64 +8327,215 @@ "transport": "http" }, { - "resource": "accessGroups.domains", - "publicResource": "accessGroups.domains", + "resource": "loginPortals", + "publicResource": "loginPortals", "operation": "create", "publicOperation": "create", "deprecated": false, "method": "POST", - "path": "/v1/access-groups/{slug}/domains", - "pathParams": [ - "slug" - ], - "publicPathParams": [ - "slug" - ], + "path": "/v1/login-portals", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "domain" + "title", + "slug", + "email", + "page" ], "publicBodyParams": [ - "domain" + "title", + "slug", + "email", + "page" ], "bodyParamDetails": [ { - "name": "domain", + "name": "title", + "required": true + }, + { + "name": "slug", + "required": true + }, + { + "name": "email", + "required": true + }, + { + "name": "page", "required": true } ], - "pathParamDetails": [ + "pathParamDetails": [], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "LoginPortalCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "responseModel": { + "name": "uid", + "publicAliases": [] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ { - "name": "slug", - "required": true, - "style": "simple", - "explode": false + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } } ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "loginPortals", + "publicResource": "loginPortals", + "operation": "list", + "publicOperation": "list", + "deprecated": false, + "method": "GET", + "path": "/v1/login-portals", + "pathParams": [], + "publicPathParams": [], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "DomainCreateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" - }, "response": { "status": "200", "contentType": "application/json", @@ -9931,50 +8654,51 @@ "transport": "http" }, { - "resource": "accessGroups.domains", - "publicResource": "accessGroups.domains", - "operation": "delete", - "publicOperation": "delete", + "resource": "accessGroups", + "publicResource": "accessGroups", + "operation": "create", + "publicOperation": "create", "deprecated": false, - "method": "DELETE", - "path": "/v1/access-groups/{slug}/domains", - "pathParams": [ - "slug" - ], - "publicPathParams": [ - "slug" - ], + "method": "POST", + "path": "/v1/access-groups", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "domain" + "name", + "slug", + "allowedDomains" ], "publicBodyParams": [ - "domain" + "name", + "slug", + "allowedDomains" ], "bodyParamDetails": [ { - "name": "domain", - "required": true - } - ], - "pathParamDetails": [ + "name": "name", + "required": false + }, { "name": "slug", - "required": true, - "style": "simple", - "explode": false + "required": false + }, + { + "name": "allowedDomains", + "required": false } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "DomainDeleteParams" + "publicName": "AccessGroupCreateParams" }, "requestBody": { "contentType": "application/json", @@ -10107,18 +8831,18 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "listRulesets", - "publicOperation": "listRulesets", + "resource": "accessGroups", + "publicResource": "accessGroups", + "operation": "retrieve", + "publicOperation": "retrieve", "deprecated": false, "method": "GET", - "path": "/v1/rulesets/{namespace}", + "path": "/v1/access-groups/{slug}", "pathParams": [ - "namespace" + "slug" ], "publicPathParams": [ - "namespace" + "slug" ], "queryParams": [], "publicQueryParams": [], @@ -10129,7 +8853,7 @@ "bodyParamDetails": [], "pathParamDetails": [ { - "name": "namespace", + "name": "slug", "required": true, "style": "simple", "explode": false @@ -10141,7 +8865,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleListRulesetsParams" + "publicName": "AccessGroupRetrieveParams" }, "response": { "status": "200", @@ -10261,62 +8985,44 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "createRuleset", - "publicOperation": "createRuleset", + "resource": "accessGroups", + "publicResource": "accessGroups", + "operation": "update", + "publicOperation": "update", "deprecated": false, - "method": "POST", - "path": "/v1/rulesets/{namespace}", + "method": "PATCH", + "path": "/v1/access-groups/{slug}", "pathParams": [ - "namespace" + "slug" ], "publicPathParams": [ - "namespace" + "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "title", - "description", - "slug", - "isPrivate", - "document" + "name", + "slug" ], "publicBodyParams": [ - "title", - "description", - "slug", - "isPrivate", - "document" + "name", + "slug" ], "bodyParamDetails": [ { - "name": "title", - "required": true - }, - { - "name": "description", + "name": "name", "required": false }, { "name": "slug", - "required": true - }, - { - "name": "isPrivate", "required": false - }, - { - "name": "document", - "required": true } ], "pathParamDetails": [ { - "name": "namespace", + "name": "slug", "required": true, "style": "simple", "explode": false @@ -10328,7 +9034,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleCreateRulesetParams" + "publicName": "AccessGroupUpdateParams" }, "requestBody": { "contentType": "application/json", @@ -10354,10 +9060,6 @@ } ] }, - "responseModel": { - "name": "uid", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -10465,68 +9167,27 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "updateRuleset", - "publicOperation": "updateRuleset", + "resource": "accessGroups", + "publicResource": "accessGroups", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, - "method": "PATCH", - "path": "/v1/rulesets/{namespace}/{slug}", + "method": "DELETE", + "path": "/v1/access-groups/{slug}", "pathParams": [ - "namespace", "slug" ], "publicPathParams": [ - "namespace", "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "namespace", - "slug", - "title", - "description", - "isPrivate" - ], - "publicBodyParams": [ - "namespace", - "slug", - "title", - "description", - "isPrivate" - ], - "bodyParamDetails": [ - { - "name": "namespace", - "required": false - }, - { - "name": "slug", - "required": false - }, - { - "name": "title", - "required": false - }, - { - "name": "description", - "required": false - }, - { - "name": "isPrivate", - "required": false - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ - { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, { "name": "slug", "required": true, @@ -10540,20 +9201,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleUpdateRulesetParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "AccessGroupDeleteParams" }, "response": { "status": "200", @@ -10673,35 +9321,36 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "deleteRuleset", - "publicOperation": "deleteRuleset", + "resource": "accessGroups.domains", + "publicResource": "accessGroups.domains", + "operation": "create", + "publicOperation": "create", "deprecated": false, - "method": "DELETE", - "path": "/v1/rulesets/{namespace}/{slug}", + "method": "POST", + "path": "/v1/access-groups/{slug}/domains", "pathParams": [ - "namespace", "slug" ], "publicPathParams": [ - "namespace", "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ + "bodyParams": [ + "domain" + ], + "publicBodyParams": [ + "domain" + ], + "bodyParamDetails": [ { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, + "name": "domain", + "required": true + } + ], + "pathParamDetails": [ { "name": "slug", "required": true, @@ -10715,7 +9364,20 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleDeleteRulesetParams" + "publicName": "DomainCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -10835,35 +9497,36 @@ "transport": "http" }, { - "resource": "rules", - "publicResource": "rules", - "operation": "retrieveRulesetDocument", - "publicOperation": "retrieveRulesetDocument", + "resource": "accessGroups.domains", + "publicResource": "accessGroups.domains", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, - "method": "GET", - "path": "/v1/rulesets/{namespace}/{slug}", + "method": "DELETE", + "path": "/v1/access-groups/{slug}/domains", "pathParams": [ - "namespace", "slug" ], "publicPathParams": [ - "namespace", "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ + "bodyParams": [ + "domain" + ], + "publicBodyParams": [ + "domain" + ], + "bodyParamDetails": [ { - "name": "namespace", - "required": true, - "style": "simple", - "explode": false - }, + "name": "domain", + "required": true + } + ], + "pathParamDetails": [ { "name": "slug", "required": true, @@ -10877,16 +9540,29 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleRetrieveRulesetDocumentParams" + "publicName": "DomainDeleteParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", - "contentType": "text/plain", - "encoding": "text", + "contentType": "application/json", + "encoding": "json", "contents": [ { - "contentType": "text/plain", - "encoding": "text" + "contentType": "application/json", + "encoding": "json" } ] }, @@ -10999,47 +9675,30 @@ { "resource": "rules", "publicResource": "rules", - "operation": "createRulesetAccessGroup", - "publicOperation": "createRulesetAccessGroup", + "operation": "listRulesets", + "publicOperation": "listRulesets", "deprecated": false, - "method": "POST", - "path": "/v1/rulesets/{namespace}/{slug}/access-group", + "method": "GET", + "path": "/v1/rulesets/{namespace}", "pathParams": [ - "namespace", - "slug" + "namespace" ], "publicPathParams": [ - "namespace", - "slug" + "namespace" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "accessGroupSlug" - ], - "publicBodyParams": [ - "accessGroupSlug" - ], - "bodyParamDetails": [ - { - "name": "accessGroupSlug", - "required": true - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { "name": "namespace", "required": true, "style": "simple", "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -11048,20 +9707,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleCreateRulesetAccessGroupParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "RuleListRulesetsParams" }, "response": { "status": "200", @@ -11183,32 +9829,54 @@ { "resource": "rules", "publicResource": "rules", - "operation": "deleteRulesetAccessGroup", - "publicOperation": "deleteRulesetAccessGroup", + "operation": "createRuleset", + "publicOperation": "createRuleset", "deprecated": false, - "method": "DELETE", - "path": "/v1/rulesets/{namespace}/{slug}/access-group", + "method": "POST", + "path": "/v1/rulesets/{namespace}", "pathParams": [ - "namespace", - "slug" + "namespace" ], "publicPathParams": [ - "namespace", - "slug" + "namespace" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "accessGroupSlug" + "title", + "description", + "slug", + "isPrivate", + "document" ], "publicBodyParams": [ - "accessGroupSlug" + "title", + "description", + "slug", + "isPrivate", + "document" ], "bodyParamDetails": [ { - "name": "accessGroupSlug", + "name": "title", + "required": true + }, + { + "name": "description", + "required": false + }, + { + "name": "slug", + "required": true + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "document", "required": true } ], @@ -11218,12 +9886,6 @@ "required": true, "style": "simple", "explode": false - }, - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -11232,7 +9894,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RuleDeleteRulesetAccessGroupParams" + "publicName": "RuleCreateRulesetParams" }, "requestBody": { "contentType": "application/json", @@ -11258,6 +9920,10 @@ } ] }, + "responseModel": { + "name": "uid", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -11346,47 +10012,115 @@ } }, { - "status": "500", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "500", - "publicAliases": [] - } + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "rules", + "publicResource": "rules", + "operation": "updateRuleset", + "publicOperation": "updateRuleset", + "deprecated": false, + "method": "PATCH", + "path": "/v1/rulesets/{namespace}/{slug}", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "namespace", + "slug", + "title", + "description", + "isPrivate" + ], + "publicBodyParams": [ + "namespace", + "slug", + "title", + "description", + "isPrivate" + ], + "bodyParamDetails": [ + { + "name": "namespace", + "required": false + }, + { + "name": "slug", + "required": false + }, + { + "name": "title", + "required": false + }, + { + "name": "description", + "required": false + }, + { + "name": "isPrivate", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false } ], - "responseLinks": [], - "transport": "http" - }, - { - "resource": "themes", - "publicResource": "themes", - "operation": "list", - "publicOperation": "list", - "deprecated": false, - "method": "GET", - "path": "/v1/themes", - "pathParams": [], - "publicPathParams": [], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "RuleUpdateRulesetParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -11505,70 +10239,49 @@ "transport": "http" }, { - "resource": "themes", - "publicResource": "themes", - "operation": "create", - "publicOperation": "create", + "resource": "rules", + "publicResource": "rules", + "operation": "deleteRuleset", + "publicOperation": "deleteRuleset", "deprecated": false, - "method": "POST", - "path": "/v1/themes", - "pathParams": [], - "publicPathParams": [], + "method": "DELETE", + "path": "/v1/rulesets/{namespace}/{slug}", + "pathParams": [ + "namespace", + "slug" + ], + "publicPathParams": [ + "namespace", + "slug" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "name", - "description", - "slug", - "document" - ], - "publicBodyParams": [ - "name", - "description", - "slug", - "document" - ], - "bodyParamDetails": [ - { - "name": "name", - "required": true - }, + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "description", - "required": false + "name": "namespace", + "required": true, + "style": "simple", + "explode": false }, { "name": "slug", - "required": true - }, - { - "name": "document", - "required": true + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ThemeCreateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "RuleDeleteRulesetParams" }, "response": { "status": "200", @@ -11581,10 +10294,6 @@ } ] }, - "responseModel": { - "name": "uid", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -11692,42 +10401,35 @@ "transport": "http" }, { - "resource": "themes", - "publicResource": "themes", - "operation": "update", - "publicOperation": "update", + "resource": "rules", + "publicResource": "rules", + "operation": "retrieveRulesetDocument", + "publicOperation": "retrieveRulesetDocument", "deprecated": false, - "method": "PATCH", - "path": "/v1/themes/{slug}", + "method": "GET", + "path": "/v1/rulesets/{namespace}/{slug}", "pathParams": [ + "namespace", "slug" ], "publicPathParams": [ + "namespace", "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "name", - "description" - ], - "publicBodyParams": [ - "name", - "description" - ], - "bodyParamDetails": [ + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "name", - "required": false + "name": "namespace", + "required": true, + "style": "simple", + "explode": false }, - { - "name": "description", - "required": false - } - ], - "pathParamDetails": [ { "name": "slug", "required": true, @@ -11741,29 +10443,16 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ThemeUpdateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "RuleRetrieveRulesetDocumentParams" }, "response": { "status": "200", - "contentType": "application/json", - "encoding": "json", + "contentType": "text/plain", + "encoding": "text", "contents": [ { - "contentType": "application/json", - "encoding": "json" + "contentType": "text/plain", + "encoding": "text" } ] }, @@ -11874,17 +10563,19 @@ "transport": "http" }, { - "resource": "themes", - "publicResource": "themes", - "operation": "replaceDocument", - "publicOperation": "replaceDocument", + "resource": "rules", + "publicResource": "rules", + "operation": "createRulesetAccessGroup", + "publicOperation": "createRulesetAccessGroup", "deprecated": false, - "method": "PUT", - "path": "/v1/themes/{slug}", + "method": "POST", + "path": "/v1/rulesets/{namespace}/{slug}/access-group", "pathParams": [ + "namespace", "slug" ], "publicPathParams": [ + "namespace", "slug" ], "queryParams": [], @@ -11892,18 +10583,24 @@ "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "document" + "accessGroupSlug" ], "publicBodyParams": [ - "document" + "accessGroupSlug" ], "bodyParamDetails": [ { - "name": "document", + "name": "accessGroupSlug", "required": true } ], "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, { "name": "slug", "required": true, @@ -11917,7 +10614,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ThemeReplaceDocumentParams" + "publicName": "RuleCreateRulesetAccessGroupParams" }, "requestBody": { "contentType": "application/json", @@ -12050,27 +10747,44 @@ "transport": "http" }, { - "resource": "themes", - "publicResource": "themes", - "operation": "delete", - "publicOperation": "delete", + "resource": "rules", + "publicResource": "rules", + "operation": "deleteRulesetAccessGroup", + "publicOperation": "deleteRulesetAccessGroup", "deprecated": false, "method": "DELETE", - "path": "/v1/themes/{slug}", + "path": "/v1/rulesets/{namespace}/{slug}/access-group", "pathParams": [ + "namespace", "slug" ], "publicPathParams": [ + "namespace", "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], + "bodyParams": [ + "accessGroupSlug" + ], + "publicBodyParams": [ + "accessGroupSlug" + ], + "bodyParamDetails": [ + { + "name": "accessGroupSlug", + "required": true + } + ], "pathParamDetails": [ + { + "name": "namespace", + "required": true, + "style": "simple", + "explode": false + }, { "name": "slug", "required": true, @@ -12084,7 +10798,20 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ThemeDeleteParams" + "publicName": "RuleDeleteRulesetAccessGroupParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -12206,17 +10933,13 @@ { "resource": "themes", "publicResource": "themes", - "operation": "retrieve", - "publicOperation": "retrieve", + "operation": "list", + "publicOperation": "list", "deprecated": false, "method": "GET", - "path": "/v1/themes/{slug}", - "pathParams": [ - "slug" - ], - "publicPathParams": [ - "slug" - ], + "path": "/v1/themes", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -12224,30 +10947,20 @@ "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - } - ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "ThemeRetrieveParams" - }, "response": { "status": "200", - "contentType": "text/plain", - "encoding": "text", + "contentType": "application/json", + "encoding": "json", "contents": [ { - "contentType": "text/plain", - "encoding": "text" + "contentType": "application/json", + "encoding": "json" } ] }, @@ -12358,28 +11071,71 @@ "transport": "http" }, { - "resource": "teams", - "publicResource": "teams", - "operation": "list", - "publicOperation": "list", + "resource": "themes", + "publicResource": "themes", + "operation": "create", + "publicOperation": "create", "deprecated": false, - "method": "GET", - "path": "/v1/teams", + "method": "POST", + "path": "/v1/themes", "pathParams": [], "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], + "bodyParams": [ + "name", + "description", + "slug", + "document" + ], + "publicBodyParams": [ + "name", + "description", + "slug", + "document" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": true + }, + { + "name": "description", + "required": false + }, + { + "name": "slug", + "required": true + }, + { + "name": "document", + "required": true + } + ], "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "ThemeCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -12391,6 +11147,10 @@ } ] }, + "responseModel": { + "name": "uid", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -12498,28 +11258,70 @@ "transport": "http" }, { - "resource": "teams.members", - "publicResource": "teams.members", - "operation": "list", - "publicOperation": "list", + "resource": "themes", + "publicResource": "themes", + "operation": "update", + "publicOperation": "update", "deprecated": false, - "method": "GET", - "path": "/v1/teams/members", - "pathParams": [], - "publicPathParams": [], + "method": "PATCH", + "path": "/v1/themes/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], + "bodyParams": [ + "name", + "description" + ], + "publicBodyParams": [ + "name", + "description" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": false + }, + { + "name": "description", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "ThemeUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -12638,38 +11440,38 @@ "transport": "http" }, { - "resource": "teams.members", - "publicResource": "teams.members", - "operation": "update", - "publicOperation": "update", + "resource": "themes", + "publicResource": "themes", + "operation": "replaceDocument", + "publicOperation": "replaceDocument", "deprecated": false, - "method": "PATCH", - "path": "/v1/teams/members/{uid}", + "method": "PUT", + "path": "/v1/themes/{slug}", "pathParams": [ - "uid" + "slug" ], "publicPathParams": [ - "uid" + "slug" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "role" + "document" ], "publicBodyParams": [ - "role" + "document" ], "bodyParamDetails": [ { - "name": "role", + "name": "document", "required": true } ], "pathParamDetails": [ { - "name": "uid", + "name": "slug", "required": true, "style": "simple", "explode": false @@ -12681,7 +11483,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "MemberUpdateParams" + "publicName": "ThemeReplaceDocumentParams" }, "requestBody": { "contentType": "application/json", @@ -12814,18 +11616,18 @@ "transport": "http" }, { - "resource": "teams.members", - "publicResource": "teams.members", + "resource": "themes", + "publicResource": "themes", "operation": "delete", "publicOperation": "delete", "deprecated": false, "method": "DELETE", - "path": "/v1/teams/members/{uid}", + "path": "/v1/themes/{slug}", "pathParams": [ - "uid" + "slug" ], "publicPathParams": [ - "uid" + "slug" ], "queryParams": [], "publicQueryParams": [], @@ -12836,7 +11638,7 @@ "bodyParamDetails": [], "pathParamDetails": [ { - "name": "uid", + "name": "slug", "required": true, "style": "simple", "explode": false @@ -12848,7 +11650,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "MemberDeleteParams" + "publicName": "ThemeDeleteParams" }, "response": { "status": "200", @@ -12968,67 +11770,50 @@ "transport": "http" }, { - "resource": "teams.invites", - "publicResource": "teams.invites", - "operation": "member", - "publicOperation": "member", + "resource": "themes", + "publicResource": "themes", + "operation": "retrieve", + "publicOperation": "retrieve", "deprecated": false, - "method": "POST", - "path": "/v1/teams/invites", - "pathParams": [], - "publicPathParams": [], + "method": "GET", + "path": "/v1/themes/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "email", - "role" - ], - "publicBodyParams": [ - "email", - "role" - ], - "bodyParamDetails": [ - { - "name": "email", - "required": true - }, + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "role", - "required": true + "name": "slug", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "InviteMemberParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "ThemeRetrieveParams" }, "response": { "status": "200", - "contentType": "application/json", - "encoding": "json", + "contentType": "text/plain", + "encoding": "text", "contents": [ { - "contentType": "application/json", - "encoding": "json" + "contentType": "text/plain", + "encoding": "text" } ] }, @@ -13139,19 +11924,15 @@ "transport": "http" }, { - "resource": "teams.invites", - "publicResource": "teams.invites", - "operation": "resend", - "publicOperation": "resend", + "resource": "teams", + "publicResource": "teams", + "operation": "list", + "publicOperation": "list", "deprecated": false, - "method": "PATCH", - "path": "/v1/teams/invites/{uid}", - "pathParams": [ - "uid" - ], - "publicPathParams": [ - "uid" - ], + "method": "GET", + "path": "/v1/teams", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -13159,22 +11940,12 @@ "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "uid", - "required": true, - "style": "simple", - "explode": false - } - ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "InviteResendParams" - }, "response": { "status": "200", "contentType": "application/json", @@ -13293,19 +12064,15 @@ "transport": "http" }, { - "resource": "teams.invites", - "publicResource": "teams.invites", - "operation": "cancel", - "publicOperation": "cancel", + "resource": "teams.members", + "publicResource": "teams.members", + "operation": "list", + "publicOperation": "list", "deprecated": false, - "method": "DELETE", - "path": "/v1/teams/invites/{uid}", - "pathParams": [ - "uid" - ], - "publicPathParams": [ - "uid" - ], + "method": "GET", + "path": "/v1/teams/members", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -13313,22 +12080,12 @@ "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "uid", - "required": true, - "style": "simple", - "explode": false - } - ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "InviteCancelParams" - }, "response": { "status": "200", "contentType": "application/json", @@ -13447,28 +12204,64 @@ "transport": "http" }, { - "resource": "scalarDocs", - "publicResource": "scalarDocs", - "operation": "listGuides", - "publicOperation": "listGuides", + "resource": "teams.members", + "publicResource": "teams.members", + "operation": "update", + "publicOperation": "update", "deprecated": false, - "method": "GET", - "path": "/v1/guides", - "pathParams": [], - "publicPathParams": [], + "method": "PATCH", + "path": "/v1/teams/members/{uid}", + "pathParams": [ + "uid" + ], + "publicPathParams": [ + "uid" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], + "bodyParams": [ + "role" + ], + "publicBodyParams": [ + "role" + ], + "bodyParamDetails": [ + { + "name": "role", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "uid", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "MemberUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -13587,76 +12380,41 @@ "transport": "http" }, { - "resource": "scalarDocs", - "publicResource": "scalarDocs", - "operation": "createGuide", - "publicOperation": "createGuide", + "resource": "teams.members", + "publicResource": "teams.members", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, - "method": "POST", - "path": "/v1/guides", - "pathParams": [], - "publicPathParams": [], + "method": "DELETE", + "path": "/v1/teams/members/{uid}", + "pathParams": [ + "uid" + ], + "publicPathParams": [ + "uid" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "name", - "slug", - "isPrivate", - "allowedUsers", - "allowedDomains" - ], - "publicBodyParams": [ - "name", - "slug", - "isPrivate", - "allowedUsers", - "allowedDomains" - ], - "bodyParamDetails": [ - { - "name": "name", - "required": true - }, - { - "name": "slug", - "required": false - }, - { - "name": "isPrivate", - "required": true - }, - { - "name": "allowedUsers", - "required": true - }, + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "allowedDomains", - "required": true + "name": "uid", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocCreateGuideParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "MemberDeleteParams" }, "response": { "status": "200", @@ -13776,41 +12534,58 @@ "transport": "http" }, { - "resource": "scalarDocs", - "publicResource": "scalarDocs", - "operation": "publishGuide", - "publicOperation": "publishGuide", + "resource": "teams.invites", + "publicResource": "teams.invites", + "operation": "member", + "publicOperation": "member", "deprecated": false, "method": "POST", - "path": "/v1/guides/{slug}/publish", - "pathParams": [ - "slug" - ], - "publicPathParams": [ - "slug" - ], + "path": "/v1/teams/invites", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ + "bodyParams": [ + "email", + "role" + ], + "publicBodyParams": [ + "email", + "role" + ], + "bodyParamDetails": [ { - "name": "slug", - "required": true, - "style": "simple", - "explode": false + "name": "email", + "required": true + }, + { + "name": "role", + "required": true } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocPublishGuideParams" + "publicName": "InviteMemberParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -13930,41 +12705,41 @@ "transport": "http" }, { - "resource": "scalarDocs", - "publicResource": "scalarDocs", - "operation": "listProjects", - "publicOperation": "listProjects", + "resource": "teams.invites", + "publicResource": "teams.invites", + "operation": "resend", + "publicOperation": "resend", "deprecated": false, - "method": "GET", - "path": "/v1/docs", - "pathParams": [], - "publicPathParams": [], - "queryParams": [ - "limit" + "method": "PATCH", + "path": "/v1/teams/invites/{uid}", + "pathParams": [ + "uid" ], - "publicQueryParams": [ - "limit" + "publicPathParams": [ + "uid" ], + "queryParams": [], + "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [], - "queryParamDetails": [ + "pathParamDetails": [ { - "name": "limit", - "required": false, - "style": "form", - "explode": true + "name": "uid", + "required": true, + "style": "simple", + "explode": false } ], + "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocListProjectsParams" + "publicName": "InviteResendParams" }, "response": { "status": "200", @@ -14084,88 +12859,41 @@ "transport": "http" }, { - "resource": "scalarDocs", - "publicResource": "scalarDocs", - "operation": "createProject", - "publicOperation": "createProject", + "resource": "teams.invites", + "publicResource": "teams.invites", + "operation": "cancel", + "publicOperation": "cancel", "deprecated": false, - "method": "POST", - "path": "/v1/docs", - "pathParams": [], - "publicPathParams": [], + "method": "DELETE", + "path": "/v1/teams/invites/{uid}", + "pathParams": [ + "uid" + ], + "publicPathParams": [ + "uid" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "name", - "slug", - "isPrivate", - "blank", - "provider", - "githubRepository", - "bitbucketRepository" - ], - "publicBodyParams": [ - "name", - "slug", - "isPrivate", - "blank", - "provider", - "githubRepository", - "bitbucketRepository" - ], - "bodyParamDetails": [ - { - "name": "name", - "required": true - }, - { - "name": "slug", - "required": false - }, - { - "name": "isPrivate", - "required": false - }, - { - "name": "blank", - "required": false - }, - { - "name": "provider", - "required": true - }, - { - "name": "githubRepository", - "required": false - }, + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "bitbucketRepository", - "required": false + "name": "uid", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocCreateProjectParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "InviteCancelParams" }, "response": { "status": "200", @@ -14178,10 +12906,6 @@ } ] }, - "responseModel": { - "name": "docs_project", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -14291,17 +13015,13 @@ { "resource": "scalarDocs", "publicResource": "scalarDocs", - "operation": "retrieveProject", - "publicOperation": "retrieveProject", + "operation": "listGuides", + "publicOperation": "listGuides", "deprecated": false, "method": "GET", - "path": "/v1/docs/{slug}", - "pathParams": [ - "slug" - ], - "publicPathParams": [ - "slug" - ], + "path": "/v1/guides", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -14309,22 +13029,12 @@ "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false - } - ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "ScalarDocRetrieveProjectParams" - }, "response": { "status": "200", "contentType": "application/json", @@ -14336,10 +13046,6 @@ } ] }, - "responseModel": { - "name": "docs_project", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -14449,84 +13155,61 @@ { "resource": "scalarDocs", "publicResource": "scalarDocs", - "operation": "updateProject", - "publicOperation": "updateProject", + "operation": "createGuide", + "publicOperation": "createGuide", "deprecated": false, - "method": "PATCH", - "path": "/v1/docs/{slug}", - "pathParams": [ - "slug" - ], - "publicPathParams": [ - "slug" - ], + "method": "POST", + "path": "/v1/guides", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ "name", + "slug", "isPrivate", - "accessGroups", - "loginPortalUid", - "activeThemeId", - "agentEnabled", - "analyticsEnabled" + "allowedUsers", + "allowedDomains" ], "publicBodyParams": [ "name", + "slug", "isPrivate", - "accessGroups", - "loginPortalUid", - "activeThemeId", - "agentEnabled", - "analyticsEnabled" + "allowedUsers", + "allowedDomains" ], "bodyParamDetails": [ { "name": "name", - "required": false - }, - { - "name": "isPrivate", - "required": false - }, - { - "name": "accessGroups", - "required": false + "required": true }, { - "name": "loginPortalUid", + "name": "slug", "required": false }, { - "name": "activeThemeId", - "required": false + "name": "isPrivate", + "required": true }, { - "name": "agentEnabled", - "required": false + "name": "allowedUsers", + "required": true }, { - "name": "analyticsEnabled", - "required": false - } - ], - "pathParamDetails": [ - { - "name": "slug", - "required": true, - "style": "simple", - "explode": false + "name": "allowedDomains", + "required": true } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocUpdateProjectParams" + "publicName": "ScalarDocCreateGuideParams" }, "requestBody": { "contentType": "application/json", @@ -14661,11 +13344,11 @@ { "resource": "scalarDocs", "publicResource": "scalarDocs", - "operation": "deleteProject", - "publicOperation": "deleteProject", + "operation": "publishGuide", + "publicOperation": "publishGuide", "deprecated": false, - "method": "DELETE", - "path": "/v1/docs/{slug}", + "method": "POST", + "path": "/v1/guides/{slug}/publish", "pathParams": [ "slug" ], @@ -14693,7 +13376,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocDeleteProjectParams" + "publicName": "ScalarDocPublishGuideParams" }, "response": { "status": "200", @@ -14815,73 +13498,39 @@ { "resource": "scalarDocs", "publicResource": "scalarDocs", - "operation": "publishProject", - "publicOperation": "publishProject", + "operation": "listProjects", + "publicOperation": "listProjects", "deprecated": false, - "method": "POST", - "path": "/v1/docs/{slug}/publish", - "pathParams": [ - "slug" + "method": "GET", + "path": "/v1/docs", + "pathParams": [], + "publicPathParams": [], + "queryParams": [ + "limit" ], - "publicPathParams": [ - "slug" + "publicQueryParams": [ + "limit" ], - "queryParams": [], - "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "commitSha", - "preview", - "configPath" - ], - "publicBodyParams": [ - "commitSha", - "preview", - "configPath" - ], - "bodyParamDetails": [ - { - "name": "commitSha", - "required": false - }, - { - "name": "preview", - "required": false - }, - { - "name": "configPath", - "required": false - } - ], - "pathParamDetails": [ + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], + "queryParamDetails": [ { - "name": "slug", - "required": true, - "style": "simple", - "explode": false + "name": "limit", + "required": false, + "style": "form", + "explode": true } ], - "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocPublishProjectParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "ScalarDocListProjectsParams" }, "response": { "status": "200", @@ -15003,50 +13652,86 @@ { "resource": "scalarDocs", "publicResource": "scalarDocs", - "operation": "listProjectConfig", - "publicOperation": "listProjectConfig", + "operation": "createProject", + "publicOperation": "createProject", "deprecated": false, - "method": "GET", - "path": "/v1/docs/{slug}/config", - "pathParams": [ - "slug" - ], - "publicPathParams": [ - "slug" - ], - "queryParams": [ - "ref" - ], - "publicQueryParams": [ - "ref" - ], + "method": "POST", + "path": "/v1/docs", + "pathParams": [], + "publicPathParams": [], + "queryParams": [], + "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ + "bodyParams": [ + "name", + "slug", + "isPrivate", + "blank", + "provider", + "githubRepository", + "bitbucketRepository" + ], + "publicBodyParams": [ + "name", + "slug", + "isPrivate", + "blank", + "provider", + "githubRepository", + "bitbucketRepository" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": true + }, { "name": "slug", - "required": true, - "style": "simple", - "explode": false - } - ], - "queryParamDetails": [ + "required": false + }, { - "name": "ref", - "required": false, - "style": "form", - "explode": true + "name": "isPrivate", + "required": false + }, + { + "name": "blank", + "required": false + }, + { + "name": "provider", + "required": true + }, + { + "name": "githubRepository", + "required": false + }, + { + "name": "bitbucketRepository", + "required": false } ], + "pathParamDetails": [], + "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocListProjectConfigParams" + "publicName": "ScalarDocCreateProjectParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -15059,6 +13744,10 @@ } ] }, + "responseModel": { + "name": "docs_project", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -15151,74 +13840,41 @@ "contentType": "application/json", "encoding": "json", "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "500", - "publicAliases": [] - } - } - ], - "responseLinks": [], - "transport": "http" - }, - { - "resource": "scalarDocs", - "publicResource": "scalarDocs", - "operation": "updateProjectConfig", - "publicOperation": "updateProjectConfig", - "deprecated": false, - "method": "PUT", - "path": "/v1/docs/{slug}/config", - "pathParams": [ - "slug" - ], - "publicPathParams": [ - "slug" - ], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [ - "content", - "ref", - "baseToken", - "message", - "path" - ], - "publicBodyParams": [ - "content", - "ref", - "baseToken", - "message", - "path" - ], - "bodyParamDetails": [ - { - "name": "content", - "required": true - }, - { - "name": "ref", - "required": false - }, - { - "name": "baseToken", - "required": false - }, - { - "name": "message", - "required": false - }, - { - "name": "path", - "required": false + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } } ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "retrieveProject", + "publicOperation": "retrieveProject", + "deprecated": false, + "method": "GET", + "path": "/v1/docs/{slug}", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { "name": "slug", @@ -15233,20 +13889,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocUpdateProjectConfigParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "ScalarDocRetrieveProjectParams" }, "response": { "status": "200", @@ -15259,6 +13902,10 @@ } ] }, + "responseModel": { + "name": "docs_project", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -15368,11 +14015,11 @@ { "resource": "scalarDocs", "publicResource": "scalarDocs", - "operation": "listProjectDomain", - "publicOperation": "listProjectDomain", + "operation": "updateProject", + "publicOperation": "updateProject", "deprecated": false, - "method": "GET", - "path": "/v1/docs/{slug}/domain", + "method": "PATCH", + "path": "/v1/docs/{slug}", "pathParams": [ "slug" ], @@ -15383,9 +14030,54 @@ "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], + "bodyParams": [ + "name", + "isPrivate", + "accessGroups", + "loginPortalUid", + "activeThemeId", + "agentEnabled", + "analyticsEnabled" + ], + "publicBodyParams": [ + "name", + "isPrivate", + "accessGroups", + "loginPortalUid", + "activeThemeId", + "agentEnabled", + "analyticsEnabled" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": false + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "accessGroups", + "required": false + }, + { + "name": "loginPortalUid", + "required": false + }, + { + "name": "activeThemeId", + "required": false + }, + { + "name": "agentEnabled", + "required": false + }, + { + "name": "analyticsEnabled", + "required": false + } + ], "pathParamDetails": [ { "name": "slug", @@ -15400,7 +14092,20 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocListProjectDomainParams" + "publicName": "ScalarDocUpdateProjectParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -15522,11 +14227,11 @@ { "resource": "scalarDocs", "publicResource": "scalarDocs", - "operation": "listProjectDomainStatus", - "publicOperation": "listProjectDomainStatus", + "operation": "deleteProject", + "publicOperation": "deleteProject", "deprecated": false, - "method": "GET", - "path": "/v1/docs/{slug}/domain/status", + "method": "DELETE", + "path": "/v1/docs/{slug}", "pathParams": [ "slug" ], @@ -15554,7 +14259,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ScalarDocListProjectDomainStatusParams" + "publicName": "ScalarDocDeleteProjectParams" }, "response": { "status": "200", @@ -15674,28 +14379,76 @@ "transport": "http" }, { - "resource": "namespaces", - "publicResource": "namespaces", - "operation": "list", - "publicOperation": "list", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "publishProject", + "publicOperation": "publishProject", "deprecated": false, - "method": "GET", - "path": "/v1/namespaces", - "pathParams": [], - "publicPathParams": [], + "method": "POST", + "path": "/v1/docs/{slug}/publish", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], + "bodyParams": [ + "commitSha", + "preview", + "configPath" + ], + "publicBodyParams": [ + "commitSha", + "preview", + "configPath" + ], + "bodyParamDetails": [ + { + "name": "commitSha", + "required": false + }, + { + "name": "preview", + "required": false + }, + { + "name": "configPath", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "ScalarDocPublishProjectParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -15814,52 +14567,52 @@ "transport": "http" }, { - "resource": "authentication", - "publicResource": "authentication", - "operation": "exchangePersonalToken", - "publicOperation": "exchangePersonalToken", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "listProjectConfig", + "publicOperation": "listProjectConfig", "deprecated": false, - "method": "POST", - "path": "/v1/auth/exchange", - "pathParams": [], - "publicPathParams": [], - "queryParams": [], - "publicQueryParams": [], + "method": "GET", + "path": "/v1/docs/{slug}/config", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], + "queryParams": [ + "ref" + ], + "publicQueryParams": [ + "ref" + ], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "personalToken" - ], - "publicBodyParams": [ - "personalToken" + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } ], - "bodyParamDetails": [ + "queryParamDetails": [ { - "name": "personalToken", - "required": true + "name": "ref", + "required": false, + "style": "form", + "explode": true } ], - "pathParamDetails": [], - "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "AuthenticationExchangePersonalTokenParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "ScalarDocListProjectConfigParams" }, "response": { "status": "200", @@ -15979,28 +14732,88 @@ "transport": "http" }, { - "resource": "authentication", - "publicResource": "authentication", - "operation": "listCurrentUser", - "publicOperation": "listCurrentUser", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "updateProjectConfig", + "publicOperation": "updateProjectConfig", "deprecated": false, - "method": "GET", - "path": "/v1/auth/me", - "pathParams": [], - "publicPathParams": [], + "method": "PUT", + "path": "/v1/docs/{slug}/config", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], + "bodyParams": [ + "content", + "ref", + "baseToken", + "message", + "path" + ], + "publicBodyParams": [ + "content", + "ref", + "baseToken", + "message", + "path" + ], + "bodyParamDetails": [ + { + "name": "content", + "required": true + }, + { + "name": "ref", + "required": false + }, + { + "name": "baseToken", + "required": false + }, + { + "name": "message", + "required": false + }, + { + "name": "path", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "slug", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "ScalarDocUpdateProjectConfigParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -16012,10 +14825,6 @@ } ] }, - "responseModel": { - "name": "user", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -16123,41 +14932,41 @@ "transport": "http" }, { - "resource": "sdks", - "publicResource": "sdks", - "operation": "list", - "publicOperation": "list", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "listProjectDomain", + "publicOperation": "listProjectDomain", "deprecated": false, "method": "GET", - "path": "/v1/sdks", - "pathParams": [], - "publicPathParams": [], - "queryParams": [ - "limit" + "path": "/v1/docs/{slug}/domain", + "pathParams": [ + "slug" ], - "publicQueryParams": [ - "limit" + "publicPathParams": [ + "slug" ], + "queryParams": [], + "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [], - "queryParamDetails": [ + "pathParamDetails": [ { - "name": "limit", - "required": false, - "style": "form", - "explode": true + "name": "slug", + "required": true, + "style": "simple", + "explode": false } ], + "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SdkListParams" + "publicName": "ScalarDocListProjectDomainParams" }, "response": { "status": "200", @@ -16277,82 +15086,41 @@ "transport": "http" }, { - "resource": "sdks", - "publicResource": "sdks", - "operation": "create", - "publicOperation": "create", + "resource": "scalarDocs", + "publicResource": "scalarDocs", + "operation": "listProjectDomainStatus", + "publicOperation": "listProjectDomainStatus", "deprecated": false, - "method": "POST", - "path": "/v1/sdks", - "pathParams": [], - "publicPathParams": [], + "method": "GET", + "path": "/v1/docs/{slug}/domain/status", + "pathParams": [ + "slug" + ], + "publicPathParams": [ + "slug" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "apiUid", - "languages", - "title", - "slug", - "className", - "config" - ], - "publicBodyParams": [ - "apiUid", - "languages", - "title", - "slug", - "className", - "config" - ], - "bodyParamDetails": [ - { - "name": "apiUid", - "required": true - }, - { - "name": "languages", - "required": true - }, - { - "name": "title", - "required": false - }, + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { "name": "slug", - "required": false - }, - { - "name": "className", - "required": false - }, - { - "name": "config", - "required": false + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SdkCreateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "ScalarDocListProjectDomainStatusParams" }, "response": { "status": "200", @@ -16365,10 +15133,6 @@ } ] }, - "responseModel": { - "name": "uid", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -16476,42 +15240,28 @@ "transport": "http" }, { - "resource": "sdks", - "publicResource": "sdks", - "operation": "retrieve", - "publicOperation": "retrieve", + "resource": "namespaces", + "publicResource": "namespaces", + "operation": "list", + "publicOperation": "list", "deprecated": false, "method": "GET", - "path": "/v1/sdks/{uid}", - "pathParams": [ - "uid" - ], - "publicPathParams": [ - "uid" - ], + "path": "/v1/namespaces", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [], "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "uid", - "required": true, - "style": "simple", - "explode": false - } - ], + "bodyParamDetails": [], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "SdkRetrieveParams" - }, "response": { "status": "200", "contentType": "application/json", @@ -16523,10 +15273,6 @@ } ] }, - "responseModel": { - "name": "sdk", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -16634,80 +15380,39 @@ "transport": "http" }, { - "resource": "sdks", - "publicResource": "sdks", - "operation": "update", - "publicOperation": "update", + "resource": "authentication", + "publicResource": "authentication", + "operation": "exchangePersonalToken", + "publicOperation": "exchangePersonalToken", "deprecated": false, - "method": "PATCH", - "path": "/v1/sdks/{uid}", - "pathParams": [ - "uid" - ], - "publicPathParams": [ - "uid" - ], + "method": "POST", + "path": "/v1/auth/exchange", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "title", - "slug", - "isPrivate", - "config", - "apiUid", - "apiVersion" + "personalToken" ], "publicBodyParams": [ - "title", - "slug", - "isPrivate", - "config", - "apiUid", - "apiVersion" + "personalToken" ], "bodyParamDetails": [ { - "name": "title", - "required": false - }, - { - "name": "slug", - "required": false - }, - { - "name": "isPrivate", - "required": false - }, - { - "name": "config", - "required": false - }, - { - "name": "apiUid", - "required": false - }, - { - "name": "apiVersion", - "required": false - } - ], - "pathParamDetails": [ - { - "name": "uid", - "required": true, - "style": "simple", - "explode": false + "name": "personalToken", + "required": true } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SdkUpdateParams" + "publicName": "AuthenticationExchangePersonalTokenParams" }, "requestBody": { "contentType": "application/json", @@ -16840,19 +15545,15 @@ "transport": "http" }, { - "resource": "sdks", - "publicResource": "sdks", - "operation": "delete", - "publicOperation": "delete", + "resource": "authentication", + "publicResource": "authentication", + "operation": "listCurrentUser", + "publicOperation": "listCurrentUser", "deprecated": false, - "method": "DELETE", - "path": "/v1/sdks/{uid}", - "pathParams": [ - "uid" - ], - "publicPathParams": [ - "uid" - ], + "method": "GET", + "path": "/v1/auth/me", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -16860,22 +15561,12 @@ "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "uid", - "required": true, - "style": "simple", - "explode": false - } - ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "SdkDeleteParams" - }, "response": { "status": "200", "contentType": "application/json", @@ -16887,6 +15578,10 @@ } ] }, + "responseModel": { + "name": "user", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -16996,67 +15691,39 @@ { "resource": "sdks", "publicResource": "sdks", - "operation": "build", - "publicOperation": "build", + "operation": "list", + "publicOperation": "list", "deprecated": false, - "method": "POST", - "path": "/v1/sdks/{uid}/build", - "pathParams": [ - "uid" + "method": "GET", + "path": "/v1/sdks", + "pathParams": [], + "publicPathParams": [], + "queryParams": [ + "limit" ], - "publicPathParams": [ - "uid" + "publicQueryParams": [ + "limit" ], - "queryParams": [], - "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "version", - "languages" - ], - "publicBodyParams": [ - "version", - "languages" - ], - "bodyParamDetails": [ - { - "name": "version", - "required": false - }, - { - "name": "languages", - "required": false - } - ], - "pathParamDetails": [ + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [], + "queryParamDetails": [ { - "name": "uid", - "required": true, - "style": "simple", - "explode": false + "name": "limit", + "required": false, + "style": "form", + "explode": true } ], - "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "SdkBuildParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "SdkListParams" }, "response": { "status": "200", @@ -17176,56 +15843,69 @@ "transport": "http" }, { - "resource": "sdks.versions", - "publicResource": "sdks.versions", + "resource": "sdks", + "publicResource": "sdks", "operation": "create", "publicOperation": "create", "deprecated": false, "method": "POST", - "path": "/v1/sdks/{uid}/versions", - "pathParams": [ - "uid" - ], - "publicPathParams": [ - "uid" - ], + "path": "/v1/sdks", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "version", - "apiVersion" + "apiUid", + "languages", + "title", + "slug", + "className", + "config" ], "publicBodyParams": [ - "version", - "apiVersion" + "apiUid", + "languages", + "title", + "slug", + "className", + "config" ], "bodyParamDetails": [ { - "name": "version", + "name": "apiUid", "required": true }, { - "name": "apiVersion", + "name": "languages", "required": true - } - ], - "pathParamDetails": [ + }, { - "name": "uid", - "required": true, - "style": "simple", - "explode": false + "name": "title", + "required": false + }, + { + "name": "slug", + "required": false + }, + { + "name": "className", + "required": false + }, + { + "name": "config", + "required": false } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "VersionCreateParams" + "publicName": "SdkCreateParams" }, "requestBody": { "contentType": "application/json", @@ -17251,6 +15931,10 @@ } ] }, + "responseModel": { + "name": "uid", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -17358,20 +16042,18 @@ "transport": "http" }, { - "resource": "sdks.versions", - "publicResource": "sdks.versions", - "operation": "delete", - "publicOperation": "delete", + "resource": "sdks", + "publicResource": "sdks", + "operation": "retrieve", + "publicOperation": "retrieve", "deprecated": false, - "method": "DELETE", - "path": "/v1/sdks/{uid}/versions/{version}", + "method": "GET", + "path": "/v1/sdks/{uid}", "pathParams": [ - "uid", - "version" + "uid" ], "publicPathParams": [ - "uid", - "version" + "uid" ], "queryParams": [], "publicQueryParams": [], @@ -17386,12 +16068,6 @@ "required": true, "style": "simple", "explode": false - }, - { - "name": "version", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -17400,7 +16076,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "VersionDeleteParams" + "publicName": "SdkRetrieveParams" }, "response": { "status": "200", @@ -17413,6 +16089,10 @@ } ] }, + "responseModel": { + "name": "sdk", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -17520,13 +16200,13 @@ "transport": "http" }, { - "resource": "sdks.repositories", - "publicResource": "sdks.repositories", - "operation": "link", - "publicOperation": "link", + "resource": "sdks", + "publicResource": "sdks", + "operation": "update", + "publicOperation": "update", "deprecated": false, - "method": "POST", - "path": "/v1/sdks/{uid}/repositories", + "method": "PATCH", + "path": "/v1/sdks/{uid}", "pathParams": [ "uid" ], @@ -17538,32 +16218,44 @@ "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "language", - "repositoryId", - "baseBranch", - "prereleaseType" + "title", + "slug", + "isPrivate", + "config", + "apiUid", + "apiVersion" ], "publicBodyParams": [ - "language", - "repositoryId", - "baseBranch", - "prereleaseType" + "title", + "slug", + "isPrivate", + "config", + "apiUid", + "apiVersion" ], "bodyParamDetails": [ { - "name": "language", - "required": true + "name": "title", + "required": false }, { - "name": "repositoryId", - "required": true + "name": "slug", + "required": false }, { - "name": "baseBranch", - "required": true + "name": "isPrivate", + "required": false }, { - "name": "prereleaseType", + "name": "config", + "required": false + }, + { + "name": "apiUid", + "required": false + }, + { + "name": "apiVersion", "required": false } ], @@ -17581,7 +16273,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RepositoryLinkParams" + "publicName": "SdkUpdateParams" }, "requestBody": { "contentType": "application/json", @@ -17714,20 +16406,18 @@ "transport": "http" }, { - "resource": "sdks.repositories", - "publicResource": "sdks.repositories", - "operation": "unlink", - "publicOperation": "unlink", + "resource": "sdks", + "publicResource": "sdks", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, "method": "DELETE", - "path": "/v1/sdks/{uid}/repositories/{language}", + "path": "/v1/sdks/{uid}", "pathParams": [ - "uid", - "language" + "uid" ], "publicPathParams": [ - "uid", - "language" + "uid" ], "queryParams": [], "publicQueryParams": [], @@ -17742,12 +16432,6 @@ "required": true, "style": "simple", "explode": false - }, - { - "name": "language", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -17756,7 +16440,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RepositoryUnlinkParams" + "publicName": "SdkDeleteParams" }, "response": { "status": "200", @@ -17876,52 +16560,38 @@ "transport": "http" }, { - "resource": "sdks.repositories", - "publicResource": "sdks.repositories", - "operation": "updatePublishing", - "publicOperation": "updatePublishing", + "resource": "sdks", + "publicResource": "sdks", + "operation": "build", + "publicOperation": "build", "deprecated": false, "method": "POST", - "path": "/v1/sdks/{uid}/repositories/{language}/publishing", + "path": "/v1/sdks/{uid}/build", "pathParams": [ - "uid", - "language" + "uid" ], "publicPathParams": [ - "uid", - "language" + "uid" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "publishOnMerge", - "authMethod", - "access", - "tag" + "version", + "languages" ], "publicBodyParams": [ - "publishOnMerge", - "authMethod", - "access", - "tag" + "version", + "languages" ], "bodyParamDetails": [ { - "name": "publishOnMerge", - "required": true - }, - { - "name": "authMethod", - "required": false - }, - { - "name": "access", + "name": "version", "required": false }, { - "name": "tag", + "name": "languages", "required": false } ], @@ -17931,12 +16601,6 @@ "required": true, "style": "simple", "explode": false - }, - { - "name": "language", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -17945,7 +16609,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "RepositoryUpdatePublishingParams" + "publicName": "SdkBuildParams" }, "requestBody": { "contentType": "application/json", @@ -18078,28 +16742,70 @@ "transport": "http" }, { - "resource": "mcp.servers", - "publicResource": "mcp.servers", - "operation": "list", - "publicOperation": "list", + "resource": "sdks.versions", + "publicResource": "sdks.versions", + "operation": "create", + "publicOperation": "create", "deprecated": false, - "method": "GET", - "path": "/v1/mcp/servers", - "pathParams": [], - "publicPathParams": [], + "method": "POST", + "path": "/v1/sdks/{uid}/versions", + "pathParams": [ + "uid" + ], + "publicPathParams": [ + "uid" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], + "bodyParams": [ + "version", + "apiVersion" + ], + "publicBodyParams": [ + "version", + "apiVersion" + ], + "bodyParamDetails": [ + { + "name": "version", + "required": true + }, + { + "name": "apiVersion", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "uid", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "VersionCreateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -18218,70 +16924,49 @@ "transport": "http" }, { - "resource": "mcp.servers", - "publicResource": "mcp.servers", - "operation": "create", - "publicOperation": "create", + "resource": "sdks.versions", + "publicResource": "sdks.versions", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, - "method": "POST", - "path": "/v1/mcp/servers", - "pathParams": [], - "publicPathParams": [], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [ - "name", - "slug", - "versionUids", - "projectUids" + "method": "DELETE", + "path": "/v1/sdks/{uid}/versions/{version}", + "pathParams": [ + "uid", + "version" ], - "publicBodyParams": [ - "name", - "slug", - "versionUids", - "projectUids" + "publicPathParams": [ + "uid", + "version" ], - "bodyParamDetails": [ - { - "name": "name", - "required": true - }, - { - "name": "slug", - "required": false - }, + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "versionUids", - "required": false + "name": "uid", + "required": true, + "style": "simple", + "explode": false }, { - "name": "projectUids", - "required": false + "name": "version", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ServerCreateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "VersionDeleteParams" }, "response": { "status": "200", @@ -18401,29 +17086,56 @@ "transport": "http" }, { - "resource": "mcp.servers", - "publicResource": "mcp.servers", - "operation": "retrieve", - "publicOperation": "retrieve", + "resource": "sdks.repositories", + "publicResource": "sdks.repositories", + "operation": "link", + "publicOperation": "link", "deprecated": false, - "method": "GET", - "path": "/v1/mcp/servers/{id}", + "method": "POST", + "path": "/v1/sdks/{uid}/repositories", "pathParams": [ - "id" + "uid" ], "publicPathParams": [ - "id" + "uid" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], + "bodyParams": [ + "language", + "repositoryId", + "baseBranch", + "prereleaseType" + ], + "publicBodyParams": [ + "language", + "repositoryId", + "baseBranch", + "prereleaseType" + ], + "bodyParamDetails": [ + { + "name": "language", + "required": true + }, + { + "name": "repositoryId", + "required": true + }, + { + "name": "baseBranch", + "required": true + }, + { + "name": "prereleaseType", + "required": false + } + ], "pathParamDetails": [ { - "name": "id", + "name": "uid", "required": true, "style": "simple", "explode": false @@ -18435,7 +17147,20 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ServerRetrieveParams" + "publicName": "RepositoryLinkParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -18448,10 +17173,6 @@ } ] }, - "responseModel": { - "name": "mcp_server", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -18559,62 +17280,37 @@ "transport": "http" }, { - "resource": "mcp.servers", - "publicResource": "mcp.servers", - "operation": "update", - "publicOperation": "update", + "resource": "sdks.repositories", + "publicResource": "sdks.repositories", + "operation": "unlink", + "publicOperation": "unlink", "deprecated": false, - "method": "PATCH", - "path": "/v1/mcp/servers/{id}", + "method": "DELETE", + "path": "/v1/sdks/{uid}/repositories/{language}", "pathParams": [ - "id" + "uid", + "language" ], "publicPathParams": [ - "id" + "uid", + "language" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "name", - "slug", - "autoAddOperations", - "operations", - "docsPages" - ], - "publicBodyParams": [ - "name", - "slug", - "autoAddOperations", - "operations", - "docsPages" - ], - "bodyParamDetails": [ - { - "name": "name", - "required": false - }, - { - "name": "slug", - "required": false - }, - { - "name": "autoAddOperations", - "required": false - }, + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "operations", - "required": false + "name": "uid", + "required": true, + "style": "simple", + "explode": false }, { - "name": "docsPages", - "required": false - } - ], - "pathParamDetails": [ - { - "name": "id", + "name": "language", "required": true, "style": "simple", "explode": false @@ -18626,20 +17322,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ServerUpdateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "RepositoryUnlinkParams" }, "response": { "status": "200", @@ -18652,10 +17335,6 @@ } ] }, - "responseModel": { - "name": "mcp_server", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -18763,29 +17442,64 @@ "transport": "http" }, { - "resource": "mcp.servers", - "publicResource": "mcp.servers", - "operation": "delete", - "publicOperation": "delete", + "resource": "sdks.repositories", + "publicResource": "sdks.repositories", + "operation": "updatePublishing", + "publicOperation": "updatePublishing", "deprecated": false, - "method": "DELETE", - "path": "/v1/mcp/servers/{id}", + "method": "POST", + "path": "/v1/sdks/{uid}/repositories/{language}/publishing", "pathParams": [ - "id" + "uid", + "language" ], "publicPathParams": [ - "id" + "uid", + "language" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], + "bodyParams": [ + "publishOnMerge", + "authMethod", + "access", + "tag" + ], + "publicBodyParams": [ + "publishOnMerge", + "authMethod", + "access", + "tag" + ], + "bodyParamDetails": [ + { + "name": "publishOnMerge", + "required": true + }, + { + "name": "authMethod", + "required": false + }, + { + "name": "access", + "required": false + }, + { + "name": "tag", + "required": false + } + ], "pathParamDetails": [ { - "name": "id", + "name": "uid", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "language", "required": true, "style": "simple", "explode": false @@ -18797,7 +17511,20 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "ServerDeleteParams" + "publicName": "RepositoryUpdatePublishingParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" }, "response": { "status": "200", @@ -18917,19 +17644,15 @@ "transport": "http" }, { - "resource": "mcp.servers.installations", - "publicResource": "mcp.servers.installations", + "resource": "mcp.servers", + "publicResource": "mcp.servers", "operation": "list", "publicOperation": "list", "deprecated": false, "method": "GET", - "path": "/v1/mcp/servers/{id}/installations", - "pathParams": [ - "id" - ], - "publicPathParams": [ - "id" - ], + "path": "/v1/mcp/servers", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -18937,22 +17660,12 @@ "bodyParams": [], "publicBodyParams": [], "bodyParamDetails": [], - "pathParamDetails": [ - { - "name": "id", - "required": true, - "style": "simple", - "explode": false - } - ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], - "paramsModel": { - "publicName": "InstallationListParams" - }, "response": { "status": "200", "contentType": "application/json", @@ -19071,19 +17784,15 @@ "transport": "http" }, { - "resource": "mcp.servers.installations", - "publicResource": "mcp.servers.installations", + "resource": "mcp.servers", + "publicResource": "mcp.servers", "operation": "create", "publicOperation": "create", "deprecated": false, "method": "POST", - "path": "/v1/mcp/servers/{id}/installations", - "pathParams": [ - "id" - ], - "publicPathParams": [ - "id" - ], + "path": "/v1/mcp/servers", + "pathParams": [], + "publicPathParams": [], "queryParams": [], "publicQueryParams": [], "headerParams": [], @@ -19091,12 +17800,14 @@ "bodyParams": [ "name", "slug", - "documentAuth" + "versionUids", + "projectUids" ], "publicBodyParams": [ "name", "slug", - "documentAuth" + "versionUids", + "projectUids" ], "bodyParamDetails": [ { @@ -19108,25 +17819,22 @@ "required": false }, { - "name": "documentAuth", - "required": true - } - ], - "pathParamDetails": [ + "name": "versionUids", + "required": false + }, { - "name": "id", - "required": true, - "style": "simple", - "explode": false + "name": "projectUids", + "required": false } ], + "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "InstallationCreateParams" + "publicName": "ServerCreateParams" }, "requestBody": { "contentType": "application/json", @@ -19152,10 +17860,6 @@ } ] }, - "responseModel": { - "name": "mcp_installation", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -19263,20 +17967,18 @@ "transport": "http" }, { - "resource": "mcp.servers.installations", - "publicResource": "mcp.servers.installations", + "resource": "mcp.servers", + "publicResource": "mcp.servers", "operation": "retrieve", "publicOperation": "retrieve", "deprecated": false, "method": "GET", - "path": "/v1/mcp/servers/{id}/installations/{installationId}", + "path": "/v1/mcp/servers/{id}", "pathParams": [ - "id", - "installationId" + "id" ], "publicPathParams": [ - "id", - "installationId" + "id" ], "queryParams": [], "publicQueryParams": [], @@ -19291,12 +17993,6 @@ "required": true, "style": "simple", "explode": false - }, - { - "name": "installationId", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -19305,7 +18001,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "InstallationRetrieveParams" + "publicName": "ServerRetrieveParams" }, "response": { "status": "200", @@ -19319,7 +18015,7 @@ ] }, "responseModel": { - "name": "mcp_installation", + "name": "mcp_server", "publicAliases": [] }, "result": { @@ -19429,20 +18125,18 @@ "transport": "http" }, { - "resource": "mcp.servers.installations", - "publicResource": "mcp.servers.installations", + "resource": "mcp.servers", + "publicResource": "mcp.servers", "operation": "update", "publicOperation": "update", "deprecated": false, "method": "PATCH", - "path": "/v1/mcp/servers/{id}/installations/{installationId}", + "path": "/v1/mcp/servers/{id}", "pathParams": [ - "id", - "installationId" + "id" ], "publicPathParams": [ - "id", - "installationId" + "id" ], "queryParams": [], "publicQueryParams": [], @@ -19451,18 +18145,16 @@ "bodyParams": [ "name", "slug", - "isPrivate", - "loginPortalUid", - "documentAuth", - "mcpVersion" + "autoAddOperations", + "operations", + "docsPages" ], "publicBodyParams": [ "name", "slug", - "isPrivate", - "loginPortalUid", - "documentAuth", - "mcpVersion" + "autoAddOperations", + "operations", + "docsPages" ], "bodyParamDetails": [ { @@ -19474,34 +18166,195 @@ "required": false }, { - "name": "isPrivate", + "name": "autoAddOperations", "required": false }, { - "name": "loginPortalUid", + "name": "operations", "required": false }, { - "name": "documentAuth", + "name": "docsPages", "required": false + } + ], + "pathParamDetails": [ + { + "name": "id", + "required": true, + "style": "simple", + "explode": false + } + ], + "queryParamDetails": [], + "headerParamDetails": [], + "cookieParams": [], + "publicCookieParams": [], + "cookieParamDetails": [], + "paramsModel": { + "publicName": "ServerUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, + "response": { + "status": "200", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ] + }, + "responseModel": { + "name": "mcp_server", + "publicAliases": [] + }, + "result": { + "successStatus": "200", + "errorStatuses": [ + "400", + "401", + "403", + "404", + "422", + "500" + ] + }, + "errorResponses": [ + { + "status": "400", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "400", + "publicAliases": [] + } + }, + { + "status": "401", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "401", + "publicAliases": [] + } + }, + { + "status": "403", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "403", + "publicAliases": [] + } + }, + { + "status": "404", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "404", + "publicAliases": [] + } + }, + { + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } }, { - "name": "mcpVersion", - "required": false + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } } ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "mcp.servers", + "publicResource": "mcp.servers", + "operation": "delete", + "publicOperation": "delete", + "deprecated": false, + "method": "DELETE", + "path": "/v1/mcp/servers/{id}", + "pathParams": [ + "id" + ], + "publicPathParams": [ + "id" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { "name": "id", "required": true, "style": "simple", "explode": false - }, - { - "name": "installationId", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -19510,20 +18363,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "InstallationUpdateParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "ServerDeleteParams" }, "response": { "status": "200", @@ -19536,10 +18376,6 @@ } ] }, - "responseModel": { - "name": "mcp_installation", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ @@ -19649,18 +18485,16 @@ { "resource": "mcp.servers.installations", "publicResource": "mcp.servers.installations", - "operation": "delete", - "publicOperation": "delete", + "operation": "list", + "publicOperation": "list", "deprecated": false, - "method": "DELETE", - "path": "/v1/mcp/servers/{id}/installations/{installationId}", + "method": "GET", + "path": "/v1/mcp/servers/{id}/installations", "pathParams": [ - "id", - "installationId" + "id" ], "publicPathParams": [ - "id", - "installationId" + "id" ], "queryParams": [], "publicQueryParams": [], @@ -19675,12 +18509,6 @@ "required": true, "style": "simple", "explode": false - }, - { - "name": "installationId", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -19689,7 +18517,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "InstallationDeleteParams" + "publicName": "InstallationListParams" }, "response": { "status": "200", @@ -19811,32 +18639,42 @@ { "resource": "mcp.servers.installations", "publicResource": "mcp.servers.installations", - "operation": "createAccessGroup", - "publicOperation": "createAccessGroup", + "operation": "create", + "publicOperation": "create", "deprecated": false, "method": "POST", - "path": "/v1/mcp/servers/{id}/installations/{installationId}/access-group", + "path": "/v1/mcp/servers/{id}/installations", "pathParams": [ - "id", - "installationId" + "id" ], "publicPathParams": [ - "id", - "installationId" + "id" ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "accessGroupUid" + "name", + "slug", + "documentAuth" ], "publicBodyParams": [ - "accessGroupUid" + "name", + "slug", + "documentAuth" ], "bodyParamDetails": [ { - "name": "accessGroupUid", + "name": "name", + "required": true + }, + { + "name": "slug", + "required": false + }, + { + "name": "documentAuth", "required": true } ], @@ -19846,12 +18684,6 @@ "required": true, "style": "simple", "explode": false - }, - { - "name": "installationId", - "required": true, - "style": "simple", - "explode": false } ], "queryParamDetails": [], @@ -19860,7 +18692,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "InstallationCreateAccessGroupParams" + "publicName": "InstallationCreateParams" }, "requestBody": { "contentType": "application/json", @@ -19886,6 +18718,10 @@ } ] }, + "responseModel": { + "name": "mcp_installation", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -19995,11 +18831,11 @@ { "resource": "mcp.servers.installations", "publicResource": "mcp.servers.installations", - "operation": "deleteAccessGroup", - "publicOperation": "deleteAccessGroup", + "operation": "retrieve", + "publicOperation": "retrieve", "deprecated": false, - "method": "DELETE", - "path": "/v1/mcp/servers/{id}/installations/{installationId}/access-group", + "method": "GET", + "path": "/v1/mcp/servers/{id}/installations/{installationId}", "pathParams": [ "id", "installationId" @@ -20012,18 +18848,9 @@ "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "accessGroupUid" - ], - "publicBodyParams": [ - "accessGroupUid" - ], - "bodyParamDetails": [ - { - "name": "accessGroupUid", - "required": true - } - ], + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], "pathParamDetails": [ { "name": "id", @@ -20044,20 +18871,7 @@ "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "InstallationDeleteAccessGroupParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "InstallationRetrieveParams" }, "response": { "status": "200", @@ -20070,6 +18884,10 @@ } ] }, + "responseModel": { + "name": "mcp_installation", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -20143,62 +18961,136 @@ } }, { - "status": "422", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "422", - "publicAliases": [] - } + "status": "422", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "422", + "publicAliases": [] + } + }, + { + "status": "500", + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "model": { + "name": "500", + "publicAliases": [] + } + } + ], + "responseLinks": [], + "transport": "http" + }, + { + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "update", + "publicOperation": "update", + "deprecated": false, + "method": "PATCH", + "path": "/v1/mcp/servers/{id}/installations/{installationId}", + "pathParams": [ + "id", + "installationId" + ], + "publicPathParams": [ + "id", + "installationId" + ], + "queryParams": [], + "publicQueryParams": [], + "headerParams": [], + "publicHeaderParams": [], + "bodyParams": [ + "name", + "slug", + "isPrivate", + "loginPortalUid", + "documentAuth", + "mcpVersion" + ], + "publicBodyParams": [ + "name", + "slug", + "isPrivate", + "loginPortalUid", + "documentAuth", + "mcpVersion" + ], + "bodyParamDetails": [ + { + "name": "name", + "required": false + }, + { + "name": "slug", + "required": false + }, + { + "name": "isPrivate", + "required": false + }, + { + "name": "loginPortalUid", + "required": false }, { - "status": "500", - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "model": { - "name": "500", - "publicAliases": [] - } + "name": "documentAuth", + "required": false + }, + { + "name": "mcpVersion", + "required": false + } + ], + "pathParamDetails": [ + { + "name": "id", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "installationId", + "required": true, + "style": "simple", + "explode": false } ], - "responseLinks": [], - "transport": "http" - }, - { - "resource": "oAuth", - "publicResource": "oAuth", - "operation": "oauthAuthorize", - "publicOperation": "oauthAuthorize", - "deprecated": false, - "method": "GET", - "path": "/v1/oauth/authorize", - "pathParams": [], - "publicPathParams": [], - "queryParams": [], - "publicQueryParams": [], - "headerParams": [], - "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "InstallationUpdateParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -20210,6 +19102,10 @@ } ] }, + "responseModel": { + "name": "mcp_installation", + "publicAliases": [] + }, "result": { "successStatus": "200", "errorStatuses": [ @@ -20317,94 +19213,49 @@ "transport": "http" }, { - "resource": "oAuth", - "publicResource": "oAuth", - "operation": "oauthToken", - "publicOperation": "oauthToken", + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "delete", + "publicOperation": "delete", "deprecated": false, - "method": "POST", - "path": "/v1/oauth/token", - "pathParams": [], - "publicPathParams": [], + "method": "DELETE", + "path": "/v1/mcp/servers/{id}/installations/{installationId}", + "pathParams": [ + "id", + "installationId" + ], + "publicPathParams": [ + "id", + "installationId" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [ - "grant_type", - "client_id", - "client_secret", - "code", - "redirect_uri", - "code_verifier", - "refresh_token", - "scope" - ], - "publicBodyParams": [ - "grant_type", - "client_id", - "client_secret", - "code", - "redirect_uri", - "code_verifier", - "refresh_token", - "scope" - ], - "bodyParamDetails": [ - { - "name": "grant_type", - "required": true - }, - { - "name": "client_id", - "required": false - }, - { - "name": "client_secret", - "required": false - }, - { - "name": "code", - "required": false - }, - { - "name": "redirect_uri", - "required": false - }, - { - "name": "code_verifier", - "required": false - }, + "bodyParams": [], + "publicBodyParams": [], + "bodyParamDetails": [], + "pathParamDetails": [ { - "name": "refresh_token", - "required": false + "name": "id", + "required": true, + "style": "simple", + "explode": false }, { - "name": "scope", - "required": false + "name": "installationId", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "OAuthOauthTokenParams" - }, - "requestBody": { - "contentType": "application/json", - "encoding": "json", - "contents": [ - { - "contentType": "application/json", - "encoding": "json" - } - ], - "required": true, - "publicName": "body", - "publicIdentifier": "body" + "publicName": "InstallationDeleteParams" }, "response": { "status": "200", @@ -20524,57 +19375,58 @@ "transport": "http" }, { - "resource": "oAuth", - "publicResource": "oAuth", - "operation": "oauthRevoke", - "publicOperation": "oauthRevoke", + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "createAccessGroup", + "publicOperation": "createAccessGroup", "deprecated": false, "method": "POST", - "path": "/v1/oauth/revoke", - "pathParams": [], - "publicPathParams": [], + "path": "/v1/mcp/servers/{id}/installations/{installationId}/access-group", + "pathParams": [ + "id", + "installationId" + ], + "publicPathParams": [ + "id", + "installationId" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], "bodyParams": [ - "token", - "token_type_hint", - "client_id", - "client_secret" + "accessGroupUid" ], "publicBodyParams": [ - "token", - "token_type_hint", - "client_id", - "client_secret" + "accessGroupUid" ], "bodyParamDetails": [ { - "name": "token", + "name": "accessGroupUid", "required": true - }, - { - "name": "token_type_hint", - "required": false - }, + } + ], + "pathParamDetails": [ { - "name": "client_id", - "required": false + "name": "id", + "required": true, + "style": "simple", + "explode": false }, { - "name": "client_secret", - "required": false + "name": "installationId", + "required": true, + "style": "simple", + "explode": false } ], - "pathParamDetails": [], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], "paramsModel": { - "publicName": "OAuthOauthRevokeParams" + "publicName": "InstallationCreateAccessGroupParams" }, "requestBody": { "contentType": "application/json", @@ -20707,28 +19559,72 @@ "transport": "http" }, { - "resource": "oAuth", - "publicResource": "oAuth", - "operation": "oauthAuthorizationServerMetadata", - "publicOperation": "oauthAuthorizationServerMetadata", + "resource": "mcp.servers.installations", + "publicResource": "mcp.servers.installations", + "operation": "deleteAccessGroup", + "publicOperation": "deleteAccessGroup", "deprecated": false, - "method": "GET", - "path": "/.well-known/oauth-authorization-server", - "pathParams": [], - "publicPathParams": [], + "method": "DELETE", + "path": "/v1/mcp/servers/{id}/installations/{installationId}/access-group", + "pathParams": [ + "id", + "installationId" + ], + "publicPathParams": [ + "id", + "installationId" + ], "queryParams": [], "publicQueryParams": [], "headerParams": [], "publicHeaderParams": [], - "bodyParams": [], - "publicBodyParams": [], - "bodyParamDetails": [], - "pathParamDetails": [], + "bodyParams": [ + "accessGroupUid" + ], + "publicBodyParams": [ + "accessGroupUid" + ], + "bodyParamDetails": [ + { + "name": "accessGroupUid", + "required": true + } + ], + "pathParamDetails": [ + { + "name": "id", + "required": true, + "style": "simple", + "explode": false + }, + { + "name": "installationId", + "required": true, + "style": "simple", + "explode": false + } + ], "queryParamDetails": [], "headerParamDetails": [], "cookieParams": [], "publicCookieParams": [], "cookieParamDetails": [], + "paramsModel": { + "publicName": "InstallationDeleteAccessGroupParams" + }, + "requestBody": { + "contentType": "application/json", + "encoding": "json", + "contents": [ + { + "contentType": "application/json", + "encoding": "json" + } + ], + "required": true, + "publicName": "body", + "publicIdentifier": "body" + }, "response": { "status": "200", "contentType": "application/json", @@ -20740,10 +19636,6 @@ } ] }, - "responseModel": { - "name": "oauth_authorization_server_metadata", - "publicAliases": [] - }, "result": { "successStatus": "200", "errorStatuses": [ diff --git a/sig/scalar_api_ruby/client.rbs b/sig/scalar_api_ruby/client.rbs index 9c4afe3..62a044a 100644 --- a/sig/scalar_api_ruby/client.rbs +++ b/sig/scalar_api_ruby/client.rbs @@ -36,8 +36,6 @@ module Scalar attr_reader mcp: Scalar::Resources::Mcp - attr_reader o_auth: Scalar::Resources::OAuth - private def auth_headers: -> ::Hash[String, String] def initialize: ( diff --git a/sig/scalar_api_ruby/models.rbs b/sig/scalar_api_ruby/models.rbs index b01903d..7296249 100644 --- a/sig/scalar_api_ruby/models.rbs +++ b/sig/scalar_api_ruby/models.rbs @@ -57,22 +57,6 @@ module Scalar class Nanoid = Scalar::Models::Nanoid - class OauthAuthorizationServerMetadata = Scalar::Models::OauthAuthorizationServerMetadata - - class OauthError = Scalar::Models::OauthError - - class OAuthOauthAuthorizationServerMetadataParams = Scalar::Models::OAuthOauthAuthorizationServerMetadataParams - - class OAuthOauthAuthorizeParams = Scalar::Models::OAuthOauthAuthorizeParams - - class OAuthOauthRevokeParams = Scalar::Models::OAuthOauthRevokeParams - - class OAuthOauthTokenParams = Scalar::Models::OAuthOauthTokenParams - - module OauthScope = Scalar::Models::OauthScope - - class OauthToken = Scalar::Models::OauthToken - class RegistryCreateAPIDocumentAccessGroupParams = Scalar::Models::RegistryCreateAPIDocumentAccessGroupParams class RegistryCreateAPIDocumentParams = Scalar::Models::RegistryCreateAPIDocumentParams diff --git a/sig/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbs b/sig/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbs deleted file mode 100644 index 7161f18..0000000 --- a/sig/scalar_api_ruby/models/o_auth_oauth_authorization_server_metadata_params.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Scalar - module Models - type o_auth_oauth_authorization_server_metadata_params = - { } & Scalar::Internal::Type::request_parameters - - class OAuthOauthAuthorizationServerMetadataParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - def initialize: (?request_options: Scalar::request_opts) -> void - - def to_hash: -> { request_options: Scalar::RequestOptions } - end - end -end diff --git a/sig/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbs b/sig/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbs deleted file mode 100644 index a571ecd..0000000 --- a/sig/scalar_api_ruby/models/o_auth_oauth_authorize_params.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Scalar - module Models - type o_auth_oauth_authorize_params = - { } & Scalar::Internal::Type::request_parameters - - class OAuthOauthAuthorizeParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - def initialize: (?request_options: Scalar::request_opts) -> void - - def to_hash: -> { request_options: Scalar::RequestOptions } - end - end -end diff --git a/sig/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbs b/sig/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbs deleted file mode 100644 index d9a25ac..0000000 --- a/sig/scalar_api_ruby/models/o_auth_oauth_revoke_params.rbs +++ /dev/null @@ -1,47 +0,0 @@ -module Scalar - module Models - type o_auth_oauth_revoke_params = - { - token: String, - client_id: String, - client_secret: String, - token_type_hint: String - } - & Scalar::Internal::Type::request_parameters - - class OAuthOauthRevokeParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - attr_accessor token: String - - attr_reader client_id: String? - - def client_id=: (String) -> String - - attr_reader client_secret: String? - - def client_secret=: (String) -> String - - attr_reader token_type_hint: String? - - def token_type_hint=: (String) -> String - - def initialize: ( - token: String, - ?client_id: String, - ?client_secret: String, - ?token_type_hint: String, - ?request_options: Scalar::request_opts - ) -> void - - def to_hash: -> { - token: String, - client_id: String, - client_secret: String, - token_type_hint: String, - request_options: Scalar::RequestOptions - } - end - end -end diff --git a/sig/scalar_api_ruby/models/o_auth_oauth_token_params.rbs b/sig/scalar_api_ruby/models/o_auth_oauth_token_params.rbs deleted file mode 100644 index 1e0b00e..0000000 --- a/sig/scalar_api_ruby/models/o_auth_oauth_token_params.rbs +++ /dev/null @@ -1,75 +0,0 @@ -module Scalar - module Models - type o_auth_oauth_token_params = - { - grant_type: String, - client_id: String, - client_secret: String, - code: String, - code_verifier: String, - redirect_uri: String, - refresh_token: String, - scope: String - } - & Scalar::Internal::Type::request_parameters - - class OAuthOauthTokenParams < Scalar::Internal::Type::BaseModel - extend Scalar::Internal::Type::RequestParameters::Converter - include Scalar::Internal::Type::RequestParameters - - attr_accessor grant_type: String - - attr_reader client_id: String? - - def client_id=: (String) -> String - - attr_reader client_secret: String? - - def client_secret=: (String) -> String - - attr_reader code: String? - - def code=: (String) -> String - - attr_reader code_verifier: String? - - def code_verifier=: (String) -> String - - attr_reader redirect_uri: String? - - def redirect_uri=: (String) -> String - - attr_reader refresh_token: String? - - def refresh_token=: (String) -> String - - attr_reader scope: String? - - def scope=: (String) -> String - - def initialize: ( - grant_type: String, - ?client_id: String, - ?client_secret: String, - ?code: String, - ?code_verifier: String, - ?redirect_uri: String, - ?refresh_token: String, - ?scope: String, - ?request_options: Scalar::request_opts - ) -> void - - def to_hash: -> { - grant_type: String, - client_id: String, - client_secret: String, - code: String, - code_verifier: String, - redirect_uri: String, - refresh_token: String, - scope: String, - request_options: Scalar::RequestOptions - } - end - end -end diff --git a/sig/scalar_api_ruby/models/o_auth_oauth_token_response.rbs b/sig/scalar_api_ruby/models/o_auth_oauth_token_response.rbs deleted file mode 100644 index 7f6120e..0000000 --- a/sig/scalar_api_ruby/models/o_auth_oauth_token_response.rbs +++ /dev/null @@ -1,11 +0,0 @@ -module Scalar - module Models - type o_auth_oauth_token_response = Scalar::OauthToken | Scalar::OauthError - - module OAuthOauthTokenResponse - extend Scalar::Internal::Type::Union - - def self?.variants: -> ::Array[Scalar::Models::o_auth_oauth_token_response] - end - end -end diff --git a/sig/scalar_api_ruby/models/oauth_authorization_server_metadata.rbs b/sig/scalar_api_ruby/models/oauth_authorization_server_metadata.rbs deleted file mode 100644 index 0985a7f..0000000 --- a/sig/scalar_api_ruby/models/oauth_authorization_server_metadata.rbs +++ /dev/null @@ -1,65 +0,0 @@ -module Scalar - module Models - type oauth_authorization_server_metadata = - { - authorization_endpoint: String, - code_challenge_methods_supported: ::Array[String], - grant_types_supported: ::Array[String], - issuer: String, - response_types_supported: ::Array[String], - revocation_endpoint: String, - revocation_endpoint_auth_methods_supported: ::Array[String], - scopes_supported: ::Array[String], - token_endpoint: String, - token_endpoint_auth_methods_supported: ::Array[String] - } - - class OauthAuthorizationServerMetadata < Scalar::Internal::Type::BaseModel - attr_accessor authorization_endpoint: String - - attr_accessor code_challenge_methods_supported: ::Array[String] - - attr_accessor grant_types_supported: ::Array[String] - - attr_accessor issuer: String - - attr_accessor response_types_supported: ::Array[String] - - attr_accessor revocation_endpoint: String - - attr_accessor revocation_endpoint_auth_methods_supported: ::Array[String] - - attr_accessor scopes_supported: ::Array[String] - - attr_accessor token_endpoint: String - - attr_accessor token_endpoint_auth_methods_supported: ::Array[String] - - def initialize: ( - authorization_endpoint: String, - code_challenge_methods_supported: ::Array[String], - grant_types_supported: ::Array[String], - issuer: String, - response_types_supported: ::Array[String], - revocation_endpoint: String, - revocation_endpoint_auth_methods_supported: ::Array[String], - scopes_supported: ::Array[String], - token_endpoint: String, - token_endpoint_auth_methods_supported: ::Array[String] - ) -> void - - def to_hash: -> { - authorization_endpoint: String, - code_challenge_methods_supported: ::Array[String], - grant_types_supported: ::Array[String], - issuer: String, - response_types_supported: ::Array[String], - revocation_endpoint: String, - revocation_endpoint_auth_methods_supported: ::Array[String], - scopes_supported: ::Array[String], - token_endpoint: String, - token_endpoint_auth_methods_supported: ::Array[String] - } - end - end -end diff --git a/sig/scalar_api_ruby/models/oauth_error.rbs b/sig/scalar_api_ruby/models/oauth_error.rbs deleted file mode 100644 index d42c37b..0000000 --- a/sig/scalar_api_ruby/models/oauth_error.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module Scalar - module Models - type oauth_error = { error: String, error_description: String } - - class OauthError < Scalar::Internal::Type::BaseModel - attr_accessor error: String - - attr_reader error_description: String? - - def error_description=: (String) -> String - - def initialize: (error: String, ?error_description: String) -> void - - def to_hash: -> { error: String, error_description: String } - end - end -end diff --git a/sig/scalar_api_ruby/models/oauth_scope.rbs b/sig/scalar_api_ruby/models/oauth_scope.rbs deleted file mode 100644 index fb4dcaa..0000000 --- a/sig/scalar_api_ruby/models/oauth_scope.rbs +++ /dev/null @@ -1,15 +0,0 @@ -module Scalar - module Models - type oauth_scope = :read | :write | :admin - - module OauthScope - extend Scalar::Internal::Type::Enum - - READ: :read - WRITE: :write - ADMIN: :admin - - def self?.values: -> ::Array[Scalar::Models::oauth_scope] - end - end -end diff --git a/sig/scalar_api_ruby/models/oauth_token.rbs b/sig/scalar_api_ruby/models/oauth_token.rbs deleted file mode 100644 index 1f6f32c..0000000 --- a/sig/scalar_api_ruby/models/oauth_token.rbs +++ /dev/null @@ -1,40 +0,0 @@ -module Scalar - module Models - type oauth_token = - { - access_token: String, - expires_in: Integer, - refresh_token: String, - scope: Scalar::Models::oauth_scope, - token_type: :Bearer - } - - class OauthToken < Scalar::Internal::Type::BaseModel - attr_accessor access_token: String - - attr_accessor expires_in: Integer - - attr_accessor refresh_token: String - - attr_accessor scope: Scalar::Models::oauth_scope - - attr_accessor token_type: :Bearer - - def initialize: ( - access_token: String, - expires_in: Integer, - refresh_token: String, - scope: Scalar::Models::oauth_scope, - ?token_type: :Bearer - ) -> void - - def to_hash: -> { - access_token: String, - expires_in: Integer, - refresh_token: String, - scope: Scalar::Models::oauth_scope, - token_type: :Bearer - } - end - end -end diff --git a/sig/scalar_api_ruby/resources/o_auth.rbs b/sig/scalar_api_ruby/resources/o_auth.rbs deleted file mode 100644 index 12022dc..0000000 --- a/sig/scalar_api_ruby/resources/o_auth.rbs +++ /dev/null @@ -1,33 +0,0 @@ -module Scalar - module Resources - class OAuth - def oauth_authorization_server_metadata: ( - ?request_options: Scalar::request_opts - ) -> Scalar::OauthAuthorizationServerMetadata - - def oauth_authorize: (?request_options: Scalar::request_opts) -> top - - def oauth_revoke: ( - token: String, - ?client_id: String, - ?client_secret: String, - ?token_type_hint: String, - ?request_options: Scalar::request_opts - ) -> Scalar::OauthError - - def oauth_token: ( - grant_type: String, - ?client_id: String, - ?client_secret: String, - ?code: String, - ?code_verifier: String, - ?redirect_uri: String, - ?refresh_token: String, - ?scope: String, - ?request_options: Scalar::request_opts - ) -> Scalar::Models::o_auth_oauth_token_response - - def initialize: (client: Scalar::Client) -> void - end - end -end diff --git a/tests/smoke-test.rb b/tests/smoke-test.rb index e92379e..f2853a9 100644 --- a/tests/smoke-test.rb +++ b/tests/smoke-test.rb @@ -1160,61 +1160,6 @@ {id: "42", access_group_uid: "UakgbKJ5m9gl0JDMbcJqL"} ) end - }, - { - operation: "oauthAuthorizationServerMetadata", - method: "GET", - path: "/.well-known/oauth-authorization-server", - run: -> { client.o_auth.oauth_authorization_server_metadata } - }, - { - operation: "oauthAuthorize", - method: "GET", - path: "/v1/oauth/authorize", - run: -> { client.o_auth.oauth_authorize } - }, - { - operation: "oauthRevoke", - method: "POST", - path: "/v1/oauth/revoke", - label: "required params", - run: -> { client.o_auth.oauth_revoke({token: ""}) } - }, - { - operation: "oauthRevoke", - method: "POST", - path: "/v1/oauth/revoke", - label: "all params", - run: -> do - client.o_auth.oauth_revoke({token: "", client_id: "", client_secret: "", token_type_hint: ""}) - end - }, - { - operation: "oauthToken", - method: "POST", - path: "/v1/oauth/token", - label: "required params", - run: -> { client.o_auth.oauth_token({grant_type: ""}) } - }, - { - operation: "oauthToken", - method: "POST", - path: "/v1/oauth/token", - label: "all params", - run: -> do - client.o_auth.oauth_token( - { - grant_type: "", - client_id: "", - client_secret: "", - code: "", - code_verifier: "", - redirect_uri: "", - refresh_token: "", - scope: "" - } - ) - end } ] From b012cf99690a404e82e60132f32288c7bdee0a81 Mon Sep 17 00:00:00 2001 From: scalarbot Date: Mon, 5 Oct 2026 21:48:26 +0000 Subject: [PATCH 5/7] feat(api)!: update auth scheme OAuth2 (+1 more change) - Regenerated with generator `0.36.3` (previously `0.36.0`). - Configuration of `oauth2` auth scheme `OAuth2` changed. BREAKING CHANGE: Configuration of `oauth2` auth scheme `OAuth2` changed. Build: VDFfd4JAAL0Bnz1W63jkU --- scalar-sdk.manifest.json | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/scalar-sdk.manifest.json b/scalar-sdk.manifest.json index e34bbeb..f060424 100644 --- a/scalar-sdk.manifest.json +++ b/scalar-sdk.manifest.json @@ -1,7 +1,7 @@ { "name": "Scalar", "slug": "scalar", - "generatorVersion": "0.36.0", + "generatorVersion": "0.36.3", "servers": [ "https://access.scalar.com" ], @@ -27,13 +27,12 @@ "flows": [ { "kind": "authorizationCode", - "authorizationUrl": "https://access.scalar.com/v1/oauth/authorize", - "tokenUrl": "https://access.scalar.com/v1/oauth/token", - "refreshUrl": "https://access.scalar.com/v1/oauth/token", + "authorizationUrl": "https://auth.scalar.com/_scalar/oauth/authorize", + "tokenUrl": "https://auth.scalar.com/_scalar/oauth/token", "scopes": [ - "read", - "write", - "admin" + "platform:read", + "platform:write", + "platform:admin" ] } ] From a767517d8290873f7946c6dc8ac5c1e926109625 Mon Sep 17 00:00:00 2001 From: scalarbot Date: Tue, 6 Oct 2026 16:35:07 +0000 Subject: [PATCH 6/7] feat(api)!: update schema method MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Schema `method` changed from `enum(delete | get | head | …)` to `string`. BREAKING CHANGE: Schema `method` changed from `enum(delete | get | head | …)` to `string`. Build: ffXO34OxOwh6yZs1U9pY1 --- .../models/managed_doc_version.rb | 6 +-- lib/scalar_api_ruby/models/method.rb | 17 +------- .../models/managed_doc_version.rbi | 6 +-- rbi/scalar_api_ruby/models/method.rbi | 21 +--------- scalar-sdk.manifest.json | 39 +++---------------- sig/scalar_api_ruby/models.rbs | 2 +- .../models/managed_doc_version.rbs | 8 ++-- sig/scalar_api_ruby/models/method.rbs | 27 +------------ 8 files changed, 19 insertions(+), 107 deletions(-) diff --git a/lib/scalar_api_ruby/models/managed_doc_version.rb b/lib/scalar_api_ruby/models/managed_doc_version.rb index 6b938bf..3733748 100644 --- a/lib/scalar_api_ruby/models/managed_doc_version.rb +++ b/lib/scalar_api_ruby/models/managed_doc_version.rb @@ -89,8 +89,8 @@ class Tool < Scalar::Internal::Type::BaseModel # @!attribute method_ # - # @return [Symbol, Scalar::Models::Method] - required :method_, enum: -> { Scalar::Method }, api_name: :method + # @return [String] + required :method_, String, api_name: :method # @!attribute path # @@ -99,7 +99,7 @@ class Tool < Scalar::Internal::Type::BaseModel # @!method initialize(enabled_tools:, method_:, path:) # @param enabled_tools [Array] - # @param method_ [Symbol, Scalar::Models::Method] + # @param method_ [String] # @param path [String] module EnabledTool diff --git a/lib/scalar_api_ruby/models/method.rb b/lib/scalar_api_ruby/models/method.rb index 43e3d69..c103989 100644 --- a/lib/scalar_api_ruby/models/method.rb +++ b/lib/scalar_api_ruby/models/method.rb @@ -2,21 +2,6 @@ module Scalar module Models - module Method - extend Scalar::Internal::Type::Enum - - DELETE = :delete - GET = :get - HEAD = :head - OPTIONS = :options - PATCH = :patch - POST = :post - PUT = :put - QUERY = :query - TRACE = :trace - - # @!method self.values - # @return [Array] - end + Method = String end end diff --git a/rbi/scalar_api_ruby/models/managed_doc_version.rbi b/rbi/scalar_api_ruby/models/managed_doc_version.rbi index 81205f5..8c8130b 100644 --- a/rbi/scalar_api_ruby/models/managed_doc_version.rbi +++ b/rbi/scalar_api_ruby/models/managed_doc_version.rbi @@ -134,7 +134,7 @@ module Scalar end attr_accessor :enabled_tools - sig { returns(Scalar::Method::TaggedSymbol) } + sig { returns(String) } attr_accessor :method_ sig { returns(String) } @@ -144,7 +144,7 @@ module Scalar params( enabled_tools: T::Array[Scalar::ManagedDocVersion::Tool::EnabledTool::OrSymbol], - method_: Scalar::Method::OrSymbol, + method_: String, path: String ).returns(T.attached_class) end @@ -158,7 +158,7 @@ module Scalar T::Array[ Scalar::ManagedDocVersion::Tool::EnabledTool::TaggedSymbol ], - method_: Scalar::Method::TaggedSymbol, + method_: String, path: String } ) diff --git a/rbi/scalar_api_ruby/models/method.rbi b/rbi/scalar_api_ruby/models/method.rbi index f20000a..ac637b5 100644 --- a/rbi/scalar_api_ruby/models/method.rbi +++ b/rbi/scalar_api_ruby/models/method.rbi @@ -2,25 +2,6 @@ module Scalar module Models - module Method - extend Scalar::Internal::Type::Enum - - TaggedSymbol = T.type_alias { T.all(Symbol, Scalar::Method) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - DELETE = T.let(:delete, Scalar::Method::TaggedSymbol) - GET = T.let(:get, Scalar::Method::TaggedSymbol) - HEAD = T.let(:head, Scalar::Method::TaggedSymbol) - OPTIONS = T.let(:options, Scalar::Method::TaggedSymbol) - PATCH = T.let(:patch, Scalar::Method::TaggedSymbol) - POST = T.let(:post, Scalar::Method::TaggedSymbol) - PUT = T.let(:put, Scalar::Method::TaggedSymbol) - QUERY = T.let(:query, Scalar::Method::TaggedSymbol) - TRACE = T.let(:trace, Scalar::Method::TaggedSymbol) - - sig { override.returns(T::Array[Scalar::Method::TaggedSymbol]) } - def self.values - end - end + Method = String end end diff --git a/scalar-sdk.manifest.json b/scalar-sdk.manifest.json index f060424..541a2fa 100644 --- a/scalar-sdk.manifest.json +++ b/scalar-sdk.manifest.json @@ -789,40 +789,11 @@ "publicAliases": [], "deprecated": false, "type": { - "kind": "enum", - "values": [ - "delete", - "get", - "head", - "options", - "patch", - "post", - "put", - "query", - "trace" - ], - "names": [ - "Delete", - "Get", - "Head", - "Options", - "Patch", - "Post", - "Put", - "Query", - "Trace" - ], - "deprecations": [ - false, - false, - false, - false, - false, - false, - false, - false, - false - ] + "kind": "primitive", + "type": "string", + "validation": { + "pattern": "^[!#$%&'*+.^_`|~0-9A-Za-z-]+$" + } } }, { diff --git a/sig/scalar_api_ruby/models.rbs b/sig/scalar_api_ruby/models.rbs index 7296249..5ae80b6 100644 --- a/sig/scalar_api_ruby/models.rbs +++ b/sig/scalar_api_ruby/models.rbs @@ -49,7 +49,7 @@ module Scalar module Mcp = Scalar::Models::Mcp - module Method = Scalar::Models::Method + class Method = Scalar::Models::Method class Namespace = Scalar::Models::Namespace diff --git a/sig/scalar_api_ruby/models/managed_doc_version.rbs b/sig/scalar_api_ruby/models/managed_doc_version.rbs index fe416d5..aef9ab8 100644 --- a/sig/scalar_api_ruby/models/managed_doc_version.rbs +++ b/sig/scalar_api_ruby/models/managed_doc_version.rbs @@ -83,26 +83,26 @@ module Scalar type tool = { enabled_tools: ::Array[Scalar::Models::ManagedDocVersion::Tool::enabled_tool], - method_: Scalar::Models::method_, + method_: String, path: String } class Tool < Scalar::Internal::Type::BaseModel attr_accessor enabled_tools: ::Array[Scalar::Models::ManagedDocVersion::Tool::enabled_tool] - attr_accessor method_: Scalar::Models::method_ + attr_accessor method_: String attr_accessor path: String def initialize: ( enabled_tools: ::Array[Scalar::Models::ManagedDocVersion::Tool::enabled_tool], - method_: Scalar::Models::method_, + method_: String, path: String ) -> void def to_hash: -> { enabled_tools: ::Array[Scalar::Models::ManagedDocVersion::Tool::enabled_tool], - method_: Scalar::Models::method_, + method_: String, path: String } diff --git a/sig/scalar_api_ruby/models/method.rbs b/sig/scalar_api_ruby/models/method.rbs index dbfa7ae..92f2ff0 100644 --- a/sig/scalar_api_ruby/models/method.rbs +++ b/sig/scalar_api_ruby/models/method.rbs @@ -1,30 +1,5 @@ module Scalar module Models - type method_ = - :delete - | :get - | :head - | :options - | :patch - | :post - | :put - | :query - | :trace - - module Method - extend Scalar::Internal::Type::Enum - - DELETE: :delete - GET: :get - HEAD: :head - OPTIONS: :options - PATCH: :patch - POST: :post - PUT: :put - QUERY: :query - TRACE: :trace - - def self?.values: -> ::Array[Scalar::Models::method_] - end + class Method = String end end From 96b8510e2ef3dd5a4717bf00da75fc2fc89fd4b4 Mon Sep 17 00:00:00 2001 From: "scalar-docs[bot]" <148485328+scalar-docs[bot]@users.noreply.github.com> Date: Fri, 9 Oct 2026 18:46:51 +0000 Subject: [PATCH 7/7] release: 0.2.0 --- .claude/skills/scalar-ruby-sdk/SKILL.md | 2 +- .release-please-manifest.json | 2 +- CHANGELOG.md | 44 +++++++++++++++++++++++++ Gemfile.lock | 2 +- README.md | 2 +- SKILL.md | 2 +- lib/scalar_api_ruby/version.rb | 2 +- 7 files changed, 50 insertions(+), 6 deletions(-) diff --git a/.claude/skills/scalar-ruby-sdk/SKILL.md b/.claude/skills/scalar-ruby-sdk/SKILL.md index 59c4c4c..9a4e14e 100644 --- a/.claude/skills/scalar-ruby-sdk/SKILL.md +++ b/.claude/skills/scalar-ruby-sdk/SKILL.md @@ -12,7 +12,7 @@ Generated Ruby client for Scalar API, published as `scalar_api_ruby`. Use the ge Add the gem to your application's `Gemfile`: ```ruby -gem "scalar_api_ruby", "~> 0.1.0" # x-release-please-version +gem "scalar_api_ruby", "~> 0.2.0" # x-release-please-version ``` Or install it directly: diff --git a/.release-please-manifest.json b/.release-please-manifest.json index a915e8c..2be9c43 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.1" + ".": "0.2.0" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 849f575..ba76098 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,49 @@ # Changelog +## [0.2.0](https://github.com/scalar/scalar-ruby/compare/v0.1.1...v0.2.0) (2026-10-09) + + +### ⚠ BREAKING CHANGES + +* **api:** Schema `method` changed from `enum(delete | get | head | …)` to `string`. +* **api:** Configuration of `oauth2` auth scheme `OAuth2` changed. +* **api:** 10 breaking changes to the SDK surface. + - Removed operation `oAuth.oauthAuthorize` (`GET /v1/oauth/authorize`). + - Removed operation `oAuth.oauthToken` (`POST /v1/oauth/token`). + - Removed operation `oAuth.oauthRevoke` (`POST /v1/oauth/revoke`). + - Removed operation `oAuth.oauthAuthorizationServerMetadata` (`GET /.well-known/oauth-authorization-server`). + - Removed schema `oauth_token`. + - Removed schema `oauth_scope`. + - Removed schema `oauth_error`. + - Removed schema `oauth_token_request`. + - Removed schema `oauth_revoke_request`. + - Removed schema `oauth_authorization_server_metadata`. +* **api:** 4 breaking changes to the SDK surface. + - Property `api_document.tags` type changed from `unknown` to `string`. + - Property `managed_doc_version.tools` type changed from `Array` to `Array`. + - Property `github_project.accessGroups` type changed from `unknown` to `string`. + - Property `docs_project.accessGroups` type changed from `unknown` to `string`. +* **api:** 10 breaking changes to the SDK surface. + - Removed body field `lastKnownVersionSha` from `registry.updateApiDocumentVersion`. + - Removed body field `lastKnownVersionSha` from `registry.createApiDocumentVersion`. + - Response of `schemas.version.create` changed from `uid` to `none`. + - Schema `slug` shape changed. + - Schema `namespace` shape changed. + - Added required property `managed_doc_version.endpointCount`. + - Removed optional property `managed_doc_version.versionSha`. + - Schema `method` shape changed. + - Added required property `github_project.userInfoHookUrl`. + - Added required property `github_project.analyticsEnabled`. + +### Features + +* **api:** add operation accessGroups.create (+66 more changes) ([6808193](https://github.com/scalar/scalar-ruby/commit/68081934feaa706b74cfd4902e57ae856d8c0f45)) +* **api:** remove operation oAuth.oauthAuthorize (+9 more changes) ([04d9ebb](https://github.com/scalar/scalar-ruby/commit/04d9ebb2a30e0d09d3e236668e2d7c9d27d3a15b)) +* **api:** update auth scheme OAuth2 (+1 more change) ([b012cf9](https://github.com/scalar/scalar-ruby/commit/b012cf99690a404e82e60132f32288c7bdee0a81)) +* **api:** update property api_document.tags (+3 more changes) ([21db53f](https://github.com/scalar/scalar-ruby/commit/21db53f16e8ed92be07de3f544e780bb44373872)) +* **api:** update schema method ([a767517](https://github.com/scalar/scalar-ruby/commit/a767517d8290873f7946c6dc8ac5c1e926109625)) +* **api:** update SDK surface (15 changes) ([ec912cc](https://github.com/scalar/scalar-ruby/commit/ec912cc28d1b0a39bda9e8a398a9b59b928f031c)) + ## [0.1.1](https://github.com/scalar/scalar-ruby/compare/v0.1.0...v0.1.1) (2026-09-15) diff --git a/Gemfile.lock b/Gemfile.lock index f062ed1..84cc27c 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - scalar_api_ruby (0.1.0) + scalar_api_ruby (0.2.0) cgi connection_pool diff --git a/README.md b/README.md index 6b4366e..250a976 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ The full API of this library can be found in [api.md](./api.md). Add the gem to your application's `Gemfile`: ```ruby -gem "scalar_api_ruby", "~> 0.1.0" # x-release-please-version +gem "scalar_api_ruby", "~> 0.2.0" # x-release-please-version ``` Or install it directly: diff --git a/SKILL.md b/SKILL.md index 944eb1c..2e108b9 100644 --- a/SKILL.md +++ b/SKILL.md @@ -12,7 +12,7 @@ Generated Ruby client for Scalar API, published as `scalar_api_ruby`. Use the ge Add the gem to your application's `Gemfile`: ```ruby -gem "scalar_api_ruby", "~> 0.1.0" # x-release-please-version +gem "scalar_api_ruby", "~> 0.2.0" # x-release-please-version ``` Or install it directly: diff --git a/lib/scalar_api_ruby/version.rb b/lib/scalar_api_ruby/version.rb index bca90b8..94fb104 100644 --- a/lib/scalar_api_ruby/version.rb +++ b/lib/scalar_api_ruby/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Scalar - VERSION = "0.1.1" # x-release-please-version + VERSION = "0.2.0" # x-release-please-version end